isaacscript-common 2.3.0 → 3.0.0

package/functions/color.lua

@@ -0,0 +1,140 @@
+local ____exports = {}
+local OBJECT_NAME
+local ____SerializationBrand = require("enums.private.SerializationBrand")
+local SerializationBrand = ____SerializationBrand.SerializationBrand
+local ____SerializationType = require("enums.SerializationType")
+local SerializationType = ____SerializationType.SerializationType
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
+local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
+local ____table = require("functions.table")
+local copyValuesToTable = ____table.copyValuesToTable
+local getNumbersFromTable = ____table.getNumbersFromTable
+local tableHasKeys = ____table.tableHasKeys
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
+--- Helper function to check if something is an instantiated Color object.
+-- 
+-- @category color
+function ____exports.isColor(self, object)
+    return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
+end
+local KEYS = {
+    "R",
+    "G",
+    "B",
+    "A",
+    "RO",
+    "GO",
+    "BO"
+}
+OBJECT_NAME = "Color"
+---
+-- @category color
+function ____exports.colorEquals(self, color1, color2)
+    return isaacAPIClassEquals(nil, color1, color2, KEYS)
+end
+--- Helper function to copy a `Color` object.
+-- 
+-- @param color The Color object to copy. In the case of deserialization, this will actually be a
+-- Lua table instead of an instantiated Color class.
+-- @param serializationType Default is `SerializationType.NONE`.
+-- @category color
+function ____exports.copyColor(self, color, serializationType)
+    if serializationType == nil then
+        serializationType = SerializationType.NONE
+    end
+    repeat
+        local ____switch4 = serializationType
+        local ____cond4 = ____switch4 == SerializationType.NONE
+        if ____cond4 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
+        ____cond4 = ____cond4 or ____switch4 == SerializationType.SERIALIZE
+        if ____cond4 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
+        ____cond4 = ____cond4 or ____switch4 == SerializationType.DESERIALIZE
+        if ____cond4 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)
+                ))
+                if r == nil then
+                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: r")
+                end
+                if g == nil then
+                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: g")
+                end
+                if b == nil then
+                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: b")
+                end
+                return Color(
+                    r,
+                    g,
+                    b,
+                    a,
+                    ro,
+                    go,
+                    bo
+                )
+            end
+        end
+        do
+            do
+                return ensureAllCases(nil, serializationType)
+            end
+        end
+    until true
+end
+--- Returns `Color(1, 1, 1)`.
+-- 
+-- @category color
+function ____exports.getDefaultColor(self)
+    return Color(1, 1, 1)
+end
+--- Used to determine is the given table is a serialized `Color` object created by the save data
+-- manager and/or the `deepCopy` function.
+-- 
+-- @category color
+function ____exports.isSerializedColor(self, object)
+    local objectType = type(object)
+    if objectType ~= "table" then
+        return false
+    end
+    local ____table = object
+    return tableHasKeys(
+        nil,
+        ____table,
+        table.unpack(KEYS)
+    ) and ____table[SerializationBrand.COLOR] ~= nil
+end
+return ____exports

package/functions/debug.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Helper function to get a stack trace.
+ *
+ * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+ * enabled.
+ */
+export declare function getTraceback(): string;
+/**
+ * Players can boot the game with an launch option called "--luadebug", which will enable additional
+ * functionality that is considered to be unsafe. For more information about this flag, see the
+ * wiki: https://bindingofisaacrebirth.fandom.com/wiki/Launch_Options
+ *
+ * When this flag is enabled, the global environment will be slightly different. The differences are
+ * documented here: https://wofsauge.github.io/IsaacDocs/rep/Globals.html
+ *
+ * This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
+ * is enabled or not.
+ */
+export declare function isLuaDebugEnabled(): boolean;
+/**
+ * Helper function to print a stack trace to the "log.txt" file, similar to JavaScript's
+ * `console.trace` function.
+ *
+ * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+ * enabled.
+ */
+export declare function traceback(): void;

package/functions/debug.lua

@@ -0,0 +1,49 @@
+local ____exports = {}
+local ____log = require("functions.log")
+local log = ____log.log
+--- Helper function to get a stack trace.
+-- 
+-- This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+-- enabled.
+function ____exports.getTraceback(self)
+    if debug ~= nil then
+        return debug.traceback()
+    end
+    if sandboxGetTraceback ~= nil then
+        return sandboxGetTraceback()
+    end
+    return "stack traceback:\n(the \"--luadebug\" flag is not enabled)"
+end
+--- Players can boot the game with an launch option called "--luadebug", which will enable additional
+-- functionality that is considered to be unsafe. For more information about this flag, see the
+-- wiki: https://bindingofisaacrebirth.fandom.com/wiki/Launch_Options
+-- 
+-- When this flag is enabled, the global environment will be slightly different. The differences are
+-- documented here: https://wofsauge.github.io/IsaacDocs/rep/Globals.html
+-- 
+-- This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
+-- is enabled or not.
+function ____exports.isLuaDebugEnabled(self)
+    return package ~= nil
+end
+--- Helper function to print a stack trace to the "log.txt" file, similar to JavaScript's
+-- `console.trace` function.
+-- 
+-- This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+-- enabled.
+function ____exports.traceback(self)
+    local tracebackOutput = ____exports.getTraceback(nil)
+    log(tracebackOutput)
+end
+local function setDebugFunctionsGlobal(self)
+    if debug == nil and sandboxGetTraceback == nil then
+        return
+    end
+    local globals = _G
+    globals.getTraceback = ____exports.getTraceback
+    globals.traceback = ____exports.traceback
+end
+if ____exports.isLuaDebugEnabled(nil) or sandboxGetTraceback ~= nil then
+    setDebugFunctionsGlobal(nil)
+end
+return ____exports

package/functions/deepCopy.d.ts

@@ -0,0 +1,29 @@
+import { SerializationType } from "../enums/SerializationType";
+/**
+ * `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
+ * of the nested references remain.
+ *
+ * It supports the following object types:
+ *
+ * - Primitives (i.e. strings, numbers, and booleans)
+ * - `LuaTable` / basic TSTL objects
+ * - TSTL `Map`
+ * - TSTL `Set`
+ * - TSTL classes
+ * - `DefaultMap`
+ * - Isaac `Color` objects
+ * - Isaac `KColor` objects
+ * - Isaac `RNG` objects
+ * - Isaac `Vector` objects
+ *
+ * It does not support:
+ * - objects with values of `null` (since that transpiles to `nil`)
+ * - other Isaac API objects such as `EntityPtr` (that have a type of "userdata")
+ *
+ * @param value The primitive or object to copy.
+ * @param serializationType Has 3 possible values. Can leave objects as-is, or can 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(value: unknown, serializationType?: SerializationType, traversalDescription?: string): unknown;

package/functions/deepCopy.lua

@@ -0,0 +1,382 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__InstanceOf = ____lualib.__TS__InstanceOf
+local Map = ____lualib.Map
+local WeakMap = ____lualib.WeakMap
+local WeakSet = ____lualib.WeakSet
+local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local ____exports = {}
+local deepCopyTable, deepCopyDefaultMap, deepCopyMap, deepCopySet, deepCopyTSTLClass, deepCopyArray, deepCopyNormalLuaTable, getCopiedEntries, checkMetatable, deepCopyUserdata, COPYABLE_ISAAC_API_CLASS_TYPES_SET
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____CopyableIsaacAPIClassType = require("enums.private.CopyableIsaacAPIClassType")
+local CopyableIsaacAPIClassType = ____CopyableIsaacAPIClassType.CopyableIsaacAPIClassType
+local ____SerializationBrand = require("enums.private.SerializationBrand")
+local SerializationBrand = ____SerializationBrand.SerializationBrand
+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 ____serializationBrand = require("features.saveDataManager.serializationBrand")
+local isSerializationBrand = ____serializationBrand.isSerializationBrand
+local ____array = require("functions.array")
+local isArray = ____array.isArray
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local getIsaacAPIClassType = ____isaacAPIClass.getIsaacAPIClassType
+local ____log = require("functions.log")
+local log = ____log.log
+local ____serialization = require("functions.serialization")
+local copyIsaacAPIClass = ____serialization.copyIsaacAPIClass
+local deserializeIsaacAPIClass = ____serialization.deserializeIsaacAPIClass
+local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
+local ____tstlClass = require("functions.tstlClass")
+local isUserDefinedTSTLClass = ____tstlClass.isUserDefinedTSTLClass
+local newTSTLClass = ____tstlClass.newTSTLClass
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
+local getTraversalDescription = ____utils.getTraversalDescription
+--- `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
+-- of the nested references remain.
+-- 
+-- It supports the following object types:
+-- 
+-- - Primitives (i.e. strings, numbers, and booleans)
+-- - `LuaTable` / basic TSTL objects
+-- - TSTL `Map`
+-- - TSTL `Set`
+-- - TSTL classes
+-- - `DefaultMap`
+-- - Isaac `Color` objects
+-- - Isaac `KColor` objects
+-- - Isaac `RNG` objects
+-- - Isaac `Vector` objects
+-- 
+-- It does not support:
+-- - objects with values of `null` (since that transpiles to `nil`)
+-- - other Isaac API objects such as `EntityPtr` (that have a type of "userdata")
+-- 
+-- @param value The primitive or object to copy.
+-- @param serializationType Has 3 possible values. Can leave objects as-is, or can 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.
+function ____exports.deepCopy(self, value, serializationType, traversalDescription)
+    if serializationType == nil then
+        serializationType = SerializationType.NONE
+    end
+    if traversalDescription == nil then
+        traversalDescription = ""
+    end
+    if SAVE_DATA_MANAGER_DEBUG then
+        local logString = "deepCopy is operating on: " .. traversalDescription
+        if serializationType == SerializationType.SERIALIZE then
+            logString = logString .. " (serializing)"
+        elseif serializationType == SerializationType.DESERIALIZE then
+            logString = logString .. " (deserializing)"
+        end
+        logString = logString .. ": " .. tostring(value)
+        log(logString)
+    end
+    local valueType = type(value)
+    repeat
+        local ____switch6 = valueType
+        local ____cond6 = ____switch6 == "nil" or ____switch6 == "boolean" or ____switch6 == "number" or ____switch6 == "string"
+        if ____cond6 then
+            do
+                return value
+            end
+        end
+        ____cond6 = ____cond6 or (____switch6 == "function" or ____switch6 == "thread")
+        if ____cond6 then
+            do
+                if serializationType == SerializationType.SERIALIZE then
+                    error((("The deep copy function does not support serialization of \"" .. traversalDescription) .. "\", since it is type: ") .. valueType)
+                end
+                return value
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == "table"
+        if ____cond6 then
+            do
+                local valueTable = value
+                return deepCopyTable(nil, valueTable, serializationType, traversalDescription)
+            end
+        end
+        ____cond6 = ____cond6 or ____switch6 == "userdata"
+        if ____cond6 then
+            do
+                return deepCopyUserdata(nil, value, serializationType, traversalDescription)
+            end
+        end
+        do
+            do
+                return ensureAllCases(nil, valueType)
+            end
+        end
+    until true
+end
+function deepCopyTable(self, ____table, serializationType, traversalDescription)
+    if __TS__InstanceOf(____table, DefaultMap) or ____table[SerializationBrand.DEFAULT_MAP] ~= nil then
+        return deepCopyDefaultMap(nil, ____table, serializationType, traversalDescription)
+    end
+    if __TS__InstanceOf(____table, Map) or ____table[SerializationBrand.MAP] ~= nil then
+        return deepCopyMap(nil, ____table, serializationType, traversalDescription)
+    end
+    if __TS__InstanceOf(____table, Set) or ____table[SerializationBrand.SET] ~= nil then
+        return deepCopySet(nil, ____table, serializationType, traversalDescription)
+    end
+    if __TS__InstanceOf(____table, WeakMap) then
+        error("The deep copy function does not support copying the \"WeakMap\" class for: " .. traversalDescription)
+    end
+    if __TS__InstanceOf(____table, WeakSet) then
+        error("The deep copy function does not support copying the \"WeakSet\" class for: " .. traversalDescription)
+    end
+    if isUserDefinedTSTLClass(nil, ____table) then
+        return deepCopyTSTLClass(nil, ____table, serializationType, traversalDescription)
+    end
+    checkMetatable(nil, ____table, traversalDescription)
+    if isSerializedIsaacAPIClass(nil, ____table) and serializationType == SerializationType.DESERIALIZE then
+        return deserializeIsaacAPIClass(nil, ____table)
+    end
+    if isArray(nil, ____table) then
+        return deepCopyArray(nil, ____table, serializationType, traversalDescription)
+    end
+    return deepCopyNormalLuaTable(nil, ____table, serializationType, traversalDescription)
+end
+function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescription)
+    local ____temp_0
+    if __TS__InstanceOf(defaultMap, DefaultMap) then
+        ____temp_0 = defaultMap:getConstructorArg()
+    else
+        ____temp_0 = nil
+    end
+    local constructorArg = ____temp_0
+    local newDefaultMap
+    repeat
+        local ____switch23 = serializationType
+        local ____cond23 = ____switch23 == SerializationType.NONE
+        if ____cond23 then
+            do
+                newDefaultMap = __TS__New(DefaultMap, constructorArg)
+                break
+            end
+        end
+        ____cond23 = ____cond23 or ____switch23 == SerializationType.SERIALIZE
+        if ____cond23 then
+            do
+                if type(constructorArg) ~= "boolean" and type(constructorArg) ~= "number" and type(constructorArg) ~= "string" then
+                    return deepCopyMap(nil, defaultMap, serializationType, traversalDescription)
+                end
+                newDefaultMap = {}
+                newDefaultMap[SerializationBrand.DEFAULT_MAP] = ""
+                newDefaultMap[SerializationBrand.DEFAULT_MAP_VALUE] = constructorArg
+                break
+            end
+        end
+        ____cond23 = ____cond23 or ____switch23 == SerializationType.DESERIALIZE
+        if ____cond23 then
+            do
+                if __TS__InstanceOf(defaultMap, DefaultMap) then
+                    error(("The deep copy function failed to deserialize a default map of \"" .. traversalDescription) .. "\", since it was not a Lua table.")
+                end
+                local defaultMapValue = defaultMap[SerializationBrand.DEFAULT_MAP_VALUE]
+                if defaultMapValue == nil then
+                    error((("The deep copy function failed to deserialize a default map of \"" .. traversalDescription) .. "\", since there was no serialization brand of: ") .. SerializationBrand.DEFAULT_MAP_VALUE)
+                end
+                newDefaultMap = __TS__New(DefaultMap, defaultMapValue)
+                break
+            end
+        end
+        do
+            do
+                return ensureAllCases(nil, serializationType)
+            end
+        end
+    until true
+    local ____getCopiedEntries_result_1 = getCopiedEntries(nil, defaultMap, serializationType, traversalDescription)
+    local entries = ____getCopiedEntries_result_1.entries
+    local convertedNumberKeysToStrings = ____getCopiedEntries_result_1.convertedNumberKeysToStrings
+    if convertedNumberKeysToStrings then
+        if __TS__InstanceOf(newDefaultMap, DefaultMap) then
+            newDefaultMap:set(SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "")
+        else
+            newDefaultMap[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] = ""
+        end
+    end
+    for ____, ____value in ipairs(entries) do
+        local key = ____value[1]
+        local value = ____value[2]
+        if __TS__InstanceOf(newDefaultMap, DefaultMap) then
+            newDefaultMap:set(key, value)
+        else
+            newDefaultMap[key] = value
+        end
+    end
+    return newDefaultMap
+end
+function deepCopyMap(self, map, serializationType, traversalDescription)
+    local newMap
+    if serializationType == SerializationType.SERIALIZE then
+        newMap = {}
+        newMap[SerializationBrand.MAP] = ""
+    else
+        newMap = __TS__New(Map)
+    end
+    local ____getCopiedEntries_result_2 = getCopiedEntries(nil, map, serializationType, traversalDescription)
+    local entries = ____getCopiedEntries_result_2.entries
+    local convertedNumberKeysToStrings = ____getCopiedEntries_result_2.convertedNumberKeysToStrings
+    if convertedNumberKeysToStrings then
+        if __TS__InstanceOf(newMap, Map) then
+            newMap:set(SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "")
+        else
+            newMap[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] = ""
+        end
+    end
+    for ____, ____value in ipairs(entries) do
+        local key = ____value[1]
+        local value = ____value[2]
+        if __TS__InstanceOf(newMap, Map) then
+            newMap:set(key, value)
+        else
+            newMap[key] = value
+        end
+    end
+    return newMap
+end
+function deepCopySet(self, set, serializationType, traversalDescription)
+    local newSet
+    if serializationType == SerializationType.SERIALIZE then
+        newSet = {}
+        newSet[SerializationBrand.SET] = ""
+    else
+        newSet = __TS__New(Set)
+    end
+    local ____getCopiedEntries_result_3 = getCopiedEntries(nil, set, serializationType, traversalDescription)
+    local entries = ____getCopiedEntries_result_3.entries
+    local convertedNumberKeysToStrings = ____getCopiedEntries_result_3.convertedNumberKeysToStrings
+    if convertedNumberKeysToStrings then
+        if __TS__InstanceOf(newSet, Set) then
+            error("The deep copy function cannot convert number keys to strings for a Set.")
+        else
+            newSet[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] = ""
+        end
+    end
+    for ____, ____value in ipairs(entries) do
+        local key = ____value[1]
+        if __TS__InstanceOf(newSet, Set) then
+            newSet:add(key)
+        else
+            newSet[key] = ""
+        end
+    end
+    return newSet
+end
+function deepCopyTSTLClass(self, tstlClass, serializationType, traversalDescription)
+    local newClass
+    if serializationType == SerializationType.SERIALIZE then
+        newClass = {}
+    else
+        newClass = newTSTLClass(nil, tstlClass)
+    end
+    local ____getCopiedEntries_result_4 = getCopiedEntries(nil, tstlClass, serializationType, traversalDescription)
+    local entries = ____getCopiedEntries_result_4.entries
+    local convertedNumberKeysToStrings = ____getCopiedEntries_result_4.convertedNumberKeysToStrings
+    if convertedNumberKeysToStrings then
+        newClass[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] = ""
+    end
+    for ____, ____value in ipairs(entries) do
+        local key = ____value[1]
+        local value = ____value[2]
+        newClass[key] = value
+    end
+    return newClass
+end
+function deepCopyArray(self, array, serializationType, traversalDescription)
+    local newArray = {}
+    for ____, value in ipairs(array) do
+        local newValue = ____exports.deepCopy(nil, value, serializationType, traversalDescription)
+        newArray[#newArray + 1] = newValue
+    end
+    return newArray
+end
+function deepCopyNormalLuaTable(self, ____table, serializationType, traversalDescription)
+    local newTable = {}
+    local ____getCopiedEntries_result_5 = getCopiedEntries(nil, ____table, serializationType, traversalDescription)
+    local entries = ____getCopiedEntries_result_5.entries
+    local convertedNumberKeysToStrings = ____getCopiedEntries_result_5.convertedNumberKeysToStrings
+    if convertedNumberKeysToStrings then
+        newTable[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] = ""
+    end
+    for ____, ____value in ipairs(entries) do
+        local key = ____value[1]
+        local value = ____value[2]
+        newTable[key] = value
+    end
+    return newTable
+end
+function getCopiedEntries(self, object, serializationType, traversalDescription)
+    local entries = {}
+    if __TS__InstanceOf(object, Map) or __TS__InstanceOf(object, Set) then
+        for ____, ____value in __TS__Iterator(object:entries()) do
+            local key = ____value[1]
+            local value = ____value[2]
+            entries[#entries + 1] = {key, value}
+        end
+    else
+        for key, value in pairs(object) do
+            entries[#entries + 1] = {key, value}
+        end
+    end
+    local hasNumberKeys = __TS__ArraySome(
+        entries,
+        function(____, ____bindingPattern0)
+            local key
+            key = ____bindingPattern0[1]
+            return type(key) == "number"
+        end
+    )
+    local convertNumberKeysToStrings = serializationType == SerializationType.SERIALIZE and hasNumberKeys
+    local copiedEntries = {}
+    for ____, ____value in ipairs(entries) do
+        local key = ____value[1]
+        local value = ____value[2]
+        do
+            if isSerializationBrand(nil, key) then
+                goto __continue78
+            end
+            traversalDescription = getTraversalDescription(nil, key, traversalDescription)
+            local newValue = ____exports.deepCopy(nil, value, serializationType, traversalDescription)
+            local keyToUse = convertNumberKeysToStrings and tostring(key) or key
+            copiedEntries[#copiedEntries + 1] = {keyToUse, newValue}
+        end
+        ::__continue78::
+    end
+    return {entries = copiedEntries, convertedNumberKeysToStrings = convertNumberKeysToStrings}
+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 explicitly handled by the save data manager. (e.g. TypeScriptToLua Maps, TypeScriptToLua Sets, etc.)")
+end
+function deepCopyUserdata(self, value, serializationType, traversalDescription)
+    local classType = getIsaacAPIClassType(nil, value)
+    if classType == nil then
+        error("The deep copy function was not able to derive the Isaac API class type for: " .. traversalDescription)
+    end
+    if not COPYABLE_ISAAC_API_CLASS_TYPES_SET:has(classType) then
+        error((("The deep copy function does not support copying \"" .. traversalDescription) .. "\", since it is an Isaac API class of type: ") .. classType)
+    end
+    return copyIsaacAPIClass(nil, value, serializationType)
+end
+COPYABLE_ISAAC_API_CLASS_TYPES_SET = __TS__New(
+    Set,
+    getEnumValues(nil, CopyableIsaacAPIClassType)
+)
+return ____exports

package/functions/deepCopyTests.d.ts

@@ -0,0 +1 @@
+export declare function deepCopyTests(): void;