isaacscript-common 15.0.0 → 15.0.2

package/src/classes/features/callbackLogic/GameReorderedCallbacks.ts

@@ -1,11 +1,3 @@
-// By default, callbacks fire in the following order:
-// - `POST_NEW_ROOM` --> `POST_NEW_LEVEL` --> `POST_GAME_STARTED`
-
-// It is easier to write mod code if the callbacks run in a more logical order:
-// - `POST_GAME_STARTED` --> `POST_NEW_LEVEL` --> `POST_NEW_ROOM`
-
-// Manually reorganize the callback execution so that this is the case.
-
 import {
   CollectibleType,
   LevelStage,
@@ -20,6 +12,15 @@ import { PostNewLevelReordered } from "../../callbacks/PostNewLevelReordered";
 import { PostNewRoomReordered } from "../../callbacks/PostNewRoomReordered";
 import { Feature } from "../../private/Feature";
 
+/**
+ * By default, callbacks fire in the following order:
+ * - `POST_NEW_ROOM` --> `POST_NEW_LEVEL` --> `POST_GAME_STARTED`
+ *
+ * It is easier to write mod code if the callbacks run in a more logical order:
+ * - `POST_GAME_STARTED` --> `POST_NEW_LEVEL` --> `POST_NEW_ROOM`
+ *
+ * Manually reorganize the callback execution so that this is the case.
+ */
 export class GameReorderedCallbacks extends Feature {
   private currentStage: int | null = null;
   private currentStageType: int | null = null;
@@ -134,16 +135,50 @@ export class GameReorderedCallbacks extends Feature {
     this.currentStageType = stageType;
   }
 
+  /**
+   * Helper function to tell the `POST_NEW_LEVEL_REORDERED` callback that it should always fire on
+   * the next `POST_NEW_LEVEL`.
+   *
+   * If some specific cases, mods can change the current level during run initialization on the 0th
+   * frame. However, due to how the callback reordering works, the custom `POST_NEW_LEVEL` callback
+   * will never fire on the 0th frame. To get around this, call this function before changing levels
+   * to temporarily force the callback to fire.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.CUSTOM_GRID_ENTITIES`.
+   */
   @Exported
   public forceNewLevelCallback(): void {
     this.forceNewLevel = true;
   }
 
+  /**
+   * Helper function to tell the `POST_NEW_ROOM_REORDERED` callback that it should always fire on
+   * the next `POST_NEW_ROOM`.
+   *
+   * If some specific cases, mods can change the current room during run initialization on the 0th
+   * frame. However, due to how the callback reordering works, the custom `POST_NEW_ROOM` callback
+   * will never fire on the 0th frame. To get around this, call this function before changing rooms
+   * to temporarily force the callback to fire.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.CUSTOM_GRID_ENTITIES`.
+   */
   @Exported
   public forceNewRoomCallback(): void {
     this.forceNewRoom = true;
   }
 
+  /**
+   * Helper function to manually set the variable that the reordered callback logic uses to track
+   * the current stage and stage type.
+   *
+   * This is useful because if the stage is changed with the `Game.SetStage` method, the reordered
+   * callbacks will stop working.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.CUSTOM_GRID_ENTITIES`.
+   */
   @Exported
   public reorderedCallbacksSetStage(
     stage: LevelStage,

package/src/classes/features/other/CharacterHealthConversion.ts

@@ -80,6 +80,9 @@ export class CharacterHealthConversion extends Feature {
    * containers --> soul hearts) or Dark Judas (red heart containers --> black hearts).
    *
    * Call this function once at the beginning of your mod to declare the health conversion type.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.CHARACTER_HEALTH_CONVERSION`.
    */
   @Exported
   public registerCharacterHealthConversion(

package/src/classes/features/other/CharacterStats.ts

@@ -56,6 +56,8 @@ export class CharacterStats extends Feature {
    *
    * Note that the format for the `CacheFlag.FIRE_DELAY` value should be in the tears stat format,
    * not the `MaxFireDelay` format.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CHARACTER_STATS`.
    */
   @Exported
   public registerCharacterStats(

package/src/classes/features/other/CollectibleItemPoolType.ts

@@ -49,6 +49,9 @@ export class CollectibleItemPoolType extends Feature {
    * Helper function to get the item pool type that a given collectible came from. Since there is no
    * native method in the API to get this, we listen in the `PRE_GET_COLLECTIBLE` callback for item
    * pool types, and then assume that the next spawned collectible will match.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.COLLECTIBLE_ITEM_POOL_TYPE`.
    */
   @Exported
   public getCollectibleItemPoolType(collectible: EntityPickup): ItemPoolType {

package/src/classes/features/other/CustomHotkeys.ts

@@ -71,6 +71,8 @@ export class CustomHotkeys extends Feature {
    * hardcoded and is instead the return value of a provided function. This is useful for situations
    * where the key can change (like if end-users can specify a custom hotkey using Mod Config Menu).
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_HOTKEYS`.
+   *
    * @param getKeyFunc The function that returns the key that will trigger the hotkey.
    * @param triggerFunc A function containing the arbitrary code that you want to execute when the
    *                    hotkey is triggered.
@@ -95,6 +97,8 @@ export class CustomHotkeys extends Feature {
    * This can be used to easily set up custom hotkeys to facilitate custom game features or to
    * assist in debugging.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_HOTKEYS`.
+   *
    * @param keyboard The key that you want to trigger the hotkey.
    * @param triggerFunc A function containing the arbitrary code that you want to execute when the
    *                    hotkey is triggered.
@@ -113,6 +117,8 @@ export class CustomHotkeys extends Feature {
   /**
    * Helper function to remove a hotkey created with the `setConditionalHotkey` function.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_HOTKEYS`.
+   *
    * @param getKeyFunc Equal to the `getKeyFunc` that you passed when initially registering the
    *                   hotkey.
    */
@@ -130,6 +136,8 @@ export class CustomHotkeys extends Feature {
   /**
    * Helper function to remove a hotkey created with the `setHotkey` function.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_HOTKEYS`.
+   *
    * @param keyboard Equal to the keyboard value that you passed when initially registering the
    *                 hotkey.
    */

package/src/classes/features/other/CustomItemPools.ts

@@ -64,6 +64,8 @@ export class CustomItemPools extends Feature {
    *
    * Note that custom item pools do not currently support partial weight decrementation on sight.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_ITEM_POOLS`.
+   *
    * @param itemPoolTypeCustom An integer that identifies what kind of item pool you are creating.
    *                           It should correspond to a local `ItemPoolTypeCustom` enum in your
    *                           mod. The integer can be any unique value and can safely overlap with
@@ -95,6 +97,8 @@ export class CustomItemPools extends Feature {
    * By default, a collectible will not be removed from the pool once it is selected, unless the
    * `decrease` argument is set to true (similar to how a vanilla item pool works).
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_ITEM_POOLS`.
+   *
    * @param itemPoolTypeCustom An integer representing the custom item pool to use.
    * @param decrease Optional. Whether or not to remove the selected collectible from the item pool.
    *                 Default is true.

package/src/classes/features/other/CustomPickups.ts

@@ -120,6 +120,8 @@ export class CustomPickups extends Feature {
    * Note that when you specify your custom pickup in the "entities2.xml" file, it should have a
    * type of "5" and be associated with an anm2 file that has a "Collect" animation.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_PICKUPS`.
+   *
    * @param pickupVariantCustom The variant for the corresponding custom pickup.
    * @param subType The sub-type for the corresponding custom pickup.
    * @param collectFunc The function to run when the player collects this pickup.

package/src/classes/features/other/CustomStages.ts

@@ -400,8 +400,9 @@ export class CustomStages extends Feature {
    * Helper function to warp to a custom stage/level.
    *
    * Custom stages/levels must first be defined in the "tsconfig.json" file. See the documentation
-   * for
-   * more details: https://isaacscript.github.io/main/custom-stages/
+   * for more details: https://isaacscript.github.io/main/custom-stages/
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_STAGES`.
    *
    * @param name The name of the custom stage, corresponding to what is in the "tsconfig.json" file.
    * @param firstFloor Optional. Whether to go to the first floor or the second floor. For example,
@@ -489,6 +490,8 @@ export class CustomStages extends Feature {
   /**
    * Helper function to disable the custom stage. This is typically called before taking the player
    * to a vanilla floor.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_STAGES`.
    */
   @Exported
   public disableCustomStage(): void {

package/src/classes/features/other/CustomTrapdoors.ts

@@ -630,6 +630,8 @@ export class CustomTrapdoors extends Feature {
    * Registration is needed so that custom trapdoors can be serializable when the player saves and
    * quits.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_TRAPDOORS`.
+   *
    * @param destinationName The integer that identifies the type of custom trapdoor. It should
    *                        correspond to a local `CustomTrapdoorType` enum in your mod. The integer
    *                        can be any unique value and can safely overlap with values chosen by
@@ -669,6 +671,8 @@ export class CustomTrapdoors extends Feature {
    * Under the hood, the custom trapdoor is represented by a decoration grid entity and is manually
    * respawned every time the player re-enters the room.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_TRAPDOORS`.
+   *
    * @param gridIndexOrPosition The location in the room to spawn the trapdoor.
    * @param destinationName Optional. A string representing the name of the of destination that the
    *                        custom trapdoor will take the player to. Default is undefined, which

package/src/classes/features/other/DebugDisplay.ts

@@ -59,6 +59,8 @@ export class DebugDisplay extends Feature {
    * If the "togglePlayerDisplay" function is called, text will be drawn on the screen next to each
    * player. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setPlayerDisplay(
@@ -71,6 +73,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleTearDisplay" function is called, text will be drawn on the screen next to each
    * tear. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setTearDisplay(textCallback: (tear: EntityTear) => string): void {
@@ -81,6 +85,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleFamiliarDisplay" function is called, text will be drawn on the screen next to
    * each familiar. Use this function to specify a callback function that returns the string that
    * should be drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setFamiliarDisplay(
@@ -93,6 +99,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleBombDisplay" function is called, text will be drawn on the screen next to each
    * bomb. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setBombDisplay(textCallback: (bomb: EntityBomb) => string): void {
@@ -103,6 +111,8 @@ export class DebugDisplay extends Feature {
    * If the "togglePickupDisplay" function is called, text will be drawn on the screen next to each
    * pickup. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setPickupDisplay(
@@ -115,6 +125,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleSlotDisplay" function is called, text will be drawn on the screen next to each
    * slot. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setSlotDisplay(textCallback: (slot: Entity) => string): void {
@@ -125,6 +137,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleLaserDisplay" function is called, text will be drawn on the screen next to each
    * laser. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setLaserDisplay(textCallback: (laser: EntityLaser) => string): void {
@@ -135,6 +149,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleKnifeDisplay" function is called, text will be drawn on the screen next to each
    * knife. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setKnifeDisplay(textCallback: (knife: EntityKnife) => string): void {
@@ -145,6 +161,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleProjectileDisplay" function is called, text will be drawn on the screen next to
    * each projectile. Use this function to specify a callback function that returns the string that
    * should be drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setProjectileDisplay(
@@ -157,6 +175,8 @@ export class DebugDisplay extends Feature {
    * If the "extra console commands" feature is specified, the "effectDisplay" console command will
    * draw text on the screen next to each effect. Use this function to specify a callback function
    * that returns the string that should be drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setEffectDisplay(
@@ -169,6 +189,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleNPCDisplay" function is called, text will be drawn on the screen next to each
    * NPC. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setNPCDisplay(textCallback: (npc: EntityNPC) => string): void {
@@ -179,6 +201,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleRockDisplay" function is called, text will be drawn on the screen next to each
    * rock. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setRockDisplay(textCallback: (rock: GridEntityRock) => string): void {
@@ -189,6 +213,8 @@ export class DebugDisplay extends Feature {
    * If the "togglePitDisplay" function is called, text will be drawn on the screen next to each
    * pit. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setPitDisplay(textCallback: (pit: GridEntityPit) => string): void {
@@ -199,6 +225,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleSpikesDisplay" function is called, text will be drawn on the screen next to each
    * spikes. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setSpikesDisplay(
@@ -211,6 +239,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleTNTDisplay" function is called, text will be drawn on the screen next to each
    * TNT. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setTNTDisplay(textCallback: (tnt: GridEntityTNT) => string): void {
@@ -221,6 +251,8 @@ export class DebugDisplay extends Feature {
    * If the "togglePoopDisplay" function is called, text will be drawn on the screen next to each
    * poop. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setPoopDisplay(textCallback: (poop: GridEntityPoop) => string): void {
@@ -231,6 +263,8 @@ export class DebugDisplay extends Feature {
    * If the "toggleDoorDisplay" function is called, text will be drawn on the screen next to each
    * door. Use this function to specify a callback function that returns the string that should be
    * drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setDoorDisplay(textCallback: (door: GridEntityDoor) => string): void {
@@ -241,6 +275,8 @@ export class DebugDisplay extends Feature {
    * If the "togglePressurePlateDisplay" function is called, text will be drawn on the screen next
    * to each pressure plate. Use this function to specify a callback function that returns the
    * string that should be drawn.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public setPressurePlateDisplay(
@@ -265,13 +301,19 @@ export class DebugDisplay extends Feature {
 
   /**
    * Toggles the debug display for players, which will draw text on the screen next to each player.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public togglePlayerDisplay(): void {
     this.toggleFeature(this.player, "player");
   }
 
-  /** Toggles the debug display for tears, which will draw text on the screen next to each tear. */
+  /**
+   * Toggles the debug display for tears, which will draw text on the screen next to each tear.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+   */
   @Exported
   public toggleTearDisplay(): void {
     this.toggleFeature(this.tear, "tear");
@@ -280,13 +322,19 @@ export class DebugDisplay extends Feature {
   /**
    * Toggles the debug display for familiars, which will draw text on the screen next to each
    * familiar.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public toggleFamiliarDisplay(): void {
     this.toggleFeature(this.familiar, "familiar");
   }
 
-  /** Toggles the debug display for bombs, which will draw text on the screen next to each bomb. */
+  /**
+   * Toggles the debug display for bombs, which will draw text on the screen next to each bomb.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+   */
   @Exported
   public toggleBombDisplay(): void {
     this.toggleFeature(this.bomb, "bomb");
@@ -294,13 +342,19 @@ export class DebugDisplay extends Feature {
 
   /**
    * Toggles the debug display for pickups, which will draw text on the screen next to each pickup.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public togglePickupDisplay(): void {
     this.toggleFeature(this.pickup, "pickup");
   }
 
-  /** Toggles the debug display for slots, which will draw text on the screen next to each slot. */
+  /**
+   * Toggles the debug display for slots, which will draw text on the screen next to each slot.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+   */
   @Exported
   public toggleSlotDisplay(): void {
     this.toggleFeature(this.slot, "slot");
@@ -308,6 +362,8 @@ export class DebugDisplay extends Feature {
 
   /**
    * Toggles the debug display for lasers, which will draw text on the screen next to each laser.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public toggleLaserDisplay(): void {
@@ -316,6 +372,8 @@ export class DebugDisplay extends Feature {
 
   /**
    * Toggles the debug display for knives, which will draw text on the screen next to each knife.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public toggleKnifeDisplay(): void {
@@ -325,6 +383,8 @@ export class DebugDisplay extends Feature {
   /**
    * Toggles the debug display for projectiles, which will draw text on the screen next to each
    * projectile.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public toggleProjectileDisplay(): void {
@@ -333,25 +393,39 @@ export class DebugDisplay extends Feature {
 
   /**
    * Toggles the debug display for effects, which will draw text on the screen next to each effect.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public toggleEffectDisplay(): void {
     this.toggleFeature(this.effect, "effect");
   }
 
-  /** Toggles the debug display for NPCs, which will draw text on the screen next to each NPC. */
+  /**
+   * Toggles the debug display for NPCs, which will draw text on the screen next to each NPC.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+   */
   @Exported
   public toggleNPCDisplay(): void {
     this.toggleFeature(this.npc, "NPC");
   }
 
-  /** Toggles the debug display for rocks, which will draw text on the screen next to each rock. */
+  /**
+   * Toggles the debug display for rocks, which will draw text on the screen next to each rock.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+   */
   @Exported
   public toggleRockDisplay(): void {
     this.toggleFeature(this.rock, "rock");
   }
 
-  /** Toggles the debug display for pits, which will draw text on the screen next to each pit. */
+  /**
+   * Toggles the debug display for pits, which will draw text on the screen next to each pit.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+   */
   @Exported
   public togglePitDisplay(): void {
     this.toggleFeature(this.pit, "pit");
@@ -359,25 +433,39 @@ export class DebugDisplay extends Feature {
 
   /**
    * Toggles the debug display for spikes, which will draw text on the screen next to each spike.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public toggleSpikesDisplay(): void {
     this.toggleFeature(this.spikes, "spikes");
   }
 
-  /** Toggles the debug display for TNT, which will draw text on the screen next to each TNT. */
+  /**
+   * Toggles the debug display for TNT, which will draw text on the screen next to each TNT.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+   */
   @Exported
   public toggleTNTDisplay(): void {
     this.toggleFeature(this.tnt, "tnt");
   }
 
-  /** Toggles the debug display for poops, which will draw text on the screen next to each poop. */
+  /**
+   * Toggles the debug display for poops, which will draw text on the screen next to each poop.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+   */
   @Exported
   public togglePoopDisplay(): void {
     this.toggleFeature(this.poop, "poop");
   }
 
-  /** Toggles the debug display for doors, which will draw text on the screen next to each door. */
+  /**
+   * Toggles the debug display for doors, which will draw text on the screen next to each door.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+   */
   @Exported
   public toggleDoorDisplay(): void {
     this.toggleFeature(this.door, "door");
@@ -386,6 +474,8 @@ export class DebugDisplay extends Feature {
   /**
    * Toggles the debug display for pressure plates, which will draw text on the screen next to each
    * pressure plate.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
    */
   @Exported
   public togglePressurePlateDisplay(): void {

package/src/classes/features/other/DeployJSONRoom.ts

@@ -216,6 +216,8 @@ export class DeployJSONRoom extends Feature {
    * }
    * ```
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DEPLOY_JSON_ROOM`.
+   *
    * @param jsonRoom The JSON room to deploy.
    * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
    *                  the `RNG.Next` method will be called. Default is `getRandomSeed()`.

package/src/classes/features/other/DisableAllSound.ts

@@ -37,6 +37,8 @@ export class DisableAllSound extends Feature {
    *
    * Use this function to set things back to normal after having used `disableAllSounds`.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_ALL_SOUND`.
+   *
    * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
    *            that multiple mod features can work in tandem.
    */
@@ -61,6 +63,8 @@ export class DisableAllSound extends Feature {
    *
    * Use the `enableAllSounds` helper function to set things back to normal.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_ALL_SOUND`.
+   *
    * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
    *            that multiple mod features can work in tandem.
    */

package/src/classes/features/other/SpawnCollectible.ts

@@ -31,6 +31,8 @@ export class SpawnCollectible extends Feature {
    * to be a quest item), then you can use the `spawnCollectibleUnsafe` helper function instead
    * (which does not require an upgraded mod).
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.SPAWN_COLLECTIBLE`.
+   *
    * @param collectibleType The collectible type to spawn.
    * @param position The position to spawn the collectible at.
    * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
@@ -76,6 +78,8 @@ export class SpawnCollectible extends Feature {
    * collectibles costing coins and preventing quest items from being rotated by Tainted Isaac's
    * rotation mechanic.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.SPAWN_COLLECTIBLE`.
+   *
    * @param itemPoolType The item pool to draw the collectible type from.
    * @param position The position to spawn the collectible at.
    * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,

package/src/classes/features/other/SpawnRockAltRewards.ts

@@ -89,6 +89,9 @@ export class SpawnRockAltRewards extends Feature {
    * The logic in this function is based on the rewards listed on the wiki:
    * https://bindingofisaacrebirth.fandom.com/wiki/Rocks
    *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.SPAWN_ALT_ROCK_REWARDS`.
+   *
    * @param position The place to spawn the reward.
    * @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a
    *                    chance at spawning coins and spiders.
@@ -137,6 +140,9 @@ export class SpawnRockAltRewards extends Feature {
    * breaks of `RockAltType.URN`.
    *
    * For more information, see the documentation for the `spawnRockAltReward` function.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.SPAWN_ALT_ROCK_REWARDS`.
    */
   @Exported
   public spawnRockAltRewardUrn(position: Vector, rng: RNG): boolean {
@@ -200,6 +206,9 @@ export class SpawnRockAltRewards extends Feature {
    * breaks of `RockAltType.MUSHROOM`.
    *
    * For more information, see the documentation for the `spawnRockAltReward` function.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.SPAWN_ALT_ROCK_REWARDS`.
    */
   @Exported
   public spawnRockAltRewardMushroom(position: Vector, rng: RNG): boolean {
@@ -286,6 +295,9 @@ export class SpawnRockAltRewards extends Feature {
    * breaks of `RockAltType.SKULL`.
    *
    * For more information, see the documentation for the `spawnRockAltReward` function.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.SPAWN_ALT_ROCK_REWARDS`.
    */
   @Exported
   public spawnRockAltRewardSkull(position: Vector, rng: RNG): boolean {
@@ -354,6 +366,9 @@ export class SpawnRockAltRewards extends Feature {
    * breaks of `RockAltType.POLYP`.
    *
    * For more information, see the documentation for the `spawnRockAltReward` function.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.SPAWN_ALT_ROCK_REWARDS`.
    */
   @Exported
   public spawnRockAltRewardPolyp(position: Vector, rng: RNG): boolean {
@@ -429,6 +444,9 @@ export class SpawnRockAltRewards extends Feature {
    * breaks of `RockAltType.BUCKET_DOWNPOUR`.
    *
    * For more information, see the documentation for the `spawnRockAltReward` function.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.SPAWN_ALT_ROCK_REWARDS`.
    */
   @Exported
   public spawnRockAltRewardBucketDownpour(position: Vector, rng: RNG): boolean {
@@ -511,6 +529,9 @@ export class SpawnRockAltRewards extends Feature {
    * breaks of `RockAltType.BUCKET_DROSS`.
    *
    * For more information, see the documentation for the `spawnRockAltReward` function.
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.SPAWN_ALT_ROCK_REWARDS`.
    */
   @Exported
   public spawnRockAltRewardBucketDross(position: Vector, rng: RNG): boolean {