isaacscript-common 13.0.0 → 13.1.0

package/dist/index.d.ts

@@ -967,6 +967,13 @@ export declare function copyVector(vector: Vector): Vector;
  */
 export declare interface Corner {
     readonly type: CornerType;
+    /** The grid index of the corresponding wall tile. */
+    readonly gridIndex: int;
+    /**
+     * The position is not the same as the center of the corresponding grid index. Rather, it is the
+     * exact position of the corner, which will be offset from the grid index position by half of a
+     * grid tile.
+     */
     readonly position: Readonly<Vector>;
 }
 
@@ -2051,12 +2058,8 @@ export declare function emptyArray<T>(array: T[]): void;
  * this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
  * (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most
  * effects (1000), doors, and walls.
- *
- * @param fillWithDecorations Optional. Set to true to fill every grid tile with an invisible
- *                            decoration, which prevents vanilla entities in the room from
- *                            respawning the next time that the player enters. Default is false.
  */
-export declare function emptyRoom(fillWithDecorations: boolean): void;
+export declare function emptyRoom(): void;
 
 /**
  * Helper function to enable all inputs. Use this function to set things back to normal after having
@@ -2126,15 +2129,18 @@ export declare function enableExtraConsoleCommands(mod: ModUpgraded): void;
 export declare function enableFastReset(): void;
 
 /**
- * Helper function to return an array with the elements from start to end. It is inclusive at the
- * start and exclusive at the end. (The "e" stands for exclusive.)
+ * Helper function to return an array of integers with the specified range, inclusive on the lower
+ * end and exclusive on the high end. (The "e" stands for exclusive.)
  *
- * If only one argument is specified, then it will assume that the start is 0.
+ * - For example, `eRange(1, 3)` will return `[1, 2]`.
+ * - For example, `eRange(2)` will return `[0, 1]`.
  *
- * - For example, `erange(1, 3)` will return `[1, 2]`.
- * - For example, `erange(2)` will return `[0, 1]`.
+ * @param start The number to start at.
+ * @param end Optional. The number to end at. If not specified, then the start will be 0 and the
+ *            first argument will be the end.
+ * @param increment Optional. The increment to use. Default is 1.
  */
-export declare function erange(start: int, end?: int): int[];
+export declare function eRange(start: int, end?: int, increment?: number): int[];
 
 declare type ErrorCustomClassNotSerializable = "Error: Custom classes with one or more methods are not serializable when inside of an array, map, or set. For more information, see: https://isaacscript.github.io/main/gotchas#custom-classes-are-not-serializable";
 
@@ -3400,6 +3406,15 @@ export declare function getGridEntityIDFromConstituents(gridEntityType: GridEnti
  */
 export declare function getGridIndexDelta(roomShape: RoomShape, doorSlot: DoorSlot): int | undefined;
 
+/**
+ * Helper function to get all of the grid indexes between two grid indexes on either a horizontal or
+ * vertical line, inclusive on both ends.
+ *
+ * This function will throw a run-time error if the two provided grid indexes are not on the same
+ * horizontal or vertical line.
+ */
+export declare function getGridIndexesBetween(gridIndex1: int, gridIndex2: int, roomShape: RoomShape): int[];
+
 /**
  * Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
  * function will return 6.
@@ -4883,7 +4898,12 @@ export declare function getRoomShapeBounds(roomShape: RoomShape): readonly [widt
  */
 export declare function getRoomShapeCharges(roomShape: RoomShape): int;
 
-/** Helper function to get the corners that exist in the given room shape. */
+/**
+ * Helper function to get the corners that exist in the given room shape.
+ *
+ * Note that these corner locations are not accurate for the Mother Boss Room and the Home closet
+ * rooms. (Those rooms have custom shapes.)
+ */
 export declare function getRoomShapeCorners(roomShape: RoomShape): readonly Corner[];
 
 /**
@@ -5640,6 +5660,14 @@ export declare function inDoubleTrouble(): boolean;
 
 export declare function inGenesisRoom(): boolean;
 
+/**
+ * Helper function to check if the current room is either the left Home closet (behind the red door)
+ * or the right Home closet (with one random pickup).
+ *
+ * Home closets have a unique shape that is different from any other room in the game.
+ */
+export declare function inHomeCloset(): boolean;
+
 /**
  * Initializes an array with all of the elements containing the specified default value.
  *
@@ -5740,15 +5768,18 @@ export declare function inSecretShop(): boolean;
 export declare function inStartingRoom(): boolean;
 
 /**
- * Helper function to return an array with the elements from start to end, inclusive. (The "i"
- * stands for inclusive.)
+ * Helper function to return an array of integers with the specified range, inclusive on both ends.
+ * (The "i" stands for inclusive.)
  *
- * If only one argument is specified, then it will assume that the start is 0.
+ * - For example, `iRange(1, 3)` will return `[1, 2, 3]`.
+ * - For example, `iRange(2)` will return `[0, 1, 2]`.
  *
- * - For example, `irange(1, 3)` will return `[1, 2, 3]`.
- * - For example, `irange(2)` will return `[0, 1, 2]`.
+ * @param start The number to start at.
+ * @param end Optional. The number to end at. If not specified, then the start will be 0 and the
+ *            first argument will be the end.
+ * @param increment Optional. The increment to use. Default is 1.
  */
-export declare function irange(start: int, end?: int): int[];
+export declare function iRange(start: int, end?: int, increment?: number): int[];
 
 /**
  * Helper function to check if an instantiated Isaac API class is equal to another one of the same
@@ -6597,6 +6628,25 @@ export declare function isVanillaTrinketType(trinketType: TrinketType): boolean;
  */
 export declare function isVanillaTSTLClass(object: unknown): boolean;
 
+/**
+ * Helper function to determine if a given wall is a "real" wall generated by the vanilla game. This
+ * is useful because mods can use custom spawned walls as a stand-in for custom grid entities.
+ *
+ * This function checks for identity via a combination of `StageAPI.IsCustomGrid` and the
+ * `isVanillaWallGridIndex` function.
+ */
+export declare function isVanillaWall(gridEntity: GridEntity): boolean;
+
+/**
+ * Helper function to determine if a given grid index should have a wall generated by the vanilla
+ * game. This is useful as a mechanism to distinguish between real walls and custom walls spawned by
+ * mods.
+ *
+ * This function properly handles the special cases of the Mother boss room and the Home closet
+ * rooms, which are both non-standard room shapes.
+ */
+export declare function isVanillaWallGridIndex(gridIndex: int): boolean;
+
 /** Helper function to check if something is an instantiated `Vector` object. */
 export declare function isVector(object: unknown): object is Vector;
 
@@ -10655,6 +10705,14 @@ export declare function serializeVector(vector: Vector): SerializedVector;
  */
 export declare function setActiveItem(player: EntityPlayer, collectibleType: CollectibleType, activeSlot: ActiveSlot, charge?: int, keepInPools?: boolean): void;
 
+/**
+ * Helper function to add one or more elements to a set at once without having to repeatedly call
+ * the `Set.add` method.
+ *
+ * This function is variadic, meaning that you can pass as many things as you want to add.
+ */
+export declare function setAdd<T>(set: Set<T>, ...elements: T[]): void;
+
 /**
  * Helper function to make using sets with an type of `PlayerIndex` easier. Use this instead of the
  * `Set.add` method if you have a set of this type.
@@ -10744,6 +10802,22 @@ export declare function setCollectiblesRerolledForItemTracker(): void;
  */
 export declare function setCollectibleSubType(collectible: EntityPickup, newCollectibleType: CollectibleType): void;
 
+/**
+ * Helper function to run arbitrary code when you press and release a specific keyboard key.
+ *
+ * This can be used to easily set up custom hotkeys to facilitate custom game features or to assist
+ * in debugging.
+ *
+ * This is different from the `setHotkey` function in that the keyboard activation key is not
+ * hardcoded and is instead the return value of a provided function. This is useful for situations
+ * where the key can change (like if end-users can specify a custom hotkey using Mod Config Menu).
+ *
+ * @param getKeyFunc The function that returns the key that will trigger the hotkey.
+ * @param triggerFunc A function containing the arbitrary code that you want to execute when the
+ *                    hotkey is triggered.
+ */
+export declare function setConditionalHotkey(getKeyFunc: () => Keyboard | undefined, triggerFunc: () => void): void;
+
 /**
  * Helper function to warp to a custom stage/level.
  *
@@ -10877,15 +10951,11 @@ export declare function setHasPlayer(set: Set<PlayerIndex>, player: EntityPlayer
  * This can be used to easily set up custom hotkeys to facilitate custom game features or to assist
  * in debugging.
  *
- * @param keyboardOrFunc Either the key that you want to trigger the hotkey or a function that
- *                       returns the key that will trigger the hotkey. Normally, you would just
- *                       specify the key directly, but you can use a function for situations where
- *                       the key can change (like if end-users can specify a custom hotkey using Mod
- *                       Config Menu).
+ * @param keyboard The key that you want to trigger the hotkey.
  * @param triggerFunc A function containing the arbitrary code that you want to execute when the
  *                    hotkey is triggered.
  */
-export declare function setHotkey(keyboardOrFunc: Keyboard | (() => Keyboard | undefined), triggerFunc: () => void): void;
+export declare function setHotkey(keyboard: Keyboard, triggerFunc: () => void): void;
 
 /**
  * Supply a function to be repeatedly run on an interval of N game frames in the `POST_UPDATE`
@@ -12122,12 +12192,21 @@ export declare const UI_HEART_WIDTH = 12;
 /** Helper function to put things back to normal after the `pause` function was used. */
 export declare function unpause(): void;
 
+/**
+ * Helper function to remove a hotkey created with the `setConditionalHotkey` function.
+ *
+ * @param getKeyFunc Equal to the `getKeyFunc` that you passed when initially registering the
+ *                   hotkey.
+ */
+export declare function unsetConditionalHotkey(getKeyFunc: () => Keyboard | undefined): void;
+
 /**
  * Helper function to remove a hotkey created with the `setHotkey` function.
  *
- * @param keyboardOrFunc Equal to the value that you passed when initially registering the hotkey.
+ * @param keyboard Equal to the keyboard value that you passed when initially registering the
+ *                 hotkey.
  */
-export declare function unsetHotkey(keyboardOrFunc: Keyboard | (() => Keyboard | undefined)): void;
+export declare function unsetHotkey(keyboard: Keyboard): void;
 
 /**
  * Use this function to enable the custom callbacks and other optional features provided by