isaacscript-common 15.0.2 → 15.0.4

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

@@ -75,6 +75,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getFirstModdedCollectibleType(): CollectibleType | undefined {
@@ -100,6 +103,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getLastCollectibleType(): CollectibleType {
@@ -124,6 +130,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getModdedCollectibleTypes(): CollectibleType[] {
@@ -142,6 +151,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getNumCollectibleTypes(): int {
@@ -157,6 +169,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getNumModdedCollectibleTypes(): int {
@@ -175,6 +190,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getFirstModdedTrinketType(): TrinketType | undefined {
@@ -195,6 +213,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getLastTrinketType(): TrinketType {
@@ -215,6 +236,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getModdedTrinketTypes(): TrinketType[] {
@@ -237,6 +261,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getNumTrinketTypes(): int {
@@ -248,6 +275,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getNumModdedTrinketTypes(): int {
@@ -262,6 +292,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getTrinketTypes(): TrinketType[] {
@@ -280,6 +313,9 @@ export class ModdedElementDetection extends Feature {
    *
    * This function can only be called if at least one callback has been executed. This is because
    * not all cards 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_DETECTION`.
    */
   @Exported
   public getAllCardTypes(): CardType[] {
@@ -294,6 +330,9 @@ export class ModdedElementDetection extends Feature {
    *
    * This function can only be called if at least one callback has been executed. This is because
    * not all cards 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_DETECTION`.
    */
   @Exported
   public getFirstModdedCardType(): CardType | undefined {
@@ -314,6 +353,9 @@ export class ModdedElementDetection extends Feature {
    *
    * This function can only be called if at least one callback has been executed. This is because
    * not all cards 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_DETECTION`.
    */
   @Exported
   public getLastCardType(): CardType {
@@ -330,6 +372,9 @@ export class ModdedElementDetection extends Feature {
    *
    * This function can only be called if at least one callback has been executed. This is because
    * not all cards 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_DETECTION`.
    */
   @Exported
   public getModdedCardTypes(): CardType[] {
@@ -351,6 +396,9 @@ export class ModdedElementDetection extends Feature {
    *
    * This function can only be called if at least one callback has been executed. This is because
    * not all cards 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_DETECTION`.
    */
   @Exported
   public getNumCardTypes(): int {
@@ -362,6 +410,9 @@ export class ModdedElementDetection 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_DETECTION`.
    */
   @Exported
   public getNumModdedCardTypes(): int {
@@ -382,6 +433,9 @@ export class ModdedElementDetection extends Feature {
    * This function can only be called if at least one callback has been executed. This is because
    * not all pill effects 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_DETECTION`.
    */
   @Exported
   public getAllPillEffects(): PillEffect[] {
@@ -397,6 +451,9 @@ export class ModdedElementDetection extends Feature {
    * This function can only be called if at least one callback has been executed. This is because
    * not all pill effects 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_DETECTION`.
    */
   @Exported
   public getFirstModdedPillEffect(): PillEffect | undefined {
@@ -422,6 +479,9 @@ export class ModdedElementDetection extends Feature {
    * This function can only be called if at least one callback has been executed. This is because
    * not all pill effects 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_DETECTION`.
    */
   @Exported
   public getLastPillEffect(): PillEffect {
@@ -439,6 +499,9 @@ export class ModdedElementDetection extends Feature {
    * This function can only be called if at least one callback has been executed. This is because
    * not all pill effects 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_DETECTION`.
    */
   @Exported
   public getModdedPillEffects(): PillEffect[] {
@@ -462,6 +525,9 @@ export class ModdedElementDetection extends Feature {
    * This function can only be called if at least one callback has been executed. This is because
    * not all pill effects 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_DETECTION`.
    */
   @Exported
   public getNumPillEffects(): int {
@@ -474,6 +540,9 @@ export class ModdedElementDetection extends Feature {
    * This function can only be called if at least one callback has been executed. This is because
    * not all pill effects 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_DETECTION`.
    */
   @Exported
   public getNumModdedPillEffects(): int {

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

@@ -344,6 +344,8 @@ export 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`.
    */
   @Exported
   public getCollectibleArray(): readonly CollectibleType[] {
@@ -361,6 +363,8 @@ export 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`.
    */
   @Exported
   public getCollectibleSet(): ReadonlySet<CollectibleType> {
@@ -377,6 +381,8 @@ export 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`.
    */
   @Exported
   public getCollectiblesForTransformation(
@@ -399,6 +405,8 @@ export 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`.
    */
   @Exported
   public getCollectiblesWithCacheFlag(
@@ -423,6 +431,8 @@ export 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`.
    */
   @Exported
   public getCollectiblesWithTag(
@@ -443,6 +453,8 @@ export class ModdedElementSets extends Feature {
   /**
    * 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`.
    */
   @Exported
   public getEdenActiveCollectibles(): ReadonlySet<CollectibleType> {
@@ -453,6 +465,8 @@ export class ModdedElementSets extends Feature {
   /**
    * 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`.
    */
   @Exported
   public getEdenPassiveCollectibles(): ReadonlySet<CollectibleType> {
@@ -467,6 +481,8 @@ export 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).
    */
@@ -484,6 +500,8 @@ export 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`.
    */
   @Exported
   public getFlyingTrinkets(): ReadonlySet<TrinketType> {
@@ -501,6 +519,8 @@ export 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`.
    */
   @Exported
   public getModdedCollectibleArray(): readonly CollectibleType[] {
@@ -517,6 +537,8 @@ export 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`.
    */
   @Exported
   public getModdedCollectibleSet(): ReadonlySet<CollectibleType> {
@@ -532,6 +554,8 @@ export 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`.
    */
   @Exported
   public getModdedTrinketArray(): readonly TrinketType[] {
@@ -547,6 +571,8 @@ export 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`.
    */
   @Exported
   public getModdedTrinketSet(): ReadonlySet<TrinketType> {
@@ -559,6 +585,8 @@ export 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`.
    */
   @Exported
   public getPlayerCollectibleMap(
@@ -599,6 +627,8 @@ export 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`.
    */
   @Exported
   public getPlayerCollectiblesWithCacheFlag(
@@ -622,7 +652,11 @@ export class ModdedElementSets extends Feature {
     return playerCollectibles;
   }
 
-  /** 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`.
+   */
   @Exported
   public getPlayerCollectiblesWithTag(
     player: EntityPlayer,
@@ -642,7 +676,11 @@ export class ModdedElementSets extends Feature {
     return playerCollectibles;
   }
 
-  /** 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`.
+   */
   @Exported
   public getPlayerCollectiblesForTransformation(
     player: EntityPlayer,
@@ -671,6 +709,8 @@ export 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`.
    */
   @Exported
   public getPlayerTrinketsWithCacheFlag(
@@ -690,7 +730,11 @@ export class ModdedElementSets extends Feature {
     return playerTrinkets;
   }
 
-  /** 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`.
+   */
   @Exported
   public getRandomEdenActiveCollectible(
     seedOrRNG: Seed | RNG = getRandomSeed(),
@@ -704,7 +748,11 @@ export class ModdedElementSets extends Feature {
     );
   }
 
-  /** 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`.
+   */
   @Exported
   public getRandomEdenPassiveCollectible(
     seedOrRNG: Seed | RNG = getRandomSeed(),
@@ -726,6 +774,8 @@ export 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`.
    */
   @Exported
   public getTrinketArray(): readonly TrinketType[] {
@@ -741,6 +791,8 @@ export 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`.
    */
   @Exported
   public getTrinketSet(): ReadonlySet<TrinketType> {
@@ -754,6 +806,8 @@ export 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`.
    */
   @Exported
   public getTrinketsWithCacheFlag(
@@ -774,6 +828,8 @@ export 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`.
    */
   @Exported
   public getVanillaCollectibleArray(): readonly CollectibleType[] {
@@ -786,6 +842,8 @@ export 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`.
    */
   @Exported
   public getVanillaCollectibleSet(): ReadonlySet<CollectibleType> {
@@ -798,6 +856,8 @@ export 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`.
    */
   @Exported
   public getVanillaTrinketArray(): readonly TrinketType[] {
@@ -810,6 +870,8 @@ export 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`.
    */
   @Exported
   public getVanillaTrinketSet(): ReadonlySet<TrinketType> {

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

@@ -81,6 +81,8 @@ export 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/src/classes/features/other/Pause.ts

@@ -121,6 +121,8 @@ export 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`.
    */
   @Exported
   public pause(): void {
@@ -179,7 +181,11 @@ export class Pause extends Feature {
     this.stopTearsAndProjectilesFromMoving();
   }
 
-  /** 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`.
+   */
   @Exported
   public unpause(): void {
     if (!this.v.run.isPseudoPaused) {

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

@@ -155,6 +155,8 @@ export 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
@@ -198,6 +200,8 @@ export 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/src/classes/features/other/PickupIndexCreation.ts

@@ -232,6 +232,9 @@ export 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`.
    */
   @Exported
   public getPickupIndex(pickup: EntityPickup): PickupIndex {

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

@@ -82,6 +82,8 @@ export 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.
@@ -111,6 +113,8 @@ export 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`.
    */
   @Exported
   public getPlayerLastPassiveCollectible(

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

@@ -62,6 +62,8 @@ export 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`.
    */
   @Exported
   public isPlayerUsingPony(player: EntityPlayer): boolean {
@@ -71,6 +73,8 @@ export class PonyDetection extends Feature {
   /**
    * 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`.
    */
   @Exported
   public anyPlayerUsingPony(): boolean {

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

@@ -41,6 +41,9 @@ export 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`.
    */
   @Exported
   public preventChildEntities(entity: Entity): void {

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

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

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

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

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

@@ -38,6 +38,8 @@ export 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`.
    */
   @Exported
   public getRoomClearGameFrame(): int | undefined {
@@ -47,6 +49,8 @@ export class RoomClearFrame extends Feature {
   /**
    * 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`.
    */
   @Exported
   public getRoomClearRoomFrame(): int | undefined {

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

@@ -67,6 +67,8 @@ export 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`.
    */
   @Exported
   public getRoomHistory(): ReadonlyArray<Readonly<RoomDescription>> {
@@ -78,6 +80,8 @@ export 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`.
    */
   @Exported
   public getPreviousRoomDescription(): Readonly<RoomDescription> {
@@ -105,6 +109,8 @@ export 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`.
    */
   @Exported
   public getLatestRoomDescription(): Readonly<RoomDescription> | undefined {
@@ -119,6 +125,8 @@ export 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`.
    */
   @Exported
   public isLeavingRoom(): boolean {