isaacscript-common 1.2.202 → 1.2.205

package/dist/functions/color.lua

@@ -1,15 +1,94 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-function ____exports.copyColor(self, color)
-    return Color(
-        color.R,
-        color.G,
-        color.B,
-        color.A,
-        color.RO,
-        color.GO,
-        color.BO
-    )
+local OBJECT_NAME
+local ____SerializationBrand = require("enums.private.SerializationBrand")
+local SerializationBrand = ____SerializationBrand.SerializationBrand
+local ____SerializationType = require("enums.SerializationType")
+local SerializationType = ____SerializationType.SerializationType
+local ____table = require("functions.table")
+local copyValuesToTable = ____table.copyValuesToTable
+local getNumbersFromTable = ____table.getNumbersFromTable
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
+local isUserdataObject = ____utils.isUserdataObject
+function ____exports.isColor(self, object)
+    return isUserdataObject(nil, object, OBJECT_NAME)
+end
+local KEYS = {
+    "R",
+    "G",
+    "B",
+    "A",
+    "RO",
+    "GO",
+    "BO"
+}
+OBJECT_NAME = "Color"
+function ____exports.copyColor(self, color, serializationType)
+    if serializationType == nil then
+        serializationType = SerializationType.NONE
+    end
+    repeat
+        local ____switch3 = serializationType
+        local ____cond3 = ____switch3 == SerializationType.NONE
+        if ____cond3 then
+            do
+                if not ____exports.isColor(nil, color) then
+                    error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+                end
+                return Color(
+                    color.R,
+                    color.G,
+                    color.B,
+                    color.A,
+                    color.RO,
+                    color.GO,
+                    color.BO
+                )
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == SerializationType.SERIALIZE
+        if ____cond3 then
+            do
+                if not ____exports.isColor(nil, color) then
+                    error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+                end
+                local colorTable = {}
+                copyValuesToTable(nil, color, KEYS, colorTable)
+                colorTable[SerializationBrand.COLOR] = ""
+                return colorTable
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == SerializationType.DESERIALIZE
+        if ____cond3 then
+            do
+                local colorType = type(color)
+                if ____exports.isColor(nil, color) or colorType ~= "table" then
+                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
+                end
+                local r, g, b, a, ro, go, bo = table.unpack(getNumbersFromTable(
+                    nil,
+                    color,
+                    OBJECT_NAME,
+                    table.unpack(KEYS)
+                ))
+                return Color(
+                    r,
+                    g,
+                    b,
+                    a,
+                    ro,
+                    go,
+                    bo
+                )
+            end
+        end
+        do
+            do
+                return ensureAllCases(nil, serializationType)
+            end
+        end
+    until true
 end
 function ____exports.copyKColor(self, kColor)
     return KColor(kColor.Red, kColor.Green, kColor.Blue, kColor.Alpha)

package/dist/functions/deepCopy.d.ts

@@ -6,22 +6,18 @@ import { SerializationType } from "../enums/SerializationType";
  *
  * It supports the following object types:
  *
- * - LuaTables / basic TSTL objects
- * - TSTL Maps
- * - TSTL Sets
- * - TSTL Classes
- * - DefaultMaps
- * - Isaac Vectors
+ * - `LuaTable` / basic TSTL objects
+ * - TSTL `Map`
+ * - TSTL `Set`
+ * - TSTL classes
+ * - `DefaultMap`
+ * - Isaac `RNG` objects
+ * - Isaac `Vector` objects
  *
  * @param oldObject The object to copy.
  * @param serializationType Has 3 possible values. Can leave TypeScriptToLua objects as-is, or can
- * serialize objects to Lua tables, or can deserialize Lua tables to objects. Defaults to
+ * serialize objects to Lua tables, or can deserialize Lua tables to objects. Default is
  * `SerializationType.NONE`.
  * @param traversalDescription Used to track the current key that we are operating on.
  */
 export declare function deepCopy(oldObject: LuaTable | Map<AnyNotNil, unknown> | Set<AnyNotNil>, serializationType?: SerializationType, traversalDescription?: string): LuaTable | Map<AnyNotNil, unknown> | Set<AnyNotNil>;
-/**
- * Used to determine is the given table is a serialized Vector created by the save data manager
- * and/or the `deepCopy` function.
- */
-export declare function isSerializedVector(object: unknown): boolean;

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, copyVector, checkMetatable, validateValue, TSTL_CLASS_KEYS
+local isTSTLClass, copyClass, getNewClassFromMetatable, deepCopyValue, checkMetatable, validateValue, TSTL_CLASS_KEYS
 local ____DefaultMap = require("classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
 local ____SerializationBrand = require("enums.private.SerializationBrand")
@@ -17,10 +17,15 @@ local ____constants = require("features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 local ____log = require("functions.log")
 local log = ____log.log
+local ____rng = require("functions.rng")
+local copyRNG = ____rng.copyRNG
+local isRNG = ____rng.isRNG
+local isSerializedRNG = ____rng.isSerializedRNG
 local ____utils = require("functions.utils")
 local getTraversalDescription = ____utils.getTraversalDescription
 local ____vector = require("functions.vector")
-local deserializeVector = ____vector.deserializeVector
+local copyVector = ____vector.copyVector
+local isSerializedVector = ____vector.isSerializedVector
 local isVector = ____vector.isVector
 function ____exports.deepCopy(self, oldObject, serializationType, traversalDescription)
     if serializationType == nil then
@@ -202,12 +207,10 @@ function deepCopyValue(self, oldObject, newObject, key, value, traversalDescript
         end
     end
     local newValue
-    if isVector(nil, value) then
-        local vector = value
-        newValue = copyVector(nil, vector, serializationType)
-    elseif ____exports.isSerializedVector(nil, value) and serializationType == SerializationType.DESERIALIZE then
-        local serializedVector = value
-        newValue = deserializeVector(nil, serializedVector)
+    if isRNG(nil, value) or isSerializedRNG(nil, value) and serializationType == SerializationType.DESERIALIZE then
+        newValue = copyRNG(nil, value, serializationType)
+    elseif isVector(nil, value) or isSerializedVector(nil, value) and serializationType == SerializationType.DESERIALIZE then
+        newValue = copyVector(nil, value, serializationType)
     elseif valueType == "table" then
         local ____table = value
         traversalDescription = getTraversalDescription(nil, key, traversalDescription)
@@ -224,40 +227,21 @@ function deepCopyValue(self, oldObject, newObject, key, value, traversalDescript
         newObject[keyToUse] = newValue
     end
 end
-function copyVector(self, vector, serializationType)
-    if serializationType == SerializationType.SERIALIZE then
-        local vectorTable = {}
-        vectorTable.X = vector.X
-        vectorTable.Y = vector.Y
-        vectorTable[SerializationBrand.VECTOR] = ""
-        return vectorTable
-    end
-    local newVector = Vector(vector.X, vector.Y)
-    return newVector
-end
 function checkMetatable(self, ____table, traversalDescription)
     local metatable = getmetatable(____table)
     if metatable == nil then
         return
     end
     local tableDescription = traversalDescription == "" and "the table to copy" or ("\"" .. traversalDescription) .. "\""
-    error(("The deepCopy function detected that " .. tableDescription) .. " has a metatable. Copying tables with metatables is not supported (unless they are TypeScriptToLua Maps, Sets, or Classes).")
+    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
         return
     end
     if valueType == "function" or valueType == "nil" or valueType == "thread" or valueType == "userdata" then
-        error(((("The deepCopy function detected that \"" .. traversalDescription) .. "\" is type ") .. valueType) .. ", which is not supported.")
-    end
-end
-function ____exports.isSerializedVector(self, object)
-    local objectType = type(object)
-    if objectType ~= "table" then
-        return false
+        error(((("The deepCopy function detected that \"" .. traversalDescription) .. "\" is of type \"") .. valueType) .. "\", which is not supported.")
     end
-    local ____table = object
-    return ____table[SerializationBrand.VECTOR] ~= nil and ____table.X ~= nil and ____table.Y ~= nil
 end
 TSTL_CLASS_KEYS = __TS__New(Set, {"____constructor", "__index", "constructor"})
 return ____exports

package/dist/functions/doors.d.ts

@@ -13,6 +13,8 @@ export declare function getDevilRoomDoor(): GridEntityDoor | undefined;
  * lowest slot number.
  */
 export declare function getDevilRoomOrAngelRoomDoor(): GridEntityDoor | undefined;
+/** Helper function to get the possible door slots that can exist for a given room shape. */
+export declare function getDoorSlotsForRoomShape(roomShape: RoomShape): ReadonlySet<DoorSlot>;
 /**
  * Helper function to get all of the doors in the room. By default, it will return every door. You
  * can optionally specify one or more room types to return only the doors that match the specified
@@ -29,6 +31,8 @@ export declare function getDoorsToRoomIndex(...roomGridIndex: int[]): GridEntity
 export declare function getRepentanceDoor(): GridEntityDoor | undefined;
 export declare function isAngelRoomDoor(door: GridEntityDoor): boolean;
 export declare function isDevilRoomDoor(door: GridEntityDoor): boolean;
+/** Helper function to see if a door slot could exist for a given room shape. */
+export declare function isDoorSlotInRoomShape(doorSlot: DoorSlot, roomShape: RoomShape): boolean;
 /**
  * This refers to the Repentance door that spawns in a boss room after defeating the boss.
  * You have to spend one key to open it.

package/dist/functions/doors.lua

@@ -11,6 +11,8 @@ local ____constants = require("constants")
 local MAX_NUM_DOORS = ____constants.MAX_NUM_DOORS
 local ____doorSlotToDirection = require("objects.doorSlotToDirection")
 local DOOR_SLOT_TO_DIRECTION = ____doorSlotToDirection.DOOR_SLOT_TO_DIRECTION
+local ____roomShapeToDoorSlots = require("objects.roomShapeToDoorSlots")
+local ROOM_SHAPE_TO_DOOR_SLOTS = ____roomShapeToDoorSlots.ROOM_SHAPE_TO_DOOR_SLOTS
 function ____exports.getDoors(self, ...)
     local roomTypes = {...}
     local room = game:GetRoom()
@@ -22,13 +24,13 @@ function ____exports.getDoors(self, ...)
             do
                 local door = room:GetDoor(i)
                 if door == nil then
-                    goto __continue11
+                    goto __continue12
                 end
                 if #roomTypes == 0 or roomTypesSet:has(door.TargetRoomType) then
                     __TS__ArrayPush(doors, door)
                 end
             end
-            ::__continue11::
+            ::__continue12::
             i = i + 1
         end
     end
@@ -95,6 +97,10 @@ function ____exports.getDevilRoomOrAngelRoomDoor(self)
     end
     return ____temp_2
 end
+function ____exports.getDoorSlotsForRoomShape(self, roomShape)
+    local doorSlots = ROOM_SHAPE_TO_DOOR_SLOTS[roomShape]
+    return doorSlots == nil and __TS__New(Set) or doorSlots
+end
 function ____exports.getDoorsToRoomIndex(self, ...)
     local roomGridIndex = {...}
     local roomGridIndexesSet = __TS__New(Set, roomGridIndex)
@@ -117,6 +123,10 @@ end
 function ____exports.isDevilRoomDoor(self, door)
     return door.TargetRoomType == RoomType.ROOM_DEVIL
 end
+function ____exports.isDoorSlotInRoomShape(self, doorSlot, roomShape)
+    local doorSlots = ____exports.getDoorSlotsForRoomShape(nil, roomShape)
+    return doorSlots:has(doorSlot)
+end
 function ____exports.isDoorToDownpour(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false

package/dist/functions/entity.lua

@@ -10,7 +10,8 @@ local ____storyBossesSet = require("sets.storyBossesSet")
 local STORY_BOSSES_SET = ____storyBossesSet.STORY_BOSSES_SET
 local ____random = require("functions.random")
 local getRandom = ____random.getRandom
-local nextSeed = ____random.nextSeed
+local ____rng = require("functions.rng")
+local newRNG = ____rng.newRNG
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
 function ____exports.removeEntities(self, entities, cap)
@@ -136,13 +137,12 @@ function ____exports.rerollEnemy(self, entity)
 end
 function ____exports.setEntityRandomColor(self, entity)
     local colorValues = {}
-    local seed = entity.InitSeed
+    local rng = newRNG(nil, entity.InitSeed)
     ____repeat(
         nil,
         3,
         function()
-            seed = nextSeed(nil, seed)
-            local randomColorValue = getRandom(nil, seed)
+            local randomColorValue = getRandom(nil, rng)
             __TS__ArrayPush(colorValues, randomColorValue)
         end
     )

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[], seed?: Seed, verbose?: boolean): JSONRoom;
+export declare function getRandomJSONRoom(jsonRooms: JSONRoom[], rng?: RNG, verbose?: boolean): JSONRoom;

package/dist/functions/jsonRoom.lua

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

package/dist/functions/map.d.ts

@@ -1,12 +1,5 @@
-/// <reference types="isaac-typescript-definitions" />
-import { DefaultMap } from "../classes/DefaultMap";
 /** Helper function to copy a map. (You can also use a Map constructor to accomplish this task.) */
 export declare function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V>;
-/**
- * Helper function to make using default maps with `Seed` values easier. Use this instead of
- * manually getting the current value, incrementing it, and then setting it.
- */
-export declare function defaultMapGetNextSeed<K, A extends unknown[]>(map: DefaultMap<K, Seed, A>, key: K, ...extraArgs: A): Seed;
 /**
  * Helper function to get the closest value from a map based on partial search text. For the
  * purposes of this function, both search text and map keys are converted to lowercase before
@@ -26,8 +19,3 @@ export declare function defaultMapGetNextSeed<K, A extends unknown[]>(map: Defau
  * ```
  */
 export declare function getMapPartialMatch<T>(searchText: string, map: ReadonlyMap<string, T>): [string, T] | undefined;
-/**
- * Helper function to make using maps with `Seed` values easier. Use this instead of manually
- * getting the current value, incrementing it, and then setting it.
- */
-export declare function mapGetNextSeed<K>(map: Map<K, Seed>, key: K): Seed | undefined;

package/dist/functions/map.lua

@@ -8,8 +8,6 @@ local __TS__StringReplaceAll = ____lualib.__TS__StringReplaceAll
 local __TS__StringStartsWith = ____lualib.__TS__StringStartsWith
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
-local ____random = require("functions.random")
-local nextSeed = ____random.nextSeed
 function ____exports.copyMap(self, oldMap)
     local newMap = __TS__New(Map)
     for ____, ____value in __TS__Iterator(oldMap:entries()) do
@@ -19,15 +17,6 @@ function ____exports.copyMap(self, oldMap)
     end
     return newMap
 end
-function ____exports.defaultMapGetNextSeed(self, map, key, ...)
-    local seed = map:getAndSetDefault(key, ...)
-    if seed == 0 then
-        error("The seed map had a value of 0 for the key of: " .. tostring(key))
-    end
-    local newSeed = nextSeed(nil, seed)
-    map:set(key, newSeed)
-    return newSeed
-end
 function ____exports.getMapPartialMatch(self, searchText, map)
     local keys = {__TS__Spread(map:keys())}
     __TS__ArraySort(keys)
@@ -51,16 +40,4 @@ function ____exports.getMapPartialMatch(self, searchText, map)
     end
     return {matchingKey, value}
 end
-function ____exports.mapGetNextSeed(self, map, key)
-    local seed = map:get(key)
-    if seed == nil then
-        return nil
-    end
-    if seed == 0 then
-        error("The seed map had a value of 0 for the key of: " .. tostring(key))
-    end
-    local newSeed = nextSeed(nil, seed)
-    map:set(key, newSeed)
-    return newSeed
-end
 return ____exports

package/dist/functions/random.d.ts

@@ -3,81 +3,48 @@
  * 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.)
+ *
+ * Note that this function will invoke the `Next` method on the `RNG` object before returning the
+ * random number.
  */
-export declare function getRandom(seed?: Seed): float;
+export declare function getRandom(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.)
  *
+ * Note that this function will invoke the `Next` method on the `RNG` object before returning the
+ * random number.
+ *
  * Example:
  * ```ts
- * const realNumberBetweenOneAndThree = getRandomFloat(1, 3, seed);
+ * const realNumberBetweenOneAndThree = getRandomFloat(1, 3);
  * ```
  */
-export declare function getRandomFloat(min: int, max: int, seed?: Seed): float;
+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.)
- *
- * Note that this function will invoke the `Next` method on the `RNG` object before returning the
- * random number.
  */
-export declare function getRandomFloatFromRNG(min: int, max: int, rng: RNG): float;
+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.)
- *
- * Note that this function will invoke the `Next` method on the `RNG` object before returning the
- * random number.
- */
-export declare function getRandomFromRNG(rng: RNG): float;
-/**
- * This returns a random integer between min and max, inclusive.
- *
- * Example:
- * ```ts
- * const oneTwoOrThree = getRandomInt(1, 3, seed);
- * ```
  */
-export declare function getRandomInt(min: int, max: int, seed?: Seed): int;
+export declare function getRandomFromSeed(seed: Seed): float;
 /**
- * This returns a random integer between min and max, inclusive.
+ * This returns a random integer between min and max. It is inclusive on both ends.
  *
- * Example:
- * ```ts
- * const oneTwoOrThree = getRandomInt(1, 3, seed);
- * ```
- */
-export declare function getRandomIntFromRNG(min: int, max: int, rng: RNG): int;
-/**
- * Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
- * instead of calling the `Random` function directly since that can return a value of 0 and crash
- * the game.
- */
-export declare function getRandomSeed(): Seed;
-/**
- * Helper function to initialize an RNG object.
+ * Note that this function will invoke the `Next` method on the `RNG` object before returning the
+ * random number.
  *
  * Example:
  * ```ts
- * const startSeed = Game():GetSeeds():GetStartSeed();
- * const rng = initRNG(startSeed);
- * const fiftyFiftyChance = rng.RandomInt(2) === 0;
+ * const oneTwoOrThree = getRandomInt(1, 3);
  * ```
- *
- * It is recommended to not deal with RNG objects directly and instead use seeds. Also see the
- * `getRandom`, `getRandomInt`, and `getRandomFloat` helper functions.
- *
- * @param seed The seed to initialize it with. Default is `getRandomSeed()`.
- */
-export declare function newRNG(seed?: Seed): RNG;
-/**
- * Helper function to get the next seed value.
- *
- * This function is useful because it is standard practice to work with seed values directly over
- * RNG objects, since the latter are not serializable.
  */
-export declare function nextSeed(seed: Seed): Seed;
+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;

package/dist/functions/random.lua

@@ -1,19 +1,37 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local RECOMMENDED_SHIFT_IDX
-function ____exports.getRandomFloatFromRNG(self, min, max, rng)
+local ____rng = require("functions.rng")
+local newRNG = ____rng.newRNG
+function ____exports.getRandom(self, rng)
+    if rng == nil then
+        rng = newRNG(nil)
+    end
+    return rng:RandomFloat()
+end
+function ____exports.getRandomFloat(self, min, max, rng)
+    if rng == nil then
+        rng = newRNG(nil)
+    end
     if min > max then
         local oldMin = min
         local oldMax = max
         min = oldMax
         max = oldMin
     end
-    return min + ____exports.getRandomFromRNG(nil, rng) * (max - min)
+    return min + ____exports.getRandom(nil, rng) * (max - min)
 end
-function ____exports.getRandomFromRNG(self, rng)
-    return rng:RandomFloat()
+function ____exports.getRandomFloatFromSeed(self, min, max, seed)
+    local rng = newRNG(nil, seed)
+    return ____exports.getRandomFloat(nil, min, max, rng)
 end
-function ____exports.getRandomIntFromRNG(self, min, max, rng)
+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)
+    end
     if min > max then
         local oldMin = min
         local oldMax = max
@@ -22,47 +40,8 @@ function ____exports.getRandomIntFromRNG(self, min, max, rng)
     end
     return rng:RandomInt(max - min + 1) + min
 end
-function ____exports.getRandomSeed(self)
-    local randomNumber = Random()
-    local safeRandomNumber = randomNumber == 0 and 1 or randomNumber
-    return safeRandomNumber
-end
-function ____exports.newRNG(self, seed)
-    if seed == nil then
-        seed = ____exports.getRandomSeed(nil)
-    end
-    if seed == 0 then
-        error("You cannot initialize an RNG object with a seed of 0, or the game will crash.")
-    end
-    local rng = RNG()
-    rng:SetSeed(seed, RECOMMENDED_SHIFT_IDX)
-    return rng
-end
-RECOMMENDED_SHIFT_IDX = 35
-function ____exports.getRandom(self, seed)
-    if seed == nil then
-        seed = ____exports.getRandomSeed(nil)
-    end
-    local rng = ____exports.newRNG(nil, seed)
-    return ____exports.getRandomFromRNG(nil, rng)
-end
-function ____exports.getRandomFloat(self, min, max, seed)
-    if seed == nil then
-        seed = ____exports.getRandomSeed(nil)
-    end
-    local rng = ____exports.newRNG(nil, seed)
-    return ____exports.getRandomFloatFromRNG(nil, min, max, rng)
-end
-function ____exports.getRandomInt(self, min, max, seed)
-    if seed == nil then
-        seed = ____exports.getRandomSeed(nil)
-    end
-    local rng = ____exports.newRNG(nil, seed)
-    return ____exports.getRandomIntFromRNG(nil, min, max, rng)
-end
-function ____exports.nextSeed(self, seed)
-    local rng = ____exports.newRNG(nil, seed)
-    rng:Next()
-    return rng:GetSeed()
+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/rng.d.ts

@@ -0,0 +1,47 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="typescript-to-lua/language-extensions" />
+import { SerializationType } from "../enums/SerializationType";
+declare type SerializedRNG = LuaTable<string, string | number>;
+interface CopyRNGReturn {
+    [SerializationType.NONE]: RNG;
+    [SerializationType.SERIALIZE]: SerializedRNG;
+    [SerializationType.DESERIALIZE]: RNG;
+}
+/**
+ * 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.
+ * @param serializationType Default is `SerializationType.NONE`.
+ */
+export declare function copyRNG<R extends RNG | SerializedRNG, S extends SerializationType>(rng: R, serializationType: S): CopyRNGReturn[S];
+export declare function copyRNG<R extends RNG | SerializedRNG>(rng: R): CopyRNGReturn[SerializationType.NONE];
+/**
+ * Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
+ * instead of calling the `Random` function directly since that can return a value of 0 and crash
+ * the game.
+ */
+export declare function getRandomSeed(): Seed;
+/** Helper function to check if something is an instantiated RNG object. */
+export declare function isRNG(object: unknown): object is RNG;
+/**
+ * Used to determine is the given table is a serialized Vector created by the save data manager
+ * and/or the `deepCopy` function.
+ */
+export declare function isSerializedRNG(object: unknown): object is SerializedRNG;
+/**
+ * Helper function to initialize an RNG object using Blade's recommended shift index.
+ *
+ * @param seed The seed to initialize it with. Default is `getRandomSeed()`.
+ */
+export declare function newRNG(seed?: Seed): RNG;
+/**
+ * Helper function to get the next seed value.
+ *
+ * This function is useful if you are working with data structures that store seed values instead of
+ * RNG objects.
+ */
+export declare function nextSeed(seed: Seed): Seed;
+/** Helper function to set a seed to an RNG object using Blade's recommended shift index. */
+export declare function setSeed(rng: RNG, seed: Seed): void;
+export {};