isaacscript-common 17.7.2 → 17.8.0

package/dist/index.d.ts

@@ -6839,6 +6839,19 @@ export declare function inDimension(dimension: Dimension): boolean;
 
 export declare function inDoubleTrouble(): boolean;
 
+/**
+ * Helper function to check if a variable is within a certain range, exclusive on both ends. (The
+ * "e" stands for exclusive.)
+ *
+ * - For example, `inERange(1, 1, 3)` will return `false`.
+ * - For example, `inERange(1.01, 1, 3)` will return `true`.
+ *
+ * @param num The number to check.
+ * @param start The start of the range to check.
+ * @param end The end of the range to check.
+ */
+export declare function inERange(num: int, start: int, end: int): boolean;
+
 export declare function inGenesisRoom(): boolean;
 
 /**
@@ -6849,6 +6862,19 @@ export declare function inGenesisRoom(): boolean;
  */
 export declare function inHomeCloset(): boolean;
 
+/**
+ * Helper function to check if a variable is within a certain range, inclusive on both ends. (The
+ * "i" stands for inclusive.)
+ *
+ * - For example, `inIRange(1, 1, 3)` will return `true`.
+ * - For example, `inIRange(0, 1, 3)` will return `false`.
+ *
+ * @param num The number to check.
+ * @param start The start of the range to check.
+ * @param end The end of the range to check.
+ */
+export declare function inIRange(num: int, start: int, end: int): boolean;
+
 /**
  * Initializes an array with all of the elements containing the specified default value.
  *
@@ -9463,6 +9489,9 @@ export declare enum ModCallbackCustom {
      *
      * Use this callback to know when a pickup is added to the player's inventory or health.
      *
+     * Note that this will not fire when the player takes a collectible; use either the
+     * `POST_PLAYER_COLLECTIBLE_ADDED` or the `PRE_ITEM_PICKUP` callback for that.
+     *
      * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
      * - You can provide an optional third argument that will make the callback only fire if it
      *   matches the `PickupVariant` provided.
@@ -11549,6 +11578,7 @@ export declare type PickupIndex = int & {
 
 declare class PickupIndexCreation extends Feature {
     private roomHistory;
+    private saveDataManager;
     private postPickupInit;
     private setPickupIndex;
     private getPickupIndexFromPreviousData;
@@ -11559,6 +11589,12 @@ declare class PickupIndexCreation extends Feature {
      * Keep track of the metadata for later.
      */
     private trackDespawningPickupMetadata;
+    /**
+     * If the despawning pickup was in a Treasure Room or Boss Room, then it is possible that the
+     * pickup could re-appear during The Ascent. If this is the case, we store the metadata on a
+     * separate map to reference later.
+     */
+    private getPickupDataMapForCurrentRoom;
     private getPostAscentPickupIndex;
     /**
      * Mods often have to track variables relating to a pickups. Finding an index for these kinds of
@@ -13239,6 +13275,20 @@ declare class SaveDataManager extends Feature {
      * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
      */
     saveDataManagerReset(key: string, childObjectKey: SaveDataKey): void;
+    /**
+     * Helper function to check to see if the game is in the menu, as far as the save data manager is
+     * concerned. This function will return true when the game is first opened until the
+     * `POST_PLAYER_INIT` callback fires. It will also return true in between the `PRE_GAME_EXIT`
+     * callback firing and the `POST_PLAYER_INIT` callback firing.
+     *
+     * This function is useful because the `POST_ENTITY_REMOVE` callback fires after the
+     * `PRE_GAME_EXIT` callback. Thus, if save data needs to be updated from the `POST_ENTITY_REMOVE`
+     * callback and the player is in the process of saving and quitting, the feature will have to
+     * explicitly call the `saveDataManagerSave` function.
+     *
+     * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+     */
+    saveDataManagerInMenu(): boolean;
 }
 
 export declare const SECOND_IN_MILLISECONDS = 1000;