isaacscript-common 2.0.11 → 2.0.14

package/dist/functions/pickups.d.ts

@@ -33,7 +33,7 @@ export declare function isRedHeart(pickup: EntityPickup): boolean;
  * @param cap Optional. If specified, will only remove the given amount of cards.
  * @returns True if one or more cards were removed, false otherwise.
  */
-export declare function removeAllBatteries(batterySubType?: BatterySubType | int, cap?: int): boolean;
+export declare function removeAllBatteries(batterySubType?: BatterySubType, cap?: int): boolean;
 /**
  * Helper function to remove all of the cards in the room.
  *
@@ -41,7 +41,7 @@ export declare function removeAllBatteries(batterySubType?: BatterySubType | int
  * @param cap Optional. If specified, will only remove the given amount of cards.
  * @returns True if one or more cards were removed, false otherwise.
  */
-export declare function removeAllCards(card?: Card | int, cap?: int): boolean;
+export declare function removeAllCards(card?: Card, cap?: int): boolean;
 /**
  * Helper function to remove all of the coins in the room.
  *
@@ -49,16 +49,16 @@ export declare function removeAllCards(card?: Card | int, cap?: int): boolean;
  * @param cap Optional. If specified, will only remove the given amount of coins.
  * @returns True if one or more coins were removed, false otherwise.
  */
-export declare function removeAllCoins(coinSubType?: CoinSubType | int, cap?: int): boolean;
+export declare function removeAllCoins(coinSubType?: CoinSubType, cap?: int): boolean;
 /**
  * Helper function to remove all of the collectibles in the room.
  *
  * @param collectibleType Optional. If specified, will only remove collectibles that match this
- * collectible type.
+ *                        collectible type.
  * @param cap Optional. If specified, will only remove the given amount of collectibles.
  * @returns True if one or more collectibles were removed, false otherwise.
  */
-export declare function removeAllCollectibles(collectibleType?: CollectibleType | int, cap?: int): boolean;
+export declare function removeAllCollectibles(collectibleType?: CollectibleType, cap?: int): boolean;
 /**
  * Helper function to remove all of the hearts in the room.
  *
@@ -66,7 +66,7 @@ export declare function removeAllCollectibles(collectibleType?: CollectibleType
  * @param cap Optional. If specified, will only remove the given amount of hearts.
  * @returns True if one or more hearts were removed, false otherwise.
  */
-export declare function removeAllHearts(heartSubType?: HeartSubType | int, cap?: int): boolean;
+export declare function removeAllHearts(heartSubType?: HeartSubType, cap?: int): boolean;
 /**
  * Helper function to remove all of the keys in the room.
  *
@@ -74,7 +74,7 @@ export declare function removeAllHearts(heartSubType?: HeartSubType | int, cap?:
  * @param cap Optional. If specified, will only remove the given amount of keys.
  * @returns True if one or more keys were removed, false otherwise.
  */
-export declare function removeAllKeys(keySubType?: KeySubType | int, cap?: int): boolean;
+export declare function removeAllKeys(keySubType?: KeySubType, cap?: int): boolean;
 /**
  * Helper function to remove all of the pills in the room.
  *
@@ -90,45 +90,45 @@ export declare function removeAllPills(pillColor?: PillColor, cap?: int): boolea
  * @param cap Optional. If specified, will only remove the given amount of trinkets.
  * @returns True if one or more trinkets were removed, false otherwise.
  */
-export declare function removeAllSacks(sackSubType?: SackSubType | int, cap?: int): boolean;
+export declare function removeAllSacks(sackSubType?: SackSubType, cap?: int): boolean;
 /**
  * Helper function to remove all of the trinkets in the room.
  *
  * @param trinketType Optional. If specified, will only remove trinkets that match this trinket
- * type.
+ *                    type.
  * @param cap Optional. If specified, will only remove the given amount of trinkets.
  * @returns True if one or more trinkets were removed, false otherwise.
  */
-export declare function removeAllTrinkets(trinketType?: TrinketType | int, cap?: int): boolean;
+export declare function removeAllTrinkets(trinketType?: TrinketType, cap?: int): boolean;
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90).
  */
-export declare function spawnBattery(subType: BatterySubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
-export declare function spawnBatteryWithSeed(subType: BatterySubType | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnBattery(subType: BatterySubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnBatteryWithSeed(subType: BatterySubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300).
  */
-export declare function spawnCard(subType: Card | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
-export declare function spawnCardWithSeed(subType: Card | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnCard(subType: Card, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnCardWithSeed(subType: Card, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20). */
-export declare function spawnCoin(subType: CoinSubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
-export declare function spawnCoinWithSeed(subType: CoinSubType | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnCoin(subType: CoinSubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnCoinWithSeed(subType: CoinSubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10). */
-export declare function spawnHeart(subType: HeartSubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
-export declare function spawnHeartWithSeed(subType: HeartSubType | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnHeart(subType: HeartSubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnHeartWithSeed(subType: HeartSubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30). */
-export declare function spawnKey(subType: KeySubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
-export declare function spawnKeyWithSeed(subType: KeySubType | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnKey(subType: KeySubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnKeyWithSeed(subType: KeySubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70). */
-export declare function spawnPill(pillColor: PillColor | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
-export declare function spawnPillWithSeed(subType: PillColor | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnPill(pillColor: PillColor, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnPillWithSeed(subType: PillColor, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.GRAB_BAG` (69).
  */
-export declare function spawnSack(subType: SackSubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
-export declare function spawnSackWithSeed(subType: SackSubType | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnSack(subType: SackSubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnSackWithSeed(subType: SackSubType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350).
  */
-export declare function spawnTrinket(subType: TrinketType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
-export declare function spawnTrinketWithSeed(subType: TrinketType | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnTrinket(subType: TrinketType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnTrinketWithSeed(subType: TrinketType, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;

package/dist/functions/pills.d.ts

@@ -23,17 +23,18 @@ export declare function getNormalPillColorFromHorse(pillColor: PillColor): PillC
  * Due to limitations in the API, this function will not work properly for modded pill effects, and
  * will always return `DEFAULT_PILL_EFFECT_CLASS` in those cases.
  */
-export declare function getPillEffectClass(pillEffect: PillEffect | int): ItemConfigPillEffectClass;
+export declare function getPillEffectClass(pillEffect: PillEffect): ItemConfigPillEffectClass;
 /**
  * Helper function to get a pill effect name from a PillEffect enum value.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const pillEffect = PillEffect.BAD_GAS;
  * const pillEffectName = getPillEffectName(pillEffect); // trinketName is "Bad Gas"
  * ```
  */
-export declare function getPillEffectName(pillEffect: PillEffect | int): string;
+export declare function getPillEffectName(pillEffect: PillEffect): string;
 /**
  * Helper function to get a pill effect type from a PillEffect enum value. In this context, the type
  * is equal to positive, negative, or neutral. This is derived from the suffix of the the "class"
@@ -43,5 +44,5 @@ export declare function getPillEffectName(pillEffect: PillEffect | int): string;
  * Due to limitations in the API, this function will not work properly for modded pill effects, and
  * will always return `DEFAULT_PILL_EFFECT_TYPE` in those cases.
  */
-export declare function getPillEffectType(pillEffect: PillEffect | int): ItemConfigPillEffectType;
+export declare function getPillEffectType(pillEffect: PillEffect): ItemConfigPillEffectType;
 export declare function isHorsePill(pillColor: PillColor): boolean;

package/dist/functions/player.d.ts

@@ -1,6 +1,6 @@
 import { ActiveSlot, CacheFlag, CollectibleType, PlayerType, TrinketType } from "isaac-typescript-definitions";
 import { HealthType } from "../enums/HealthType";
-export declare function addCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType | int): void;
+export declare function addCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType): void;
 /**
  * Helper function to add a stat to a player based on the `CacheFlag` provided. Call this function
  * from the EvaluateCache callback.
@@ -17,18 +17,18 @@ export declare function addCollectibleCostume(player: EntityPlayer, collectibleT
  * - CacheFlag.LUCK (1 << 10)
  */
 export declare function addStat(player: EntityPlayer, cacheFlag: CacheFlag, amount: number): void;
-export declare function addTrinketCostume(player: EntityPlayer, trinketType: TrinketType | int): void;
-export declare function anyPlayerHasCollectible(collectibleType: CollectibleType | int): boolean;
-export declare function anyPlayerHasTrinket(trinketType: TrinketType | int): boolean;
+export declare function addTrinketCostume(player: EntityPlayer, trinketType: TrinketType): void;
+export declare function anyPlayerHasCollectible(collectibleType: CollectibleType): boolean;
+export declare function anyPlayerHasTrinket(trinketType: TrinketType): boolean;
 /**
  * Helper function to determine if the given character is present.
  *
  * This function is variadic, meaning that you can supply as many characters as you want to check
  * for. Returns true if any of the characters supplied are present.
  */
-export declare function anyPlayerIs(...matchingCharacters: Array<PlayerType | int>): boolean;
+export declare function anyPlayerIs(...matchingCharacters: PlayerType[]): boolean;
 /**
- * Helper function to determine if a player will destroy a rock/pot/skull/etc. if they walk over it.
+ * Helper function to determine if a player will destroy a rock/pot/skull if they walk over it.
  *
  * The following situations allow for this to be true:
  * - the player has Leo (collectible 302)
@@ -41,7 +41,7 @@ export declare function canPlayerCrushRocks(player: EntityPlayer): boolean;
  * Helper function to find the active slot that the player has the corresponding collectible type
  * in. Returns undefined if the player does not have the collectible in any active slot.
  */
-export declare function getActiveItemSlot(player: EntityPlayer, collectibleType: CollectibleType | int): ActiveSlot | undefined;
+export declare function getActiveItemSlot(player: EntityPlayer, collectibleType: CollectibleType): ActiveSlot | undefined;
 /**
  * Helper function to get how long Azazel's Brimstone laser should be. You can pass either an
  * `EntityPlayer` object or a tear height stat.
@@ -94,12 +94,12 @@ export declare function getPlayerCloserThan(position: Vector, distance: float):
  *
  * This function is variadic, meaning that you can specify N collectible types.
  */
-export declare function getPlayerCollectibleCount(player: EntityPlayer, ...collectibleTypes: Array<CollectibleType | int>): int;
+export declare function getPlayerCollectibleCount(player: EntityPlayer, ...collectibleTypes: CollectibleType[]): int;
 /**
  * Iterates over every item in the game and returns a map containing the number of each item that
  * the player has.
  */
-export declare function getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType | int, int>;
+export declare function getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType, int>;
 /**
  * Returns the number of red hearts that the player has, excluding any rotten hearts. For example,
  * if the player has one full black heart, one full soul heart, and one half black heart, this
@@ -152,14 +152,14 @@ export declare function getPlayerSoulHearts(player: EntityPlayer): int;
  * This function is variadic, meaning that you can supply as many characters as you want to check
  * for. Returns true if any of the characters supplied are present.
  */
-export declare function getPlayersOfType(...characters: Array<PlayerType | int>): EntityPlayer[];
+export declare function getPlayersOfType(...characters: PlayerType[]): EntityPlayer[];
 /**
  * Helper function to get only the players that have a certain collectible.
  *
  * This function is variadic, meaning that you can supply as many collectible types as you want to
  * check for. It only returns the players that have all of the collectibles.
  */
-export declare function getPlayersWithCollectible(...collectibleTypes: Array<CollectibleType | int>): EntityPlayer[];
+export declare function getPlayersWithCollectible(...collectibleTypes: CollectibleType[]): EntityPlayer[];
 /**
  * Helper function to determine how many heart containers that Tainted Magdalene has that will not
  * be automatically depleted over time. By default, this is 2, but this function will return 4 so
@@ -175,7 +175,7 @@ export declare function getTaintedMagdaleneNonTemporaryMaxHearts(player: EntityP
  * Returns the total number of collectibles amongst all players. For example, if player 1 has 1 Sad
  * Onion and player 2 has 2 Sad Onions, then this function would return 3.
  */
-export declare function getTotalPlayerCollectibles(collectibleType: CollectibleType | int): int;
+export declare function getTotalPlayerCollectibles(collectibleType: CollectibleType): int;
 /** After touching a white fire, a player will turn into The Lost until they clear a room. */
 export declare function hasLostCurse(player: EntityPlayer): boolean;
 /**
@@ -199,7 +199,7 @@ export declare function isBethany(player: EntityPlayer): boolean;
  * This function is variadic, meaning that you can supply as many characters as you want to check
  * for. Returns true if the player is any of the supplied characters.
  */
-export declare function isCharacter(player: EntityPlayer, ...characters: Array<PlayerType | int>): boolean;
+export declare function isCharacter(player: EntityPlayer, ...characters: PlayerType[]): boolean;
 /**
  * Helper function for detecting when a player is Eden or Tainted Eden. Useful for situations where
  * you want to know if the starting stats were randomized, for example.
@@ -230,19 +230,19 @@ export declare function isVanillaPlayer(player: EntityPlayer): boolean;
  * This function is variadic, meaning that you can supply as many collectible types as you want to
  * add.
  */
-export declare function playerAddCollectible(player: EntityPlayer, ...collectibleTypes: Array<CollectibleType | int>): void;
+export declare function playerAddCollectible(player: EntityPlayer, ...collectibleTypes: CollectibleType[]): void;
 /**
  * Helper function to check to see if a player has one or more collectibles.
  *
  * This function is variadic, meaning that you can supply as many collectible types as you want to
  * check for. Returns true if the player has any of the supplied collectible types.
  */
-export declare function playerHasCollectible(player: EntityPlayer, ...collectibleTypes: Array<CollectibleType | int>): boolean;
+export declare function playerHasCollectible(player: EntityPlayer, ...collectibleTypes: CollectibleType[]): boolean;
 /**
  * Helper function to remove a collectible costume from a player. Use this helper function to avoid
  * having to request the collectible from the item config.
  */
-export declare function removeCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType | int): void;
+export declare function removeCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType): void;
 /**
  * Helper function to remove the Dead Eye multiplier from a player.
  *
@@ -254,7 +254,7 @@ export declare function removeDeadEyeMultiplier(player: EntityPlayer): void;
  * Helper function to remove a trinket costume from a player. Use this helper function to avoid
  * having to request the trinket from the item config.
  */
-export declare function removeTrinketCostume(player: EntityPlayer, trinketType: TrinketType | int): void;
+export declare function removeTrinketCostume(player: EntityPlayer, trinketType: TrinketType): void;
 /**
  * Helper function to set an active collectible to a particular slot. This has different behavior
  * than calling the `player.AddCollectible` method with the `activeSlot` argument, because this
@@ -268,7 +268,7 @@ export declare function removeTrinketCostume(player: EntityPlayer, trinketType:
  * @param collectibleType The collectible type of the item to give.
  * @param activeSlot The slot to set.
  * @param charge Optional. The argument of charges to set. If not specified, the item will be set
- * with maximum charges.
+ *               with maximum charges.
  * @param keepInPools Optional. Whether or not to remove the item from pools. Default is false.
  */
 export declare function setActiveItem(player: EntityPlayer, collectibleType: CollectibleType, activeSlot: ActiveSlot, charge?: int, keepInPools?: boolean): void;
@@ -286,4 +286,4 @@ export declare function setBlindfold(player: EntityPlayer, enabled: boolean, mod
  * Helper function to use an active item without showing an animation, keeping the item, or adding
  * any costumes.
  */
-export declare function useActiveItemTemp(player: EntityPlayer, collectibleType: CollectibleType | int): void;
+export declare function useActiveItemTemp(player: EntityPlayer, collectibleType: CollectibleType): void;

package/dist/functions/playerIndex.d.ts

@@ -51,7 +51,8 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
  * If this is not desired, use the `getAllPlayers` helper function instead.
  *
  * @param performCharacterExclusions Whether or not to exclude characters that are not directly
- * controlled by the player (i.e. Esau & Tainted Soul). Default is false.
+ *                                   controlled by the player (i.e. Esau & Tainted Soul). Default is
+ *                                   false.
  */
 export declare function getPlayers(performCharacterExclusions?: boolean): EntityPlayer[];
 /**

package/dist/functions/positionVelocity.d.ts

@@ -10,7 +10,7 @@ export declare function anyPlayerCloserThan(position: Vector, distance: float):
  * specific situations.
  *
  * @param startingPosition The position to start searching from. If this position is not overlapping
- * with anything, then it will be returned.
+ *                         with anything, then it will be returned.
  * @param avoidActiveEntities Optional. Default is false.
  */
 export declare function findFreePosition(startingPosition: Vector, avoidActiveEntities?: boolean): Vector;
@@ -20,7 +20,8 @@ export declare function findFreePosition(startingPosition: Vector, avoidActiveEn
  * This is useful for rewinding entity positions at a later time. Also see `setEntityPositions`.
  *
  * @param entities Optional. If provided, will only get the positions of the provided entities. Use
- * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
  */
 export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Vector>;
 /**
@@ -29,7 +30,8 @@ export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Ve
  * This is useful for rewinding entity velocities at a later time. Also see `setEntityVelocities`.
  *
  * @param entities Optional. If provided, will only get the velocities of the provided entities. Use
- * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
  */
 export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector>;
 /**
@@ -42,7 +44,8 @@ export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, V
  *
  * @param entityPositions The map providing the positions for every entity.
  * @param entities Optional. If provided, will only set the positions of the provided entities. Use
- * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
  */
 export declare function setEntityPositions(entityPositions: Map<PtrHash, Vector>, entities?: Entity[]): void;
 /**
@@ -55,6 +58,7 @@ export declare function setEntityPositions(entityPositions: Map<PtrHash, Vector>
  *
  * @param entityVelocities The map providing the velocities for every entity.
  * @param entities Optional. If provided, will only set the velocities of the provided entities. Use
- * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
  */
 export declare function setEntityVelocities(entityVelocities: Map<PtrHash, Vector>, entities?: Entity[]): void;

package/dist/functions/random.d.ts

@@ -4,13 +4,14 @@
  * high end. (This is because the `RNG.RandomFloat` method will never return a value of exactly 1.)
  *
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
- * `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  */
 export declare function getRandom(seedOrRNG?: Seed | RNG): float;
 /**
  * This returns a random float between min and max.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const realNumberBetweenOneAndThree = getRandomFloat(1, 3);
  * ```
@@ -18,7 +19,7 @@ export declare function getRandom(seedOrRNG?: Seed | RNG): float;
  * @param min The lower bound for the random number (inclusive).
  * @param max The upper bound for the random number (exclusive).
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
- * `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  */
 export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RNG): float;
 /**
@@ -27,7 +28,8 @@ export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RN
  * Note that this function will invoke the `Next` method on the `RNG` object before returning the
  * random number.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const oneTwoOrThree = getRandomInt(1, 3);
  * ```
@@ -35,6 +37,6 @@ export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RN
  * @param min The lower bound for the random number (inclusive).
  * @param max The upper bound for the random number (inclusive).
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
- * `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  */
 export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG): int;

package/dist/functions/rng.d.ts

@@ -13,7 +13,7 @@ interface CopyRNGReturn {
  * Helper function to copy an `RNG` object.
  *
  * @param rng The RNG object to copy. In the case of deserialization, this will actually be a Lua
- * table instead of an instantiated RNG class.
+ *            table instead of an instantiated RNG class.
  * @param serializationType Default is `SerializationType.NONE`.
  */
 export declare function copyRNG<R extends RNG | SerializedRNG, S extends SerializationType>(rng: R, serializationType: S): CopyRNGReturn[S];

package/dist/functions/rooms.d.ts

@@ -1,4 +1,4 @@
-import { BossID, Dimension, Direction, DoorSlot, ItemPoolType, MinibossID, RoomTransitionAnim, RoomType } from "isaac-typescript-definitions";
+import { BossID, Dimension, Direction, DoorSlot, ItemPoolType, MinibossID, RoomShape, RoomTransitionAnim, RoomType } from "isaac-typescript-definitions";
 /**
  * Helper function for quickly switching to a new room without playing a particular animation. Use
  * this helper function over invoking the `Game.ChangeRoom` method directly to ensure that you do
@@ -14,6 +14,11 @@ export declare function getAllRoomGridIndexes(): int[];
  * tricky to properly detect.
  */
 export declare function getCurrentDimension(): Dimension;
+/**
+ * Helper function to get the number of rooms that are currently on the floor layout. This does not
+ * include off-grid rooms, like the Devil Room.
+ */
+export declare function getNumRooms(): int;
 /**
  * Helper function to get an array of all of the safe grid indexes for rooms that match the
  * specified room type.
@@ -29,6 +34,13 @@ export declare function getRoomGridIndexesForType(...roomTypes: RoomType[]): int
  * `ItemPoolType.ItemPoolType.POOL_ANGEL` if you are in an Angel Room.
  */
 export declare function getRoomItemPoolType(): ItemPoolType;
+/**
+ * Helper function to get the grid indexes of all the rooms connected to the given room index.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export declare function getRoomNeighbors(roomGridIndex?: int): int[];
+export declare function getRoomShapeNeighborGridIndexDeltas(roomShape: RoomShape): int[];
 /**
  * Helper function to get the proper name of a room type.
  *
@@ -41,8 +53,9 @@ export declare function getRoomTypeName(roomType: RoomType): string;
  * the list.
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
- * extra-dimensional rooms are automatically be generated and can be seen when you iterate over the
- * `RoomList`. Default is false.
+ *                                     extra-dimensional rooms are automatically be generated and
+ *                                     can be seen when you iterate over the `RoomList`. Default is
+ *                                     false.
  */
 export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
 /**
@@ -88,6 +101,11 @@ export declare function inGenesisRoom(): boolean;
 /** Helper function to determine if the current room shape is one of the four L room shapes. */
 export declare function inLRoom(): boolean;
 export declare function inMegaSatanRoom(): boolean;
+/**
+ * Helper function to determine if the current room is part of the Repentance "escape sequence" in
+ * the Mines/Ashpit.
+ */
+export declare function inMineShaft(): boolean;
 /**
  * Helper function to check if the current room is a miniboss room for a particular miniboss. This
  * will only work for mini-bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
@@ -113,8 +131,8 @@ export declare function inStartingRoom(): boolean;
  * This function will only check rooms in the current dimension.
  *
  * @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
- * the array will be ignored. If not specified, then all rooms will be checked. Undefined by
- * default.
+ *                           the array will be ignored. If not specified, then all rooms will be
+ *                           checked. Undefined by default.
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean;
 export declare function isDoorSlotValidAtGridIndex(doorSlot: DoorSlot, roomGridIndex: int): boolean;
@@ -135,6 +153,12 @@ export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
 export declare function isRoomInsideMap(roomGridIndex?: int): boolean;
 /** Helper function to check if a room exists at the given room grid index. */
 export declare function roomExists(roomGridIndex: int): boolean;
+/**
+ * Helper function to get the coordinates of a given grid index. The floor is represented by a 13x13
+ * grid. For example, since the starting room is in the center, the starting room grid index of 84
+ * be equal to coordinates of (?, ?).
+ */
+export declare function roomGridIndexToXY(roomGridIndex: int): [x: int, y: int];
 /**
  * If the `Room.Update` method is called in a PostNewRoom callback, then some entities will slide
  * around (such as the player). Since those entity velocities are already at zero, setting them to

package/dist/functions/rooms.lua

@@ -3,8 +3,8 @@ local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
-local Map = ____lualib.Map
 local __TS__Spread = ____lualib.__TS__Spread
+local Map = ____lualib.Map
 local __TS__StringIncludes = ____lualib.__TS__StringIncludes
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
@@ -25,11 +25,16 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local sfxManager = ____cachedClasses.sfxManager
 local ____constants = require("constants")
-local MAX_ROOM_INDEX = ____constants.MAX_ROOM_INDEX
+local LEVEL_GRID_ROW_WIDTH = ____constants.LEVEL_GRID_ROW_WIDTH
+local MAX_LEVEL_GRID_INDEX = ____constants.MAX_LEVEL_GRID_INDEX
 local NUM_DIMENSIONS = ____constants.NUM_DIMENSIONS
+local ____roomShapeToDoorSlotsToGridIndexDelta = require("objects.roomShapeToDoorSlotsToGridIndexDelta")
+local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToDoorSlotsToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
 local ____roomTypeNames = require("objects.roomTypeNames")
 local DEFAULT_ROOM_TYPE_NAME = ____roomTypeNames.DEFAULT_ROOM_TYPE_NAME
 local ROOM_TYPE_NAMES = ____roomTypeNames.ROOM_TYPE_NAMES
+local ____mineShaftRoomSubTypesSet = require("sets.mineShaftRoomSubTypesSet")
+local MINE_SHAFT_ROOM_SUB_TYPE_SET = ____mineShaftRoomSubTypesSet.MINE_SHAFT_ROOM_SUB_TYPE_SET
 local ____doors = require("functions.doors")
 local closeAllDoors = ____doors.closeAllDoors
 local getDoors = ____doors.getDoors
@@ -58,6 +63,10 @@ local ____roomShape = require("functions.roomShape")
 local getGridIndexDelta = ____roomShape.getGridIndexDelta
 local ____utils = require("functions.utils")
 local erange = ____utils.erange
+local irange = ____utils.irange
+function ____exports.getRoomShapeNeighborGridIndexDeltas(self, roomShape)
+    return {__TS__Spread(ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]:values())}
+end
 function ____exports.getRooms(self, includeExtraDimensionalRooms)
     if includeExtraDimensionalRooms == nil then
         includeExtraDimensionalRooms = false
@@ -77,14 +86,10 @@ function ____exports.getRooms(self, includeExtraDimensionalRooms)
             end
         end
     else
-        do
-            local i = 0
-            while i <= MAX_ROOM_INDEX do
-                local roomDescriptor = level:GetRoomByIdx(i)
-                if roomDescriptor.Data ~= nil then
-                    roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
-                end
-                i = i + 1
+        for ____, roomGridIndex in ipairs(irange(nil, MAX_LEVEL_GRID_INDEX)) do
+            local roomDescriptor = level:GetRoomByIdx(roomGridIndex)
+            if roomDescriptor.Data ~= nil then
+                roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
             end
         end
     end
@@ -132,6 +137,10 @@ function ____exports.getCurrentDimension(self)
     end
     return error("Failed to get the current dimension using the starting room index of: " .. tostring(startingRoomGridIndex))
 end
+function ____exports.getNumRooms(self)
+    local rooms = ____exports.getRooms(nil)
+    return #rooms
+end
 function ____exports.getRoomGridIndexesForType(self, ...)
     local roomTypesSet = __TS__New(Set, {...})
     local rooms = ____exports.getRooms(nil)
@@ -151,6 +160,26 @@ function ____exports.getRoomItemPoolType(self)
     local roomSeed = room:GetSpawnSeed()
     return itemPool:GetPoolForRoom(roomType, roomSeed)
 end
+function ____exports.getRoomNeighbors(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    if roomDescriptor.SafeGridIndex < 0 or roomDescriptor.SafeGridIndex > MAX_LEVEL_GRID_INDEX then
+        return {}
+    end
+    local roomData = roomDescriptor.Data
+    if roomData == nil then
+        return {}
+    end
+    local roomShape = roomData.Shape
+    local gridIndexDeltas = ____exports.getRoomShapeNeighborGridIndexDeltas(nil, roomShape)
+    local gridIndexes = __TS__ArrayMap(
+        gridIndexDeltas,
+        function(____, gridIndexDelta) return roomDescriptor.SafeGridIndex + gridIndexDelta end
+    )
+    return __TS__ArrayFilter(
+        gridIndexes,
+        function(____, gridIndex) return ____exports.roomExists(nil, gridIndex) end
+    )
+end
 function ____exports.getRoomTypeName(self, roomType)
     local roomTypeName = ROOM_TYPE_NAMES[roomType]
     return roomTypeName == nil and DEFAULT_ROOM_TYPE_NAME or roomTypeName
@@ -158,14 +187,10 @@ end
 function ____exports.getRoomsOfDimension(self, dimension)
     local level = game:GetLevel()
     local roomsMap = __TS__New(Map)
-    do
-        local i = 0
-        while i <= MAX_ROOM_INDEX do
-            local roomDescriptor = level:GetRoomByIdx(i, dimension)
-            if roomDescriptor.Data ~= nil then
-                roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
-            end
-            i = i + 1
+    for ____, roomGridIndex in ipairs(irange(nil, MAX_LEVEL_GRID_INDEX)) do
+        local roomDescriptor = level:GetRoomByIdx(roomGridIndex, dimension)
+        if roomDescriptor.Data ~= nil then
+            roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
         end
     end
     return {__TS__Spread(roomsMap:values())}
@@ -226,6 +251,11 @@ function ____exports.inMegaSatanRoom(self)
     local roomGridIndex = getRoomGridIndex(nil)
     return roomGridIndex == GridRoom.MEGA_SATAN
 end
+function ____exports.inMineShaft(self)
+    local roomStageID = getRoomStageID(nil)
+    local roomSubType = getRoomSubType(nil)
+    return (roomStageID == StageID.MINES or roomStageID == StageID.ASHPIT) and MINE_SHAFT_ROOM_SUB_TYPE_SET:has(roomSubType)
+end
 function ____exports.inMinibossRoomOf(self, minibossID)
     local room = game:GetRoom()
     local roomType = room:GetType()
@@ -279,7 +309,7 @@ function ____exports.isDoorSlotValidAtGridIndexForRedRoom(self, doorSlot, roomGr
         return false
     end
     local redRoomGridIndex = roomGridIndex + delta
-    return not ____exports.roomExists(nil, redRoomGridIndex)
+    return not ____exports.roomExists(nil, redRoomGridIndex) and redRoomGridIndex >= 0 and redRoomGridIndex <= MAX_LEVEL_GRID_INDEX
 end
 function ____exports.isRedKeyRoom(self, roomGridIndex)
     local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
@@ -291,6 +321,11 @@ function ____exports.isRoomInsideMap(self, roomGridIndex)
     end
     return roomGridIndex >= 0
 end
+function ____exports.roomGridIndexToXY(self, roomGridIndex)
+    local x = roomGridIndex % LEVEL_GRID_ROW_WIDTH
+    local y = math.floor(roomGridIndex / LEVEL_GRID_ROW_WIDTH)
+    return {x, y}
+end
 function ____exports.roomUpdateSafe(self)
     local room = game:GetRoom()
     local entities = getEntities(nil)
@@ -310,12 +345,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue56
+                goto __continue67
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue56::
+        ::__continue67::
     end
     sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/functions/run.d.ts

@@ -9,4 +9,4 @@ export declare function onSetSeed(): boolean;
  * Helper function to restart the game using the console command of "restart". You can optionally
  * specify a `PlayerType` to restart the game as that character.
  */
-export declare function restart(character?: PlayerType | int): void;
+export declare function restart(character?: PlayerType): void;