isaacscript-common 10.0.1 → 10.0.2

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 10.0.1
+isaacscript-common 10.0.2
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -4268,6 +4268,14 @@ do
         end
     end
 end
+do
+    local ____export = require("lua_modules.isaac-typescript-definitions.dist.src.enums.CopyableIsaacAPIClassType")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("lua_modules.isaac-typescript-definitions.dist.src.enums.CurseID")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -4853,7 +4861,7 @@ return ____exports
 ["lua_modules.isaac-typescript-definitions.dist.package"] = function(...) 
 return {
     name = "isaac-typescript-definitions",
-    version = "7.0.0",
+    version = "7.2.0",
     description = "TypeScript definitions for The Binding of Isaac: Repentance.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",
@@ -10007,7 +10015,7 @@ ____exports.SwingerVariant.SWINGER = 0
 ____exports.SwingerVariant[____exports.SwingerVariant.SWINGER] = "SWINGER"
 ____exports.SwingerVariant.SWINGER_HEAD = 1
 ____exports.SwingerVariant[____exports.SwingerVariant.SWINGER_HEAD] = "SWINGER_HEAD"
-____exports.SwingerVariant.SWINGER_NECK = 2
+____exports.SwingerVariant.SWINGER_NECK = 10
 ____exports.SwingerVariant[____exports.SwingerVariant.SWINGER_NECK] = "SWINGER_NECK"
 --- For `EntityType.DIP` (217).
 ____exports.DipVariant = {}
@@ -11012,6 +11020,17 @@ ____exports.ControllerIndex.CONTROLLER_2 = 2
 ____exports.ControllerIndex[____exports.ControllerIndex.CONTROLLER_2] = "CONTROLLER_2"
 ____exports.ControllerIndex.CONTROLLER_3 = 3
 ____exports.ControllerIndex[____exports.ControllerIndex.CONTROLLER_3] = "CONTROLLER_3"
+return ____exports
+ end,
+["lua_modules.isaac-typescript-definitions.dist.src.enums.CopyableIsaacAPIClassType"] = function(...) 
+local ____exports = {}
+--- An enum containing the Isaac API classes that can be safely copied / serialized.
+____exports.CopyableIsaacAPIClassType = {}
+____exports.CopyableIsaacAPIClassType.BIT_SET_128 = "BitSet128"
+____exports.CopyableIsaacAPIClassType.COLOR = "Color"
+____exports.CopyableIsaacAPIClassType.K_COLOR = "KColor"
+____exports.CopyableIsaacAPIClassType.RNG = "RNG"
+____exports.CopyableIsaacAPIClassType.VECTOR = "Vector"
 return ____exports
  end,
 ["lua_modules.isaac-typescript-definitions.dist.src.enums.CurseID"] = function(...) 
@@ -26888,18 +26907,6 @@ ____exports.SerializationType.SERIALIZE = 1
 ____exports.SerializationType[____exports.SerializationType.SERIALIZE] = "SERIALIZE"
 ____exports.SerializationType.DESERIALIZE = 2
 ____exports.SerializationType[____exports.SerializationType.DESERIALIZE] = "DESERIALIZE"
-return ____exports
- end,
-["src.enums.private.CopyableIsaacAPIClassType"] = function(...) 
-local ____exports = {}
---- - This must match the JSDoc comments for `deepCopy` and `merge`.
--- - This must match the `SerializableIsaacAPIClass` type union.
-____exports.CopyableIsaacAPIClassType = {}
-____exports.CopyableIsaacAPIClassType.BIT_SET_128 = "BitSet128"
-____exports.CopyableIsaacAPIClassType.COLOR = "Color"
-____exports.CopyableIsaacAPIClassType.K_COLOR = "KColor"
-____exports.CopyableIsaacAPIClassType.RNG = "RNG"
-____exports.CopyableIsaacAPIClassType.VECTOR = "Vector"
 return ____exports
  end,
 ["src.features.saveDataManager.saveDataManagerConstants"] = function(...) 
@@ -29619,8 +29626,8 @@ return ____exports
  end,
 ["src.objects.isaacAPIClassTypeToBrand"] = function(...) 
 local ____exports = {}
-local ____CopyableIsaacAPIClassType = require("src.enums.private.CopyableIsaacAPIClassType")
-local CopyableIsaacAPIClassType = ____CopyableIsaacAPIClassType.CopyableIsaacAPIClassType
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local CopyableIsaacAPIClassType = ____isaac_2Dtypescript_2Ddefinitions.CopyableIsaacAPIClassType
 local ____SerializationBrand = require("src.enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 ____exports.ISAAC_API_CLASS_TYPE_TO_BRAND = {
@@ -29833,44 +29840,75 @@ return ____exports
  end,
 ["src.objects.isaacAPIClassTypeToFunctions"] = function(...) 
 local ____exports = {}
-local ____CopyableIsaacAPIClassType = require("src.enums.private.CopyableIsaacAPIClassType")
-local CopyableIsaacAPIClassType = ____CopyableIsaacAPIClassType.CopyableIsaacAPIClassType
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local CopyableIsaacAPIClassType = ____isaac_2Dtypescript_2Ddefinitions.CopyableIsaacAPIClassType
 local ____bitSet128 = require("src.functions.bitSet128")
 local copyBitSet128 = ____bitSet128.copyBitSet128
 local deserializeBitSet128 = ____bitSet128.deserializeBitSet128
+local isBitSet128 = ____bitSet128.isBitSet128
 local isSerializedBitSet128 = ____bitSet128.isSerializedBitSet128
 local serializeBitSet128 = ____bitSet128.serializeBitSet128
 local ____color = require("src.functions.color")
 local copyColor = ____color.copyColor
 local deserializeColor = ____color.deserializeColor
+local isColor = ____color.isColor
 local isSerializedColor = ____color.isSerializedColor
 local serializeColor = ____color.serializeColor
 local ____kColor = require("src.functions.kColor")
 local copyKColor = ____kColor.copyKColor
 local deserializeKColor = ____kColor.deserializeKColor
+local isKColor = ____kColor.isKColor
 local isSerializedKColor = ____kColor.isSerializedKColor
 local serializeKColor = ____kColor.serializeKColor
 local ____rng = require("src.functions.rng")
 local copyRNG = ____rng.copyRNG
 local deserializeRNG = ____rng.deserializeRNG
+local isRNG = ____rng.isRNG
 local isSerializedRNG = ____rng.isSerializedRNG
 local serializeRNG = ____rng.serializeRNG
 local ____vector = require("src.functions.vector")
 local copyVector = ____vector.copyVector
 local deserializeVector = ____vector.deserializeVector
 local isSerializedVector = ____vector.isSerializedVector
+local isVector = ____vector.isVector
 local serializeVector = ____vector.serializeVector
 ____exports.ISAAC_API_CLASS_TYPE_TO_FUNCTIONS = {
-    [CopyableIsaacAPIClassType.BIT_SET_128] = {isSerialized = isSerializedBitSet128, copy = copyBitSet128, serialize = serializeBitSet128, deserialize = deserializeBitSet128},
-    [CopyableIsaacAPIClassType.COLOR] = {isSerialized = isSerializedColor, copy = copyColor, serialize = serializeColor, deserialize = deserializeColor},
-    [CopyableIsaacAPIClassType.K_COLOR] = {isSerialized = isSerializedKColor, copy = copyKColor, serialize = serializeKColor, deserialize = deserializeKColor},
-    [CopyableIsaacAPIClassType.RNG] = {isSerialized = isSerializedRNG, copy = copyRNG, serialize = serializeRNG, deserialize = deserializeRNG},
-    [CopyableIsaacAPIClassType.VECTOR] = {isSerialized = isSerializedVector, copy = copyVector, serialize = serializeVector, deserialize = deserializeVector}
+    [CopyableIsaacAPIClassType.BIT_SET_128] = {
+        is = isBitSet128,
+        isSerialized = isSerializedBitSet128,
+        copy = copyBitSet128,
+        serialize = serializeBitSet128,
+        deserialize = deserializeBitSet128
+    },
+    [CopyableIsaacAPIClassType.COLOR] = {
+        is = isColor,
+        isSerialized = isSerializedColor,
+        copy = copyColor,
+        serialize = serializeColor,
+        deserialize = deserializeColor
+    },
+    [CopyableIsaacAPIClassType.K_COLOR] = {
+        is = isKColor,
+        isSerialized = isSerializedKColor,
+        copy = copyKColor,
+        serialize = serializeKColor,
+        deserialize = deserializeKColor
+    },
+    [CopyableIsaacAPIClassType.RNG] = {
+        is = isRNG,
+        isSerialized = isSerializedRNG,
+        copy = copyRNG,
+        serialize = serializeRNG,
+        deserialize = deserializeRNG
+    },
+    [CopyableIsaacAPIClassType.VECTOR] = {
+        is = isVector,
+        isSerialized = isSerializedVector,
+        copy = copyVector,
+        serialize = serializeVector,
+        deserialize = deserializeVector
+    }
 }
-return ____exports
- end,
-["src.types.SerializedIsaacAPIClass"] = function(...) 
-local ____exports = {}
 return ____exports
  end,
 ["src.functions.serialization"] = function(...) 
@@ -29939,6 +29977,21 @@ function ____exports.deserializeIsaacAPIClass(self, serializedIsaacAPIClass)
     end
     return functions:deserialize(serializedIsaacAPIClass)
 end
+--- Helper function to generically check if a given object is a copyable Isaac API class. (This is
+-- used by the save data manager when determining what is safe to copy.)
+-- 
+-- For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+function ____exports.isCopyableIsaacAPIClass(self, object)
+    local allFunctions = __TS__ObjectValues(ISAAC_API_CLASS_TYPE_TO_FUNCTIONS)
+    local isFunctions = __TS__ArrayMap(
+        allFunctions,
+        function(____, functions) return functions.is end
+    )
+    return __TS__ArraySome(
+        isFunctions,
+        function(____, identityFunction) return identityFunction(nil, object) end
+    )
+end
 --- Helper function to generically check if a given Lua table is a serialized Isaac API class. (This
 -- is used by the save data manager when reading data from the "save#.dat" file.)
 -- 
@@ -29977,18 +30030,16 @@ return ____exports
  end,
 ["src.functions.deepCopy"] = function(...) 
 local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
+local Set = ____lualib.Set
 local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local ____exports = {}
-local deepCopyTable, deepCopyDefaultMap, getNewDefaultMap, deepCopyMap, deepCopySet, deepCopyTSTLClass, deepCopyArray, deepCopyNormalLuaTable, getCopiedEntries, checkMetatable, deepCopyUserdata, COPYABLE_ISAAC_API_CLASS_TYPES_SET
+local deepCopyTable, deepCopyDefaultMap, getNewDefaultMap, deepCopyMap, deepCopySet, deepCopyTSTLClass, deepCopyArray, deepCopyNormalLuaTable, getCopiedEntries, checkMetatable, deepCopyUserdata
 local ____DefaultMap = require("src.classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
-local ____CopyableIsaacAPIClassType = require("src.enums.private.CopyableIsaacAPIClassType")
-local CopyableIsaacAPIClassType = ____CopyableIsaacAPIClassType.CopyableIsaacAPIClassType
 local ____SerializationBrand = require("src.enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____SerializationType = require("src.enums.SerializationType")
@@ -29999,8 +30050,6 @@ local ____serializationBrands = require("src.features.saveDataManager.serializat
 local isSerializationBrand = ____serializationBrands.isSerializationBrand
 local ____array = require("src.functions.array")
 local isArray = ____array.isArray
-local ____enums = require("src.functions.enums")
-local getEnumValues = ____enums.getEnumValues
 local ____isaacAPIClass = require("src.functions.isaacAPIClass")
 local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 local ____log = require("src.functions.log")
@@ -30008,6 +30057,7 @@ local log = ____log.log
 local ____serialization = require("src.functions.serialization")
 local copyIsaacAPIClass = ____serialization.copyIsaacAPIClass
 local deserializeIsaacAPIClass = ____serialization.deserializeIsaacAPIClass
+local isCopyableIsaacAPIClass = ____serialization.isCopyableIsaacAPIClass
 local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
 local serializeIsaacAPIClass = ____serialization.serializeIsaacAPIClass
 local ____tstlClass = require("src.functions.tstlClass")
@@ -30091,6 +30141,9 @@ function ____exports.deepCopy(self, value, serializationType, traversalDescripti
                 if serializationType == SerializationType.SERIALIZE then
                     error((("The deep copy function does not support serialization of \"" .. traversalDescription) .. "\", since it is type: ") .. valueType)
                 end
+                if serializationType == SerializationType.DESERIALIZE then
+                    error((("The deep copy function does not support deserialization of \"" .. traversalDescription) .. "\", since it is type: ") .. valueType)
+                end
                 return value
             end
         end
@@ -30242,15 +30295,15 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
 end
 function getNewDefaultMap(self, defaultMap, serializationType, traversalDescription, constructorArg)
     repeat
-        local ____switch34 = serializationType
-        local ____cond34 = ____switch34 == SerializationType.NONE
-        if ____cond34 then
+        local ____switch35 = serializationType
+        local ____cond35 = ____switch35 == SerializationType.NONE
+        if ____cond35 then
             do
                 return __TS__New(DefaultMap, constructorArg)
             end
         end
-        ____cond34 = ____cond34 or ____switch34 == SerializationType.SERIALIZE
-        if ____cond34 then
+        ____cond35 = ____cond35 or ____switch35 == SerializationType.SERIALIZE
+        if ____cond35 then
             do
                 local newDefaultMap = {}
                 newDefaultMap[SerializationBrand.DEFAULT_MAP] = ""
@@ -30258,8 +30311,8 @@ function getNewDefaultMap(self, defaultMap, serializationType, traversalDescript
                 return newDefaultMap
             end
         end
-        ____cond34 = ____cond34 or ____switch34 == SerializationType.DESERIALIZE
-        if ____cond34 then
+        ____cond35 = ____cond35 or ____switch35 == SerializationType.DESERIALIZE
+        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.")
@@ -30459,7 +30512,7 @@ function getCopiedEntries(self, object, serializationType, traversalDescription,
         local value = ____value[2]
         do
             if isSerializationBrand(nil, key) then
-                goto __continue87
+                goto __continue88
             end
             traversalDescription = getTraversalDescription(nil, key, traversalDescription)
             local newValue = ____exports.deepCopy(
@@ -30481,7 +30534,7 @@ function getCopiedEntries(self, object, serializationType, traversalDescription,
             end
             copiedEntries[#copiedEntries + 1] = {keyToUse, newValue}
         end
-        ::__continue87::
+        ::__continue88::
     end
     return {entries = copiedEntries, convertedNumberKeysToStrings = convertNumberKeysToStrings}
 end
@@ -30494,15 +30547,12 @@ function checkMetatable(self, luaMap, 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)
-    if SAVE_DATA_MANAGER_DEBUG then
-        log(nil, "deepCopy is copying userdata.")
-    end
     local classType = getIsaacAPIClassName(nil, value)
     if classType == nil then
         error("The deep copy function was not able to derive the Isaac API class type for: " .. traversalDescription)
     end
-    if not COPYABLE_ISAAC_API_CLASS_TYPES_SET:has(classType) then
-        error((("The deep copy function does not support copying \"" .. traversalDescription) .. "\", since it is an Isaac API class of type: ") .. classType)
+    if not isCopyableIsaacAPIClass(nil, value) then
+        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
@@ -30521,15 +30571,12 @@ function deepCopyUserdata(self, value, serializationType, traversalDescription)
         ____cond99 = ____cond99 or ____switch99 == SerializationType.DESERIALIZE
         if ____cond99 then
             do
-                return deserializeIsaacAPIClass(nil, value)
+                error(("The deep copy function can not deserialize \"" .. traversalDescription) .. "\", since it is userdata.")
             end
+            break
         end
     until true
 end
-COPYABLE_ISAAC_API_CLASS_TYPES_SET = __TS__New(
-    Set,
-    getEnumValues(nil, CopyableIsaacAPIClassType)
-)
 return ____exports
  end,
 ["src.interfaces.SaveData"] = function(...) 
@@ -31937,7 +31984,7 @@ local ____flag = require("src.functions.flag")
 local hasFlag = ____flag.hasFlag
 --- Helper function to get the actual bit flag for modded curses.
 -- 
--- Will throw a runtime error if the provided curse does not exist.
+-- Will throw a run-time error if the provided curse does not exist.
 -- 
 -- Use this over the `Isaac.GetCurseIdByName` method because that will return an integer instead of
 -- a bit flag.
@@ -45571,16 +45618,21 @@ end
 -- Specifically, this will clear the current room of all entities and grid entities, and then spawn
 -- all of the entries and grid entities in the provided JSON room.
 -- 
+-- You can create JSON rooms by using the `convert-xml-to-json` tool (e.g. `npx convert-xml-to-json
+-- my-rooms.xml`).
+-- 
 -- This function is meant to be used in the `POST_NEW_ROOM` callback.
 -- 
 -- For example:
 -- 
 -- ```ts
 -- 
--- import customRooms from "./customRooms";
+-- import customRooms from "./customRooms.json";
 -- 
--- const firstJSONRoom = customRooms.rooms.room[0];
--- deployJSONRoom(firstJSONRoom);
+-- export function postNewRoom(): void {
+--   const firstJSONRoom = customRooms.rooms.room[0];
+--   deployJSONRoom(firstJSONRoom);
+-- }
 -- ```
 -- 
 -- @param jsonRoom The JSON room to deploy. *
@@ -45618,6 +45670,9 @@ end
 -- Specifically, this will clear the current room of all entities and grid entities, and then spawn
 -- all of the entries and grid entities in one of the provided JSON rooms.
 -- 
+-- You can create JSON rooms by using the `convert-xml-to-json` tool (e.g. `npx convert-xml-to-json
+-- my-rooms.xml`).
+-- 
 -- This function is meant to be used in the `POST_NEW_ROOM` callback.
 -- 
 -- Note that this function does not simply choose a random element in the provided array; it will
@@ -45627,10 +45682,12 @@ end
 -- For example:
 -- 
 -- ```ts
--- import customRooms from "./customRooms";
+-- import customRooms from "./customRooms.json";
 -- 
--- const jsonRooms = customRooms.rooms.room;
--- deployRandomJSONRoom(jsonRooms);
+-- export function postNewRoom(): void {
+--   const jsonRooms = customRooms.rooms.room;
+--   deployRandomJSONRoom(jsonRooms);
+-- }
 -- ```
 -- 
 -- @param jsonRooms An array of JSON rooms to randomly select from. In practice, this will be
@@ -46846,7 +46903,7 @@ return ____exports
 ["package"] = function(...) 
 return {
     name = "isaacscript-common",
-    version = "10.0.1",
+    version = "10.0.2",
     description = "Helper functions and features for IsaacScript mods.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",
@@ -46857,7 +46914,7 @@ return {
     type = "commonjs",
     main = "dist/src/index",
     types = "dist/src/index.d.ts",
-    dependencies = {["isaac-typescript-definitions"] = "^7.0.0"}
+    dependencies = {["isaac-typescript-definitions"] = "^7.2.0"}
 }
  end,
 ["src.functions.map"] = function(...) 
@@ -48334,8 +48391,7 @@ function copiedObjectHasKeyAndValueString(self)
     local keyToLookFor = "abc"
     local valueToLookFor = "def"
     local oldObject = {abc = valueToLookFor}
-    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasKeyAndValueString")
-    local newObject = newTable
+    local newObject = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasKeyAndValueString")
     local value = newObject[keyToLookFor]
     if value == nil then
         error("The copied object did not have a key of: " .. keyToLookFor)
@@ -48352,8 +48408,7 @@ function copiedTableHasKeyAndValueNumber(self)
     local valueToLookFor = 456
     local oldTable = {}
     oldTable[keyToLookFor] = valueToLookFor
-    local newObject = deepCopy(nil, oldTable, SerializationType.NONE, "copiedTableHasKeyAndValueNumber")
-    local newTable = newObject
+    local newTable = deepCopy(nil, oldTable, SerializationType.NONE, "copiedTableHasKeyAndValueNumber")
     local value = newTable[keyToLookFor]
     if value == nil then
         error("The copied object did not have a key of: " .. tostring(keyToLookFor))
@@ -48370,8 +48425,7 @@ function copiedTableDoesNotCoerceTypes(self)
     local valueToLookFor = 456
     local oldTable = {}
     oldTable[keyToLookFor] = valueToLookFor
-    local newObject = deepCopy(nil, oldTable, SerializationType.NONE, "copiedTableDoesNotCoerceTypes")
-    local newTable = newObject
+    local newTable = deepCopy(nil, oldTable, SerializationType.NONE, "copiedTableDoesNotCoerceTypes")
     local keyString = tostring(keyToLookFor)
     local valueString = tostring(valueToLookFor)
     local valueFromString = newTable[keyString]
@@ -48387,8 +48441,7 @@ function copiedObjectHasNoReferencesForPrimitivesForward(self)
     local originalStringValue = "abcdef"
     local originalNumberValue = 123
     local oldObject = {abc = originalStringValue, def = originalNumberValue}
-    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasNoReferencesForPrimitivesForward")
-    local newObject = newTable
+    local newObject = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasNoReferencesForPrimitivesForward")
     oldObject.abc = "newValue"
     if oldObject.abc == newObject.abc then
         error("The copied object has a string reference going forward.")
@@ -48402,8 +48455,7 @@ function copiedObjectHasNoReferencesForPrimitivesBackward(self)
     local originalStringValue = "abcdef"
     local originalNumberValue = 123
     local oldObject = {abc = originalStringValue, def = originalNumberValue}
-    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasNoReferencesForPrimitivesBackward")
-    local newObject = newTable
+    local newObject = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasNoReferencesForPrimitivesBackward")
     newObject.abc = "newValue"
     if newObject.abc == oldObject.abc then
         error("The copied object has a string reference going backward.")
@@ -48415,8 +48467,7 @@ function copiedObjectHasNoReferencesForPrimitivesBackward(self)
 end
 function copiedObjectHasNoReferencesForArray(self)
     local oldObject = {abc = {1, 2, 3}}
-    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasNoReferencesForArray")
-    local newObject = newTable
+    local newObject = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasNoReferencesForArray")
     if oldObject.abc == newObject.abc then
         error("The copied object has the same point to the child array.")
     end
@@ -48443,8 +48494,7 @@ function copiedObjectHasChildObject(self)
     local keyToLookFor = "def"
     local valueToLookFor = "ghi"
     local oldObject = {abc = {def = valueToLookFor}}
-    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasChildObject")
-    local newObject = newTable
+    local newObject = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasChildObject")
     local childObject = newObject[childObjectIndex]
     if childObject == nil then
         error("Failed to find the child object at index: " .. childObjectIndex)
@@ -48468,8 +48518,7 @@ function copiedMapIsMap(self)
     local valueToLookFor = "def"
     local oldMap = __TS__New(Map)
     oldMap:set(keyToLookFor, valueToLookFor)
-    local newObject = deepCopy(nil, oldMap, SerializationType.NONE, "copiedMapIsMap")
-    local newMap = newObject
+    local newMap = deepCopy(nil, oldMap, SerializationType.NONE, "copiedMapIsMap")
     if not isTSTLMap(nil, newMap) then
         error("The copied Map was not a Map and has a type of: " .. __TS__TypeOf(newMap))
     end
@@ -48479,8 +48528,7 @@ function copiedMapHasValue(self)
     local valueToLookFor = "def"
     local oldMap = __TS__New(Map)
     oldMap:set(keyToLookFor, valueToLookFor)
-    local newTable = deepCopy(nil, oldMap, SerializationType.NONE, "copiedMapHasValue")
-    local newMap = newTable
+    local newMap = deepCopy(nil, oldMap, SerializationType.NONE, "copiedMapHasValue")
     if not isTSTLMap(nil, newMap) then
         error("The copied Map was not a Map and has a type of: " .. __TS__TypeOf(newMap))
     end
@@ -48496,8 +48544,7 @@ function copiedSetIsSet(self)
     local valueToLookFor = "abc"
     local oldSet = __TS__New(Set)
     oldSet:add(valueToLookFor)
-    local newTable = deepCopy(nil, oldSet, SerializationType.NONE, "copiedSetIsSet")
-    local newSet = newTable
+    local newSet = deepCopy(nil, oldSet, SerializationType.NONE, "copiedSetIsSet")
     if not isTSTLSet(nil, newSet) then
         error("The copied Set was not a Set and has a type of: " .. __TS__TypeOf(newSet))
     end
@@ -48506,8 +48553,7 @@ function copiedSetHasValue(self)
     local valueToLookFor = "abc"
     local oldSet = __TS__New(Set)
     oldSet:add(valueToLookFor)
-    local newTable = deepCopy(nil, oldSet, SerializationType.NONE, "copiedSetHasValue")
-    local newSet = newTable
+    local newSet = deepCopy(nil, oldSet, SerializationType.NONE, "copiedSetHasValue")
     if not isTSTLSet(nil, newSet) then
         error("The copied Set was not a Set and has a type of: " .. __TS__TypeOf(newSet))
     end
@@ -48524,8 +48570,7 @@ function copiedMapHasChildMap(self)
     local keyToLookFor = "childMap"
     local oldMap = __TS__New(Map)
     oldMap:set(keyToLookFor, oldChildMap)
-    local newTable = deepCopy(nil, oldMap, SerializationType.NONE, "copiedMapHasChildMap")
-    local newMap = newTable
+    local newMap = deepCopy(nil, oldMap, SerializationType.NONE, "copiedMapHasChildMap")
     if not isTSTLMap(nil, newMap) then
         error("The copied Map was not a Map and had a type of: " .. __TS__TypeOf(newMap))
     end
@@ -48557,8 +48602,7 @@ function copiedDefaultMapHasChildDefaultMap(self)
     local oldChildMap = oldParentMap:getAndSetDefault(parentMapKey)
     oldChildMap:getAndSetDefault(childMapKey1)
     oldChildMap:set(childMapKey2, childMapCustomValue)
-    local newTable = deepCopy(nil, oldParentMap, SerializationType.NONE, "copiedDefaultMapHasChildDefaultMap")
-    local newParentMap = newTable
+    local newParentMap = deepCopy(nil, oldParentMap, SerializationType.NONE, "copiedDefaultMapHasChildDefaultMap")
     if not isDefaultMap(nil, newParentMap) then
         error("The copied parent DefaultMap was not a DefaultMap and had a type of: " .. __TS__TypeOf(newParentMap))
     end
@@ -54833,6 +54877,47 @@ function ____exports.getVanillaTrinketSet(self)
     lazyInitVanillaTrinketTypes(nil)
     return VANILLA_TRINKET_TYPES_SET
 end
+return ____exports
+ end,
+["src.types.WeightedArray"] = function(...) 
+local ____exports = {}
+return ____exports
+ end,
+["src.functions.weighted"] = function(...) 
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local ____exports = {}
+local ____array = require("src.functions.array")
+local arrayToString = ____array.arrayToString
+local sumArray = ____array.sumArray
+local ____random = require("src.functions.random")
+local getRandomFloat = ____random.getRandomFloat
+local ____rng = require("src.functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+--- Get a random value from a `WeightedArray`. (The second element in the array is the weight.)
+function ____exports.getRandomFromWeightedArray(self, weightedArray, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if #weightedArray == 0 then
+        error("Failed to get a random element from a weighted array since the provided array was empty.")
+    end
+    local weights = __TS__ArrayMap(
+        weightedArray,
+        function(____, tuple) return tuple[2] end
+    )
+    local totalWeight = sumArray(nil, weights)
+    local randomWeight = getRandomFloat(nil, 0, totalWeight, seedOrRNG)
+    local weightAccumulator = 0
+    for ____, tuple in ipairs(weightedArray) do
+        local element, weight = table.unpack(tuple)
+        weightAccumulator = weightAccumulator + weight
+        if weightAccumulator >= randomWeight then
+            return element
+        end
+    end
+    error("Failed to get a random element from a weighted array: " .. arrayToString(nil, weightedArray))
+end
 return ____exports
  end,
 ["src.objects.colors"] = function(...) 
@@ -56096,6 +56181,14 @@ do
         end
     end
 end
+do
+    local ____export = require("src.functions.weighted")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("src.maps.cardNameToTypeMap")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/package.lua

@@ -1,6 +1,6 @@
 return {
     name = "isaacscript-common",
-    version = "10.0.1",
+    version = "10.0.2",
     description = "Helper functions and features for IsaacScript mods.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",
@@ -11,5 +11,5 @@ return {
     type = "commonjs",
     main = "dist/src/index",
     types = "dist/src/index.d.ts",
-    dependencies = {["isaac-typescript-definitions"] = "^7.0.0"}
+    dependencies = {["isaac-typescript-definitions"] = "^7.2.0"}
 }

package/dist/src/features/deployJSONRoom.d.ts

@@ -6,16 +6,21 @@ import { JSONRoom } from "../interfaces/JSONRoomsFile";
  * Specifically, this will clear the current room of all entities and grid entities, and then spawn
  * all of the entries and grid entities in the provided JSON room.
  *
+ * You can create JSON rooms by using the `convert-xml-to-json` tool (e.g. `npx convert-xml-to-json
+ * my-rooms.xml`).
+ *
  * This function is meant to be used in the `POST_NEW_ROOM` callback.
  *
  * For example:
  *
  * ```ts
  *
- * import customRooms from "./customRooms";
+ * import customRooms from "./customRooms.json";
  *
- * const firstJSONRoom = customRooms.rooms.room[0];
- * deployJSONRoom(firstJSONRoom);
+ * export function postNewRoom(): void {
+ *   const firstJSONRoom = customRooms.rooms.room[0];
+ *   deployJSONRoom(firstJSONRoom);
+ * }
  * ```
  *
  * @param jsonRoom The JSON room to deploy. *
@@ -30,6 +35,9 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom | Readonly<JSONRoom>,
  * Specifically, this will clear the current room of all entities and grid entities, and then spawn
  * all of the entries and grid entities in one of the provided JSON rooms.
  *
+ * You can create JSON rooms by using the `convert-xml-to-json` tool (e.g. `npx convert-xml-to-json
+ * my-rooms.xml`).
+ *
  * This function is meant to be used in the `POST_NEW_ROOM` callback.
  *
  * Note that this function does not simply choose a random element in the provided array; it will
@@ -39,10 +47,12 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom | Readonly<JSONRoom>,
  * For example:
  *
  * ```ts
- * import customRooms from "./customRooms";
+ * import customRooms from "./customRooms.json";
  *
- * const jsonRooms = customRooms.rooms.room;
- * deployRandomJSONRoom(jsonRooms);
+ * export function postNewRoom(): void {
+ *   const jsonRooms = customRooms.rooms.room;
+ *   deployRandomJSONRoom(jsonRooms);
+ * }
  * ```
  *
  * @param jsonRooms An array of JSON rooms to randomly select from. In practice, this will be

package/dist/src/features/deployJSONRoom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deployJSONRoom.d.ts","sourceRoot":"","sources":["../../../src/features/deployJSONRoom.ts"],"names":[],"mappings":";;AAuDA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAuKvD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,EACvC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAuBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAaN;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAwB5D"}
+{"version":3,"file":"deployJSONRoom.d.ts","sourceRoot":"","sources":["../../../src/features/deployJSONRoom.ts"],"names":[],"mappings":";;AAuDA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAuKvD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,EACvC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAuBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAaN;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAwB5D"}