isaacscript-common 1.2.249 → 1.2.252

package/dist/enums/private/CopyableIsaacAPIClassType.d.ts

@@ -0,0 +1,7 @@
+/** This must match the enumeration in the JSDoc comments for `deepCopy` and `merge`. */
+export declare enum CopyableIsaacAPIClassType {
+    COLOR = "Color",
+    KCOLOR = "KColor",
+    RNG = "RNG",
+    VECTOR = "Vector"
+}

package/dist/enums/private/CopyableIsaacAPIClassType.lua

@@ -0,0 +1,8 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+____exports.CopyableIsaacAPIClassType = CopyableIsaacAPIClassType or ({})
+____exports.CopyableIsaacAPIClassType.COLOR = "Color"
+____exports.CopyableIsaacAPIClassType.KCOLOR = "KColor"
+____exports.CopyableIsaacAPIClassType.RNG = "RNG"
+____exports.CopyableIsaacAPIClassType.VECTOR = "Vector"
+return ____exports

package/dist/enums/private/SerializationBrand.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="typescript-to-lua/language-extensions" />
 /**
  * During serialization, we write an arbitrary string key to the object with a value of an empty
  * string. This is used during deserialization to instantiate the correct type of object.
@@ -8,6 +7,12 @@
  */
 export declare enum SerializationBrand {
     DEFAULT_MAP = "__TSTL_DEFAULT_MAP",
+    MAP = "__TSTL_MAP",
+    SET = "__TSTL_SET",
+    COLOR = "__COLOR",
+    KCOLOR = "__KCOLOR",
+    RNG = "__RNG",
+    VECTOR = "__VECTOR",
     /**
      * This is set to the value that represents the default value (instead of an empty string like the
      * other brands are).
@@ -17,12 +22,17 @@ export declare enum SerializationBrand {
      * object.
      */
     DEFAULT_MAP_VALUE = "__TSTL_DEFAULT_MAP_VALUE",
-    MAP = "__TSTL_MAP",
-    SET = "__TSTL_SET",
-    OBJECT_WITH_NUMBER_KEYS = "__TSTL_OBJECT_WITH_NUMBER_KEYS",
-    COLOR = "__COLOR",
-    KCOLOR = "__KCOLOR",
-    RNG = "__RNG",
-    VECTOR = "__VECTOR"
+    /**
+     * The JSON library is unable to distinguish between a maps with number keys and an array. It will
+     * assume that both of these are an array. Thus, in the case of a map with number keys, it will
+     * insert null in every empty spot, leading to crashes.
+     *
+     * For example, a map with keys of 5 and 10 would be converted to the following array:
+     * `[null, null, null, null, "myValueForKey5", null, null, null, null, "myValueForKey10"]`
+     *
+     * The deep copier works around this by converting number keys to strings. It inserts this brand
+     * to keep track of the mutation.
+     */
+    OBJECT_WITH_NUMBER_KEYS = "__TSTL_OBJECT_WITH_NUMBER_KEYS"
 }
-export declare function isSerializationBrand(key: AnyNotNil): boolean;
+export declare function isSerializationBrand(key: unknown): boolean;

package/dist/enums/private/SerializationBrand.lua

@@ -6,14 +6,14 @@ local ____utils = require("functions.utils")
 local getEnumValues = ____utils.getEnumValues
 ____exports.SerializationBrand = SerializationBrand or ({})
 ____exports.SerializationBrand.DEFAULT_MAP = "__TSTL_DEFAULT_MAP"
-____exports.SerializationBrand.DEFAULT_MAP_VALUE = "__TSTL_DEFAULT_MAP_VALUE"
 ____exports.SerializationBrand.MAP = "__TSTL_MAP"
 ____exports.SerializationBrand.SET = "__TSTL_SET"
-____exports.SerializationBrand.OBJECT_WITH_NUMBER_KEYS = "__TSTL_OBJECT_WITH_NUMBER_KEYS"
 ____exports.SerializationBrand.COLOR = "__COLOR"
 ____exports.SerializationBrand.KCOLOR = "__KCOLOR"
 ____exports.SerializationBrand.RNG = "__RNG"
 ____exports.SerializationBrand.VECTOR = "__VECTOR"
+____exports.SerializationBrand.DEFAULT_MAP_VALUE = "__TSTL_DEFAULT_MAP_VALUE"
+____exports.SerializationBrand.OBJECT_WITH_NUMBER_KEYS = "__TSTL_OBJECT_WITH_NUMBER_KEYS"
 local SERIALIZATION_BRANDS = getEnumValues(nil, ____exports.SerializationBrand)
 local SERIALIZATION_BRAND_SET = __TS__New(Set, SERIALIZATION_BRANDS)
 function ____exports.isSerializationBrand(self, key)

package/dist/features/saveDataManager/exports.lua

@@ -32,8 +32,7 @@ function ____exports.saveDataManager(self, key, v, conditionalFunc)
         conditionalFunc = function() return false end
     end
     local saveDataTable = v
-    local saveDataTableCopy = deepCopy(nil, saveDataTable, SerializationType.NONE, key)
-    local saveDataCopy = saveDataTableCopy
+    local saveDataCopy = deepCopy(nil, saveDataTable, SerializationType.NONE, key)
     saveDataDefaultsMap[key] = saveDataCopy
     if conditionalFunc ~= nil then
         saveDataConditionalFuncMap:set(key, conditionalFunc)

package/dist/features/saveDataManager/main.lua

@@ -80,9 +80,8 @@ function restoreDefaults(self, childTableName)
                 logError(((("Failed to find the default copy of the child table \"" .. childTableName) .. "\" for subscriber \"") .. subscriberName) .. "\". This error usually means that your save data is out of date. You can try purging all of your save data by deleting the following directory: C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\data")
                 goto __continue14
             end
-            local childTableDefaultsTable = childTableDefaults
-            local childTableDefaultsTableCopy = deepCopy(nil, childTableDefaultsTable, SerializationType.NONE, (subscriberName .. " --> ") .. childTableName)
-            clearAndCopyAllElements(nil, childTable, childTableDefaultsTableCopy)
+            local childTableDefaultsCopy = deepCopy(nil, childTableDefaults, SerializationType.NONE, (subscriberName .. " --> ") .. childTableName)
+            clearAndCopyAllElements(nil, childTable, childTableDefaultsCopy)
         end
         ::__continue14::
     end

package/dist/features/saveDataManager/merge.lua

@@ -36,7 +36,9 @@ function ____exports.merge(self, oldObject, newTable, traversalDescription)
     if newTableType ~= "table" then
         error("The second argument given to the merge function is not a table.")
     end
-    if mergeArray(nil, oldObject, newTable) then
+    if isArray(nil, oldObject) and isArray(nil, newTable) then
+        local oldTable = oldObject
+        mergeArray(nil, oldTable, newTable)
         return
     end
     if __TS__InstanceOf(oldObject, Map) or __TS__InstanceOf(oldObject, Set) then
@@ -45,16 +47,11 @@ function ____exports.merge(self, oldObject, newTable, traversalDescription)
         mergeTable(nil, oldObject, newTable, traversalDescription)
     end
 end
-function mergeArray(self, oldObject, newTable)
-    local oldArray = oldObject
-    if not isArray(nil, oldArray) or not isArray(nil, newTable) then
-        return false
-    end
+function mergeArray(self, oldArray, newArray)
     clearTable(nil, oldArray)
-    for key, value in pairs(newTable) do
+    for key, value in pairs(newArray) do
         oldArray[key] = value
     end
-    return true
 end
 function mergeTSTLObject(self, oldObject, newTable, traversalDescription)
     oldObject:clear()
@@ -62,13 +59,13 @@ function mergeTSTLObject(self, oldObject, newTable, traversalDescription)
     for key, value in pairs(newTable) do
         do
             if isSerializationBrand(nil, key) then
-                goto __continue13
+                goto __continue12
             end
             local keyToUse = key
             if convertStringKeysToNumbers then
                 local numberKey = tonumber(key)
                 if numberKey == nil then
-                    goto __continue13
+                    goto __continue12
                 end
                 keyToUse = numberKey
             end
@@ -85,13 +82,10 @@ function mergeTSTLObject(self, oldObject, newTable, traversalDescription)
                 oldObject:add(keyToUse)
             end
         end
-        ::__continue13::
+        ::__continue12::
     end
 end
 function mergeTable(self, oldTable, newTable, traversalDescription)
-    if SAVE_DATA_MANAGER_DEBUG then
-        log("merge is operating on a table. Iterating through the keys...")
-    end
     for key, value in pairs(newTable) do
         do
             if SAVE_DATA_MANAGER_DEBUG then
@@ -99,7 +93,7 @@ function mergeTable(self, oldTable, newTable, traversalDescription)
                 log((("merge is merging: " .. traversalDescription) .. " --> ") .. valueToPrint)
             end
             if isSerializationBrand(nil, key) then
-                goto __continue23
+                goto __continue21
             end
             if isSerializedIsaacAPIClass(nil, value) then
                 if SAVE_DATA_MANAGER_DEBUG then
@@ -107,7 +101,7 @@ function mergeTable(self, oldTable, newTable, traversalDescription)
                 end
                 local deserializedObject = deserializeIsaacAPIClass(nil, value)
                 oldTable[key] = deserializedObject
-                goto __continue23
+                goto __continue21
             end
             local valueType = type(value)
             if valueType == "table" then
@@ -123,7 +117,7 @@ function mergeTable(self, oldTable, newTable, traversalDescription)
                 oldTable[key] = value
             end
         end
-        ::__continue23::
+        ::__continue21::
     end
 end
 return ____exports

package/dist/functions/array.d.ts

@@ -82,7 +82,7 @@ export declare function initArray<T>(defaultValue: T, size: int): T[];
  * - the table contains all numerical indexes that are contiguous, starting at 1
  * - the table has no keys (i.e. an "empty" table)
  */
-export declare function isArray(thing: unknown): boolean;
+export declare function isArray(object: unknown): object is unknown[];
 /** 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;
 /**

package/dist/functions/array.lua

@@ -155,17 +155,17 @@ function ____exports.initArray(self, defaultValue, size)
     )
     return array
 end
-function ____exports.isArray(self, thing)
-    if type(thing) ~= "table" then
+function ____exports.isArray(self, object)
+    if type(object) ~= "table" then
         return false
     end
-    local thingTable = thing
-    local metatable = getmetatable(thingTable)
+    local ____table = object
+    local metatable = getmetatable(____table)
     if metatable ~= nil then
         return false
     end
     local numEntries = 0
-    for key in pairs(thingTable) do
+    for key in pairs(____table) do
         numEntries = numEntries + 1
         if type(key) ~= "number" then
             return false
@@ -177,7 +177,7 @@ function ____exports.isArray(self, thing)
     do
         local i = 1
         while i <= numEntries do
-            local element = thingTable[i]
+            local element = ____table[i]
             if element == nil then
                 return false
             end

package/dist/functions/deepCopy.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 /**
  * deepCopy is a semi-generic deep cloner. It will recursively copy all of the values so that none
@@ -6,6 +5,7 @@ import { SerializationType } from "../enums/SerializationType";
  *
  * It supports the following object types:
  *
+ * - Primitives (i.e. strings, numbers, and booleans)
  * - `LuaTable` / basic TSTL objects
  * - TSTL `Map`
  * - TSTL `Set`
@@ -16,10 +16,13 @@ import { SerializationType } from "../enums/SerializationType";
  * - 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. Default is
- * `SerializationType.NONE`.
+ * 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(oldObject: LuaTable<AnyNotNil, unknown> | Map<AnyNotNil, unknown> | Set<AnyNotNil>, serializationType?: SerializationType, traversalDescription?: string): LuaTable<AnyNotNil, unknown> | Map<AnyNotNil, unknown> | Set<AnyNotNil>;
+export declare function deepCopy(value: unknown, serializationType?: SerializationType, traversalDescription?: string): unknown;

package/dist/functions/deepCopy.lua

@@ -1,13 +1,19 @@
 local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__InstanceOf = ____lualib.__TS__InstanceOf
 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__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__ArraySome = ____lualib.__TS__ArraySome
 local ____exports = {}
-local checkMetatable, deepCopyValue, validateValue, getNewValue
+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 isSerializationBrand = ____SerializationBrand.isSerializationBrand
 local SerializationBrand = ____SerializationBrand.SerializationBrand
@@ -15,19 +21,24 @@ 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 ____array = require("functions.array")
+local isArray = ____array.isArray
+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 isSerializableIsaacAPIClass = ____serialization.isSerializableIsaacAPIClass
 local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
 local ____tstlClass = require("functions.tstlClass")
-local isTSTLClass = ____tstlClass.isTSTLClass
+local isUserDefinedTSTLClass = ____tstlClass.isUserDefinedTSTLClass
 local newTSTLClass = ____tstlClass.newTSTLClass
 local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
+local getEnumValues = ____utils.getEnumValues
 local getTraversalDescription = ____utils.getTraversalDescription
-function ____exports.deepCopy(self, oldObject, serializationType, traversalDescription)
+function ____exports.deepCopy(self, value, serializationType, traversalDescription)
     if serializationType == nil then
         serializationType = SerializationType.NONE
     end
@@ -41,178 +52,305 @@ function ____exports.deepCopy(self, oldObject, serializationType, traversalDescr
         elseif serializationType == SerializationType.DESERIALIZE then
             logString = logString .. " (deserializing)"
         end
+        logString = logString .. ": " .. tostring(value)
         log(logString)
     end
-    local oldObjectType = type(oldObject)
-    if oldObjectType ~= "table" then
-        error(("The deepCopy function was given a " .. oldObjectType) .. " instead of a table.")
-    end
-    local oldTable = oldObject
-    local isClass = isTSTLClass(nil, oldTable)
-    local hasTSTLDefaultMapBrand = false
-    local hasTSTLMapBrand = false
-    local hasTSTLSetBrand = false
-    if not __TS__InstanceOf(oldObject, Map) and not __TS__InstanceOf(oldObject, Set) and not isClass then
-        checkMetatable(nil, oldTable, traversalDescription)
-        hasTSTLDefaultMapBrand = oldTable[SerializationBrand.DEFAULT_MAP] ~= nil
-        hasTSTLMapBrand = oldTable[SerializationBrand.MAP] ~= nil
-        hasTSTLSetBrand = oldTable[SerializationBrand.SET] ~= nil
-    end
-    local newObject
-    if serializationType == SerializationType.NONE and __TS__InstanceOf(oldObject, DefaultMap) then
-        local oldDefaultMap = oldObject
-        local constructorArg = oldDefaultMap:getConstructorArg()
-        newObject = __TS__New(DefaultMap, constructorArg)
-    elseif serializationType == SerializationType.DESERIALIZE and hasTSTLDefaultMapBrand then
-        local defaultValue = oldTable[SerializationBrand.DEFAULT_MAP_VALUE]
-        if type(defaultValue) ~= "boolean" and type(defaultValue) ~= "number" and type(defaultValue) ~= "string" then
-            error("The deepCopy function failed to get a valid default value for a DefaultMap object when deserializing.")
-        else
-            newObject = __TS__New(DefaultMap, defaultValue)
-        end
-    elseif serializationType == SerializationType.NONE and __TS__InstanceOf(oldObject, Map) or serializationType == SerializationType.DESERIALIZE and hasTSTLMapBrand then
-        newObject = __TS__New(Map)
-    elseif serializationType == SerializationType.NONE and __TS__InstanceOf(oldObject, Set) or serializationType == SerializationType.DESERIALIZE and hasTSTLSetBrand then
-        newObject = __TS__New(Set)
-    elseif serializationType == SerializationType.NONE and isClass then
-        local oldTSTLClass = oldObject
-        newObject = newTSTLClass(nil, oldTSTLClass)
+    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
-        newObject = {}
+        ____temp_0 = nil
     end
-    if serializationType == SerializationType.SERIALIZE then
-        local newTable = newObject
-        if __TS__InstanceOf(oldObject, DefaultMap) then
-            newTable[SerializationBrand.DEFAULT_MAP] = ""
-            local oldDefaultMap = oldObject
-            local defaultValue = oldDefaultMap:getConstructorArg()
-            if type(defaultValue) == "boolean" or type(defaultValue) == "number" or type(defaultValue) == "string" then
-                newTable[SerializationBrand.DEFAULT_MAP_VALUE] = defaultValue
+    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
-        elseif __TS__InstanceOf(oldObject, Map) then
-            newTable[SerializationBrand.MAP] = ""
-        elseif __TS__InstanceOf(oldObject, Set) then
-            newTable[SerializationBrand.SET] = ""
         end
-    end
-    if __TS__InstanceOf(oldObject, Map) then
-        for ____, ____value in __TS__Iterator(oldObject:entries()) do
-            local key = ____value[1]
-            local value = ____value[2]
+        ____cond23 = ____cond23 or ____switch23 == SerializationType.SERIALIZE
+        if ____cond23 then
             do
-                if isSerializationBrand(nil, key) then
-                    goto __continue22
+                if type(constructorArg) ~= "boolean" and type(constructorArg) ~= "number" and type(constructorArg) ~= "string" then
+                    return deepCopyMap(nil, defaultMap, serializationType, traversalDescription)
                 end
-                deepCopyValue(
-                    nil,
-                    oldObject,
-                    newObject,
-                    key,
-                    value,
-                    traversalDescription,
-                    serializationType
-                )
+                newDefaultMap = {}
+                newDefaultMap[SerializationBrand.DEFAULT_MAP] = ""
+                newDefaultMap[SerializationBrand.DEFAULT_MAP_VALUE] = constructorArg
+                break
             end
-            ::__continue22::
         end
-    elseif __TS__InstanceOf(oldObject, Set) then
-        for ____, key in __TS__Iterator(oldObject:values()) do
+        ____cond23 = ____cond23 or ____switch23 == SerializationType.DESERIALIZE
+        if ____cond23 then
             do
-                if isSerializationBrand(nil, key) then
-                    goto __continue26
+                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
-                local value = ""
-                deepCopyValue(
-                    nil,
-                    oldObject,
-                    newObject,
-                    key,
-                    value,
-                    traversalDescription,
-                    serializationType
-                )
+                newDefaultMap = __TS__New(DefaultMap, defaultMapValue)
+                break
             end
-            ::__continue26::
         end
-    else
-        for key, value in pairs(oldObject) do
+        do
             do
-                if isSerializationBrand(nil, key) then
-                    goto __continue30
-                end
-                deepCopyValue(
-                    nil,
-                    oldObject,
-                    newObject,
-                    key,
-                    value,
-                    traversalDescription,
-                    serializationType
-                )
+                return ensureAllCases(nil, serializationType)
             end
-            ::__continue30::
+        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
-    return newObject
+    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 checkMetatable(self, ____table, traversalDescription)
-    local metatable = getmetatable(____table)
-    if metatable == nil then
-        return
+function deepCopyMap(self, map, serializationType, traversalDescription)
+    local newMap
+    if serializationType == SerializationType.SERIALIZE then
+        newMap = {}
+        newMap[SerializationBrand.MAP] = ""
+    else
+        newMap = __TS__New(Map)
     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. Vectors, TypeScriptToLua Maps, etc.)")
+    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 deepCopyValue(self, oldObject, newObject, key, value, traversalDescription, serializationType)
-    local valueType = type(value)
-    validateValue(nil, value, valueType, traversalDescription)
-    local convertNumberKeysToString = false
-    local isTSTLObject = __TS__InstanceOf(oldObject, Map) or __TS__InstanceOf(oldObject, Set)
-    local keyType = type(key)
-    if serializationType == SerializationType.SERIALIZE and isTSTLObject and keyType == "number" then
-        convertNumberKeysToString = true
-        local newTable = newObject
-        newTable[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] = ""
-        if SAVE_DATA_MANAGER_DEBUG then
-            log("deepCopy is converting a TSTL map with number keys to strings.")
+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
-    local newValue = getNewValue(
-        nil,
-        key,
-        value,
-        traversalDescription,
-        serializationType
-    )
-    if __TS__InstanceOf(newObject, Map) then
-        newObject:set(key, newValue)
-    elseif __TS__InstanceOf(newObject, Set) then
-        newObject:add(key)
+    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
-        local keyToUse = convertNumberKeysToString and tostring(key) or key
-        newObject[keyToUse] = newValue
+        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 validateValue(self, value, valueType, traversalDescription)
-    if isSerializableIsaacAPIClass(nil, value) then
-        return
+function deepCopyArray(self, array, serializationType, traversalDescription)
+    local newArray = {}
+    for ____, value in ipairs(array) do
+        local newValue = ____exports.deepCopy(nil, value, serializationType, traversalDescription)
+        __TS__ArrayPush(newArray, 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
-    if valueType == "function" or valueType == "nil" or valueType == "thread" or valueType == "userdata" then
-        error(((("The deepCopy function detected that \"" .. traversalDescription) .. "\" has a value of type \"") .. valueType) .. "\", which is not supported.")
+    for ____, ____value in ipairs(entries) do
+        local key = ____value[1]
+        local value = ____value[2]
+        newTable[key] = value
     end
+    return newTable
 end
-function getNewValue(self, key, value, traversalDescription, serializationType)
-    if isSerializableIsaacAPIClass(nil, value) then
-        return copyIsaacAPIClass(nil, value, serializationType)
+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]
+            __TS__ArrayPush(entries, {key, value})
+        end
+    else
+        for key, value in pairs(object) do
+            __TS__ArrayPush(entries, {key, value})
+        end
     end
-    if isSerializedIsaacAPIClass(nil, value) and serializationType == SerializationType.DESERIALIZE then
-        return deserializeIsaacAPIClass(nil, value)
+    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
+            __TS__ArrayPush(copiedEntries, {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 type(value) == "table" then
-        local ____table = value
-        traversalDescription = getTraversalDescription(nil, key, traversalDescription)
-        return ____exports.deepCopy(nil, ____table, serializationType, traversalDescription)
+    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 value
+    return copyIsaacAPIClass(nil, value, serializationType)
 end
+COPYABLE_ISAAC_API_CLASS_TYPES_SET = __TS__New(
+    Set,
+    getEnumValues(nil, CopyableIsaacAPIClassType)
+)
 return ____exports

package/dist/functions/familiars.d.ts

@@ -1,33 +1,40 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Helper function to add and remove familiars based on a target amount that you specify. Use this
- * instead of the `EntityPlayer.CheckFamiliar` method so that the InitSeed of the spawned familiar
- * will be set properly. Note that when using this function, you need to manually account for Box of
- * Friends and Monster Manual (by looking at the number of collectible effects for the familiar).
+ * Helper function to add and remove familiars based on a target amount that you specify.
+ *
+ * This is a convenience wrapper around the `EntityPlayer.CheckFamiliar` method. Use this helper
+ * function instead so that you do not have to retrieve the `ItemConfigItem` and so that you do not
+ * specify an incorrect RNG object. (The vanilla method is bugged in that it does not increment the
+ * RNG object; see the documentation of the method for more details.)
  *
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
  * to `CacheFlag.CACHE_FAMILIARS`).
  *
- * Note that this function is only meant to be used in special circumstances. For general purpose
- * usage, please use the `checkFamiliarFromCollectibles` helper function instead.
+ * Note that this function is only meant to be used in special circumstances where the familiar
+ * count is completely custom and does not correspond to the amount of collectibles. For the general
+ * case, use the `checkFamiliarFromCollectibles` helper function instead.
+ *
+ * Note that this will spawn familiars with a completely random `InitSeed`. When calculating random
+ * events for this familiar, you should use a data structure that maps familiar `InitSeed` to RNG
+ * objects that are initialized based on the seed from
+ * `EntityPlayer.GetCollectibleRNG(collectibleType)`.
  *
  * @param player The player that owns the familiars.
  * @param collectibleType The collectible type of the collectible associated with this familiar.
- * @param numTargetFamiliars The number of familiars that should exist. This function will add or
- * remove familiars until it matches the target count.
+ * @param targetCount The number of familiars that should exist. This function will add or remove
+ * familiars until it matches the target count.
  * @param familiarVariant The variant of the familiar to spawn or remove.
  * @param familiarSubType Optional. The sub-type of the familiar to spawn or remove. If not
  * specified, it will search for existing familiars of all sub-types, and spawn new familiars with a
  * sub-type of 0.
- * @returns The amount of familiars that were added or removed. For example, the player has 0
- * collectibles and there were 2 familiars, this function would remove the 2 familiars and return
- * -2.
  */
-export declare function checkFamiliar(player: EntityPlayer, collectibleType: int, numTargetFamiliars: int, familiarVariant: int, familiarSubType?: int): int;
+export declare function checkFamiliar(player: EntityPlayer, collectibleType: int, targetCount: int, familiarVariant: int, familiarSubType?: int): void;
 /**
  * Helper function to add and remove familiars based on the amount of associated collectibles that a
- * player has. Use this instead of the `EntityPlayer.CheckFamiliar` method so that the InitSeed of
- * the spawned familiar will be set properly and Box of Friends is handled automatically.
+ * player has.
+ *
+ * Use this helper function instead of invoking the `EntityPlayer.CheckFamiliar` method directly so
+ * that the target count is handled automatically.
  *
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
  * to `CacheFlag.CACHE_FAMILIARS`).
@@ -37,15 +44,17 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: int
  * Manual). If you instead need to have a custom amount of familiars, use the `checkFamiliars`
  * function instead.
  *
+ * Note that this will spawn familiars with a completely random `InitSeed`. When calculating random
+ * events for this familiar, you should use a data structure that maps familiar `InitSeed` to RNG
+ * objects that are initialized based on the seed from
+ * `EntityPlayer.GetCollectibleRNG(collectibleType)`.
+ *
  * @param player The player that owns the familiars and collectibles.
  * @param collectibleType The collectible type of the collectible associated with this familiar.
  * @param familiarVariant The variant of the familiar to spawn or remove.
  * @param familiarSubType Optional. The sub-type of the familiar to spawn or remove. If not
  * specified, it will search for existing familiars of all sub-types, and spawn new familiars with a
  * sub-type of 0.
- * @returns The amount of familiars that were added or removed. For example, the player has 0
- * collectibles and there were 2 familiars, this function would remove the 2 familiars and return
- * -2.
  */
-export declare function checkFamiliarFromCollectibles(player: EntityPlayer, collectibleType: int, familiarVariant: int, familiarSubType?: int): int;
+export declare function checkFamiliarFromCollectibles(player: EntityPlayer, collectibleType: int, familiarVariant: int, familiarSubType?: int): void;
 export declare function isFamiliarThatShootsPlayerTears(familiar: EntityFamiliar): boolean;

package/dist/functions/familiars.lua

@@ -1,64 +1,29 @@
-local ____lualib = require("lualib_bundle")
-local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____cachedClasses = require("cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
 local ____familiarsThatShootPlayerTearsSet = require("sets.familiarsThatShootPlayerTearsSet")
 local FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET = ____familiarsThatShootPlayerTearsSet.FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET
-local ____array = require("functions.array")
-local copyArray = ____array.copyArray
-local ____entity = require("functions.entity")
-local removeEntities = ____entity.removeEntities
-local ____entitySpecific = require("functions.entitySpecific")
-local getFamiliars = ____entitySpecific.getFamiliars
-local spawnFamiliarWithSeed = ____entitySpecific.spawnFamiliarWithSeed
-local ____utils = require("functions.utils")
-local ____repeat = ____utils["repeat"]
-function ____exports.checkFamiliar(self, player, collectibleType, numTargetFamiliars, familiarVariant, familiarSubType)
-    local familiarSubTypeToSearchFor = familiarSubType == nil and -1 or familiarSubType
-    local playerPtrHash = GetPtrHash(player)
-    local familiars = getFamiliars(nil, familiarVariant, familiarSubTypeToSearchFor)
-    local familiarsForThisPlayer = __TS__ArrayFilter(
-        familiars,
-        function(____, familiar) return GetPtrHash(familiar.Player) == playerPtrHash end
-    )
-    if #familiarsForThisPlayer == numTargetFamiliars then
-        return 0
-    end
-    if #familiarsForThisPlayer > numTargetFamiliars then
-        local numFamiliarsToRemove = #familiarsForThisPlayer - numTargetFamiliars
-        local familiarsToRemove = copyArray(nil, familiarsForThisPlayer, numFamiliarsToRemove)
-        removeEntities(nil, familiarsToRemove)
-        return numFamiliarsToRemove * -1
-    end
-    local numFamiliarsToSpawn = numTargetFamiliars - #familiarsForThisPlayer
-    local collectibleRNG = player:GetCollectibleRNG(collectibleType)
-    local familiarSubTypeToUse = familiarSubType == nil and 0 or familiarSubType
-    ____repeat(
-        nil,
-        numFamiliarsToSpawn,
-        function()
-            local seed = collectibleRNG:Next()
-            local familiar = spawnFamiliarWithSeed(
-                nil,
-                familiarVariant,
-                familiarSubTypeToUse,
-                player.Position,
-                seed
-            )
-            familiar.Player = player
-        end
+function ____exports.checkFamiliar(self, player, collectibleType, targetCount, familiarVariant, familiarSubType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    player:CheckFamiliar(
+        familiarVariant,
+        targetCount,
+        RNG(),
+        itemConfigItem,
+        familiarSubType
     )
-    return numFamiliarsToSpawn
 end
 function ____exports.checkFamiliarFromCollectibles(self, player, collectibleType, familiarVariant, familiarSubType)
     local numCollectibles = player:GetCollectibleNum(collectibleType)
     local effects = player:GetEffects()
     local numCollectibleEffects = effects:GetCollectibleEffectNum(collectibleType)
-    local numTargetFamiliars = numCollectibles + numCollectibleEffects
-    return ____exports.checkFamiliar(
+    local targetCount = numCollectibles + numCollectibleEffects
+    ____exports.checkFamiliar(
         nil,
         player,
         collectibleType,
-        numTargetFamiliars,
+        targetCount,
         familiarVariant,
         familiarSubType
     )

package/dist/functions/log.d.ts

@@ -27,7 +27,7 @@ export declare function logEntityID(this: void, entity: Entity): void;
  */
 export declare function logError(this: void, msg: string): void;
 /** Helper function for printing out every flag that is turned on. Useful when debugging. */
-export declare function logFlags(this: void, flags: int, flagEnum?: LuaTable, description?: string): void;
+export declare function logFlags(this: void, flags: int, flagEnum?: LuaTable<AnyNotNil, unknown>, description?: string): void;
 /**
  * Helper function for printing out every game state flag that is turned on. Useful when debugging.
  */

package/dist/functions/serialization.d.ts

@@ -1,12 +1,11 @@
 import { SerializationType } from "../enums/SerializationType";
-import { SerializableIsaacAPIClass } from "../types/private/SerializableIsaacAPIClass";
 import { SerializedIsaacAPIClass } from "../types/private/SerializedIsaacAPIClass";
-export declare function copyIsaacAPIClass(isaacAPIClass: SerializableIsaacAPIClass, serializationType: SerializationType): unknown;
+export declare function copyIsaacAPIClass(isaacAPIClass: unknown, serializationType: SerializationType): unknown;
 /**
- * Deserialization is a special case, so we make a dedicated function for this. There is no need for
- * a "serializeIsaacAPIClass" function because the "copyIsaacAPIClass" function can handles all
- * serialization types.
+ * Deserialization is a special case, so we make a dedicated function for this.
+ *
+ * There is no need for a corresponding "serializeIsaacAPIClass" function because the
+ * "copyIsaacAPIClass" function can handles all serialization types.
  */
 export declare function deserializeIsaacAPIClass(serializedIsaacAPIClass: SerializedIsaacAPIClass): unknown;
-export declare function isSerializableIsaacAPIClass(object: unknown): object is SerializableIsaacAPIClass;
 export declare function isSerializedIsaacAPIClass(object: unknown): object is SerializedIsaacAPIClass;

package/dist/functions/serialization.lua

@@ -1,13 +1,9 @@
 local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
 local __TS__ObjectEntries = ____lualib.__TS__ObjectEntries
 local __TS__ObjectValues = ____lualib.__TS__ObjectValues
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local ____exports = {}
 local getSerializedTableType
-local ____SerializableIsaacAPIClassType = require("enums.private.SerializableIsaacAPIClassType")
-local SerializableIsaacAPIClassType = ____SerializableIsaacAPIClassType.SerializableIsaacAPIClassType
 local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
 local ____isaacAPIClassTypeToBrand = require("objects.isaacAPIClassTypeToBrand")
@@ -18,35 +14,29 @@ local ____serializedIsaacAPIClassTypeToIdentityFunction = require("objects.seria
 local SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION = ____serializedIsaacAPIClassTypeToIdentityFunction.SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local getIsaacAPIClassType = ____isaacAPIClass.getIsaacAPIClassType
-local ____utils = require("functions.utils")
-local getEnumValues = ____utils.getEnumValues
 function getSerializedTableType(self, serializedIsaacAPIClass)
     for ____, ____value in ipairs(__TS__ObjectEntries(ISAAC_API_CLASS_TYPE_TO_BRAND)) do
-        local serializableIsaacAPIClassType = ____value[1]
+        local copyableIsaacAPIClassType = ____value[1]
         local serializationBrand = ____value[2]
         if serializedIsaacAPIClass[serializationBrand] ~= nil then
-            return serializableIsaacAPIClassType
+            return copyableIsaacAPIClassType
         end
     end
     return nil
 end
-local SERIALIZABLE_ISAAC_API_CLASS_TYPES_SET = __TS__New(
-    Set,
-    getEnumValues(nil, SerializableIsaacAPIClassType)
-)
 function ____exports.copyIsaacAPIClass(self, isaacAPIClass, serializationType)
     local objectType = type(isaacAPIClass)
     if objectType ~= "userdata" then
-        error("Failed to serialize an Isaac API class since the provided object was of type: " .. objectType)
+        error("Failed to copy an Isaac API class since the provided object was of type: " .. objectType)
     end
     local isaacAPIClassType = getIsaacAPIClassType(nil, isaacAPIClass)
     if isaacAPIClassType == nil then
-        error("Failed to serialize an Isaac API class due to it not having a class type.")
+        error("Failed to copy an Isaac API class since it does not have a class type.")
     end
-    local serializableIsaacAPIClassType = isaacAPIClassType
-    local copyFunction = ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION[serializableIsaacAPIClassType]
+    local copyableIsaacAPIClassType = isaacAPIClassType
+    local copyFunction = ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION[copyableIsaacAPIClassType]
     if copyFunction == nil then
-        error(("Failed to copy Isaac API class \"" .. serializableIsaacAPIClassType) .. "\" since there is not a defined copy function for this class type.")
+        error(("Failed to copy Isaac API class \"" .. copyableIsaacAPIClassType) .. "\" since there is not a defined copy function for this class type.")
     end
     return copyFunction(nil, isaacAPIClass, serializationType)
 end
@@ -55,23 +45,16 @@ function ____exports.deserializeIsaacAPIClass(self, serializedIsaacAPIClass)
     if objectType ~= "table" then
         error("Failed to deserialize an Isaac API class since the provided object was of type: " .. objectType)
     end
-    local serializableIsaacAPIClassType = getSerializedTableType(nil, serializedIsaacAPIClass)
-    if serializableIsaacAPIClassType == nil then
+    local copyableIsaacAPIClassType = getSerializedTableType(nil, serializedIsaacAPIClass)
+    if copyableIsaacAPIClassType == nil then
         error("Failed to deserialize an API class since a valid class type brand was not found.")
     end
-    local copyFunction = ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION[serializableIsaacAPIClassType]
+    local copyFunction = ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION[copyableIsaacAPIClassType]
     if copyFunction == nil then
-        error(("Failed to deserialize Isaac API class \"" .. serializableIsaacAPIClassType) .. "\" since there is not a defined copy function for this class type.")
+        error(("Failed to deserialize Isaac API class \"" .. copyableIsaacAPIClassType) .. "\" since there is not a defined copy function for this class type.")
     end
     return copyFunction(nil, serializedIsaacAPIClass, SerializationType.DESERIALIZE)
 end
-function ____exports.isSerializableIsaacAPIClass(self, object)
-    local classType = getIsaacAPIClassType(nil, object)
-    if classType == nil then
-        return false
-    end
-    return SERIALIZABLE_ISAAC_API_CLASS_TYPES_SET:has(classType)
-end
 function ____exports.isSerializedIsaacAPIClass(self, object)
     local identityFunctions = __TS__ObjectValues(SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION)
     return __TS__ArraySome(

package/dist/functions/table.d.ts

@@ -33,4 +33,4 @@ export declare function getStringsFromTable(table: LuaTable<string, unknown>, ob
  * This function is variadic, meaning that you can specify as many arguments as you want to check
  * for.
  */
-export declare function tableHasKeys(table: LuaTable, ...keys: string[]): boolean;
+export declare function tableHasKeys(table: LuaTable<AnyNotNil, unknown>, ...keys: string[]): boolean;

package/dist/functions/tstlClass.d.ts

@@ -1,11 +1,16 @@
 import { TSTLClass } from "../types/private/TSTLClass";
 /**
- * TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys.
- *
- * For the purposes of this function, TSTL Maps, Sets, WeakMaps, and WeakSets do not count as TSTL
- * classes, because this function is intended to detect user-defined classes.
+ * Returns whether or not this is a class that is provided by the `isaacscript-common` library, such
+ * as a `DefaultMap`.
  */
-export declare function isTSTLClass(object: unknown): object is TSTLClass;
+export declare function isIsaacScriptCommonClass(object: unknown): boolean;
+/** TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys. */
+export declare function isUserDefinedTSTLClass(object: unknown): object is TSTLClass;
+/**
+ * Returns whether or not this is a class that is provided as part of the TypeScriptToLua
+ * transpiler, such as a `Map` or a `Set`.
+ */
+export declare function isVanillaTSTLClass(object: unknown): boolean;
 /**
  * Initializes a new TypeScriptToLua class in the situation where you do not know what kind of class
  * it is. This function requires that you provide an instantiated class of the same type, as it will

package/dist/functions/tstlClass.lua

@@ -1,12 +1,17 @@
 local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
-local Map = ____lualib.Map
 local __TS__InstanceOf = ____lualib.__TS__InstanceOf
+local Map = ____lualib.Map
 local WeakMap = ____lualib.WeakMap
 local WeakSet = ____lualib.WeakSet
 local ____exports = {}
 local newTSTLClassFromMetatable
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+function ____exports.isVanillaTSTLClass(self, object)
+    return __TS__InstanceOf(object, Map) or __TS__InstanceOf(object, Set) or __TS__InstanceOf(object, WeakMap) or __TS__InstanceOf(object, WeakSet)
+end
 function newTSTLClassFromMetatable(self, metatable)
     local newClass = {}
     local newClassMetatable = setmetatable(newClass, metatable.constructor.prototype)
@@ -14,8 +19,11 @@ function newTSTLClassFromMetatable(self, metatable)
     return newClass
 end
 local TSTL_CLASS_METATABLE_KEYS = __TS__New(Set, {"____constructor", "__index", "constructor"})
-function ____exports.isTSTLClass(self, object)
-    if __TS__InstanceOf(object, Map) or __TS__InstanceOf(object, Set) or __TS__InstanceOf(object, WeakMap) or __TS__InstanceOf(object, WeakSet) then
+function ____exports.isIsaacScriptCommonClass(self, object)
+    return __TS__InstanceOf(object, DefaultMap)
+end
+function ____exports.isUserDefinedTSTLClass(self, object)
+    if ____exports.isVanillaTSTLClass(nil, object) or ____exports.isIsaacScriptCommonClass(nil, object) then
         return false
     end
     local objectType = type(object)

package/dist/functions/utils.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
-/// <reference types="typescript-to-lua/language-extensions" />
 /**
  * Helper function to get type safety on a switch statement.
  *
@@ -74,7 +73,7 @@ export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
  * Helper function to log what is happening in functions that recursively move through nested data
  * structures.
  */
-export declare function getTraversalDescription(key: AnyNotNil, traversalDescription: string): string;
+export declare function getTraversalDescription(key: unknown, traversalDescription: string): string;
 /**
  * Converts a hex string like "#33aa33" to a KColor object.
  *

package/dist/objects/isaacAPIClassTypeToBrand.d.ts

@@ -1,5 +1,5 @@
-import { SerializableIsaacAPIClassType } from "../enums/private/SerializableIsaacAPIClassType";
+import { CopyableIsaacAPIClassType } from "../enums/private/CopyableIsaacAPIClassType";
 import { SerializationBrand } from "../enums/private/SerializationBrand";
 export declare const ISAAC_API_CLASS_TYPE_TO_BRAND: {
-    readonly [key in SerializableIsaacAPIClassType]: SerializationBrand;
+    readonly [key in CopyableIsaacAPIClassType]: SerializationBrand;
 };

package/dist/objects/isaacAPIClassTypeToBrand.lua

@@ -1,8 +1,8 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local ____SerializableIsaacAPIClassType = require("enums.private.SerializableIsaacAPIClassType")
-local SerializableIsaacAPIClassType = ____SerializableIsaacAPIClassType.SerializableIsaacAPIClassType
+local ____CopyableIsaacAPIClassType = require("enums.private.CopyableIsaacAPIClassType")
+local CopyableIsaacAPIClassType = ____CopyableIsaacAPIClassType.CopyableIsaacAPIClassType
 local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
-____exports.ISAAC_API_CLASS_TYPE_TO_BRAND = {[SerializableIsaacAPIClassType.COLOR] = SerializationBrand.COLOR, [SerializableIsaacAPIClassType.KCOLOR] = SerializationBrand.KCOLOR, [SerializableIsaacAPIClassType.RNG] = SerializationBrand.RNG, [SerializableIsaacAPIClassType.VECTOR] = SerializationBrand.VECTOR}
+____exports.ISAAC_API_CLASS_TYPE_TO_BRAND = {[CopyableIsaacAPIClassType.COLOR] = SerializationBrand.COLOR, [CopyableIsaacAPIClassType.KCOLOR] = SerializationBrand.KCOLOR, [CopyableIsaacAPIClassType.RNG] = SerializationBrand.RNG, [CopyableIsaacAPIClassType.VECTOR] = SerializationBrand.VECTOR}
 return ____exports

package/dist/objects/isaacAPIClassTypeToCopyFunction.d.ts

@@ -1,5 +1,5 @@
-import { SerializableIsaacAPIClassType } from "../enums/private/SerializableIsaacAPIClassType";
+import { CopyableIsaacAPIClassType } from "../enums/private/CopyableIsaacAPIClassType";
 import { SerializationType } from "../enums/SerializationType";
 export declare const ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION: {
-    readonly [key in SerializableIsaacAPIClassType]: (object: unknown, serializationType: SerializationType) => boolean;
+    readonly [key in CopyableIsaacAPIClassType]: (object: unknown, serializationType: SerializationType) => boolean;
 };

package/dist/objects/isaacAPIClassTypeToCopyFunction.lua

@@ -1,7 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local ____SerializableIsaacAPIClassType = require("enums.private.SerializableIsaacAPIClassType")
-local SerializableIsaacAPIClassType = ____SerializableIsaacAPIClassType.SerializableIsaacAPIClassType
+local ____CopyableIsaacAPIClassType = require("enums.private.CopyableIsaacAPIClassType")
+local CopyableIsaacAPIClassType = ____CopyableIsaacAPIClassType.CopyableIsaacAPIClassType
 local ____color = require("functions.color")
 local copyColor = ____color.copyColor
 local ____kColor = require("functions.kColor")
@@ -10,5 +10,5 @@ local ____rng = require("functions.rng")
 local copyRNG = ____rng.copyRNG
 local ____vector = require("functions.vector")
 local copyVector = ____vector.copyVector
-____exports.ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION = {[SerializableIsaacAPIClassType.COLOR] = copyColor, [SerializableIsaacAPIClassType.KCOLOR] = copyKColor, [SerializableIsaacAPIClassType.RNG] = copyRNG, [SerializableIsaacAPIClassType.VECTOR] = copyVector}
+____exports.ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION = {[CopyableIsaacAPIClassType.COLOR] = copyColor, [CopyableIsaacAPIClassType.KCOLOR] = copyKColor, [CopyableIsaacAPIClassType.RNG] = copyRNG, [CopyableIsaacAPIClassType.VECTOR] = copyVector}
 return ____exports

package/dist/objects/serializedIsaacAPIClassTypeToIdentityFunction.d.ts

@@ -1,4 +1,4 @@
-import { SerializableIsaacAPIClassType } from "../enums/private/SerializableIsaacAPIClassType";
+import { CopyableIsaacAPIClassType } from "../enums/private/CopyableIsaacAPIClassType";
 export declare const SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION: {
-    readonly [key in SerializableIsaacAPIClassType]: (object: unknown) => boolean;
+    readonly [key in CopyableIsaacAPIClassType]: (object: unknown) => boolean;
 };

package/dist/objects/serializedIsaacAPIClassTypeToIdentityFunction.lua

@@ -1,7 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local ____SerializableIsaacAPIClassType = require("enums.private.SerializableIsaacAPIClassType")
-local SerializableIsaacAPIClassType = ____SerializableIsaacAPIClassType.SerializableIsaacAPIClassType
+local ____CopyableIsaacAPIClassType = require("enums.private.CopyableIsaacAPIClassType")
+local CopyableIsaacAPIClassType = ____CopyableIsaacAPIClassType.CopyableIsaacAPIClassType
 local ____color = require("functions.color")
 local isSerializedColor = ____color.isSerializedColor
 local ____kColor = require("functions.kColor")
@@ -10,5 +10,5 @@ local ____rng = require("functions.rng")
 local isSerializedRNG = ____rng.isSerializedRNG
 local ____vector = require("functions.vector")
 local isSerializedVector = ____vector.isSerializedVector
-____exports.SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION = {[SerializableIsaacAPIClassType.COLOR] = isSerializedColor, [SerializableIsaacAPIClassType.KCOLOR] = isSerializedKColor, [SerializableIsaacAPIClassType.RNG] = isSerializedRNG, [SerializableIsaacAPIClassType.VECTOR] = isSerializedVector}
+____exports.SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION = {[CopyableIsaacAPIClassType.COLOR] = isSerializedColor, [CopyableIsaacAPIClassType.KCOLOR] = isSerializedKColor, [CopyableIsaacAPIClassType.RNG] = isSerializedRNG, [CopyableIsaacAPIClassType.VECTOR] = isSerializedVector}
 return ____exports

package/dist/types/private/SaveData.d.ts

@@ -1,4 +1,8 @@
 import { Primitive } from "../Primitive";
+/**
+ * I don't know how to create a recursive type definition for only primitive values. For now, this
+ * is typed as "unknown", which provides no type safety.
+ */
 declare type Serializable = Primitive | unknown;
 /**
  * Each sub-object of save data has a string as a key, without arbitrary data as a value. However,

package/dist/types/private/TSTLClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
-export declare type TSTLClass = LuaTable<string, unknown> & {
+export declare type TSTLClass = LuaTable<AnyNotNil, unknown> & {
     __tstlClassBrand: unknown;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.249",
+  "version": "1.2.252",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,8 +25,8 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.388",
-    "isaacscript-lint": "^1.0.98",
+    "isaac-typescript-definitions": "^1.0.389",
+    "isaacscript-lint": "^1.0.99",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",
     "typescript": "4.6.3",