isaacscript-common 15.0.0 → 15.0.2

package/dist/index.d.ts

@@ -1036,6 +1036,9 @@ declare 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`.
      */
     registerCharacterHealthConversion(playerType: PlayerType, conversionHeartSubType: ConversionHeartSubType): void;
 }
@@ -1068,6 +1071,8 @@ declare 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`.
      */
     registerCharacterStats(playerType: PlayerType, statMap: Map<CacheFlag, number> | ReadonlyMap<CacheFlag, number>): void;
 }
@@ -1228,6 +1233,9 @@ declare 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`.
      */
     getCollectibleItemPoolType(collectible: EntityPickup): ItemPoolType;
 }
@@ -1434,6 +1442,9 @@ declare class CustomGridEntities extends Feature {
      * will reappear if the player leaves and re-enters the room. (It will be manually respawned in
      * the `POST_NEW_ROOM` callback.)
      *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.CUSTOM_GRID_ENTITIES`.
+     *
      * Custom grid entities are built on top of real grid entities. You can use any existing grid
      * entity type as a base. For example, if you want to create a custom rock that would be breakable
      * like a normal rock, then you should specify `GridEntityType.ROCK` as the base grid entity type.
@@ -1510,6 +1521,9 @@ declare class CustomGridEntities extends Feature {
     /**
      * Helper function to remove a custom grid entity created by the `spawnCustomGrid` function.
      *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.CUSTOM_GRID_ENTITIES`.
+     *
      * @param gridIndexOrPositionOrGridEntity You can specify the custom grid entity to remove by
      *                                providing the grid index, the room position, or the grid entity
      *                                itself.
@@ -1526,6 +1540,9 @@ declare class CustomGridEntities extends Feature {
     /**
      * Helper function to get the custom grid entities in the current room. Returns an array of tuples
      * containing the raw decoration grid entity and the associated entity data.
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.CUSTOM_GRID_ENTITIES`.
      */
     getCustomGridEntities(): Array<[
     gridEntity: GridEntity,
@@ -1535,11 +1552,17 @@ declare class CustomGridEntities extends Feature {
      * Helper function to get the custom `GridEntityType` from a `GridEntity` or grid index. Returns
      * undefined if the provided `GridEntity` is not a custom grid entity, or if there was not a grid
      * entity on the provided grid index.
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.CUSTOM_GRID_ENTITIES`.
      */
     getCustomGridEntityType(gridEntityOrGridIndex: GridEntity | int): GridEntityType | undefined;
     /**
      * Helper function to check if a `GridEntity` is a custom grid entity or if a grid index has a
      * custom grid entity.
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.CUSTOM_GRID_ENTITIES`.
      */
     isCustomGridEntity(gridEntityOrGridIndex: GridEntity | int): boolean;
 }
@@ -1568,6 +1591,8 @@ declare 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.
@@ -1579,6 +1604,8 @@ declare 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.
@@ -1587,6 +1614,8 @@ declare 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.
      */
@@ -1594,6 +1623,8 @@ declare 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.
      */
@@ -1625,6 +1656,8 @@ declare 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
@@ -1643,6 +1676,8 @@ declare 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.
@@ -1674,6 +1709,8 @@ declare 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.
@@ -1832,8 +1869,9 @@ declare 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,
@@ -1848,6 +1886,8 @@ declare 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`.
      */
     disableCustomStage(): void;
 }
@@ -2340,6 +2380,8 @@ declare 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
@@ -2363,6 +2405,8 @@ declare 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
@@ -2412,166 +2456,256 @@ declare 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`.
      */
     setPlayerDisplay(textCallback: (player: EntityPlayer) => string): void;
     /**
      * 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`.
      */
     setTearDisplay(textCallback: (tear: EntityTear) => string): void;
     /**
      * 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`.
      */
     setFamiliarDisplay(textCallback: (familiar: EntityFamiliar) => string): void;
     /**
      * 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`.
      */
     setBombDisplay(textCallback: (bomb: EntityBomb) => string): void;
     /**
      * 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`.
      */
     setPickupDisplay(textCallback: (pickup: EntityPickup) => string): void;
     /**
      * 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`.
      */
     setSlotDisplay(textCallback: (slot: Entity) => string): void;
     /**
      * 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`.
      */
     setLaserDisplay(textCallback: (laser: EntityLaser) => string): void;
     /**
      * 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`.
      */
     setKnifeDisplay(textCallback: (knife: EntityKnife) => string): void;
     /**
      * 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`.
      */
     setProjectileDisplay(textCallback: (projectile: EntityProjectile) => string): void;
     /**
      * 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`.
      */
     setEffectDisplay(textCallback: (effect: EntityEffect) => string): void;
     /**
      * 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`.
      */
     setNPCDisplay(textCallback: (npc: EntityNPC) => string): void;
     /**
      * 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`.
      */
     setRockDisplay(textCallback: (rock: GridEntityRock) => string): void;
     /**
      * 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`.
      */
     setPitDisplay(textCallback: (pit: GridEntityPit) => string): void;
     /**
      * 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`.
      */
     setSpikesDisplay(textCallback: (spikes: GridEntitySpikes) => string): void;
     /**
      * 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`.
      */
     setTNTDisplay(textCallback: (tnt: GridEntityTNT) => string): void;
     /**
      * 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`.
      */
     setPoopDisplay(textCallback: (poop: GridEntityPoop) => string): void;
     /**
      * 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`.
      */
     setDoorDisplay(textCallback: (door: GridEntityDoor) => string): void;
     /**
      * 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`.
      */
     setPressurePlateDisplay(textCallback: (pressurePlate: GridEntityPressurePlate) => string): void;
     private toggleFeature;
     /**
      * 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`.
      */
     togglePlayerDisplay(): void;
-    /** 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`.
+     */
     toggleTearDisplay(): void;
     /**
      * 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`.
      */
     toggleFamiliarDisplay(): void;
-    /** 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`.
+     */
     toggleBombDisplay(): void;
     /**
      * 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`.
      */
     togglePickupDisplay(): void;
-    /** 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`.
+     */
     toggleSlotDisplay(): void;
     /**
      * 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`.
      */
     toggleLaserDisplay(): void;
     /**
      * 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`.
      */
     toggleKnifeDisplay(): void;
     /**
      * 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`.
      */
     toggleProjectileDisplay(): void;
     /**
      * 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`.
      */
     toggleEffectDisplay(): void;
-    /** 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`.
+     */
     toggleNPCDisplay(): void;
-    /** 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`.
+     */
     toggleRockDisplay(): void;
-    /** 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`.
+     */
     togglePitDisplay(): void;
     /**
      * 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`.
      */
     toggleSpikesDisplay(): void;
-    /** 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`.
+     */
     toggleTNTDisplay(): void;
-    /** 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`.
+     */
     togglePoopDisplay(): void;
-    /** 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`.
+     */
     toggleDoorDisplay(): void;
     /**
      * 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`.
      */
     togglePressurePlateDisplay(): void;
 }
@@ -2807,6 +2941,8 @@ declare 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()`.
@@ -2870,6 +3006,8 @@ declare 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.
      */
@@ -2879,6 +3017,8 @@ declare 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.
      */
@@ -3569,6 +3709,15 @@ export declare const game: Game;
 /** Game frames are what is returned by the `Game.GetFrameCount` method. */
 export declare const GAME_FRAMES_PER_SECOND = 30;
 
+/**
+ * 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.
+ */
 declare class GameReorderedCallbacks extends Feature {
     private currentStage;
     private currentStageType;
@@ -3584,8 +3733,42 @@ declare class GameReorderedCallbacks extends Feature {
     private postNewLevel;
     private postNewRoom;
     private recordCurrentStage;
+    /**
+     * 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`.
+     */
     forceNewLevelCallback(): void;
+    /**
+     * 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`.
+     */
     forceNewRoomCallback(): void;
+    /**
+     * 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`.
+     */
     reorderedCallbacksSetStage(stage: LevelStage, stageType: StageType): void;
 }
 
@@ -10276,7 +10459,7 @@ export declare class ModFeature {
  * By specifying one or more optional features, end-users will get a version of `ModUpgraded` that
  * has extra methods corresponding to the features that were specified.
  */
-export declare type ModUpgraded<T extends readonly ISCFeature[]> = ModUpgradedBase & ISCFeaturesToKeys<T>;
+export declare type ModUpgraded<T extends readonly ISCFeature[] = []> = ModUpgradedBase & ISCFeaturesToKeys<T>;
 
 /**
  * `isaacscript-common` has many custom callbacks that you can use in your mods. Instead of
@@ -12958,6 +13141,8 @@ declare 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,
@@ -12976,6 +13161,8 @@ declare 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,
@@ -13185,6 +13372,9 @@ declare 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.
@@ -13199,6 +13389,9 @@ declare 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`.
      */
     spawnRockAltRewardUrn(position: Vector, rng: RNG): boolean;
     /**
@@ -13206,6 +13399,9 @@ declare 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`.
      */
     spawnRockAltRewardMushroom(position: Vector, rng: RNG): boolean;
     /**
@@ -13213,6 +13409,9 @@ declare 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`.
      */
     spawnRockAltRewardSkull(position: Vector, rng: RNG): boolean;
     /**
@@ -13220,6 +13419,9 @@ declare 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`.
      */
     spawnRockAltRewardPolyp(position: Vector, rng: RNG): boolean;
     /**
@@ -13227,6 +13429,9 @@ declare 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`.
      */
     spawnRockAltRewardBucketDownpour(position: Vector, rng: RNG): boolean;
     /**
@@ -13234,6 +13439,9 @@ declare 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`.
      */
     spawnRockAltRewardBucketDross(position: Vector, rng: RNG): boolean;
 }
@@ -13328,6 +13536,8 @@ declare class StageHistory extends Feature {
      * that the next stage type can be properly calculated on The Ascent (which makes it unlike the
      * `getNextStageType` function).
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
+     *
      * @param upwards Whether or not the player should go up to Cathedral in the case of being on Womb
      *                2. Default is false.
      */
@@ -13339,9 +13549,15 @@ declare class StageHistory extends Feature {
      * This function accounts for the previous floors that a player has visited thus far on the run so
      * that the next stage can be properly calculated on The Ascent (which makes it unlike the
      * `getNextStage` function).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
      */
     getNextStageWithHistory(): LevelStage;
-    /** Helper function to get all of the stages that a player has visited thus far on this run. */
+    /**
+     * Helper function to get all of the stages that a player has visited thus far on this run.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
+     */
     getStageHistory(): ReadonlyArray<[
     stage: LevelStage,
     stageType: StageType
@@ -13350,6 +13566,8 @@ declare class StageHistory extends Feature {
      * Helper function to check if a player has previous visited a particular stage (or stage + stage
      * type combination) on this run.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
+     *
      * @param stage The stage to check for.
      * @param stageType Optional. If provided, will check for a specific stage and stage type
      *                  combination.
@@ -13372,6 +13590,8 @@ declare class StartAmbush extends Feature {
      *
      * Specifically, this is performed by spawning a sack on top of the player, waiting a game frame,
      * and then removing the sack and the pickups that the sack dropped.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.START_AMBUSH`.
      */
     startAmbush(): void;
 }
@@ -13496,6 +13716,9 @@ declare class TaintedLazarusPlayers extends Feature {
      * If you call the `EntityPlayer.Exists` method on the returned object, it will return false.
      * However, you can still call the other methods like you normally would (e.g.
      * `EntityPlayer.AddCollectible`).
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.CHARACTER_HEALTH_CONVERSION`.
      */
     getTaintedLazarusSubPlayer(player: EntityPlayer): EntityPlayer | undefined;
 }