isaacscript-common 14.1.2 → 14.2.0

package/dist/src/functions/deepCopy.lua

@@ -9,14 +9,12 @@ local ____exports = {}
 local deepCopyTable, deepCopyDefaultMap, getNewDefaultMap, deepCopyMap, deepCopySet, deepCopyTSTLClass, deepCopyArray, deepCopyNormalLuaTable, getCopiedEntries, checkMetatable, deepCopyUserdata
 local ____DefaultMap = require("src.classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
-local ____SerializationBrand = require("src.enums.private.SerializationBrand")
+local ____SerializationBrand = require("src.enums.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____SerializationType = require("src.enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
 local ____constants = require("src.features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
-local ____serializationBrands = require("src.features.saveDataManager.serializationBrands")
-local isSerializationBrand = ____serializationBrands.isSerializationBrand
 local ____array = require("src.functions.array")
 local isArray = ____array.isArray
 local ____isaacAPIClass = require("src.functions.isaacAPIClass")
@@ -27,6 +25,7 @@ local ____serialization = require("src.functions.serialization")
 local copyIsaacAPIClass = ____serialization.copyIsaacAPIClass
 local deserializeIsaacAPIClass = ____serialization.deserializeIsaacAPIClass
 local isCopyableIsaacAPIClass = ____serialization.isCopyableIsaacAPIClass
+local isSerializationBrand = ____serialization.isSerializationBrand
 local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
 local serializeIsaacAPIClass = ____serialization.serializeIsaacAPIClass
 local ____tstlClass = require("src.functions.tstlClass")
@@ -34,7 +33,6 @@ local getTSTLClassName = ____tstlClass.getTSTLClassName
 local isDefaultMap = ____tstlClass.isDefaultMap
 local isTSTLMap = ____tstlClass.isTSTLMap
 local isTSTLSet = ____tstlClass.isTSTLSet
-local isUserDefinedTSTLClass = ____tstlClass.isUserDefinedTSTLClass
 local newTSTLClass = ____tstlClass.newTSTLClass
 local ____types = require("src.functions.types")
 local asString = ____types.asString
@@ -71,17 +69,25 @@ local twoDimensionalSort = ____utils.twoDimensionalSort
 -- @param serializationType Optional. Has 3 possible values. Can copy objects as-is, or can
 -- serialize objects to Lua tables, or can deserialize Lua tables to
 -- objects. Default is `SerializationType.NONE`.
--- @param traversalDescription Optional. Used to track the current key that we are operating on.
--- Default is an empty string.
+-- @param traversalDescription Optional. Used to track the current key that we are operating on for
+-- debugging purposes. Default is an empty string.
+-- @param classConstructors Optional. A Lua table that maps the name of a user-defined TSTL class to
+-- its corresponding constructor. If the `deepCopy` function finds any
+-- user-defined TSTL classes when recursively iterating through the given
+-- object, it will use this map to instantiate a new class. Default is an
+-- empty Lua table.
 -- @param insideMap Optional. Tracks whether or not the deep copy function is in the process of
 -- recursively copying a TSTL Map. Default is false.
-function ____exports.deepCopy(self, value, serializationType, traversalDescription, insideMap)
+function ____exports.deepCopy(self, value, serializationType, traversalDescription, classConstructors, insideMap)
     if serializationType == nil then
         serializationType = SerializationType.NONE
     end
     if traversalDescription == nil then
         traversalDescription = ""
     end
+    if classConstructors == nil then
+        classConstructors = {}
+    end
     if insideMap == nil then
         insideMap = false
     end
@@ -125,6 +131,7 @@ function ____exports.deepCopy(self, value, serializationType, traversalDescripti
                     luaMap,
                     serializationType,
                     traversalDescription,
+                    classConstructors,
                     insideMap
                 )
             end
@@ -137,13 +144,14 @@ function ____exports.deepCopy(self, value, serializationType, traversalDescripti
         end
     until true
 end
-function deepCopyTable(self, luaMap, serializationType, traversalDescription, insideMap)
+function deepCopyTable(self, luaMap, serializationType, traversalDescription, classConstructors, insideMap)
     if isDefaultMap(nil, luaMap) or luaMap[SerializationBrand.DEFAULT_MAP] ~= nil then
         return deepCopyDefaultMap(
             nil,
             luaMap,
             serializationType,
             traversalDescription,
+            classConstructors,
             insideMap
         )
     end
@@ -153,6 +161,7 @@ function deepCopyTable(self, luaMap, serializationType, traversalDescription, in
             luaMap,
             serializationType,
             traversalDescription,
+            classConstructors,
             insideMap
         )
     end
@@ -162,6 +171,7 @@ function deepCopyTable(self, luaMap, serializationType, traversalDescription, in
             luaMap,
             serializationType,
             traversalDescription,
+            classConstructors,
             insideMap
         )
     end
@@ -172,12 +182,13 @@ function deepCopyTable(self, luaMap, serializationType, traversalDescription, in
     if className == "WeakSet" then
         error("The deep copy function does not support copying the \"WeakSet\" class for: " .. traversalDescription)
     end
-    if isUserDefinedTSTLClass(nil, luaMap) then
+    if className ~= nil or luaMap[SerializationBrand.TSTL_CLASS] ~= nil then
         return deepCopyTSTLClass(
             nil,
             luaMap,
             serializationType,
             traversalDescription,
+            classConstructors,
             insideMap
         )
     end
@@ -191,6 +202,7 @@ function deepCopyTable(self, luaMap, serializationType, traversalDescription, in
             luaMap,
             serializationType,
             traversalDescription,
+            classConstructors,
             insideMap
         )
     end
@@ -199,10 +211,11 @@ function deepCopyTable(self, luaMap, serializationType, traversalDescription, in
         luaMap,
         serializationType,
         traversalDescription,
+        classConstructors,
         insideMap
     )
 end
-function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescription, insideMap)
+function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescription, classConstructors, insideMap)
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "deepCopy is copying a DefaultMap.")
     end
@@ -222,6 +235,7 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
                 defaultMap,
                 serializationType,
                 traversalDescription,
+                classConstructors,
                 insideMap
             )
         end
@@ -239,6 +253,7 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
         defaultMap,
         serializationType,
         traversalDescription,
+        classConstructors,
         insideMap
     )
     local entries = ____getCopiedEntries_result_1.entries
@@ -284,18 +299,18 @@ function getNewDefaultMap(self, defaultMap, serializationType, traversalDescript
         if ____cond35 then
             do
                 if isDefaultMap(nil, defaultMap) then
-                    error(("The deep copy function failed to deserialize a default map of \"" .. traversalDescription) .. "\", since it was not a Lua table.")
+                    error(("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)
+                    error((("Failed to deserialize a default map of \"" .. traversalDescription) .. "\", since there was no serialization brand of: ") .. SerializationBrand.DEFAULT_MAP_VALUE)
                 end
                 return __TS__New(DefaultMap, defaultMapValue)
             end
         end
     until true
 end
-function deepCopyMap(self, map, serializationType, traversalDescription, insideMap)
+function deepCopyMap(self, map, serializationType, traversalDescription, classConstructors, insideMap)
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "deepCopy is copying a Map.")
     end
@@ -312,6 +327,7 @@ function deepCopyMap(self, map, serializationType, traversalDescription, insideM
         map,
         serializationType,
         traversalDescription,
+        classConstructors,
         insideMap
     )
     local entries = ____getCopiedEntries_result_2.entries
@@ -335,7 +351,7 @@ function deepCopyMap(self, map, serializationType, traversalDescription, insideM
     insideMap = false
     return newMap
 end
-function deepCopySet(self, set, serializationType, traversalDescription, insideMap)
+function deepCopySet(self, set, serializationType, traversalDescription, classConstructors, insideMap)
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "deepCopy is copying a Set.")
     end
@@ -351,6 +367,7 @@ function deepCopySet(self, set, serializationType, traversalDescription, insideM
         set,
         serializationType,
         traversalDescription,
+        classConstructors,
         insideMap
     )
     local entries = ____getCopiedEntries_result_3.entries
@@ -372,21 +389,53 @@ function deepCopySet(self, set, serializationType, traversalDescription, insideM
     end
     return newSet
 end
-function deepCopyTSTLClass(self, tstlClass, serializationType, traversalDescription, insideMap)
+function deepCopyTSTLClass(self, tstlClass, serializationType, traversalDescription, classConstructors, insideMap)
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "deepCopy is copying a TSTL class.")
     end
     local newClass
-    if serializationType == SerializationType.SERIALIZE then
-        newClass = {}
-    else
-        newClass = newTSTLClass(nil, tstlClass)
-    end
+    repeat
+        local ____switch65 = serializationType
+        local ____cond65 = ____switch65 == SerializationType.NONE
+        if ____cond65 then
+            do
+                newClass = newTSTLClass(nil, tstlClass)
+                break
+            end
+        end
+        ____cond65 = ____cond65 or ____switch65 == SerializationType.SERIALIZE
+        if ____cond65 then
+            do
+                newClass = {}
+                local tstlClassName = getTSTLClassName(nil, tstlClass)
+                if tstlClassName ~= nil then
+                    newClass[SerializationBrand.TSTL_CLASS] = tstlClassName
+                end
+                break
+            end
+        end
+        ____cond65 = ____cond65 or ____switch65 == SerializationType.DESERIALIZE
+        if ____cond65 then
+            do
+                local tstlClassName = tstlClass[SerializationBrand.TSTL_CLASS]
+                if tstlClassName == nil then
+                    error("Failed to deserialize a TSTL class since the brand did not contain the class name.")
+                end
+                local classConstructor = classConstructors[tstlClassName]
+                if classConstructor == nil then
+                    error(("Failed to deserialize a TSTL class since there was no constructor registered for a class name of \"" .. tstlClassName) .. "\". If this mod is using the save data manager, it must register the class constructor with the \"saveDataManagerRegisterClass\" method.")
+                end
+                newClass = __TS__New(classConstructor)
+            end
+            break
+        end
+    until true
     local ____getCopiedEntries_result_4 = getCopiedEntries(
         nil,
         tstlClass,
         serializationType,
         traversalDescription,
+        classConstructors,
         insideMap
     )
     local entries = ____getCopiedEntries_result_4.entries
@@ -401,7 +450,7 @@ function deepCopyTSTLClass(self, tstlClass, serializationType, traversalDescript
     end
     return newClass
 end
-function deepCopyArray(self, array, serializationType, traversalDescription, insideMap)
+function deepCopyArray(self, array, serializationType, traversalDescription, classConstructors, insideMap)
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "deepCopy is copying an array.")
     end
@@ -412,13 +461,14 @@ function deepCopyArray(self, array, serializationType, traversalDescription, ins
             value,
             serializationType,
             traversalDescription,
+            classConstructors,
             insideMap
         )
         newArray[#newArray + 1] = newValue
     end
     return newArray
 end
-function deepCopyNormalLuaTable(self, luaMap, serializationType, traversalDescription, insideMap)
+function deepCopyNormalLuaTable(self, luaMap, serializationType, traversalDescription, classConstructors, insideMap)
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "deepCopy is copying a normal Lua table.")
     end
@@ -428,6 +478,7 @@ function deepCopyNormalLuaTable(self, luaMap, serializationType, traversalDescri
         luaMap,
         serializationType,
         traversalDescription,
+        classConstructors,
         insideMap
     )
     local entries = ____getCopiedEntries_result_5.entries
@@ -442,7 +493,7 @@ function deepCopyNormalLuaTable(self, luaMap, serializationType, traversalDescri
     end
     return newTable
 end
-function getCopiedEntries(self, object, serializationType, traversalDescription, insideMap)
+function getCopiedEntries(self, object, serializationType, traversalDescription, classConstructors, insideMap)
     local entries = {}
     if isTSTLMap(nil, object) or isTSTLSet(nil, object) or isDefaultMap(nil, object) then
         for ____, ____value in __TS__Iterator(object:entries()) do
@@ -481,7 +532,7 @@ function getCopiedEntries(self, object, serializationType, traversalDescription,
         local value = ____value[2]
         do
             if isSerializationBrand(nil, key) then
-                goto __continue88
+                goto __continue93
             end
             traversalDescription = getTraversalDescription(nil, key, traversalDescription)
             local newValue = ____exports.deepCopy(
@@ -489,6 +540,7 @@ function getCopiedEntries(self, object, serializationType, traversalDescription,
                 value,
                 serializationType,
                 traversalDescription,
+                classConstructors,
                 insideMap
             )
             local keyToUse = key
@@ -503,7 +555,7 @@ function getCopiedEntries(self, object, serializationType, traversalDescription,
             end
             copiedEntries[#copiedEntries + 1] = {keyToUse, newValue}
         end
-        ::__continue88::
+        ::__continue93::
     end
     return {entries = copiedEntries, convertedNumberKeysToStrings = convertNumberKeysToStrings}
 end
@@ -524,21 +576,21 @@ function deepCopyUserdata(self, value, serializationType, traversalDescription)
         error((("The deep copy function does not support serializing \"" .. traversalDescription) .. "\", since it is an Isaac API class of type: ") .. classType)
     end
     repeat
-        local ____switch99 = serializationType
-        local ____cond99 = ____switch99 == SerializationType.NONE
-        if ____cond99 then
+        local ____switch104 = serializationType
+        local ____cond104 = ____switch104 == SerializationType.NONE
+        if ____cond104 then
             do
                 return copyIsaacAPIClass(nil, value)
             end
         end
-        ____cond99 = ____cond99 or ____switch99 == SerializationType.SERIALIZE
-        if ____cond99 then
+        ____cond104 = ____cond104 or ____switch104 == SerializationType.SERIALIZE
+        if ____cond104 then
             do
                 return serializeIsaacAPIClass(nil, value)
             end
         end
-        ____cond99 = ____cond99 or ____switch99 == SerializationType.DESERIALIZE
-        if ____cond99 then
+        ____cond104 = ____cond104 or ____switch104 == SerializationType.DESERIALIZE
+        if ____cond104 then
             do
                 error(("The deep copy function can not deserialize \"" .. traversalDescription) .. "\", since it is userdata.")
             end

package/dist/src/functions/deepCopyTests.lua

@@ -7,7 +7,7 @@ local ____exports = {}
 local copiedObjectIsTable, copiedObjectHasKeyAndValueString, copiedTableHasKeyAndValueNumber, copiedTableDoesNotCoerceTypes, copiedObjectHasNoReferencesForPrimitivesForward, copiedObjectHasNoReferencesForPrimitivesBackward, copiedObjectHasNoReferencesForArray, copiedObjectHasChildObject, copiedMapIsMap, copiedMapHasValue, copiedSetIsSet, copiedSetHasValue, copiedMapHasChildMap, copiedDefaultMapHasChildDefaultMap, copiedDefaultMapHasBrand, copiedSerializedMapHasStringKey, copiedSerializedMapHasNumberKey, copiedSerializedDefaultMapHasStringKey, copiedSerializedDefaultMapHasNumberKey
 local ____DefaultMap = require("src.classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
-local ____SerializationBrand = require("src.enums.private.SerializationBrand")
+local ____SerializationBrand = require("src.enums.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____SerializationType = require("src.enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType

package/dist/src/functions/initArray.d.ts

@@ -2,10 +2,10 @@
 /**
  * Initializes an array with all of the elements containing the specified default value.
  *
- * If the provided default value is not a boolean, number, or string, then it will be copied with
- * the `deepCopy` function before adding it to the new array. In this way, you can initialize an
- * array of arrays, or an array of maps, and so on. (If the `deepCopy` function was not used, then
- * all of the array elements would just be references to the same underlying data structure.)
+ * The provided default value will be copied with the `deepCopy` function before adding it to the
+ * new array. Thus, you can initialize an array of arrays, or an array of maps, and so on. (If the
+ * `deepCopy` function was not used, then all of the array elements would just be references to the
+ * same underlying data structure.)
  *
  * For example:
  *

package/dist/src/functions/initArray.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"initArray.d.ts","sourceRoot":"","sources":["../../../src/functions/initArray.ts"],"names":[],"mappings":";AAIA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,EAAE,CAY5D"}
+{"version":3,"file":"initArray.d.ts","sourceRoot":"","sources":["../../../src/functions/initArray.ts"],"names":[],"mappings":";AAGA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,EAAE,CAQ5D"}

package/dist/src/functions/initArray.lua

@@ -1,16 +1,14 @@
 local ____exports = {}
 local ____deepCopy = require("src.functions.deepCopy")
 local deepCopy = ____deepCopy.deepCopy
-local ____types = require("src.functions.types")
-local isPrimitive = ____types.isPrimitive
 local ____utils = require("src.functions.utils")
 local ____repeat = ____utils["repeat"]
 --- Initializes an array with all of the elements containing the specified default value.
 -- 
--- If the provided default value is not a boolean, number, or string, then it will be copied with
--- the `deepCopy` function before adding it to the new array. In this way, you can initialize an
--- array of arrays, or an array of maps, and so on. (If the `deepCopy` function was not used, then
--- all of the array elements would just be references to the same underlying data structure.)
+-- The provided default value will be copied with the `deepCopy` function before adding it to the
+-- new array. Thus, you can initialize an array of arrays, or an array of maps, and so on. (If the
+-- `deepCopy` function was not used, then all of the array elements would just be references to the
+-- same underlying data structure.)
 -- 
 -- For example:
 -- 
@@ -24,12 +22,8 @@ function ____exports.initArray(self, defaultValue, size)
         nil,
         size,
         function()
-            if isPrimitive(nil, defaultValue) then
-                array[#array + 1] = defaultValue
-            else
-                local copy = deepCopy(nil, defaultValue)
-                array[#array + 1] = copy
-            end
+            local copy = deepCopy(nil, defaultValue)
+            array[#array + 1] = copy
         end
     )
     return array

package/dist/src/functions/jsonRoom.d.ts

@@ -3,11 +3,15 @@ import { JSONEntity, JSONRoom } from "../interfaces/JSONRoomsFile";
 /**
  * Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
  * given JSON room.
+ *
+ * (A JSON room is an XML file converted to JSON so that it can be directly imported into your mod.)
  */
 export declare function getJSONRoomDoorSlotFlags(jsonRoom: JSONRoom): BitFlags<DoorSlotFlag>;
 /**
  * Helper function to find a specific room from an array of JSON rooms.
  *
+ * (A JSON room is an XML file converted to JSON so that it can be directly imported into your mod.)
+ *
  * @param jsonRooms The array of rooms to search through.
  * @param variant The room variant to select. (The room variant can be thought of as the ID of the
  *                room.)
@@ -16,6 +20,8 @@ export declare function getJSONRoomOfVariant(jsonRooms: JSONRoom[] | readonly JS
 /**
  * Helper function to find all of the JSON rooms that match the sub-type provided.
  *
+ * (A JSON room is an XML file converted to JSON so that it can be directly imported into your mod.)
+ *
  * @param jsonRooms The array of rooms to search through.
  * @param subType The sub-type to match.
  */
@@ -23,6 +29,9 @@ export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[] | readonly J
 /**
  * Helper function to get a random JSON entity from an array of JSON entities.
  *
+ * (A JSON entity is an entity inside of a JSON room. A JSON room is an XML file converted to JSON
+ * so that it can be directly imported into your mod.)
+ *
  * Note that this function does not simply choose a random element in the provided array; it will
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers
@@ -37,6 +46,8 @@ export declare function getRandomJSONEntity(jsonEntities: JSONEntity[], seedOrRN
 /**
  * Helper function to get a random JSON room from an array of JSON rooms.
  *
+ * (A JSON room is an XML file converted to JSON so that it can be directly imported into your mod.)
+ *
  * Note that this function does not simply choose a random element in the provided array; it will
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers

package/dist/src/functions/jsonRoom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jsonRoom.d.ts","sourceRoot":"","sources":["../../../src/functions/jsonRoom.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAGb,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAanE;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,QAAQ,GACjB,QAAQ,CAAC,YAAY,CAAC,CAgDxB;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,GAAG,SAAS,CAoBtB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,EAAE,CAMZ;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,UAAU,EAAE,EAC1B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,UAAU,CAoBZ;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,QAAQ,CAiBV"}
+{"version":3,"file":"jsonRoom.d.ts","sourceRoot":"","sources":["../../../src/functions/jsonRoom.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAGb,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAanE;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,QAAQ,GACjB,QAAQ,CAAC,YAAY,CAAC,CAgDxB;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,GAAG,SAAS,CAoBtB;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,EAAE,CAMZ;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,UAAU,EAAE,EAC1B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,UAAU,CAoBZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,QAAQ,CAiBV"}

package/dist/src/functions/jsonRoom.lua

@@ -49,6 +49,8 @@ function getJSONObjectWithChosenWeight(self, jsonOjectArray, chosenWeight)
 end
 --- Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
 -- given JSON room.
+-- 
+-- (A JSON room is an XML file converted to JSON so that it can be directly imported into your mod.)
 function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
     local roomShapeString = jsonRoom["$"].shape
     local roomShapeNumber = tonumber(roomShapeString)
@@ -89,6 +91,8 @@ function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
 end
 --- Helper function to find a specific room from an array of JSON rooms.
 -- 
+-- (A JSON room is an XML file converted to JSON so that it can be directly imported into your mod.)
+-- 
 -- @param jsonRooms The array of rooms to search through.
 -- @param variant The room variant to select. (The room variant can be thought of as the ID of the
 -- room.)
@@ -111,6 +115,8 @@ function ____exports.getJSONRoomOfVariant(self, jsonRooms, variant)
 end
 --- Helper function to find all of the JSON rooms that match the sub-type provided.
 -- 
+-- (A JSON room is an XML file converted to JSON so that it can be directly imported into your mod.)
+-- 
 -- @param jsonRooms The array of rooms to search through.
 -- @param subType The sub-type to match.
 function ____exports.getJSONRoomsOfSubType(self, jsonRooms, subType)
@@ -125,6 +131,9 @@ function ____exports.getJSONRoomsOfSubType(self, jsonRooms, subType)
 end
 --- Helper function to get a random JSON entity from an array of JSON entities.
 -- 
+-- (A JSON entity is an entity inside of a JSON room. A JSON room is an XML file converted to JSON
+-- so that it can be directly imported into your mod.)
+-- 
 -- Note that this function does not simply choose a random element in the provided array; it will
 -- properly account for each room weight using the algorithm from:
 -- https://stackoverflow.com/questions/1761626/weighted-random-numbers
@@ -163,6 +172,8 @@ function ____exports.getRandomJSONEntity(self, jsonEntities, seedOrRNG, verbose)
 end
 --- Helper function to get a random JSON room from an array of JSON rooms.
 -- 
+-- (A JSON room is an XML file converted to JSON so that it can be directly imported into your mod.)
+-- 
 -- Note that this function does not simply choose a random element in the provided array; it will
 -- properly account for each room weight using the algorithm from:
 -- https://stackoverflow.com/questions/1761626/weighted-random-numbers

package/dist/src/functions/kColor.d.ts

@@ -22,8 +22,8 @@ export declare function getRandomKColor(seedOrRNG?: Seed | RNG, alpha?: number):
 /** Helper function to check if something is an instantiated `KColor` object. */
 export declare function isKColor(object: unknown): object is KColor;
 /**
- * Used to determine is the given table is a serialized `KColor` object created by the save data
- * manager and/or the `deepCopy` function.
+ * Used to determine is the given table is a serialized `KColor` object created by the `deepCopy`
+ * function.
  */
 export declare function isSerializedKColor(object: unknown): object is SerializedKColor;
 export declare function kColorEquals(kColor1: KColor, kColor2: KColor): boolean;

package/dist/src/functions/kColor.lua

@@ -1,6 +1,6 @@
 local ____exports = {}
 local OBJECT_NAME
-local ____SerializationBrand = require("src.enums.private.SerializationBrand")
+local ____SerializationBrand = require("src.enums.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____isaacAPIClass = require("src.functions.isaacAPIClass")
 local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
@@ -74,8 +74,8 @@ function ____exports.getRandomKColor(self, seedOrRNG, alpha)
     local b = getRandom(nil, rng)
     return KColor(r, g, b, alpha)
 end
---- Used to determine is the given table is a serialized `KColor` object created by the save data
--- manager and/or the `deepCopy` function.
+--- Used to determine is the given table is a serialized `KColor` object created by the `deepCopy`
+-- function.
 function ____exports.isSerializedKColor(self, object)
     if not isTable(nil, object) then
         return false

package/dist/src/functions/logMisc.d.ts

@@ -44,8 +44,8 @@ export declare function logSet(set: Set<AnyNotNil> | ReadonlySet<AnyNotNil>): vo
 /** Helper function for logging every sound effect that is currently playing. */
 export declare function logSounds(): void;
 /**
- * Helper function for logging every key and value of a table. This is a deep log; the function will
- * recursively call itself if it counters a table within a table.
+ * Helper function for logging every key and value of a Lua table. This is a deep log; the function
+ * will recursively call itself if it counters a table within a table.
  *
  * This function will only work on tables that have string keys (because it logs the keys in order,
  * instead of randomly). It will throw a run-time error if it encounters a non-string key.
@@ -56,6 +56,13 @@ export declare function logTable(luaTable: unknown, parentTables?: number): void
  * will only do a shallow comparison.
  */
 export declare function logTableDifferences<K extends AnyNotNil, V>(table1: LuaMap<K, V>, table2: LuaMap<K, V>): void;
+/**
+ * Helper function to log the keys of a Lua table. This is not a deep log; only the keys of the
+ * top-most table will be logged.
+ *
+ * This function is useful for tables that have recursive references.
+ */
+export declare function logTableKeys(luaTable: unknown): void;
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 export declare function logTearFlags(flags: TearFlag | BitFlags<TearFlag>): void;
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */

package/dist/src/functions/logMisc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logMisc.d.ts","sourceRoot":"","sources":["../../../src/functions/logMisc.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EAKV,cAAc,EAGd,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAmBtC,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,CAG3D;AAED,wBAAgB,mBAAmB,CAAC,gBAAgB,EAAE,eAAe,EAAE,GAAG,IAAI,CAS7E;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAI3C;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAGhD;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAI1C;AAED,4FAA4F;AAC5F,wBAAgB,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,UAAU,EACrD,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAC3B,WAAW,SAAK,GACf,IAAI,CAmBN;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAiBxC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAI9C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,CAkBzC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,CAazD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CA0B3D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAoB1D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,GAC/C,IAAI,CAEN;AAED,sEAAsE;AACtE,wBAAgB,OAAO,IAAI,IAAI,CA2B9B;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAiBrC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAUzE;AAED,gFAAgF;AAChF,wBAAgB,SAAS,IAAI,IAAI,CAQhC;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,YAAY,SAAI,GAAG,IAAI,CA6ClE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,EACxD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,IAAI,CA8BN;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAEvE;AAED,gGAAgG;AAChG,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAEpE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAoBnD;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,IAAI,CAG7D"}
+{"version":3,"file":"logMisc.d.ts","sourceRoot":"","sources":["../../../src/functions/logMisc.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EAKV,cAAc,EAGd,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAmBtC,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,CAG3D;AAED,wBAAgB,mBAAmB,CAAC,gBAAgB,EAAE,eAAe,EAAE,GAAG,IAAI,CAS7E;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAI3C;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAE7E;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAGhD;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAI1C;AAED,4FAA4F;AAC5F,wBAAgB,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,UAAU,EACrD,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAC3B,WAAW,SAAK,GACf,IAAI,CAmBN;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAiBxC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAI9C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,CAkBzC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,CAazD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CA0B3D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAoB1D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,GAC/C,IAAI,CAEN;AAED,sEAAsE;AACtE,wBAAgB,OAAO,IAAI,IAAI,CA2B9B;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAiBrC;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAUzE;AAED,gFAAgF;AAChF,wBAAgB,SAAS,IAAI,IAAI,CAQhC;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,YAAY,SAAI,GAAG,IAAI,CA6ClE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,EACxD,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GACnB,IAAI,CA8BN;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAkBpD;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAEvE;AAED,gGAAgG;AAChG,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAEpE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAoBnD;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,IAAI,CAG7D"}

package/dist/src/functions/logMisc.lua

@@ -374,8 +374,8 @@ function ____exports.logSounds(self)
         end
     end
 end
---- Helper function for logging every key and value of a table. This is a deep log; the function will
--- recursively call itself if it counters a table within a table.
+--- Helper function for logging every key and value of a Lua table. This is a deep log; the function
+-- will recursively call itself if it counters a table within a table.
 -- 
 -- This function will only work on tables that have string keys (because it logs the keys in order,
 -- instead of randomly). It will throw a run-time error if it encounters a non-string key.
@@ -460,6 +460,36 @@ function ____exports.logTableDifferences(self, table1, table2)
         end
     end
 end
+--- Helper function to log the keys of a Lua table. This is not a deep log; only the keys of the
+-- top-most table will be logged.
+-- 
+-- This function is useful for tables that have recursive references.
+function ____exports.logTableKeys(self, luaTable)
+    log(nil, "Printing out the keys of a Lua table:")
+    if not isTable(nil, luaTable) then
+        log(
+            nil,
+            ("  n/a (encountered a variable of type \"" .. __TS__TypeOf(luaTable)) .. "\" instead of a table)"
+        )
+        return
+    end
+    local numElements = 0
+    iterateTableInOrder(
+        nil,
+        luaTable,
+        function(____, key)
+            log(
+                nil,
+                tostring(key)
+            )
+            numElements = numElements + 1
+        end
+    )
+    log(
+        nil,
+        "  The size of the table was: " .. tostring(numElements)
+    )
+end
 --- Helper function for printing out every tear flag that is turned on. Useful when debugging.
 function ____exports.logTearFlags(self, flags)
     ____exports.logFlags(nil, flags, TearFlag, "tear")