isaacscript-common 15.0.2 → 15.0.4

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

@@ -42,6 +42,8 @@ export declare class ModdedElementSets extends Feature {
      * This function can only be called if at least one callback has been executed. This is because
      * not all collectibles will necessarily be present when a mod first loads (due to mod load
      * order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getCollectibleArray(): readonly CollectibleType[];
     /**
@@ -54,6 +56,8 @@ export declare class ModdedElementSets extends Feature {
      * This function can only be called if at least one callback has been executed. This is because
      * not all collectibles will necessarily be present when a mod first loads (due to mod load
      * order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getCollectibleSet(): ReadonlySet<CollectibleType>;
     /**
@@ -65,6 +69,8 @@ export declare class ModdedElementSets extends Feature {
      * ```ts
      * const guppyCollectibleTypes = getCollectiblesForTransformation(PlayerForm.GUPPY);
      * ```
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getCollectiblesForTransformation(playerForm: PlayerForm): ReadonlySet<CollectibleType>;
     /**
@@ -74,6 +80,8 @@ export declare class ModdedElementSets extends Feature {
      * This function can only be called if at least one callback has been executed. This is because
      * not all collectibles will necessarily be present when a mod first loads (due to mod load
      * order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getCollectiblesWithCacheFlag(cacheFlag: CacheFlag): ReadonlySet<CollectibleType>;
     /**
@@ -85,16 +93,22 @@ export declare class ModdedElementSets extends Feature {
      * ```ts
      * const offensiveCollectibleTypes = getCollectibleTypesWithTag(ItemConfigTag.OFFENSIVE);
      * ```
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getCollectiblesWithTag(itemConfigTag: ItemConfigTag): ReadonlySet<CollectibleType>;
     /**
      * Returns a set containing every valid passive item that can be randomly granted to Eden as a
      * starting item.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getEdenActiveCollectibles(): ReadonlySet<CollectibleType>;
     /**
      * Returns a set containing every valid passive item that can be randomly granted to Eden as a
      * starting item.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getEdenPassiveCollectibles(): ReadonlySet<CollectibleType>;
     /**
@@ -104,6 +118,8 @@ export declare class ModdedElementSets extends Feature {
      * Collectibles that only grant flight conditionally are manually pruned. Collectibles such as
      * Empty Vessel should be checked for via the `hasFlyingTemporaryEffect` function.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+     *
      * @param pruneConditionalItems Whether or not collectibles that only grant flight conditionally
      *                              should be included in the set (like Empty Vessel).
      */
@@ -111,6 +127,8 @@ export declare class ModdedElementSets extends Feature {
     /**
      * Returns a set of all of the trinkets that grant flight. (All trinkets that grant flight do so
      * conditionally, like Bat Wing and Azazel's Stump.)
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getFlyingTrinkets(): ReadonlySet<TrinketType>;
     /**
@@ -122,6 +140,8 @@ export declare class ModdedElementSets extends Feature {
      * This function can only be called if at least one callback has been executed. This is because
      * not all collectibles will necessarily be present when a mod first loads (due to mod load
      * order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getModdedCollectibleArray(): readonly CollectibleType[];
     /**
@@ -133,6 +153,8 @@ export declare class ModdedElementSets extends Feature {
      * This function can only be called if at least one callback has been executed. This is because
      * not all collectibles will necessarily be present when a mod first loads (due to mod load
      * order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getModdedCollectibleSet(): ReadonlySet<CollectibleType>;
     /**
@@ -143,6 +165,8 @@ export declare class ModdedElementSets extends Feature {
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getModdedTrinketArray(): readonly TrinketType[];
     /**
@@ -153,6 +177,8 @@ export declare class ModdedElementSets extends Feature {
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getModdedTrinketSet(): ReadonlySet<TrinketType>;
     /**
@@ -160,6 +186,8 @@ export declare class ModdedElementSets extends Feature {
      * the player has.
      *
      * Note that this will filter out non-real collectibles like Lilith's Incubus.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType, int>;
     /**
@@ -183,11 +211,21 @@ export declare class ModdedElementSets extends Feature {
      * This function can only be called if at least one callback has been executed. This is because
      * not all collectibles will necessarily be present when a mod first loads (due to mod load
      * order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getPlayerCollectiblesWithCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): CollectibleType[];
-    /** Returns the number of items that a player has towards a particular transformation. */
+    /**
+     * Returns the number of items that a player has towards a particular transformation.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+     */
     getPlayerCollectiblesWithTag(player: EntityPlayer, itemConfigTag: ItemConfigTag): CollectibleType[];
-    /** Returns the number of items that a player has towards a particular transformation. */
+    /**
+     * Returns the number of items that a player has towards a particular transformation.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+     */
     getPlayerCollectiblesForTransformation(player: EntityPlayer, playerForm: PlayerForm): CollectibleType[];
     /**
      * Returns a map containing every trinket type that the player has that matches the provided
@@ -195,11 +233,21 @@ export declare class ModdedElementSets extends Feature {
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getPlayerTrinketsWithCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): Map<TrinketType, int>;
-    /** Returns a random active collectible type that that is a valid starting item for Eden. */
+    /**
+     * Returns a random active collectible type that that is a valid starting item for Eden.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+     */
     getRandomEdenActiveCollectible(seedOrRNG?: Seed | RNG, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
-    /** Returns a random passive collectible type that that is a valid starting item for Eden. */
+    /**
+     * Returns a random passive collectible type that that is a valid starting item for Eden.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+     */
     getRandomEdenPassiveCollectible(seedOrRNG?: Seed | RNG, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
     /**
      * Returns an array containing every modded trinket type in the game.
@@ -209,6 +257,8 @@ export declare class ModdedElementSets extends Feature {
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getTrinketArray(): readonly TrinketType[];
     /**
@@ -219,6 +269,8 @@ export declare class ModdedElementSets extends Feature {
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getTrinketSet(): ReadonlySet<TrinketType>;
     /**
@@ -227,6 +279,8 @@ export declare class ModdedElementSets extends Feature {
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getTrinketsWithCacheFlag(cacheFlag: CacheFlag): ReadonlySet<TrinketType>;
     /**
@@ -234,6 +288,8 @@ export declare class ModdedElementSets extends Feature {
      *
      * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
      * then use the `getVanillaCollectibleSet` helper function instead.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getVanillaCollectibleArray(): readonly CollectibleType[];
     /**
@@ -241,6 +297,8 @@ export declare class ModdedElementSets extends Feature {
      *
      * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
      * then use the `getVanillaCollectibleArray` helper function instead.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getVanillaCollectibleSet(): ReadonlySet<CollectibleType>;
     /**
@@ -248,6 +306,8 @@ export declare class ModdedElementSets extends Feature {
      *
      * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups,
      * then use the `getVanillaTrinketSet` helper function instead.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getVanillaTrinketArray(): readonly TrinketType[];
     /**
@@ -255,6 +315,8 @@ export declare class ModdedElementSets extends Feature {
      *
      * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order,
      * then use the `getVanillaTrinketArray` helper function instead.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
      */
     getVanillaTrinketSet(): ReadonlySet<TrinketType>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ModdedElementSets.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/ModdedElementSets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,eAAe,EACf,aAAa,EACb,UAAU,EACV,WAAW,EACZ,MAAM,8BAA8B,CAAC;AA0BtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AA4BhD,qBAAa,iBAAkB,SAAQ,OAAO;IAC5C,OAAO,CAAC,wBAAwB,CAAyB;IACzD,OAAO,CAAC,sBAAsB,CAA8B;IAE5D,OAAO,CAAC,4BAA4B,CAAyB;IAC7D,OAAO,CAAC,0BAA0B,CAA8B;IAEhE,OAAO,CAAC,2BAA2B,CAAyB;IAC5D,OAAO,CAAC,yBAAyB,CAA8B;IAE/D,OAAO,CAAC,oBAAoB,CAAqB;IACjD,OAAO,CAAC,kBAAkB,CAA0B;IAEpD,OAAO,CAAC,wBAAwB,CAAqB;IACrD,OAAO,CAAC,sBAAsB,CAA0B;IAExD,OAAO,CAAC,uBAAuB,CAAqB;IACpD,OAAO,CAAC,qBAAqB,CAA0B;IAEvD,OAAO,CAAC,wBAAwB,CAG5B;IAEJ,OAAO,CAAC,8BAA8B,CAGlC;IAEJ,OAAO,CAAC,0BAA0B,CAA0C;IAE5E,OAAO,CAAC,yBAAyB,CAA8B;IAC/D,OAAO,CAAC,kCAAkC,CAA8B;IACxE,OAAO,CAAC,qBAAqB,CAA0B;IAEvD,OAAO,CAAC,6BAA6B,CAA8B;IACnE,OAAO,CAAC,8BAA8B,CAA8B;IAEpE,OAAO,CAAC,sBAAsB,CAAyB;IAWvD,OAAO,CAAC,+BAA+B;IAgBvC,OAAO,CAAC,8BAA8B;IA2BtC,OAAO,CAAC,2BAA2B;IAgBnC,OAAO,CAAC,0BAA0B;IA2BlC,OAAO,CAAC,gCAAgC;IA8BxC,OAAO,CAAC,sCAAsC;IAkB9C,OAAO,CAAC,kCAAkC;IAkB1C,OAAO,CAAC,iCAAiC;IAgCzC,OAAO,CAAC,6BAA6B;IAoBrC,OAAO,CAAC,+BAA+B;IAuBvC;;;;;;;;;;OAUG;IAEI,mBAAmB,IAAI,SAAS,eAAe,EAAE;IAKxD;;;;;;;;;;OAUG;IAEI,iBAAiB,IAAI,WAAW,CAAC,eAAe,CAAC;IAKxD;;;;;;;;;OASG;IAEI,gCAAgC,CACrC,UAAU,EAAE,UAAU,GACrB,WAAW,CAAC,eAAe,CAAC;IAW/B;;;;;;;OAOG;IAEI,4BAA4B,CACjC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,eAAe,CAAC;IAW/B;;;;;;;;;OASG;IAEI,sBAAsB,CAC3B,aAAa,EAAE,aAAa,GAC3B,WAAW,CAAC,eAAe,CAAC;IAa/B;;;OAGG;IAEI,yBAAyB,IAAI,WAAW,CAAC,eAAe,CAAC;IAKhE;;;OAGG;IAEI,0BAA0B,IAAI,WAAW,CAAC,eAAe,CAAC;IAKjE;;;;;;;;;OASG;IAEI,qBAAqB,CAC1B,qBAAqB,EAAE,OAAO,GAC7B,WAAW,CAAC,eAAe,CAAC;IAQ/B;;;OAGG;IAEI,iBAAiB,IAAI,WAAW,CAAC,WAAW,CAAC;IAMpD;;;;;;;;;OASG;IAEI,yBAAyB,IAAI,SAAS,eAAe,EAAE;IAK9D;;;;;;;;;OASG;IAEI,uBAAuB,IAAI,WAAW,CAAC,eAAe,CAAC;IAK9D;;;;;;;;OAQG;IAEI,qBAAqB,IAAI,SAAS,WAAW,EAAE;IAKtD;;;;;;;;OAQG;IAEI,mBAAmB,IAAI,WAAW,CAAC,WAAW,CAAC;IAKtD;;;;;OAKG;IAEI,uBAAuB,CAC5B,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;IAe5B;;;;;;;;;;;;;;;;;;;;;OAqBG;IAEI,kCAAkC,CACvC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,eAAe,EAAE;IAkBpB,yFAAyF;IAElF,4BAA4B,CACjC,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,aAAa,GAC3B,eAAe,EAAE;IAepB,yFAAyF;IAElF,sCAAsC,CAC3C,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,eAAe,EAAE;IAkBpB;;;;;;OAMG;IAEI,8BAA8B,CACnC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC;IAcxB,4FAA4F;IAErF,8BAA8B,CACnC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IASlB,6FAA6F;IAEtF,+BAA+B,CACpC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IASlB;;;;;;;;OAQG;IAEI,eAAe,IAAI,SAAS,WAAW,EAAE;IAKhD;;;;;;;;OAQG;IAEI,aAAa,IAAI,WAAW,CAAC,WAAW,CAAC;IAKhD;;;;;;OAMG;IAEI,wBAAwB,CAC7B,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,WAAW,CAAC;IAW3B;;;;;OAKG;IAEI,0BAA0B,IAAI,SAAS,eAAe,EAAE;IAK/D;;;;;OAKG;IAEI,wBAAwB,IAAI,WAAW,CAAC,eAAe,CAAC;IAK/D;;;;;OAKG;IAEI,sBAAsB,IAAI,SAAS,WAAW,EAAE;IAKvD;;;;;OAKG;IAEI,oBAAoB,IAAI,WAAW,CAAC,WAAW,CAAC;CAIxD"}
+{"version":3,"file":"ModdedElementSets.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/ModdedElementSets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,eAAe,EACf,aAAa,EACb,UAAU,EACV,WAAW,EACZ,MAAM,8BAA8B,CAAC;AA0BtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AA4BhD,qBAAa,iBAAkB,SAAQ,OAAO;IAC5C,OAAO,CAAC,wBAAwB,CAAyB;IACzD,OAAO,CAAC,sBAAsB,CAA8B;IAE5D,OAAO,CAAC,4BAA4B,CAAyB;IAC7D,OAAO,CAAC,0BAA0B,CAA8B;IAEhE,OAAO,CAAC,2BAA2B,CAAyB;IAC5D,OAAO,CAAC,yBAAyB,CAA8B;IAE/D,OAAO,CAAC,oBAAoB,CAAqB;IACjD,OAAO,CAAC,kBAAkB,CAA0B;IAEpD,OAAO,CAAC,wBAAwB,CAAqB;IACrD,OAAO,CAAC,sBAAsB,CAA0B;IAExD,OAAO,CAAC,uBAAuB,CAAqB;IACpD,OAAO,CAAC,qBAAqB,CAA0B;IAEvD,OAAO,CAAC,wBAAwB,CAG5B;IAEJ,OAAO,CAAC,8BAA8B,CAGlC;IAEJ,OAAO,CAAC,0BAA0B,CAA0C;IAE5E,OAAO,CAAC,yBAAyB,CAA8B;IAC/D,OAAO,CAAC,kCAAkC,CAA8B;IACxE,OAAO,CAAC,qBAAqB,CAA0B;IAEvD,OAAO,CAAC,6BAA6B,CAA8B;IACnE,OAAO,CAAC,8BAA8B,CAA8B;IAEpE,OAAO,CAAC,sBAAsB,CAAyB;IAWvD,OAAO,CAAC,+BAA+B;IAgBvC,OAAO,CAAC,8BAA8B;IA2BtC,OAAO,CAAC,2BAA2B;IAgBnC,OAAO,CAAC,0BAA0B;IA2BlC,OAAO,CAAC,gCAAgC;IA8BxC,OAAO,CAAC,sCAAsC;IAkB9C,OAAO,CAAC,kCAAkC;IAkB1C,OAAO,CAAC,iCAAiC;IAgCzC,OAAO,CAAC,6BAA6B;IAoBrC,OAAO,CAAC,+BAA+B;IAuBvC;;;;;;;;;;;;OAYG;IAEI,mBAAmB,IAAI,SAAS,eAAe,EAAE;IAKxD;;;;;;;;;;;;OAYG;IAEI,iBAAiB,IAAI,WAAW,CAAC,eAAe,CAAC;IAKxD;;;;;;;;;;;OAWG;IAEI,gCAAgC,CACrC,UAAU,EAAE,UAAU,GACrB,WAAW,CAAC,eAAe,CAAC;IAW/B;;;;;;;;;OASG;IAEI,4BAA4B,CACjC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,eAAe,CAAC;IAW/B;;;;;;;;;;;OAWG;IAEI,sBAAsB,CAC3B,aAAa,EAAE,aAAa,GAC3B,WAAW,CAAC,eAAe,CAAC;IAa/B;;;;;OAKG;IAEI,yBAAyB,IAAI,WAAW,CAAC,eAAe,CAAC;IAKhE;;;;;OAKG;IAEI,0BAA0B,IAAI,WAAW,CAAC,eAAe,CAAC;IAKjE;;;;;;;;;;;OAWG;IAEI,qBAAqB,CAC1B,qBAAqB,EAAE,OAAO,GAC7B,WAAW,CAAC,eAAe,CAAC;IAQ/B;;;;;OAKG;IAEI,iBAAiB,IAAI,WAAW,CAAC,WAAW,CAAC;IAMpD;;;;;;;;;;;OAWG;IAEI,yBAAyB,IAAI,SAAS,eAAe,EAAE;IAK9D;;;;;;;;;;;OAWG;IAEI,uBAAuB,IAAI,WAAW,CAAC,eAAe,CAAC;IAK9D;;;;;;;;;;OAUG;IAEI,qBAAqB,IAAI,SAAS,WAAW,EAAE;IAKtD;;;;;;;;;;OAUG;IAEI,mBAAmB,IAAI,WAAW,CAAC,WAAW,CAAC;IAKtD;;;;;;;OAOG;IAEI,uBAAuB,CAC5B,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;IAe5B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEI,kCAAkC,CACvC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,eAAe,EAAE;IAkBpB;;;;OAIG;IAEI,4BAA4B,CACjC,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,aAAa,GAC3B,eAAe,EAAE;IAepB;;;;OAIG;IAEI,sCAAsC,CAC3C,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,eAAe,EAAE;IAkBpB;;;;;;;;OAQG;IAEI,8BAA8B,CACnC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC;IAcxB;;;;OAIG;IAEI,8BAA8B,CACnC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IASlB;;;;OAIG;IAEI,+BAA+B,CACpC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IASlB;;;;;;;;;;OAUG;IAEI,eAAe,IAAI,SAAS,WAAW,EAAE;IAKhD;;;;;;;;;;OAUG;IAEI,aAAa,IAAI,WAAW,CAAC,WAAW,CAAC;IAKhD;;;;;;;;OAQG;IAEI,wBAAwB,CAC7B,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,WAAW,CAAC;IAW3B;;;;;;;OAOG;IAEI,0BAA0B,IAAI,SAAS,eAAe,EAAE;IAK/D;;;;;;;OAOG;IAEI,wBAAwB,IAAI,WAAW,CAAC,eAAe,CAAC;IAK/D;;;;;;;OAOG;IAEI,sBAAsB,IAAI,SAAS,WAAW,EAAE;IAKvD;;;;;;;OAOG;IAEI,oBAAoB,IAAI,WAAW,CAAC,WAAW,CAAC;CAIxD"}

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

@@ -8,6 +8,8 @@ export declare class NoSirenSteal extends Feature {
      * Blacklists a familiar from being stolen by The Siren boss. This should be called once at the
      * beginning of every run.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.NO_SIREN_STEAL`.
+     *
      * @param familiarVariant The familiar variant to blacklist.
      * @param familiarSubType The sub-type to blacklist. Optional. The default is to blacklist all
      *                        sub-types of the given variant.

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

@@ -1 +1 @@
-{"version":3,"file":"NoSirenSteal.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/NoSirenSteal.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAEhB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,YAAa,SAAQ,OAAO;IAwBvC,OAAO,CAAC,sBAAsB,CAE5B;IAEF,OAAO,CAAC,2BAA2B;IAgBnC,OAAO,CAAC,oBAAoB;IA2B5B;;;;;;;OAOG;IAEI,uBAAuB,CAC5B,eAAe,EAAE,eAAe,EAChC,eAAe,CAAC,EAAE,GAAG,GACpB,IAAI;CAOR"}
+{"version":3,"file":"NoSirenSteal.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/NoSirenSteal.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAEhB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,YAAa,SAAQ,OAAO;IAwBvC,OAAO,CAAC,sBAAsB,CAE5B;IAEF,OAAO,CAAC,2BAA2B;IAgBnC,OAAO,CAAC,oBAAoB;IA2B5B;;;;;;;;;OASG;IAEI,uBAAuB,CAC5B,eAAe,EAAE,eAAe,EAChC,eAAe,CAAC,EAAE,GAAG,GACpB,IAAI;CAOR"}

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

@@ -12,9 +12,15 @@ export declare class Pause extends Feature {
      * - uses the Pause collectible on every game frame
      * - disables any player inputs (except for `ButtonAction.MENU_CONFIRM` and
      *   `ButtonAction.CONSOLE`)
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.PAUSE`.
      */
     pause(): void;
-    /** Helper function to put things back to normal after the `pause` function was used. */
+    /**
+     * Helper function to put things back to normal after the `pause` function was used.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.PAUSE`.
+     */
     unpause(): void;
 }
 //# sourceMappingURL=Pause.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Pause.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/Pause.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAYhD,qBAAa,KAAM,SAAQ,OAAO;IAUhC,OAAO,CAAC,aAAa,CAAgB;IAkBrC,OAAO,CAAC,UAAU,CAShB;IAEF,OAAO,CAAC,iCAAiC;IA0BzC,OAAO,CAAC,yBAAyB,CAiB/B;IAEF;;;;;;;;OAQG;IAEI,KAAK,IAAI,IAAI;IAwDpB,wFAAwF;IAEjF,OAAO,IAAI,IAAI;CA4BvB"}
+{"version":3,"file":"Pause.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/Pause.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAYhD,qBAAa,KAAM,SAAQ,OAAO;IAUhC,OAAO,CAAC,aAAa,CAAgB;IAkBrC,OAAO,CAAC,UAAU,CAShB;IAEF,OAAO,CAAC,iCAAiC;IA0BzC,OAAO,CAAC,yBAAyB,CAiB/B;IAEF;;;;;;;;;;OAUG;IAEI,KAAK,IAAI,IAAI;IAwDpB;;;;OAIG;IAEI,OAAO,IAAI,IAAI;CA4BvB"}

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

@@ -15,6 +15,8 @@ export declare class PersistentEntities extends Feature {
      * Helper function to stop an entity spawned with the `spawnPersistentEntity` helper function from
      * respawning.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.PERSISTENT_ENTITIES`.
+     *
      * @param persistentEntityIndex The index that was returned by the `spawnPersistentEntity`
      *                              function.
      * @param removeEntity Optional. True by default. Set to false if you want to stop an entity from
@@ -35,6 +37,8 @@ export declare class PersistentEntities extends Feature {
      * persistent, but they are not present in every room, only one specific room. This function
      * spawns entities like pickups, not familiars.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.PERSISTENT_ENTITIES`.
+     *
      * @returns A tuple containing the entity and the persistent entity index. You can use the index
      *          with the `removePersistentEntity` function.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"PersistentEntities.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PersistentEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAchD,qBAAa,kBAAmB,SAAQ,OAAO;IAuB7C,OAAO,CAAC,WAAW,CAAc;IAoBjC,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,oCAAoC;IAe5C;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAoBrC,OAAO,CAAC,oBAAoB,CAkB1B;IAEF,OAAO,CAAC,aAAa;IAsBrB;;;;;;;;;OASG;IAEI,sBAAsB,CAC3B,qBAAqB,EAAE,GAAG,EAC1B,YAAY,UAAO,GAClB,IAAI;IAoBP;;;;;;;;;;;;;;;OAeG;IAEI,qBAAqB,CAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,GACf,CAAC,MAAM,EAAE,GAAG,CAAC;CAajB"}
+{"version":3,"file":"PersistentEntities.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PersistentEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAchD,qBAAa,kBAAmB,SAAQ,OAAO;IAuB7C,OAAO,CAAC,WAAW,CAAc;IAoBjC,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,oCAAoC;IAe5C;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAoBrC,OAAO,CAAC,oBAAoB,CAkB1B;IAEF,OAAO,CAAC,aAAa;IAsBrB;;;;;;;;;;;OAWG;IAEI,sBAAsB,CAC3B,qBAAqB,EAAE,GAAG,EAC1B,YAAY,UAAO,GAClB,IAAI;IAoBP;;;;;;;;;;;;;;;;;OAiBG;IAEI,qBAAqB,CAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,GACf,CAAC,MAAM,EAAE,GAAG,CAAC;CAajB"}

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

@@ -25,6 +25,9 @@ export declare class PickupIndexCreation extends Feature {
      * have an index of 2, and so on.
      *
      * Tracking pickups requires stateful tracking, so using pickup indexes requires an upgraded mod.
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.PICKUP_INDEX_CREATION`.
      */
     getPickupIndex(pickup: EntityPickup): PickupIndex;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"PickupIndexCreation.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PickupIndexCreation.ts"],"names":[],"mappings":";AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,mBAAoB,SAAQ,OAAO;IAsB9C,OAAO,CAAC,WAAW,CAAc;IAwBjC,OAAO,CAAC,cAAc,CAoBpB;IAIF,OAAO,CAAC,sBAAsB,CAE5B;IAEF,OAAO,CAAC,oCAAoC;IAc5C;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAkDrC,OAAO,CAAC,oBAAoB,CA6B1B;IAEF,OAAO,CAAC,wBAAwB;IAyBhC;;;;;;;;;;;;OAYG;IAEI,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,WAAW;CAYzD"}
+{"version":3,"file":"PickupIndexCreation.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PickupIndexCreation.ts"],"names":[],"mappings":";AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,mBAAoB,SAAQ,OAAO;IAsB9C,OAAO,CAAC,WAAW,CAAc;IAwBjC,OAAO,CAAC,cAAc,CAoBpB;IAIF,OAAO,CAAC,sBAAsB,CAE5B;IAEF,OAAO,CAAC,oCAAoC;IAc5C;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAkDrC,OAAO,CAAC,oBAAoB,CA6B1B;IAEF,OAAO,CAAC,wBAAwB;IAyBhC;;;;;;;;;;;;;;;OAeG;IAEI,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,WAAW;CAYzD"}

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

@@ -19,6 +19,8 @@ export declare class PlayerInventory extends Feature {
      * might do this for some reason. (With that said, the next time that a collectible is normally
      * added or removed, it would trigger a re-scan, and the previous changes would be picked up.)
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.PLAYER_INVENTORY`.
+     *
      * @param player The player to get the inventory for.
      * @param includeActiveCollectibles Optional. If true, will include all active collectibles.
      *                                Default is true.
@@ -29,6 +31,8 @@ export declare class PlayerInventory extends Feature {
      * this will be the passive that is removed when the player would use Clicker.
      *
      * Returns undefined if the player does not have any passive collectibles.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.PLAYER_INVENTORY`.
      */
     getPlayerLastPassiveCollectible(player: EntityPlayer): CollectibleType | undefined;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"PlayerInventory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PlayerInventory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAY/D,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,eAAgB,SAAQ,OAAO;IA6B1C,OAAO,CAAC,oBAAoB,CAU1B;IAGF,OAAO,CAAC,sBAAsB,CAU5B;IAEF;;;;;;;;;;;;;;;;;;;OAmBG;IAEI,kBAAkB,CACvB,MAAM,EAAE,YAAY,EACpB,yBAAyB,UAAO,GAC/B,eAAe,EAAE;IAgBpB;;;;;OAKG;IAEI,+BAA+B,CACpC,MAAM,EAAE,YAAY,GACnB,eAAe,GAAG,SAAS;CAI/B"}
+{"version":3,"file":"PlayerInventory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PlayerInventory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAY/D,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,eAAgB,SAAQ,OAAO;IA6B1C,OAAO,CAAC,oBAAoB,CAU1B;IAGF,OAAO,CAAC,sBAAsB,CAU5B;IAEF;;;;;;;;;;;;;;;;;;;;;OAqBG;IAEI,kBAAkB,CACvB,MAAM,EAAE,YAAY,EACpB,yBAAyB,UAAO,GAC/B,eAAe,EAAE;IAgBpB;;;;;;;OAOG;IAEI,+BAA+B,CACpC,MAAM,EAAE,YAAY,GACnB,eAAe,GAAG,SAAS;CAI/B"}

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

@@ -5,11 +5,15 @@ export declare class PonyDetection extends Feature {
     /**
      * Helper function to see if the player is under the effects of A Pony or White Pony charge.
      * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.PONY_DETECTION`.
      */
     isPlayerUsingPony(player: EntityPlayer): boolean;
     /**
      * Helper function to see if any player is under the effects of A Pony or White Pony charge.
      * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.PONY_DETECTION`.
      */
     anyPlayerUsingPony(): boolean;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"PonyDetection.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PonyDetection.ts"],"names":[],"mappings":";AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,aAAc,SAAQ,OAAO;IAqBxC,OAAO,CAAC,0BAA0B,CAmBhC;IAEF;;;OAGG;IAEI,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO;IAIvD;;;OAGG;IAEI,kBAAkB,IAAI,OAAO;CAIrC"}
+{"version":3,"file":"PonyDetection.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PonyDetection.ts"],"names":[],"mappings":";AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,aAAc,SAAQ,OAAO;IAqBxC,OAAO,CAAC,0BAA0B,CAmBhC;IAEF;;;;;OAKG;IAEI,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO;IAIvD;;;;;OAKG;IAEI,kBAAkB,IAAI,OAAO;CAIrC"}

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

@@ -9,6 +9,9 @@ export declare class PreventChildEntities extends Feature {
      * Under the hood, this function will remove any new NPCs spawned that have a
      * `Entity.SpawnerEntity` or `Entity.Parent` value that matches the provided entity. (They are
      * removed during the `POST_NPC_INIT` callback specifically.)
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.PREVENT_CHILD_ENTITIES`.
      */
     preventChildEntities(entity: Entity): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"PreventChildEntities.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PreventChildEntities.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,oBAAqB,SAAQ,OAAO;IAkB/C,OAAO,CAAC,WAAW,CAYjB;IAEF;;;;;;;OAOG;IAEI,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAIlD"}
+{"version":3,"file":"PreventChildEntities.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PreventChildEntities.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,oBAAqB,SAAQ,OAAO;IAkB/C,OAAO,CAAC,WAAW,CAYjB;IAEF;;;;;;;;;;OAUG;IAEI,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAIlD"}

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

@@ -12,6 +12,9 @@ export declare class PreventCollectibleRotation extends Feature {
      *
      * It is required to pass the intended collectible type to this function since it is possible for
      * collectibles to rotate on the first frame that they are spawned.
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.PREVENT_COLLECTIBLE_ROTATION`.
      */
     preventCollectibleRotation(collectible: EntityPickup, collectibleType: CollectibleType): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"PreventCollectibleRotation.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PreventCollectibleRotation.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAGhB,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,0BAA2B,SAAQ,OAAO;IAoCrD,OAAO,CAAC,kBAAkB,CAIxB;IAIF,OAAO,CAAC,2BAA2B,CAIjC;IAEF,OAAO,CAAC,uBAAuB;IAiB/B;;;;;;;;OAQG;IAEI,0BAA0B,CAC/B,WAAW,EAAE,YAAY,EACzB,eAAe,EAAE,eAAe,GAC/B,IAAI;CAeR"}
+{"version":3,"file":"PreventCollectibleRotation.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PreventCollectibleRotation.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAGhB,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,0BAA2B,SAAQ,OAAO;IAoCrD,OAAO,CAAC,kBAAkB,CAIxB;IAIF,OAAO,CAAC,2BAA2B,CAIjC;IAEF,OAAO,CAAC,uBAAuB;IAiB/B;;;;;;;;;;;OAWG;IAEI,0BAA0B,CAC/B,WAAW,EAAE,YAAY,EACzB,eAAe,EAAE,eAAe,GAC/B,IAAI;CAeR"}

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

@@ -27,6 +27,9 @@ export declare class PreventGridEntityRespawn extends Feature {
      * room. However, the room data must exactly match the room type, the room shape, and the doors,
      * so this is not possible to do in a robust way without adding empty rooms to the mod's `content`
      * folder to draw the data from.
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.PREVENT_GRID_ENTITY_RESPAWN`.
      */
     preventGridEntityRespawn(): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"PreventGridEntityRespawn.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PreventGridEntityRespawn.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGhD,qBAAa,wBAAyB,SAAQ,OAAO;IAcnD,OAAO,CAAC,YAAY,CAAe;IAwBnC,OAAO,CAAC,0BAA0B,CAqDhC;IAGF,OAAO,CAAC,oBAAoB,CAE1B;IAEF;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAsB/B;;;;;;;;;;;;;;;;;;;OAmBG;IAEI,wBAAwB,IAAI,IAAI;CAuBxC"}
+{"version":3,"file":"PreventGridEntityRespawn.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PreventGridEntityRespawn.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGhD,qBAAa,wBAAyB,SAAQ,OAAO;IAcnD,OAAO,CAAC,YAAY,CAAe;IAwBnC,OAAO,CAAC,0BAA0B,CAqDhC;IAGF,OAAO,CAAC,oBAAoB,CAE1B;IAEF;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAsB/B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IAEI,wBAAwB,IAAI,IAAI;CAuBxC"}

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

@@ -5,11 +5,15 @@ export declare class RoomClearFrame extends Feature {
     /**
      * Helper function to get the game frame (i.e. `Game.GetFrameCount`) of the last time that this
      * room was cleared. Returns undefined if the room has never been cleared.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
      */
     getRoomClearGameFrame(): int | undefined;
     /**
      * Helper function to get the room frame (i.e. `Room.GetFrameCount`) of the last time that this
      * room was cleared. Returns undefined if the room has never been cleared.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
      */
     getRoomClearRoomFrame(): int | undefined;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"RoomClearFrame.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomClearFrame.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,cAAe,SAAQ,OAAO;IAuBzC,OAAO,CAAC,wBAAwB,CAO9B;IAEF;;;OAGG;IAEI,qBAAqB,IAAI,GAAG,GAAG,SAAS;IAI/C;;;OAGG;IAEI,qBAAqB,IAAI,GAAG,GAAG,SAAS;CAGhD"}
+{"version":3,"file":"RoomClearFrame.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomClearFrame.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,cAAe,SAAQ,OAAO;IAuBzC,OAAO,CAAC,wBAAwB,CAO9B;IAEF;;;;;OAKG;IAEI,qBAAqB,IAAI,GAAG,GAAG,SAAS;IAI/C;;;;;OAKG;IAEI,qBAAqB,IAAI,GAAG,GAAG,SAAS;CAGhD"}

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

@@ -5,6 +5,8 @@ export declare class RoomHistory extends Feature {
     /**
      * Helper function to get information about all of the rooms that a player has visited thus far on
      * this run.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
      */
     getRoomHistory(): ReadonlyArray<Readonly<RoomDescription>>;
     /**
@@ -12,6 +14,8 @@ export declare class RoomHistory extends Feature {
      *
      * In the special case of only one room having been visited thus far (i.e. the starting room of
      * the run), the starting room will be returned.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
      */
     getPreviousRoomDescription(): Readonly<RoomDescription>;
     /**
@@ -22,6 +26,8 @@ export declare class RoomHistory extends Feature {
      *
      * Note that this function can return undefined in the case where it is called on the first room
      * of the run.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
      */
     getLatestRoomDescription(): Readonly<RoomDescription> | undefined;
     /**
@@ -32,6 +38,8 @@ export declare class RoomHistory extends Feature {
      *
      * This function is intended to be used in the `POST_ENTITY_REMOVE` callback to detect when an
      * entity is despawning.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
      */
     isLeavingRoom(): boolean;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"RoomHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomHistory.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,WAAY,SAAQ,OAAO;IAkBtC,OAAO,CAAC,gBAAgB,CA6BtB;IAEF;;;OAGG;IAEI,cAAc,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIjE;;;;;OAKG;IAEI,0BAA0B,IAAI,QAAQ,CAAC,eAAe,CAAC;IAiB9D;;;;;;;;OAQG;IAEI,wBAAwB,IAAI,QAAQ,CAAC,eAAe,CAAC,GAAG,SAAS;IAIxE;;;;;;;;OAQG;IAEI,aAAa,IAAI,OAAO;CAqBhC"}
+{"version":3,"file":"RoomHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomHistory.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,WAAY,SAAQ,OAAO;IAkBtC,OAAO,CAAC,gBAAgB,CA6BtB;IAEF;;;;;OAKG;IAEI,cAAc,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIjE;;;;;;;OAOG;IAEI,0BAA0B,IAAI,QAAQ,CAAC,eAAe,CAAC;IAiB9D;;;;;;;;;;OAUG;IAEI,wBAAwB,IAAI,QAAQ,CAAC,eAAe,CAAC,GAAG,SAAS;IAIxE;;;;;;;;;;OAUG;IAEI,aAAa,IAAI,OAAO;CAqBhC"}

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

@@ -9,6 +9,8 @@ export declare class RunInNFrames extends Feature {
      * a run is first starting.
      *
      * You can optionally specify a `PlayerType` to restart the game as that character.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
      */
     restartNextRenderFrame(character?: PlayerType): void;
     /**
@@ -20,6 +22,8 @@ export declare class RunInNFrames extends Feature {
      * Note that this function will not handle saving and quitting. If a player saving and quitting
      * before the deferred function fires would cause a bug in your mod, then you should handle
      * deferred functions manually using serializable data.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
      */
     runInNGameFrames(func: () => void, gameFrames: int): void;
     /**
@@ -31,6 +35,8 @@ export declare class RunInNFrames extends Feature {
      * Note that this function will not handle saving and quitting. If a player saving and quitting
      * before the deferred function fires would cause a bug in your mod, then you should handle
      * deferred functions manually using serializable data.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
      */
     runInNRenderFrames(func: () => void, renderFrames: int): void;
     /**
@@ -60,6 +66,8 @@ export declare class RunInNFrames extends Feature {
      * Note that this function will not handle saving and quitting. If a player saving and quitting
      * before the deferred function fires would cause a bug in your mod, then you should handle
      * deferred functions manually using serializable data.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
      */
     runNextGameFrame(func: () => void): void;
     /**
@@ -69,6 +77,8 @@ export declare class RunInNFrames extends Feature {
      * similar way.
      *
      * Note that this function will not handle saving and quitting.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
      */
     runNextRenderFrame(func: () => void): void;
     /**
@@ -82,6 +92,8 @@ export declare class RunInNFrames extends Feature {
      * Note that this function will not handle saving and quitting. You must manually restart any
      * intervals if the player saves and quits in the middle of a run.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
+     *
      * @param func The function to repeatedly run on an interval.
      * @param gameFrames The amount of game frames to wait between each run.
      * @param runImmediately Whether or not to execute the function right now before waiting for the
@@ -99,6 +111,8 @@ export declare class RunInNFrames extends Feature {
      * Note that this function will not handle saving and quitting. You must manually restart any
      * intervals if the player saves and quits in the middle of a run.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
+     *
      * @param func The function to repeatedly run on an interval.
      * @param renderFrames The amount of game frames to wait between each run.
      * @param runImmediately Whether or not to execute the function right now before waiting for the

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

@@ -1 +1 @@
-{"version":3,"file":"RunInNFrames.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RunInNFrames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAKvE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAgBhD,qBAAa,YAAa,SAAQ,OAAO;IAuBvC,OAAO,CAAC,UAAU,CAWhB;IAGF,OAAO,CAAC,UAAU,CAWhB;IAEF;;;;;;OAMG;IAEI,sBAAsB,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI;IAM3D;;;;;;;;;OASG;IAEI,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,UAAU,EAAE,GAAG,GAAG,IAAI;IAOhE;;;;;;;;;OASG;IAEI,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,YAAY,EAAE,GAAG,GAAG,IAAI;IAOpE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEI,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IAI/C;;;;;;;OAOG;IAEI,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IAIjD;;;;;;;;;;;;;;;OAeG;IAEI,qBAAqB,CAC1B,IAAI,EAAE,MAAM,OAAO,EACnB,UAAU,EAAE,GAAG,EACf,cAAc,EAAE,OAAO,GACtB,IAAI;IAWP;;;;;;;;;;;;;;;OAeG;IAEI,uBAAuB,CAC5B,IAAI,EAAE,MAAM,OAAO,EACnB,YAAY,EAAE,GAAG,EACjB,cAAc,EAAE,OAAO,GACtB,IAAI;CAcR"}
+{"version":3,"file":"RunInNFrames.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RunInNFrames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAKvE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAgBhD,qBAAa,YAAa,SAAQ,OAAO;IAuBvC,OAAO,CAAC,UAAU,CAWhB;IAGF,OAAO,CAAC,UAAU,CAWhB;IAEF;;;;;;;;OAQG;IAEI,sBAAsB,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI;IAM3D;;;;;;;;;;;OAWG;IAEI,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,UAAU,EAAE,GAAG,GAAG,IAAI;IAOhE;;;;;;;;;;;OAWG;IAEI,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,YAAY,EAAE,GAAG,GAAG,IAAI;IAOpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEI,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IAI/C;;;;;;;;;OASG;IAEI,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IAIjD;;;;;;;;;;;;;;;;;OAiBG;IAEI,qBAAqB,CAC1B,IAAI,EAAE,MAAM,OAAO,EACnB,UAAU,EAAE,GAAG,EACf,cAAc,EAAE,OAAO,GACtB,IAAI;IAWP;;;;;;;;;;;;;;;;;OAiBG;IAEI,uBAAuB,CAC5B,IAAI,EAAE,MAAM,OAAO,EACnB,YAAY,EAAE,GAAG,EACjB,cAAc,EAAE,OAAO,GACtB,IAAI;CAcR"}

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

@@ -12,6 +12,8 @@ export declare class RunNextRoom extends Feature {
      * Note that this function will not handle saving and quitting. If a player saving and quitting
      * before the deferred function fires would cause a bug in your mod, then you should handle
      * deferred functions manually using serializable data.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_NEXT_ROOM`.
      */
     runNextRoom(func: () => void): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"RunNextRoom.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RunNextRoom.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,OAAO;IAkBtC,OAAO,CAAC,oBAAoB,CAM1B;IAEF;;;;;;OAMG;IAEI,WAAW,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;CAG3C"}
+{"version":3,"file":"RunNextRoom.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RunNextRoom.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,OAAO;IAkBtC,OAAO,CAAC,oBAAoB,CAM1B;IAEF;;;;;;;;OAQG;IAEI,WAAW,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;CAG3C"}