isaacscript-common 15.0.0 → 15.0.1

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.
@@ -3569,6 +3606,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 +3630,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 +10356,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 +13038,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 +13058,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 +13269,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 +13286,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 +13296,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 +13306,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 +13316,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 +13326,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 +13336,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 +13433,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 +13446,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 +13463,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 +13487,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 +13613,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;
 }

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 15.0.0
+isaacscript-common 15.0.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 

package/dist/src/classes/features/callbackLogic/CustomGridEntities.d.ts

@@ -10,6 +10,9 @@ export 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.
@@ -86,6 +89,9 @@ export 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.
@@ -102,6 +108,9 @@ export 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,
@@ -111,11 +120,17 @@ export 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;
 }

package/dist/src/classes/features/callbackLogic/CustomGridEntities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomGridEntities.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/callbackLogic/CustomGridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,EAClB,cAAc,EAGf,MAAM,8BAA8B,CAAC;AAYtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AAEhF,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGhD,qBAAa,kBAAmB,SAAQ,OAAO;IAgB7C,OAAO,CAAC,YAAY,CAAe;IAoBnC,OAAO,CAAC,WAAW,CA4BjB;IAIF,OAAO,CAAC,0BAA0B,CA+ChC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4EG;IAEI,qBAAqB,CAC1B,oBAAoB,EAAE,cAAc,EACpC,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,kBAAkB,CAAC,EAAE,kBAAkB,EACvC,QAAQ,CAAC,EAAE,MAAM,EACjB,gBAAgB,CAAC,EAAE,MAAM,EACzB,kBAAkB,iBAA4B,EAC9C,qBAAqB,SAAI,GACxB,UAAU;IA8Cb;;;;;;;;;;;;;;OAcG;IAEI,sBAAsB,CAC3B,+BAA+B,EAAE,GAAG,GAAG,MAAM,GAAG,UAAU,EAC1D,UAAU,UAAO,GAChB,UAAU,GAAG,SAAS;IAuCzB;;;OAGG;IAEI,qBAAqB,IAAI,KAAK,CACnC;QAAC,UAAU,EAAE,UAAU;QAAE,IAAI,EAAE,oBAAoB;KAAC,CACrD;IAoBD;;;;OAIG;IAEI,uBAAuB,CAC5B,qBAAqB,EAAE,UAAU,GAAG,GAAG,GACtC,cAAc,GAAG,SAAS;IAyB7B;;;OAGG;IAEI,kBAAkB,CAAC,qBAAqB,EAAE,UAAU,GAAG,GAAG,GAAG,OAAO;CAM5E"}
+{"version":3,"file":"CustomGridEntities.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/callbackLogic/CustomGridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,EAClB,cAAc,EAGf,MAAM,8BAA8B,CAAC;AAYtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AAEhF,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGhD,qBAAa,kBAAmB,SAAQ,OAAO;IAgB7C,OAAO,CAAC,YAAY,CAAe;IAoBnC,OAAO,CAAC,WAAW,CA4BjB;IAIF,OAAO,CAAC,0BAA0B,CA+ChC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+EG;IAEI,qBAAqB,CAC1B,oBAAoB,EAAE,cAAc,EACpC,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,kBAAkB,CAAC,EAAE,kBAAkB,EACvC,QAAQ,CAAC,EAAE,MAAM,EACjB,gBAAgB,CAAC,EAAE,MAAM,EACzB,kBAAkB,iBAA4B,EAC9C,qBAAqB,SAAI,GACxB,UAAU;IA8Cb;;;;;;;;;;;;;;;;;OAiBG;IAEI,sBAAsB,CAC3B,+BAA+B,EAAE,GAAG,GAAG,MAAM,GAAG,UAAU,EAC1D,UAAU,UAAO,GAChB,UAAU,GAAG,SAAS;IAuCzB;;;;;;OAMG;IAEI,qBAAqB,IAAI,KAAK,CACnC;QAAC,UAAU,EAAE,UAAU;QAAE,IAAI,EAAE,oBAAoB;KAAC,CACrD;IAoBD;;;;;;;OAOG;IAEI,uBAAuB,CAC5B,qBAAqB,EAAE,UAAU,GAAG,GAAG,GACtC,cAAc,GAAG,SAAS;IAyB7B;;;;;;OAMG;IAEI,kBAAkB,CAAC,qBAAqB,EAAE,UAAU,GAAG,GAAG,GAAG,OAAO;CAM5E"}

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

@@ -1,5 +1,14 @@
 import { LevelStage, StageType } from "isaac-typescript-definitions";
 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 declare class GameReorderedCallbacks extends Feature {
     private currentStage;
     private currentStageType;
@@ -15,8 +24,42 @@ export 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;
 }
 //# sourceMappingURL=GameReorderedCallbacks.d.ts.map

package/dist/src/classes/features/callbackLogic/GameReorderedCallbacks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GameReorderedCallbacks.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/callbackLogic/GameReorderedCallbacks.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,UAAU,EAEV,SAAS,EACV,MAAM,8BAA8B,CAAC;AAOtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,sBAAuB,SAAQ,OAAO;IACjD,OAAO,CAAC,YAAY,CAAoB;IACxC,OAAO,CAAC,gBAAgB,CAAoB;IAC5C,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,wBAAwB,CAA2B;IAC3D,OAAO,CAAC,qBAAqB,CAAwB;IACrD,OAAO,CAAC,oBAAoB,CAAuB;IACnD,OAAO,CAAC,4BAA4B,CAA+B;IA6BnE,OAAO,CAAC,uBAAuB,CAM7B;IAGF,OAAO,CAAC,eAAe,CAMrB;IAGF,OAAO,CAAC,YAAY,CAYlB;IAGF,OAAO,CAAC,WAAW,CA+BjB;IAEF,OAAO,CAAC,kBAAkB;IAUnB,qBAAqB,IAAI,IAAI;IAK7B,oBAAoB,IAAI,IAAI;IAK5B,0BAA0B,CAC/B,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,IAAI;CAIR"}
+{"version":3,"file":"GameReorderedCallbacks.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/callbackLogic/GameReorderedCallbacks.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EAEV,SAAS,EACV,MAAM,8BAA8B,CAAC;AAOtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD;;;;;;;;GAQG;AACH,qBAAa,sBAAuB,SAAQ,OAAO;IACjD,OAAO,CAAC,YAAY,CAAoB;IACxC,OAAO,CAAC,gBAAgB,CAAoB;IAC5C,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,wBAAwB,CAA2B;IAC3D,OAAO,CAAC,qBAAqB,CAAwB;IACrD,OAAO,CAAC,oBAAoB,CAAuB;IACnD,OAAO,CAAC,4BAA4B,CAA+B;IA6BnE,OAAO,CAAC,uBAAuB,CAM7B;IAGF,OAAO,CAAC,eAAe,CAMrB;IAGF,OAAO,CAAC,YAAY,CAYlB;IAGF,OAAO,CAAC,WAAW,CA+BjB;IAEF,OAAO,CAAC,kBAAkB;IAS1B;;;;;;;;;;;OAWG;IAEI,qBAAqB,IAAI,IAAI;IAIpC;;;;;;;;;;;OAWG;IAEI,oBAAoB,IAAI,IAAI;IAInC;;;;;;;;;OASG;IAEI,0BAA0B,CAC/B,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,IAAI;CAIR"}

package/dist/src/classes/features/callbackLogic/GameReorderedCallbacks.lua

@@ -12,6 +12,13 @@ local ____decorators = require("src.decorators")
 local Exported = ____decorators.Exported
 local ____Feature = require("src.classes.private.Feature")
 local Feature = ____Feature.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.
 ____exports.GameReorderedCallbacks = __TS__Class()
 local GameReorderedCallbacks = ____exports.GameReorderedCallbacks
 GameReorderedCallbacks.name = "GameReorderedCallbacks"

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

@@ -10,6 +10,9 @@ export 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;
 }

package/dist/src/classes/features/other/CharacterHealthConversion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CharacterHealthConversion.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CharacterHealthConversion.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,UAAU,EACX,MAAM,8BAA8B,CAAC;AAItC,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,yBAA0B,SAAQ,OAAO;IACpD,OAAO,CAAC,6BAA6B,CAGjC;IAuBJ,OAAO,CAAC,uBAAuB,CAuB7B;IAGF,OAAO,CAAC,0BAA0B,CAUhC;IAEF;;;;;OAKG;IAEI,iCAAiC,CACtC,UAAU,EAAE,UAAU,EACtB,sBAAsB,EAAE,sBAAsB,GAC7C,IAAI;CASR"}
+{"version":3,"file":"CharacterHealthConversion.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CharacterHealthConversion.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,UAAU,EACX,MAAM,8BAA8B,CAAC;AAItC,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,yBAA0B,SAAQ,OAAO;IACpD,OAAO,CAAC,6BAA6B,CAGjC;IAuBJ,OAAO,CAAC,uBAAuB,CAuB7B;IAGF,OAAO,CAAC,0BAA0B,CAUhC;IAEF;;;;;;;;OAQG;IAEI,iCAAiC,CACtC,UAAU,EAAE,UAAU,EACtB,sBAAsB,EAAE,sBAAsB,GAC7C,IAAI;CASR"}

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

@@ -20,6 +20,8 @@ export 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;
 }

package/dist/src/classes/features/other/CharacterStats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CharacterStats.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CharacterStats.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAET,UAAU,EACX,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIhD,yFAAyF;AACzF,qBAAa,cAAe,SAAQ,OAAO;IACzC,OAAO,CAAC,iBAAiB,CAAkC;IAY3D,OAAO,CAAC,aAAa,CAenB;IAEF;;;;;;;;;;;;;;;;OAgBG;IAEI,sBAAsB,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,GAC/D,IAAI;CAGR"}
+{"version":3,"file":"CharacterStats.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CharacterStats.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAET,UAAU,EACX,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIhD,yFAAyF;AACzF,qBAAa,cAAe,SAAQ,OAAO;IACzC,OAAO,CAAC,iBAAiB,CAAkC;IAY3D,OAAO,CAAC,aAAa,CAenB;IAEF;;;;;;;;;;;;;;;;;;OAkBG;IAEI,sBAAsB,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,GAC/D,IAAI;CAGR"}

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

@@ -11,6 +11,9 @@ export 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;
 }

package/dist/src/classes/features/other/CollectibleItemPoolType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CollectibleItemPoolType.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CollectibleItemPoolType.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAGb,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,OAAO;IAsBlD,OAAO,CAAC,yBAAyB,CAM/B;IAEF;;;;OAIG;IAEI,0BAA0B,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY;CAY3E"}
+{"version":3,"file":"CollectibleItemPoolType.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CollectibleItemPoolType.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAGb,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,OAAO;IAsBlD,OAAO,CAAC,yBAAyB,CAM/B;IAEF;;;;;;;OAOG;IAEI,0BAA0B,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY;CAY3E"}

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

@@ -24,6 +24,8 @@ export 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.
@@ -35,6 +37,8 @@ export 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.
@@ -43,6 +47,8 @@ export 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.
      */
@@ -50,6 +56,8 @@ export 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.
      */

package/dist/src/classes/features/other/CustomHotkeys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomHotkeys.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomHotkeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAe,MAAM,8BAA8B,CAAC;AAIrE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,aAAc,SAAQ,OAAO;IACxC;;;OAGG;IACH,OAAO,CAAC,uBAAuB,CAAmC;IAElE;;;OAGG;IACH,OAAO,CAAC,wBAAwB,CAG5B;IAEJ,OAAO,CAAC,aAAa,CAA4C;IAYjE,OAAO,CAAC,UAAU,CAiBhB;IAEF,OAAO,CAAC,gBAAgB;IAUxB;;;;;;;;;;;;;OAaG;IAEI,oBAAoB,CACzB,UAAU,EAAE,MAAM,QAAQ,GAAG,SAAS,EACtC,WAAW,EAAE,MAAM,IAAI,GACtB,IAAI;IAUP;;;;;;;;;OASG;IAEI,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,IAAI,GAAG,IAAI;IAUnE;;;;;OAKG;IAEI,sBAAsB,CAAC,UAAU,EAAE,MAAM,QAAQ,GAAG,SAAS,GAAG,IAAI;IAU3E;;;;;OAKG;IAEI,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;CAS7C"}
+{"version":3,"file":"CustomHotkeys.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomHotkeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAe,MAAM,8BAA8B,CAAC;AAIrE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,aAAc,SAAQ,OAAO;IACxC;;;OAGG;IACH,OAAO,CAAC,uBAAuB,CAAmC;IAElE;;;OAGG;IACH,OAAO,CAAC,wBAAwB,CAG5B;IAEJ,OAAO,CAAC,aAAa,CAA4C;IAYjE,OAAO,CAAC,UAAU,CAiBhB;IAEF,OAAO,CAAC,gBAAgB;IAUxB;;;;;;;;;;;;;;;OAeG;IAEI,oBAAoB,CACzB,UAAU,EAAE,MAAM,QAAQ,GAAG,SAAS,EACtC,WAAW,EAAE,MAAM,IAAI,GACtB,IAAI;IAUP;;;;;;;;;;;OAWG;IAEI,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,IAAI,GAAG,IAAI;IAUnE;;;;;;;OAOG;IAEI,sBAAsB,CAAC,UAAU,EAAE,MAAM,QAAQ,GAAG,SAAS,GAAG,IAAI;IAU3E;;;;;;;OAOG;IAEI,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;CAS7C"}

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

@@ -26,6 +26,8 @@ export 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
@@ -44,6 +46,8 @@ export 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.

package/dist/src/classes/features/other/CustomItemPools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomItemPools.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomItemPools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAO7E,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,eAAgB,SAAQ,OAAO;IAQ1C,OAAO,CAAC,iBAAiB,CAGrB;IAeJ,OAAO,CAAC,wBAAwB,CAM9B;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IAEI,sBAAsB,CAC3B,kBAAkB,EAAE,YAAY,EAChC,YAAY,EAAE,aAAa,CAAC,eAAe,CAAC,GAC3C,IAAI;IAUP;;;;;;;;;;;;;;;OAeG;IAEI,4BAA4B,CACjC,kBAAkB,EAAE,YAAY,EAChC,QAAQ,UAAQ,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,WAAW,kBAAuB,GACjC,eAAe;CAuBnB"}
+{"version":3,"file":"CustomItemPools.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomItemPools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAO7E,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,eAAgB,SAAQ,OAAO;IAQ1C,OAAO,CAAC,iBAAiB,CAGrB;IAeJ,OAAO,CAAC,wBAAwB,CAM9B;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IAEI,sBAAsB,CAC3B,kBAAkB,EAAE,YAAY,EAChC,YAAY,EAAE,aAAa,CAAC,eAAe,CAAC,GAC3C,IAAI;IAUP;;;;;;;;;;;;;;;;;OAiBG;IAEI,4BAA4B,CACjC,kBAAkB,EAAE,YAAY,EAChC,QAAQ,UAAQ,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,WAAW,kBAAuB,GACjC,eAAe;CAuBnB"}

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

@@ -20,6 +20,8 @@ export 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.

package/dist/src/classes/features/other/CustomPickups.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomPickups.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomPickups.ts"],"names":[],"mappings":"AAIA,OAAO,EAIL,aAAa,EACd,MAAM,8BAA8B,CAAC;AAStC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAkBhD,qBAAa,aAAc,SAAQ,OAAO;IACxC,4BAA4B;IAC5B,OAAO,CAAC,wBAAwB,CAA4C;IAgB5E,OAAO,CAAC,kBAAkB,CAqCxB;IAKF,OAAO,CAAC,4BAA4B,CASlC;IAEF;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEI,oBAAoB,CACzB,mBAAmB,EAAE,aAAa,EAClC,OAAO,EAAE,GAAG,EACZ,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,KAAK,IAAI,EACvD,aAAa,GAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,KAAK,OAAoB,GACxE,IAAI;CAYR"}
+{"version":3,"file":"CustomPickups.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomPickups.ts"],"names":[],"mappings":"AAIA,OAAO,EAIL,aAAa,EACd,MAAM,8BAA8B,CAAC;AAStC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAkBhD,qBAAa,aAAc,SAAQ,OAAO;IACxC,4BAA4B;IAC5B,OAAO,CAAC,wBAAwB,CAA4C;IAgB5E,OAAO,CAAC,kBAAkB,CAqCxB;IAKF,OAAO,CAAC,4BAA4B,CASlC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEI,oBAAoB,CACzB,mBAAmB,EAAE,aAAa,EAClC,OAAO,EAAE,GAAG,EACZ,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,KAAK,IAAI,EACvD,aAAa,GAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,KAAK,OAAoB,GACxE,IAAI;CAYR"}

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

@@ -13,6 +13,8 @@ export 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,
@@ -31,6 +33,8 @@ export 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,

package/dist/src/classes/features/other/SpawnCollectible.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpawnCollectible.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/SpawnCollectible.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAO7E,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGhD,qBAAa,gBAAiB,SAAQ,OAAO;IAC3C,OAAO,CAAC,0BAA0B,CAA6B;IAW/D;;;;;;;;;;;;;;;;;;;;OAoBG;IAEI,gBAAgB,CACrB,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,EACf,aAAa,UAAQ,EACrB,OAAO,CAAC,EAAE,MAAM,GACf,uBAAuB;IAoB1B;;;;;;;;;;;;;;;;OAgBG;IAEI,wBAAwB,CAC7B,YAAY,EAAE,YAAY,EAC1B,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,EACf,aAAa,UAAQ,EACrB,OAAO,CAAC,EAAE,MAAM,GACf,uBAAuB;CAa3B"}
+{"version":3,"file":"SpawnCollectible.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/SpawnCollectible.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAO7E,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGhD,qBAAa,gBAAiB,SAAQ,OAAO;IAC3C,OAAO,CAAC,0BAA0B,CAA6B;IAW/D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IAEI,gBAAgB,CACrB,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,EACf,aAAa,UAAQ,EACrB,OAAO,CAAC,EAAE,MAAM,GACf,uBAAuB;IAoB1B;;;;;;;;;;;;;;;;;;OAkBG;IAEI,wBAAwB,CAC7B,YAAY,EAAE,YAAY,EAC1B,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,EACf,aAAa,UAAQ,EACrB,OAAO,CAAC,EAAE,MAAM,GACf,uBAAuB;CAa3B"}

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

@@ -26,6 +26,9 @@ export 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.
@@ -40,6 +43,9 @@ export 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;
     /**
@@ -47,6 +53,9 @@ export 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;
     /**
@@ -54,6 +63,9 @@ export 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;
     /**
@@ -61,6 +73,9 @@ export 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;
     /**
@@ -68,6 +83,9 @@ export 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;
     /**
@@ -75,6 +93,9 @@ export 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;
 }

package/dist/src/classes/features/other/SpawnRockAltRewards.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpawnRockAltRewards.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/SpawnRockAltRewards.ts"],"names":[],"mappings":";;;AAgBA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAkBzD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAwBhD,qBAAa,mBAAoB,SAAQ,OAAO;IAC9C,OAAO,CAAC,iBAAiB,CAAoB;IAW7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IAEI,kBAAkB,CACvB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO;IA8BV;;;;;OAKG;IAEI,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IAwDjE;;;;;OAKG;IAEI,0BAA0B,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IA+EtE;;;;;OAKG;IAEI,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IA6DnE;;;;;OAKG;IAEI,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IAoEnE;;;;;OAKG;IAEI,gCAAgC,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IA2E5E;;;;;OAKG;IAEI,6BAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;CAsE1E"}
+{"version":3,"file":"SpawnRockAltRewards.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/SpawnRockAltRewards.ts"],"names":[],"mappings":";;;AAgBA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAkBzD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAwBhD,qBAAa,mBAAoB,SAAQ,OAAO;IAC9C,OAAO,CAAC,iBAAiB,CAAoB;IAW7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IAEI,kBAAkB,CACvB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO;IA8BV;;;;;;;;OAQG;IAEI,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IAwDjE;;;;;;;;OAQG;IAEI,0BAA0B,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IA+EtE;;;;;;;;OAQG;IAEI,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IA6DnE;;;;;;;;OAQG;IAEI,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IAoEnE;;;;;;;;OAQG;IAEI,gCAAgC,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;IA2E5E;;;;;;;;OAQG;IAEI,6BAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO;CAsE1E"}

package/dist/src/classes/features/other/StageHistory.d.ts

@@ -10,6 +10,8 @@ export 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.
      */
@@ -21,9 +23,15 @@ export 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
@@ -32,6 +40,8 @@ export 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.

package/dist/src/classes/features/other/StageHistory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StageHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/StageHistory.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,SAAS,EACV,MAAM,8BAA8B,CAAC;AAUtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,YAAa,SAAQ,OAAO;IAqBvC,OAAO,CAAC,qBAAqB,CAM3B;IAEF;;;;;;;;;;OAUG;IAEI,2BAA2B,CAAC,OAAO,UAAQ,GAAG,SAAS;IAiG9D;;;;;;;OAOG;IAEI,uBAAuB,IAAI,UAAU;IA8H5C,+FAA+F;IAExF,eAAe,IAAI,aAAa,CACrC;QAAC,KAAK,EAAE,UAAU;QAAE,SAAS,EAAE,SAAS;KAAC,CAC1C;IAID;;;;;;;OAOG;IAEI,eAAe,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO;CAY1E"}
+{"version":3,"file":"StageHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/StageHistory.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,SAAS,EACV,MAAM,8BAA8B,CAAC;AAUtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,YAAa,SAAQ,OAAO;IAqBvC,OAAO,CAAC,qBAAqB,CAM3B;IAEF;;;;;;;;;;;;OAYG;IAEI,2BAA2B,CAAC,OAAO,UAAQ,GAAG,SAAS;IAiG9D;;;;;;;;;OASG;IAEI,uBAAuB,IAAI,UAAU;IA8H5C;;;;OAIG;IAEI,eAAe,IAAI,aAAa,CACrC;QAAC,KAAK,EAAE,UAAU;QAAE,SAAS,EAAE,SAAS;KAAC,CAC1C;IAID;;;;;;;;;OASG;IAEI,eAAe,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO;CAY1E"}

package/dist/src/classes/features/other/StartAmbush.d.ts

@@ -6,6 +6,8 @@ export 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;
 }

package/dist/src/classes/features/other/StartAmbush.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StartAmbush.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/StartAmbush.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAMhD,qBAAa,WAAY,SAAQ,OAAO;IACtC,OAAO,CAAC,YAAY,CAAe;IAWnC;;;;;OAKG;IAEI,WAAW,IAAI,IAAI;CA+B3B"}
+{"version":3,"file":"StartAmbush.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/StartAmbush.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAMhD,qBAAa,WAAY,SAAQ,OAAO;IACtC,OAAO,CAAC,YAAY,CAAe;IAWnC;;;;;;;OAOG;IAEI,WAAW,IAAI,IAAI;CA+B3B"}

package/dist/src/classes/features/other/TaintedLazarusPlayers.d.ts

@@ -27,6 +27,9 @@ export 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;
 }

package/dist/src/classes/features/other/TaintedLazarusPlayers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TaintedLazarusPlayers.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/TaintedLazarusPlayers.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,OAAO;IAyBhC,gBAAgB,QAAO,OAAO,CAAU;IAYxD,OAAO,CAAC,cAAc,CAYpB;IAEF;;;;;;;;OAQG;IACH,OAAO,CAAC,YAAY;IA6BpB;;;;;;;;;;OAUG;IAEI,0BAA0B,CAC/B,MAAM,EAAE,YAAY,GACnB,YAAY,GAAG,SAAS;CAI5B"}
+{"version":3,"file":"TaintedLazarusPlayers.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/TaintedLazarusPlayers.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,OAAO;IAyBhC,gBAAgB,QAAO,OAAO,CAAU;IAYxD,OAAO,CAAC,cAAc,CAYpB;IAEF;;;;;;;;OAQG;IACH,OAAO,CAAC,YAAY;IA6BpB;;;;;;;;;;;;;OAaG;IAEI,0BAA0B,CAC/B,MAAM,EAAE,YAAY,GACnB,YAAY,GAAG,SAAS;CAI5B"}

package/dist/src/types/ModUpgraded.d.ts

@@ -15,7 +15,7 @@ import { Writeable } from "./Writable";
  * 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>;
 /**
  * We want to only extract the class public methods, so we omit the keys of the `Feature` base
  * class.

package/dist/src/types/ModUpgraded.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModUpgraded.d.ts","sourceRoot":"","sources":["../../../src/types/ModUpgraded.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC;;;;;;;;;GASG;AACH,oBAAY,WAAW,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,IAAI,eAAe,GACxE,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEvB;;;GAGG;AACH,aAAK,iBAAiB,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,IAAI,IAAI,CAC5D,mBAAmB,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAC9D,MAAM,OAAO,CACd,CAAC;AAEF;;;GAGG;AACH,aAAK,2BAA2B,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI;KACxD,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACzD,CAAC"}
+{"version":3,"file":"ModUpgraded.d.ts","sourceRoot":"","sources":["../../../src/types/ModUpgraded.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC;;;;;;;;;GASG;AACH,oBAAY,WAAW,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,GAAG,EAAE,IAC1D,eAAe,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEzC;;;GAGG;AACH,aAAK,iBAAiB,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,IAAI,IAAI,CAC5D,mBAAmB,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAC9D,MAAM,OAAO,CACd,CAAC;AAEF;;;GAGG;AACH,aAAK,2BAA2B,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI;KACxD,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACzD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "15.0.0",
+  "version": "15.0.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

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

@@ -144,6 +144,9 @@ export 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.
@@ -274,6 +277,9 @@ export 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.
@@ -332,6 +338,9 @@ export 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`.
    */
   @Exported
   public getCustomGridEntities(): Array<
@@ -360,6 +369,9 @@ export 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`.
    */
   @Exported
   public getCustomGridEntityType(
@@ -392,6 +404,9 @@ export class CustomGridEntities extends Feature {
   /**
    * 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`.
    */
   @Exported
   public isCustomGridEntity(gridEntityOrGridIndex: GridEntity | int): boolean {

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/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 {

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

@@ -51,6 +51,8 @@ export 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.
    */
@@ -159,6 +161,8 @@ export 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`.
    */
   @Exported
   public getNextStageWithHistory(): LevelStage {
@@ -287,7 +291,11 @@ export class StageHistory extends Feature {
     return asNumber(stage) - 1;
   }
 
-  /** 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`.
+   */
   @Exported
   public getStageHistory(): ReadonlyArray<
     [stage: LevelStage, stageType: StageType]
@@ -299,6 +307,8 @@ export 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.

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

@@ -29,6 +29,8 @@ export 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`.
    */
   @Exported
   public startAmbush(): void {

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

@@ -106,6 +106,9 @@ export 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`.
    */
   @Exported
   public getTaintedLazarusSubPlayer(

package/src/types/ModUpgraded.ts

@@ -16,8 +16,8 @@ import { Writeable } from "./Writable";
  * 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 type ModUpgraded<T extends readonly ISCFeature[]> = ModUpgradedBase &
-  ISCFeaturesToKeys<T>;
+export type ModUpgraded<T extends readonly ISCFeature[] = []> =
+  ModUpgradedBase & ISCFeaturesToKeys<T>;
 
 /**
  * We want to only extract the class public methods, so we omit the keys of the `Feature` base