isaacscript-common 15.0.3 → 15.0.5

package/dist/index.d.ts

@@ -3034,6 +3034,8 @@ declare class DisableInputs extends Feature {
      * Helper function to enable all inputs. Use this function to set things back to normal after
      * having used one of the other helper functions to disable inputs.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_INPUTS`.
+     *
      * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
      *            that multiple mod features can work in tandem.
      */
@@ -3046,6 +3048,8 @@ declare class DisableInputs extends Feature {
      *
      * Use the `enableAllInputs` helper function to set things back to normal.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_INPUTS`.
+     *
      * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
      *            that multiple mod features can work in tandem.
      * @param buttonActions An array of the actions to action.
@@ -3057,6 +3061,8 @@ declare class DisableInputs extends Feature {
      *
      * Use the `enableAllInputs` helper function to set things back to normal.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_INPUTS`.
+     *
      * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
      *            that multiple mod features can work in tandem.
      */
@@ -3067,6 +3073,8 @@ declare class DisableInputs extends Feature {
      *
      * Use the `enableAllInputs` helper function to set things back to normal.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_INPUTS`.
+     *
      * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
      *            that multiple mod features can work in tandem.
      * @param blacklist A set of ButtonActions to disallow.
@@ -3078,6 +3086,8 @@ declare class DisableInputs extends Feature {
      *
      * Use the `enableAllInputs` helper function to set things back to normal.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_INPUTS`.
+     *
      * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
      *            that multiple mod features can work in tandem.
      * @param whitelist A set of ButtonActions to allow.
@@ -3090,6 +3100,8 @@ declare class DisableInputs extends Feature {
      *
      * Use the `enableAllInputs` helper function to set things back to normal.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_INPUTS`.
+     *
      * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
      *            that multiple mod features can work in tandem.
      */
@@ -3100,6 +3112,8 @@ declare class DisableInputs extends Feature {
      *
      * Use the `enableAllInputs` helper function to set things back to normal.
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.DISABLE_INPUTS`.
+     *
      * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
      *            that multiple mod features can work in tandem.
      */
@@ -3467,6 +3481,9 @@ declare class ExtraConsoleCommands extends Feature {
      * but you can also add your own commands that are useful for your particular mod. It's easier to
      * add commands to the existing command system than to add your own logic manually to the
      * `EXECUTE_CMD` callback.
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.EXTRA_CONSOLE_COMMANDS`.
      */
     addConsoleCommand(commandName: string, commandFunction: (params: string) => void): void;
     /**
@@ -3474,6 +3491,9 @@ declare class ExtraConsoleCommands extends Feature {
      *
      * The standard library comes with many existing console commands that are useful for debugging.
      * If you want to disable one of them, use this function.
+     *
+     * In order to use this function, you must upgrade your mod with
+     * `ISCFeature.EXTRA_CONSOLE_COMMANDS`.
      */
     removeConsoleCommand(commandName: string): void;
 }
@@ -3494,11 +3514,15 @@ declare class FadeInRemover extends Feature {
      * This is useful for debugging, when you are resetting the game often.
      *
      * You can restore the vanilla behavior with the `restoreFadeIn` function.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.FADE_IN_REMOVER`.
      */
     removeFadeIn(): void;
     /**
      * Disables the fade-in remover. Only useful if you have previously called the `removeFadeIn`
      * function.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.FADE_IN_REMOVER`.
      */
     restoreFadeIn(): void;
 }
@@ -3513,11 +3537,15 @@ declare class FastReset extends Feature {
      * This is useful for debugging, when you are resetting the game often.
      *
      * You can disable the fast-reset feature with the `disableFastReset` function.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.FAST_RESET`.
      */
     enableFastReset(): void;
     /**
      * Disables the fast-reset feature. Only useful if you have previously called the
      * `enableFastReset` function.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.FAST_RESET`.
      */
     disableFastReset(): void;
 }
@@ -3655,6 +3683,8 @@ declare class FlyingDetection extends Feature {
     /**
      * Helper function to see if the player currently has flying from a temporary effect such as
      * Hanged Man, Bat Wing, and so on.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.FLYING_DETECTION`.
      */
     hasFlyingTemporaryEffect(player: EntityPlayer): boolean;
 }
@@ -3687,6 +3717,8 @@ declare class ForgottenSwitch extends Feature {
     /**
      * When used on The Forgotten, switches to The Soul. When used on The Soul, switches to The
      * Forgotten. This takes 1 game frame to take effect.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.FORGOTTEN_SWITCH`.
      */
     forgottenSwitch(): void;
 }
@@ -4672,6 +4704,9 @@ export declare function getGridEntities(...gridEntityTypes: GridEntityType[]): G
  */
 export declare function getGridEntitiesExcept(...gridEntityTypes: GridEntityType[]): GridEntity[];
 
+/** Helper function to get all grid entities in a given radius around a given point. */
+export declare function getGridEntitiesInRadius(targetPosition: Vector, radius: number): GridEntity[];
+
 /**
  * Helper function to get a map of every grid entity in the current room. The indexes of the map are
  * equal to the grid index. The values of the map are equal to the grid entities.
@@ -4681,6 +4716,9 @@ export declare function getGridEntitiesExcept(...gridEntityTypes: GridEntityType
  */
 export declare function getGridEntitiesMap(...gridEntityTypes: GridEntityType[]): Map<int, GridEntity>;
 
+/** Helper function to get the top left and bottom right corners of a given grid entity. */
+export declare function getGridEntityCollisionPoints(gridEntity: GridEntity): [topLeft: Vector, bottomRight: Vector];
+
 /** Helper function to get a string containing the grid entity's type and variant. */
 export declare function getGridEntityID(gridEntity: GridEntity): string;
 
@@ -6960,7 +6998,7 @@ export declare enum ISCFeature {
     NO_SIREN_STEAL = 33,
     PAUSE = 34,
     PERSISTENT_ENTITIES = 35,
-    PICKUP_INDEX = 36,
+    PICKUP_INDEX_CREATION = 36,
     PLAYER_INVENTORY = 37,
     PONY_DETECTION = 38,
     PREVENT_CHILD_ENTITIES = 39,
@@ -7021,7 +7059,7 @@ declare interface ISCFeatureToClass {
     [ISCFeature.NO_SIREN_STEAL]: NoSirenSteal;
     [ISCFeature.PAUSE]: Pause;
     [ISCFeature.PERSISTENT_ENTITIES]: PersistentEntities;
-    [ISCFeature.PICKUP_INDEX]: PickupIndexCreation;
+    [ISCFeature.PICKUP_INDEX_CREATION]: PickupIndexCreation;
     [ISCFeature.PLAYER_INVENTORY]: PlayerInventory;
     [ISCFeature.PONY_DETECTION]: PonyDetection;
     [ISCFeature.PREVENT_CHILD_ENTITIES]: PreventChildEntities;
@@ -7779,6 +7817,8 @@ declare class ItemPoolDetection extends Feature {
     /**
      * Helper function to get the remaining collectibles in a given item pool. This function is
      * expensive, so only use it in situations where the lag is acceptable.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
      */
     getCollectiblesInItemPool(itemPoolType: ItemPoolType): CollectibleType[];
     /**
@@ -7790,6 +7830,8 @@ declare class ItemPoolDetection extends Feature {
      *
      * Under the hood, this function works by using the `ItemPool.AddRoomBlacklist` method to
      * blacklist every collectible except for the one provided.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
      */
     isCollectibleInItemPool(collectibleType: CollectibleType, itemPoolType: ItemPoolType): boolean;
     /**
@@ -7805,6 +7847,8 @@ declare class ItemPoolDetection extends Feature {
      * - If the collectible is non-offensive, any Tainted Losts will be temporarily changed to Isaac
      *   and then changed back. (This is because Tainted Lost is not able to retrieve non-offensive
      *   collectibles from item pools).
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
      */
     isCollectibleUnlocked(collectibleType: CollectibleType, itemPoolType: ItemPoolType): boolean;
 }
@@ -9969,6 +10013,9 @@ declare 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`.
      */
     getFirstModdedCollectibleType(): CollectibleType | undefined;
     /**
@@ -9980,6 +10027,9 @@ declare 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`.
      */
     getLastCollectibleType(): CollectibleType;
     /**
@@ -9998,12 +10048,18 @@ declare 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`.
      */
     getModdedCollectibleTypes(): CollectibleType[];
     /**
      * 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`.
      */
     getNumCollectibleTypes(): int;
     /**
@@ -10012,6 +10068,9 @@ declare 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`.
      */
     getNumModdedCollectibleTypes(): int;
     /**
@@ -10019,6 +10078,9 @@ declare 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`.
      */
     getFirstModdedTrinketType(): TrinketType | undefined;
     /**
@@ -10029,6 +10091,9 @@ declare 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`.
      */
     getLastTrinketType(): TrinketType;
     /**
@@ -10042,6 +10107,9 @@ declare 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`.
      */
     getModdedTrinketTypes(): TrinketType[];
     /**
@@ -10052,11 +10120,17 @@ declare 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`.
      */
     getNumTrinketTypes(): int;
     /**
      * 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`.
      */
     getNumModdedTrinketTypes(): int;
     /**
@@ -10064,6 +10138,9 @@ declare 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`.
      */
     getTrinketTypes(): TrinketType[];
     /**
@@ -10071,6 +10148,9 @@ declare 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`.
      */
     getAllCardTypes(): CardType[];
     /**
@@ -10078,6 +10158,9 @@ declare 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`.
      */
     getFirstModdedCardType(): CardType | undefined;
     /**
@@ -10088,6 +10171,9 @@ declare 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`.
      */
     getLastCardType(): CardType;
     /**
@@ -10097,6 +10183,9 @@ declare 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`.
      */
     getModdedCardTypes(): CardType[];
     /**
@@ -10106,11 +10195,17 @@ declare 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`.
      */
     getNumCardTypes(): int;
     /**
      * 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`.
      */
     getNumModdedCardTypes(): int;
     /**
@@ -10120,6 +10215,9 @@ declare 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`.
      */
     getAllPillEffects(): PillEffect[];
     /**
@@ -10128,6 +10226,9 @@ declare 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`.
      */
     getFirstModdedPillEffect(): PillEffect | undefined;
     /**
@@ -10139,6 +10240,9 @@ declare 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`.
      */
     getLastPillEffect(): PillEffect;
     /**
@@ -10149,6 +10253,9 @@ declare 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`.
      */
     getModdedPillEffects(): PillEffect[];
     /**
@@ -10160,12 +10267,18 @@ declare 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`.
      */
     getNumPillEffects(): int;
     /**
      * 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`.
      */
     getNumModdedPillEffects(): int;
 }
@@ -10212,6 +10325,8 @@ 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[];
     /**
@@ -10224,6 +10339,8 @@ 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>;
     /**
@@ -10235,6 +10352,8 @@ 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>;
     /**
@@ -10244,6 +10363,8 @@ 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>;
     /**
@@ -10255,16 +10376,22 @@ 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>;
     /**
@@ -10274,6 +10401,8 @@ 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).
      */
@@ -10281,6 +10410,8 @@ 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>;
     /**
@@ -10292,6 +10423,8 @@ 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[];
     /**
@@ -10303,6 +10436,8 @@ 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>;
     /**
@@ -10313,6 +10448,8 @@ 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[];
     /**
@@ -10323,6 +10460,8 @@ 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>;
     /**
@@ -10330,6 +10469,8 @@ 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>;
     /**
@@ -10353,11 +10494,21 @@ 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
@@ -10365,11 +10516,21 @@ 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.
@@ -10379,6 +10540,8 @@ 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[];
     /**
@@ -10389,6 +10552,8 @@ 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>;
     /**
@@ -10397,6 +10562,8 @@ 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>;
     /**
@@ -10404,6 +10571,8 @@ 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[];
     /**
@@ -10411,6 +10580,8 @@ 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>;
     /**
@@ -10418,6 +10589,8 @@ 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[];
     /**
@@ -10425,6 +10598,8 @@ 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>;
 }
@@ -10659,6 +10834,8 @@ 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.
@@ -10782,9 +10959,15 @@ 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;
 }
 
@@ -10803,6 +10986,8 @@ 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
@@ -10823,6 +11008,8 @@ 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.
      */
@@ -10897,6 +11084,9 @@ 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;
 }
@@ -11037,6 +11227,8 @@ 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.
@@ -11047,6 +11239,8 @@ 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;
 }
@@ -11092,11 +11286,15 @@ 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;
 }
@@ -11267,6 +11465,9 @@ 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;
 }
@@ -11283,6 +11484,9 @@ 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;
 }
@@ -11315,6 +11519,9 @@ 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;
 }
@@ -12001,11 +12208,15 @@ 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;
 }
@@ -12049,6 +12260,8 @@ 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>>;
     /**
@@ -12056,6 +12269,8 @@ 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>;
     /**
@@ -12066,6 +12281,8 @@ 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;
     /**
@@ -12076,6 +12293,8 @@ 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;
 }
@@ -12093,7 +12312,7 @@ export declare function roomUpdateSafe(): void;
  * From: http://lua-users.org/wiki/SimpleRound
  *
  * @param num The number to round.
- * @param numDecimalPlaces Default is 0.
+ * @param numDecimalPlaces Optional. Default is 0.
  */
 export declare function round(num: float, numDecimalPlaces?: number): float;
 
@@ -12113,6 +12332,8 @@ 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;
     /**
@@ -12124,6 +12345,8 @@ 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;
     /**
@@ -12135,6 +12358,8 @@ 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;
     /**
@@ -12164,6 +12389,8 @@ 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;
     /**
@@ -12173,6 +12400,8 @@ 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;
     /**
@@ -12186,6 +12415,8 @@ 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
@@ -12203,6 +12434,8 @@ 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
@@ -12231,6 +12464,8 @@ 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;
 }
@@ -12325,6 +12560,8 @@ declare class SaveDataManager extends Feature {
      * You feed this function with an object containing your variables, and then it will automatically
      * manage them for you. (See below for an example.)
      *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+     *
      * The save data manager is meant to be called once for each feature of your mod. In other words,
      * you should not put all of the data for your mod on the same object. Instead, scope your
      * variables locally to a single file that contains a mod feature, and then call this function to
@@ -12429,12 +12666,16 @@ declare class SaveDataManager extends Feature {
      *
      * Obviously, doing this will overwrite the current data, so using this function can potentially
      * result in lost state.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
      */
     saveDataManagerLoad(): void;
     /**
      * The save data manager will automatically save variables to disk at the appropriate times (i.e.
      * when the run is exited). Use this function to explicitly force the save data manager to write
      * all of its variables to disk immediately.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
      */
     saveDataManagerSave(): void;
     /**
@@ -12442,6 +12683,8 @@ declare class SaveDataManager extends Feature {
      *
      * This can make debugging easier, as you can access the variables from the game's debug console.
      * e.g. `l print(g.feature1.run.foo)`
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
      */
     saveDataManagerSetGlobal(): void;
     /**
@@ -12453,11 +12696,15 @@ declare class SaveDataManager extends Feature {
      * the data fields).
      *
      * This function is variadic, which means you can pass as many classes as you want to register.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
      */
     saveDataManagerRegisterClass(...tstlClasses: AnyClass[]): void;
     /**
      * Removes a previously registered key from the save data manager. This is the opposite of the
      * "saveDataManager" method.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
      */
     saveDataManagerRemove(key: string): void;
     /**
@@ -12479,6 +12726,8 @@ declare class SaveDataManager extends Feature {
      * // Then, later on, to explicit reset all of the "room" variables:
      * mod.saveDataManagerReset("file1", "room");
      * ```
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
      */
     saveDataManagerReset(key: string, childObjectKey: SaveDataKey): void;
 }
@@ -13230,7 +13479,12 @@ export declare function spawnEffectWithSeed(effectVariant: EffectVariant, subTyp
  */
 export declare function spawnEmptyCollectible(position: Vector, seedOrRNG?: Seed | RNG): EntityPickup;
 
-/** Helper function to spawn a `EntityType.FAMILIAR` (3). */
+/**
+ * Helper function to spawn a `EntityType.FAMILIAR` (3).
+ *
+ * If you are trying to implement a custom familiar, you probably want to use the
+ * `checkFamiliarFromCollectibles` helper function instead.
+ */
 export declare function spawnFamiliar(familiarVariant: FamiliarVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityFamiliar;
 
 /** Helper function to spawn a `EntityType.FAMILIAR` (3) with a specific seed. */