isaacscript-common 1.2.211 → 1.2.214

package/dist/constants.d.ts

@@ -37,6 +37,7 @@ export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: number;
 export declare const GAME_FRAMES_PER_SECOND = 30;
 export declare const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
 export declare const ISAAC_FRAMES_PER_SECOND = 60;
+export declare const LEVEL_GRID_ROW_LENGTH = 13;
 /** In a 2x2 room, there can be 8 doors. */
 export declare const MAX_NUM_DOORS = 8;
 /**

package/dist/constants.lua

@@ -13,6 +13,7 @@ ____exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = (1 << 32) - 1
 ____exports.GAME_FRAMES_PER_SECOND = 30
 ____exports.GRID_INDEX_CENTER_OF_1X1_ROOM = 67
 ____exports.ISAAC_FRAMES_PER_SECOND = 60
+____exports.LEVEL_GRID_ROW_LENGTH = 13
 ____exports.MAX_NUM_DOORS = 8
 ____exports.MAX_NUM_FAMILIARS = 64
 ____exports.MAX_NUM_INPUTS = 4

package/dist/features/deployJSONRoom.d.ts

@@ -14,12 +14,12 @@ import { JSONRoom } from "../types/JSONRoom";
  * const firstJSONRoom = customRooms.rooms.room[0];
  * deployJSONRoom(firstJSONRoom);
  * ```
- * @param rng Optional. Specifies the RNG object that will be used for spawning every entity in the
- * room. Default is `newRNG()`.
+ * @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()`.
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
  * what the function is doing. Default is false.
  */
-export declare function deployJSONRoom(jsonRoom: JSONRoom, rng?: RNG, verbose?: boolean): void;
+export declare function deployJSONRoom(jsonRoom: JSONRoom, seedOrRNG?: Seed | RNG, verbose?: boolean): void;
 /**
  * Helper function to deconstruct a vanilla room and set up a custom room in its place.
  * Specifically, this will clear the current room of all entities and grid entities, and then spawn
@@ -39,12 +39,12 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom, rng?: RNG, verbose?:
  * const jsonRooms = customRooms.rooms.room;
  * deployRandomJSONRoom(jsonRooms);
  * ```
- * @param rng Optional. Specifies the RNG object that will be used for determining the random room.
- * After that, it is also used for spawning every entity in the room. Default is `newRNG()`.
+ * @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()`.
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
  * what the function is doing. Default is false.
  */
-export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], rng?: RNG, verbose?: boolean): void;
+export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): void;
 /**
  * Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
  * this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8),

package/dist/features/deployJSONRoom.lua

@@ -33,6 +33,8 @@ local getNPCs = ____npc.getNPCs
 local ____pickups = require("functions.pickups")
 local removeAllPickups = ____pickups.removeAllPickups
 local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
 local newRNG = ____rng.newRNG
 local ____roomData = require("functions.roomData")
 local getRoomListIndex = ____roomData.getRoomListIndex
@@ -402,14 +404,15 @@ function ____exports.deployJSONRoomInit(self, mod)
     saveDataManager(nil, "deployJSONRoom", v)
     mod:AddCallback(ModCallbacks.MC_POST_NEW_ROOM, postNewRoom)
 end
-function ____exports.deployJSONRoom(self, jsonRoom, rng, verbose)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.deployJSONRoom(self, jsonRoom, seedOrRNG, verbose)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if verbose == nil then
         verbose = false
     end
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
     if verbose then
         log("Starting to empty the room of entities and grid entities.")
     end
@@ -427,14 +430,15 @@ function ____exports.deployJSONRoom(self, jsonRoom, rng, verbose)
     fixPitGraphics(nil)
     fillRoomWithDecorations(nil)
 end
-function ____exports.deployRandomJSONRoom(self, jsonRooms, rng, verbose)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.deployRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if verbose == nil then
         verbose = false
     end
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
     local randomJSONRoom = getRandomJSONRoom(nil, jsonRooms, rng, verbose)
     if verbose then
         log((((((("Randomly chose JSON room " .. randomJSONRoom["$"].type) .. ".") .. randomJSONRoom["$"].variant) .. ".") .. randomJSONRoom["$"].subtype) .. " with name: ") .. randomJSONRoom["$"].name)

package/dist/features/saveDataManager/merge.d.ts

@@ -10,6 +10,7 @@
  * - TSTL `Set`
  * - TSTL classes
  * - `DefaultMap`
+ * - Isaac `Color` objects
  * - Isaac `RNG` objects
  * - Isaac `Vector` objects
  *

package/dist/functions/array.d.ts

@@ -43,20 +43,29 @@ export declare function getLastElement<T>(array: T[]): T;
  * Helper function to get a random element from the provided array.
  *
  * @param array The array to get an element from.
- * @param rng Optional. The RNG object used to select the random element. Default is `newRNG()`.
+ * @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()`.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export declare function getRandomArrayElement<T>(array: T[] | readonly T[], rng?: RNG, exceptions?: T[] | readonly T[]): T;
+export declare function getRandomArrayElement<T>(array: T[] | readonly T[], seedOrRNG?: Seed | RNG, exceptions?: T[] | readonly T[]): T;
 /**
  * Helper function to get a random element from the provided array. Once the random element is
  * decided, it is then removed from the array (in-place).
  *
  * @param array The array to get an element from.
- * @param rng Optional. The RNG object used to select the random element. Default is `newRNG()`.
+ * @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()`.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export declare function getRandomArrayElementAndRemove<T>(array: T[], rng?: RNG, exceptions?: T[] | readonly T[]): T;
-export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], rng?: RNG): int;
+export declare function getRandomArrayElementAndRemove<T>(array: T[], seedOrRNG?: Seed | RNG, exceptions?: T[] | readonly T[]): T;
+/**
+ * Helper function to get a random index from the provided array.
+ *
+ * @param array The array to get the index from.
+ * @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()`.
+ */
+export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seedOrRNG?: Seed | RNG): int;
 /**
  * Initializes an array with all elements containing the specified default value.
  *
@@ -74,17 +83,26 @@ export declare function initArray<T>(defaultValue: T, size: int): T[];
  * - the table has no keys (i.e. an "empty" table)
  */
 export declare function isArray(thing: unknown): boolean;
+/** Checks if an array is in the provided 2-dimensional array. */
 export declare function isArrayInArray<T>(arrayToMatch: T[] | readonly T[], parentArray: Array<T[] | readonly T[]>): boolean;
 /**
  * Shallow copies and shuffles the array using the Fisher-Yates algorithm. Returns the copied array.
  *
  * From: https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
+ *
+ * @param originalArray The array to shuffle.
+ * @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()`.
  */
-export declare function shuffleArray<T>(originalArray: T[] | readonly T[], rng?: RNG): T[];
+export declare function shuffleArray<T>(originalArray: T[] | readonly T[], seedOrRNG?: Seed | RNG): T[];
 /**
  * Shuffles the provided array in-place using the Fisher-Yates algorithm.
  *
  * From: https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
+ *
+ * @param array The array to shuffle.
+ * @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()`.
  */
-export declare function shuffleArrayInPlace<T>(array: T[], rng?: RNG): void;
+export declare function shuffleArrayInPlace<T>(array: T[], seedOrRNG?: Seed | RNG): void;
 export declare function sumArray(array: number[] | readonly number[]): number;

package/dist/functions/array.lua

@@ -12,27 +12,27 @@ local ____exports = {}
 local ____random = require("functions.random")
 local getRandomInt = ____random.getRandomInt
 local ____rng = require("functions.rng")
-local newRNG = ____rng.newRNG
+local getRandomSeed = ____rng.getRandomSeed
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
-function ____exports.getRandomArrayIndex(self, array, rng)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomArrayIndex(self, array, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if #array == 0 then
         error("Failed to get a random array index since the provided array is empty.")
     end
-    return getRandomInt(nil, 0, #array - 1, rng)
+    return getRandomInt(nil, 0, #array - 1, seedOrRNG)
 end
-function ____exports.shuffleArrayInPlace(self, array, rng)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.shuffleArrayInPlace(self, array, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     local currentIndex = #array
     local randomIndex
     while currentIndex > 0 do
         currentIndex = currentIndex - 1
-        randomIndex = ____exports.getRandomArrayIndex(nil, array, rng)
+        randomIndex = ____exports.getRandomArrayIndex(nil, array, seedOrRNG)
         local ____temp_0 = {array[randomIndex + 1], array[currentIndex + 1]}
         array[currentIndex + 1] = ____temp_0[1]
         array[randomIndex + 1] = ____temp_0[2]
@@ -115,9 +115,9 @@ end
 function ____exports.getLastElement(self, array)
     return array[#array]
 end
-function ____exports.getRandomArrayElement(self, array, rng, exceptions)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomArrayElement(self, array, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if exceptions == nil then
         exceptions = {}
@@ -130,17 +130,17 @@ function ____exports.getRandomArrayElement(self, array, rng, exceptions)
         array,
         table.unpack(exceptions)
     )
-    local randomIndex = ____exports.getRandomArrayIndex(nil, arrayWithoutExceptions, rng)
+    local randomIndex = ____exports.getRandomArrayIndex(nil, arrayWithoutExceptions, seedOrRNG)
     return arrayWithoutExceptions[randomIndex + 1]
 end
-function ____exports.getRandomArrayElementAndRemove(self, array, rng, exceptions)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomArrayElementAndRemove(self, array, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if exceptions == nil then
         exceptions = {}
     end
-    local randomArrayElement = ____exports.getRandomArrayElement(nil, array, rng, exceptions)
+    local randomArrayElement = ____exports.getRandomArrayElement(nil, array, seedOrRNG, exceptions)
     ____exports.arrayRemoveInPlace(nil, array, randomArrayElement)
     return randomArrayElement
 end
@@ -192,12 +192,12 @@ function ____exports.isArrayInArray(self, arrayToMatch, parentArray)
         function(____, element) return ____exports.arrayEquals(nil, element, arrayToMatch) end
     )
 end
-function ____exports.shuffleArray(self, originalArray, rng)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.shuffleArray(self, originalArray, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     local array = ____exports.copyArray(nil, originalArray)
-    ____exports.shuffleArrayInPlace(nil, array, rng)
+    ____exports.shuffleArrayInPlace(nil, array, seedOrRNG)
     return array
 end
 function ____exports.sumArray(self, array)

package/dist/functions/cards.d.ts

@@ -43,24 +43,27 @@ export declare function getMaxCards(): int;
  * - any objects like Dice Shard
  * - any modded cards.
  *
- * @param rng Optional. The RNG object with which to select the random card. Default is `newRNG()`.
+ * @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()`.
  * @param exceptions Optional. An array of cards to not select.
  */
-export declare function getRandomCard(rng?: RNG, exceptions?: Card[]): Card;
+export declare function getRandomCard(seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
 /**
  * @param cardType The card type that represents the pool of cards to select from.
- * @param rng Optional. The RNG object with which to select the random card. Default is `newRNG()`.
+ * @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()`.
  * @param exceptions Optional. An array of cards to not select.
  */
-export declare function getRandomCardOfType(cardType: CardType, rng?: RNG, exceptions?: Card[]): Card;
+export declare function getRandomCardOfType(cardType: CardType, seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
 /**
  * Has an equal chance of returning any rune (e.g. Rune of Hagalaz, Blank Rune, Black Rune, Soul of
  * Isaac, etc.). This will never return a Rune Shard.
  *
- * @param rng Optional. The RNG object with which to select the random rune. Default is `newRNG()`.
+ * @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()`.
  * @param exceptions Optional. An array of runes to not select.
  */
-export declare function getRandomRune(rng?: RNG, exceptions?: Card[]): Card;
+export declare function getRandomRune(seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
 /**
  * Returns true for cards that have the following card type:
  * - CardType.TAROT

package/dist/functions/cards.lua

@@ -21,7 +21,7 @@ local DEFAULT_CARD_TYPE = ____cardTypes.DEFAULT_CARD_TYPE
 local ____math = require("functions.math")
 local range = ____math.range
 local ____rng = require("functions.rng")
-local newRNG = ____rng.newRNG
+local getRandomSeed = ____rng.getRandomSeed
 local ____set = require("functions.set")
 local addSetsToSet = ____set.addSetsToSet
 local getRandomSetElement = ____set.getRandomSetElement
@@ -100,35 +100,35 @@ function ____exports.getCardName(self, card)
     end
     return DEFAULT_CARD_NAME
 end
-function ____exports.getRandomCard(self, rng, exceptions)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomCard(self, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if exceptions == nil then
         exceptions = {}
     end
-    return getRandomSetElement(nil, CARD_SET, rng, exceptions)
+    return getRandomSetElement(nil, CARD_SET, seedOrRNG, exceptions)
 end
-function ____exports.getRandomCardOfType(self, cardType, rng, exceptions)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomCardOfType(self, cardType, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if exceptions == nil then
         exceptions = {}
     end
     local cardSet = ____exports.getCardsOfType(nil, cardType)
-    return getRandomSetElement(nil, cardSet, rng, exceptions)
+    return getRandomSetElement(nil, cardSet, seedOrRNG, exceptions)
 end
-function ____exports.getRandomRune(self, rng, exceptions)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomRune(self, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if exceptions == nil then
         exceptions = {}
     end
     local runesSet = ____exports.getCardsOfType(nil, CardType.RUNE)
     runesSet:delete(Card.RUNE_SHARD)
-    return getRandomSetElement(nil, runesSet, rng, exceptions)
+    return getRandomSetElement(nil, runesSet, seedOrRNG, exceptions)
 end
 function ____exports.isCard(self, card)
     return CARD_SET:has(card)

package/dist/functions/deepCopy.d.ts

@@ -11,6 +11,7 @@ import { SerializationType } from "../enums/SerializationType";
  * - TSTL `Set`
  * - TSTL classes
  * - `DefaultMap`
+ * - Isaac `Color` objects
  * - Isaac `RNG` objects
  * - Isaac `Vector` objects
  *

package/dist/functions/deepCopy.lua

@@ -5,7 +5,7 @@ local Map = ____lualib.Map
 local __TS__InstanceOf = ____lualib.__TS__InstanceOf
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local isTSTLClass, copyClass, getNewClassFromMetatable, deepCopyValue, checkMetatable, validateValue, TSTL_CLASS_KEYS
+local isTSTLClass, copyClass, getNewClassFromMetatable, deepCopyValue, checkMetatable, validateValue, isCopyableIsaacAPIClass, TSTL_CLASS_KEYS
 local ____DefaultMap = require("classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
 local ____SerializationBrand = require("enums.private.SerializationBrand")
@@ -15,6 +15,8 @@ local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
 local ____constants = require("features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
+local ____color = require("functions.color")
+local isColor = ____color.isColor
 local ____log = require("functions.log")
 local log = ____log.log
 local ____rng = require("functions.rng")
@@ -236,12 +238,15 @@ function checkMetatable(self, ____table, traversalDescription)
     error(("The deepCopy function detected that \"" .. tableDescription) .. "\" has a metatable. Copying tables with metatables is not supported, unless they are explicitly handled by the save data manager. (e.g. Vectors, TypeScriptToLua Maps, etc.)")
 end
 function validateValue(self, value, valueType, traversalDescription)
-    if isVector(nil, value) then
+    if isCopyableIsaacAPIClass(nil, value) then
         return
     end
     if valueType == "function" or valueType == "nil" or valueType == "thread" or valueType == "userdata" then
-        error(((("The deepCopy function detected that \"" .. traversalDescription) .. "\" is of type \"") .. valueType) .. "\", which is not supported.")
+        error(((("The deepCopy function detected that \"" .. traversalDescription) .. "\" has a value of type \"") .. valueType) .. "\", which is not supported.")
     end
 end
+function isCopyableIsaacAPIClass(self, value)
+    return isColor(nil, value) or isRNG(nil, value) or isVector(nil, value)
+end
 TSTL_CLASS_KEYS = __TS__New(Set, {"____constructor", "__index", "constructor"})
 return ____exports

package/dist/functions/jsonRoom.d.ts

@@ -9,4 +9,4 @@ export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[], subType: in
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers
  */
-export declare function getRandomJSONRoom(jsonRooms: JSONRoom[], rng?: RNG, verbose?: boolean): JSONRoom;
+export declare function getRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): JSONRoom;

package/dist/functions/jsonRoom.lua

@@ -10,7 +10,7 @@ local log = ____log.log
 local ____random = require("functions.random")
 local getRandomFloat = ____random.getRandomFloat
 local ____rng = require("functions.rng")
-local newRNG = ____rng.newRNG
+local getRandomSeed = ____rng.getRandomSeed
 function getTotalWeightOfJSONRooms(self, jsonRooms)
     local weights = __TS__ArrayMap(
         jsonRooms,
@@ -66,9 +66,9 @@ function ____exports.getJSONRoomsOfSubType(self, jsonRooms, subType)
         end
     )
 end
-function ____exports.getRandomJSONRoom(self, jsonRooms, rng, verbose)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if verbose == nil then
         verbose = false
@@ -77,7 +77,7 @@ function ____exports.getRandomJSONRoom(self, jsonRooms, rng, verbose)
     if verbose then
         log("Total weight of the JSON rooms provided: " .. tostring(totalWeight))
     end
-    local chosenWeight = getRandomFloat(nil, 0, totalWeight, rng)
+    local chosenWeight = getRandomFloat(nil, 0, totalWeight, seedOrRNG)
     if verbose then
         log("Randomly chose weight for JSON room: " .. tostring(chosenWeight))
     end

package/dist/functions/npc.d.ts

@@ -49,6 +49,8 @@ export declare function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean;
  * enemies.
  */
 export declare function isRaglingDeathPatch(npc: EntityNPC): boolean;
+/** Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust. */
+export declare function isSin(npc: EntityNPC): boolean;
 /**
  * Helper function to remove all NPCs in the room.
  *

package/dist/functions/npc.lua

@@ -7,6 +7,8 @@ local ____exports = {}
 local NON_ALIVE_NPCS_TYPE_VARIANT, NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE
 local ____constants = require("constants")
 local EGGY_STATE_FRAME_OF_FINAL_SPIDER = ____constants.EGGY_STATE_FRAME_OF_FINAL_SPIDER
+local ____sinEntityTypesSet = require("sets.sinEntityTypesSet")
+local SIN_ENTITY_TYPES_SET = ____sinEntityTypesSet.SIN_ENTITY_TYPES_SET
 local ____entity = require("functions.entity")
 local getEntities = ____entity.getEntities
 local getFilteredNewEntities = ____entity.getFilteredNewEntities
@@ -139,6 +141,9 @@ function ____exports.getBosses(self, matchingEntityType, matchingVariant, matchi
         function(____, npc) return npc:IsBoss() end
     )
 end
+function ____exports.isSin(self, npc)
+    return SIN_ENTITY_TYPES_SET:has(npc.Type)
+end
 function ____exports.removeAllNPCs(self, cap)
     local npcs = ____exports.getNPCs(nil)
     return removeEntities(nil, npcs, cap)

package/dist/functions/random.d.ts

@@ -1,39 +1,27 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
  * This returns a random float between 0 and 1. It is inclusive on the low end, but exclusive on
- * the high end. (This is because the `RNG.RandomFloat` method can return a value of 0.999, but it
- * will never return a value of exactly 1.)
+ * the high end. (This is because the `RNG.RandomFloat` method will never return a value of exactly
+ * 1.)
  *
- * Note that this function will invoke the `Next` method on the `RNG` object before returning the
- * random number.
+ * @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()`.
  */
-export declare function getRandom(rng?: RNG): float;
+export declare function getRandom(seedOrRNG?: Seed | RNG): float;
 /**
- * This returns a random float between min and max. It is inclusive on the low end, but exclusive on
- * the high end. (This is because the `RNG.RandomFloat` method can return a value of 0.999, but it
- * will never return a value of exactly 1.)
- *
- * Note that this function will invoke the `Next` method on the `RNG` object before returning the
- * random number.
+ * This returns a random float between min and max.
  *
  * Example:
  * ```ts
  * const realNumberBetweenOneAndThree = getRandomFloat(1, 3);
  * ```
+ *
+ * @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()`.
  */
-export declare function getRandomFloat(min: int, max: int, rng?: RNG): float;
-/**
- * This returns a random float between min and max. It is inclusive on the low end, but exclusive on
- * the high end. (This is because the `RNG.RandomFloat` method can return a value of 0.999, but it
- * will never return a value of exactly 1.)
- */
-export declare function getRandomFloatFromSeed(min: int, max: int, seed: Seed): float;
-/**
- * This returns a random float between 0 and 1. It is inclusive on the low end, but exclusive on
- * the high end. (This is because the `RNG.RandomFloat` method can return a value of 0.999, but it
- * will never return a value of exactly 1.)
- */
-export declare function getRandomFromSeed(seed: Seed): float;
+export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RNG): float;
 /**
  * This returns a random integer between min and max. It is inclusive on both ends.
  *
@@ -44,7 +32,10 @@ export declare function getRandomFromSeed(seed: Seed): float;
  * ```ts
  * const oneTwoOrThree = getRandomInt(1, 3);
  * ```
+ *
+ * @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()`.
  */
-export declare function getRandomInt(min: int, max: int, rng?: RNG): int;
-/** This returns a random integer between min and max. It is inclusive on both ends. */
-export declare function getRandomIntFromSeed(min: int, max: int, seed: Seed): int;
+export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG): int;

package/dist/functions/random.lua

@@ -1,16 +1,19 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
 local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
 local newRNG = ____rng.newRNG
-function ____exports.getRandom(self, rng)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandom(self, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
     return rng:RandomFloat()
 end
-function ____exports.getRandomFloat(self, min, max, rng)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomFloat(self, min, max, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if min > max then
         local oldMin = min
@@ -18,20 +21,13 @@ function ____exports.getRandomFloat(self, min, max, rng)
         min = oldMax
         max = oldMin
     end
-    return min + ____exports.getRandom(nil, rng) * (max - min)
+    return min + ____exports.getRandom(nil, seedOrRNG) * (max - min)
 end
-function ____exports.getRandomFloatFromSeed(self, min, max, seed)
-    local rng = newRNG(nil, seed)
-    return ____exports.getRandomFloat(nil, min, max, rng)
-end
-function ____exports.getRandomFromSeed(self, seed)
-    local rng = newRNG(nil, seed)
-    return ____exports.getRandom(nil, rng)
-end
-function ____exports.getRandomInt(self, min, max, rng)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomInt(self, min, max, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
     if min > max then
         local oldMin = min
         local oldMax = max
@@ -40,8 +36,4 @@ function ____exports.getRandomInt(self, min, max, rng)
     end
     return rng:RandomInt(max - min + 1) + min
 end
-function ____exports.getRandomIntFromSeed(self, min, max, seed)
-    local rng = newRNG(nil, seed)
-    return ____exports.getRandomInt(nil, min, max, rng)
-end
 return ____exports

package/dist/functions/rooms.d.ts

@@ -15,6 +15,13 @@ export declare function getAllRoomGridIndexes(): int[];
  * tricky to properly detect.
  */
 export declare function getCurrentDimension(): Dimension;
+/**
+ * Helper function to get the grid index delta that a door out of the given room shape would lead
+ * to. For example, if you went through the bottom door in a room of `RoomShape.ROOMSHAPE_1x2`, you
+ * would end up in a room with a grid index that is +26 units from the `SafeGridIndex` of where you
+ * started.
+ */
+export declare function getGridIndexDelta(roomShape: RoomShape, doorSlot: DoorSlot): int | undefined;
 /**
  * Helper function to get an array of all of the safe grid indexes for rooms that match the
  * specified room type.

package/dist/functions/rooms.lua

@@ -1,11 +1,11 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local Map = ____lualib.Map
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
-local Map = ____lualib.Map
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
@@ -13,6 +13,8 @@ local sfxManager = ____cachedClasses.sfxManager
 local ____constants = require("constants")
 local MAX_ROOM_INDEX = ____constants.MAX_ROOM_INDEX
 local NUM_DIMENSIONS = ____constants.NUM_DIMENSIONS
+local ____roomShapeToGridIndexDelta = require("objects.roomShapeToGridIndexDelta")
+local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
 local ____doors = require("functions.doors")
 local closeAllDoors = ____doors.closeAllDoors
 local getDoors = ____doors.getDoors
@@ -106,6 +108,13 @@ function ____exports.getCurrentDimension(self)
     end
     return error("Failed to get the current dimension using the starting room index of: " .. tostring(startingRoomGridIndex))
 end
+function ____exports.getGridIndexDelta(self, roomShape, doorSlot)
+    local doorSlotToGridIndexMap = ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
+    if doorSlotToGridIndexMap == nil then
+        return nil
+    end
+    return doorSlotToGridIndexMap:get(doorSlot)
+end
 function ____exports.getRoomGridIndexesForType(self, ...)
     local roomTypesSet = __TS__New(Set, {...})
     local rooms = ____exports.getRooms(nil)
@@ -246,12 +255,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue46
+                goto __continue48
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue46::
+        ::__continue48::
     end
     sfxManager:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/functions/set.d.ts

@@ -25,10 +25,11 @@ export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: A
  * Helper function to get a random element from the provided set.
  *
  * @param set The set to get an element from.
- * @param rng Optional. The RNG object used to select the random element. Default is `newRNG()`.
+ * @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()`.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, rng?: RNG, exceptions?: T[] | readonly T[]): T;
+export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, seedOrRNG?: Seed | RNG, exceptions?: T[] | readonly T[]): T;
 /**
  * Helper function to get a sorted array based on the contents of a set.
  *

package/dist/functions/set.lua

@@ -8,7 +8,7 @@ local ____exports = {}
 local ____array = require("functions.array")
 local getRandomArrayElement = ____array.getRandomArrayElement
 local ____rng = require("functions.rng")
-local newRNG = ____rng.newRNG
+local getRandomSeed = ____rng.getRandomSeed
 function ____exports.getSortedSetValues(self, set)
     local values = set:values()
     local array = {__TS__Spread(values)}
@@ -48,14 +48,14 @@ function ____exports.deleteSetsFromSet(self, mainSet, ...)
         end
     end
 end
-function ____exports.getRandomSetElement(self, set, rng, exceptions)
-    if rng == nil then
-        rng = newRNG(nil)
+function ____exports.getRandomSetElement(self, set, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
     if exceptions == nil then
         exceptions = {}
     end
     local array = ____exports.getSortedSetValues(nil, set)
-    return getRandomArrayElement(nil, array, rng, exceptions)
+    return getRandomArrayElement(nil, array, seedOrRNG, exceptions)
 end
 return ____exports

package/dist/objects/roomShapeToGridIndexDelta.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Deltas are considered to be from the safe grid index of the room (i.e. the top left corner, or
+ * top right corner in the case of `RoomShape.ROOMSHAPE_LTL`).
+ */
+export declare const ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA: {
+    readonly [key in RoomShape]: Map<DoorSlot, int> | undefined;
+};

package/dist/objects/roomShapeToGridIndexDelta.lua

@@ -0,0 +1,85 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____constants = require("constants")
+local LEVEL_GRID_ROW_LENGTH = ____constants.LEVEL_GRID_ROW_LENGTH
+local LEFT = -1
+local UP = -LEVEL_GRID_ROW_LENGTH
+local RIGHT = 1
+local DOWN = LEVEL_GRID_ROW_LENGTH
+____exports.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = {
+    [RoomShape.ROOMSHAPE_1x1] = __TS__New(Map, {{DoorSlot.LEFT0, LEFT}, {DoorSlot.UP0, UP}, {DoorSlot.RIGHT0, RIGHT}, {DoorSlot.DOWN0, DOWN}}),
+    [RoomShape.ROOMSHAPE_IH] = __TS__New(Map, {{DoorSlot.LEFT0, LEFT}, {DoorSlot.RIGHT0, RIGHT}}),
+    [RoomShape.ROOMSHAPE_IV] = __TS__New(Map, {{DoorSlot.UP0, UP}, {DoorSlot.DOWN0, DOWN}}),
+    [RoomShape.ROOMSHAPE_1x2] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT},
+        {DoorSlot.DOWN0, DOWN + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT},
+        {DoorSlot.RIGHT1, DOWN + RIGHT}
+    }),
+    [RoomShape.ROOMSHAPE_IIV] = __TS__New(Map, {{DoorSlot.UP0, UP}, {DoorSlot.DOWN0, DOWN + DOWN}}),
+    [RoomShape.ROOMSHAPE_2x1] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT + RIGHT},
+        {DoorSlot.DOWN0, DOWN},
+        {DoorSlot.UP1, RIGHT + UP},
+        {DoorSlot.DOWN1, RIGHT + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_IIH] = __TS__New(Map, {{DoorSlot.LEFT0, LEFT}, {DoorSlot.RIGHT0, RIGHT + RIGHT}}),
+    [RoomShape.ROOMSHAPE_2x2] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT + RIGHT},
+        {DoorSlot.DOWN0, DOWN + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT},
+        {DoorSlot.UP1, RIGHT + UP},
+        {DoorSlot.RIGHT1, RIGHT + DOWN + RIGHT},
+        {DoorSlot.DOWN1, RIGHT + DOWN + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_LTL] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, DOWN + LEFT + UP},
+        {DoorSlot.RIGHT0, RIGHT},
+        {DoorSlot.DOWN0, DOWN + LEFT + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT + LEFT},
+        {DoorSlot.UP1, UP},
+        {DoorSlot.RIGHT1, DOWN + RIGHT},
+        {DoorSlot.DOWN1, DOWN + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_LTR] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT},
+        {DoorSlot.DOWN0, DOWN + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT},
+        {DoorSlot.UP1, DOWN + RIGHT + UP},
+        {DoorSlot.RIGHT1, DOWN + RIGHT + RIGHT},
+        {DoorSlot.DOWN1, DOWN + RIGHT + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_LBL] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT + RIGHT},
+        {DoorSlot.DOWN0, DOWN},
+        {DoorSlot.LEFT1, RIGHT + DOWN + LEFT},
+        {DoorSlot.UP1, RIGHT + UP},
+        {DoorSlot.RIGHT1, RIGHT + DOWN + RIGHT},
+        {DoorSlot.DOWN1, RIGHT + DOWN + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_LBR] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT + RIGHT},
+        {DoorSlot.DOWN0, DOWN + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT},
+        {DoorSlot.UP1, RIGHT + UP},
+        {DoorSlot.RIGHT1, DOWN + RIGHT},
+        {DoorSlot.DOWN1, RIGHT + DOWN}
+    }),
+    [RoomShape.NUM_ROOMSHAPES] = nil
+}
+return ____exports

package/dist/sets/sinEntityTypesSet.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare const SIN_ENTITY_TYPES_SET: ReadonlySet<EntityType>;

package/dist/sets/sinEntityTypesSet.lua

@@ -0,0 +1,14 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+____exports.SIN_ENTITY_TYPES_SET = __TS__New(Set, {
+    EntityType.ENTITY_SLOTH,
+    EntityType.ENTITY_LUST,
+    EntityType.ENTITY_WRATH,
+    EntityType.ENTITY_GLUTTONY,
+    EntityType.ENTITY_GREED,
+    EntityType.ENTITY_ENVY,
+    EntityType.ENTITY_PRIDE
+})
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.211",
+  "version": "1.2.214",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -29,7 +29,7 @@
     "isaacscript-lint": "^1.0.95",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",
-    "typescript": "4.6.2",
+    "typescript": "4.6.3",
     "typescript-to-lua": "^1.4.2"
   }
 }