isaacscript-common 6.6.4 → 6.6.5

package/dist/callbacks/postCustomDoorEnter.d.ts

@@ -39,7 +39,7 @@ export declare function initCustomDoor(mod: ModUpgraded, effectVariant: EffectVa
  * The custom door is an `EntityEffect`. You can manually open or close the door by modifying its
  * state. (The values to use correspond to the `DoorState` enum.)
  *
- * This function will throw a runtime error if:
+ * This function will throw a run-time error if:
  * - the door slot already has a vanilla door
  * - the door slot already has a custom door
  * - the tile at the door slot does not have a wall

package/dist/callbacks/postCustomDoorEnter.lua

@@ -199,7 +199,7 @@ end
 -- The custom door is an `EntityEffect`. You can manually open or close the door by modifying its
 -- state. (The values to use correspond to the `DoorState` enum.)
 -- 
--- This function will throw a runtime error if:
+-- This function will throw a run-time error if:
 -- - the door slot already has a vanilla door
 -- - the door slot already has a custom door
 -- - the tile at the door slot does not have a wall

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

@@ -16,10 +16,6 @@ export declare enum SerializationBrand {
     /**
      * This is set to the value that represents the default value (instead of an empty string like the
      * other brands are).
-     *
-     * Default maps that use a factory function are unserializable, but do not throw runtime errors
-     * because the merge function can derive the factory function from the already-instantiated
-     * object.
      */
     DEFAULT_MAP_VALUE = "__TSTL_DEFAULT_MAP_VALUE",
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"SerializationBrand.d.ts","sourceRoot":"","sources":["../../../src/enums/private/SerializationBrand.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oBAAY,kBAAkB;IAE5B,WAAW,uBAAuB;IAClC,GAAG,eAAe;IAClB,GAAG,eAAe;IAGlB,KAAK,YAAY;IACjB,OAAO,cAAc;IACrB,GAAG,UAAU;IACb,MAAM,aAAa;IAEnB;;;;;;;OAOG;IACH,iBAAiB,6BAA6B;IAE9C;;;;;;;;;;OAUG;IACH,uBAAuB,mCAAmC;CAC3D"}
+{"version":3,"file":"SerializationBrand.d.ts","sourceRoot":"","sources":["../../../src/enums/private/SerializationBrand.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oBAAY,kBAAkB;IAE5B,WAAW,uBAAuB;IAClC,GAAG,eAAe;IAClB,GAAG,eAAe;IAGlB,KAAK,YAAY;IACjB,OAAO,cAAc;IACrB,GAAG,UAAU;IACb,MAAM,aAAa;IAEnB;;;OAGG;IACH,iBAAiB,6BAA6B;IAE9C;;;;;;;;;;OAUG;IACH,uBAAuB,mCAAmC;CAC3D"}

package/dist/functions/deepCopy.d.ts

@@ -21,10 +21,13 @@ import { SerializationType } from "../enums/SerializationType";
  * - 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.
+ * @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 insideMap Optional. Tracks whether or not the deep copy function is in the process of
+ *                  recursively copying a TSTL Map. Default is false.
  */
-export declare function deepCopy(value: unknown, serializationType?: SerializationType, traversalDescription?: string): unknown;
+export declare function deepCopy(value: unknown, serializationType?: SerializationType, traversalDescription?: string, insideMap?: boolean): unknown;
 //# sourceMappingURL=deepCopy.d.ts.map

package/dist/functions/deepCopy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deepCopy.d.ts","sourceRoot":"","sources":["../../src/functions/deepCopy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AA4B/D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,OAAO,EACd,iBAAiB,oBAAyB,EAC1C,oBAAoB,SAAK,GACxB,OAAO,CA6CT"}
+{"version":3,"file":"deepCopy.d.ts","sourceRoot":"","sources":["../../src/functions/deepCopy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AA4B/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,OAAO,EACd,iBAAiB,oBAAyB,EAC1C,oBAAoB,SAAK,EACzB,SAAS,UAAQ,GAChB,OAAO,CAkDT"}

package/dist/functions/deepCopy.lua

@@ -66,17 +66,23 @@ local twoDimensionalSort = ____utils.twoDimensionalSort
 -- - other Isaac API objects such as `EntityPtr` (that have a type of "userdata")
 -- 
 -- @param value The primitive or object to copy.
--- @param serializationType Has 3 possible values. Can leave objects as-is, or can serialize objects
--- to Lua tables, or can deserialize Lua tables to objects. Default is
--- `SerializationType.NONE`.
--- @param traversalDescription Used to track the current key that we are operating on.
-function ____exports.deepCopy(self, value, serializationType, traversalDescription)
+-- @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 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)
     if serializationType == nil then
         serializationType = SerializationType.NONE
     end
     if traversalDescription == nil then
         traversalDescription = ""
     end
+    if insideMap == nil then
+        insideMap = false
+    end
     if SAVE_DATA_MANAGER_DEBUG then
         local logString = "deepCopy is operating on: " .. traversalDescription
         if serializationType == SerializationType.SERIALIZE then
@@ -109,7 +115,13 @@ function ____exports.deepCopy(self, value, serializationType, traversalDescripti
         if ____cond6 then
             do
                 local luaTable = value
-                return deepCopyTable(nil, luaTable, serializationType, traversalDescription)
+                return deepCopyTable(
+                    nil,
+                    luaTable,
+                    serializationType,
+                    traversalDescription,
+                    insideMap
+                )
             end
         end
         ____cond6 = ____cond6 or ____switch6 == "userdata"
@@ -120,15 +132,33 @@ function ____exports.deepCopy(self, value, serializationType, traversalDescripti
         end
     until true
 end
-function deepCopyTable(self, luaTable, serializationType, traversalDescription)
+function deepCopyTable(self, luaTable, serializationType, traversalDescription, insideMap)
     if isDefaultMap(nil, luaTable) or luaTable[SerializationBrand.DEFAULT_MAP] ~= nil then
-        return deepCopyDefaultMap(nil, luaTable, serializationType, traversalDescription)
+        return deepCopyDefaultMap(
+            nil,
+            luaTable,
+            serializationType,
+            traversalDescription,
+            insideMap
+        )
     end
     if isTSTLMap(nil, luaTable) or luaTable[SerializationBrand.MAP] ~= nil then
-        return deepCopyMap(nil, luaTable, serializationType, traversalDescription)
+        return deepCopyMap(
+            nil,
+            luaTable,
+            serializationType,
+            traversalDescription,
+            insideMap
+        )
     end
     if isTSTLSet(nil, luaTable) or luaTable[SerializationBrand.SET] ~= nil then
-        return deepCopySet(nil, luaTable, serializationType, traversalDescription)
+        return deepCopySet(
+            nil,
+            luaTable,
+            serializationType,
+            traversalDescription,
+            insideMap
+        )
     end
     local className = getTSTLClassName(nil, luaTable)
     if className == "WeakMap" then
@@ -138,18 +168,36 @@ function deepCopyTable(self, luaTable, serializationType, traversalDescription)
         error("The deep copy function does not support copying the \"WeakSet\" class for: " .. traversalDescription)
     end
     if isUserDefinedTSTLClass(nil, luaTable) then
-        return deepCopyTSTLClass(nil, luaTable, serializationType, traversalDescription)
+        return deepCopyTSTLClass(
+            nil,
+            luaTable,
+            serializationType,
+            traversalDescription,
+            insideMap
+        )
     end
     checkMetatable(nil, luaTable, traversalDescription)
     if isSerializedIsaacAPIClass(nil, luaTable) and serializationType == SerializationType.DESERIALIZE then
         return deserializeIsaacAPIClass(nil, luaTable)
     end
     if isArray(nil, luaTable) then
-        return deepCopyArray(nil, luaTable, serializationType, traversalDescription)
-    end
-    return deepCopyNormalLuaTable(nil, luaTable, serializationType, traversalDescription)
+        return deepCopyArray(
+            nil,
+            luaTable,
+            serializationType,
+            traversalDescription,
+            insideMap
+        )
+    end
+    return deepCopyNormalLuaTable(
+        nil,
+        luaTable,
+        serializationType,
+        traversalDescription,
+        insideMap
+    )
 end
-function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescription)
+function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescription, insideMap)
     local ____isDefaultMap_result_0
     if isDefaultMap(nil, defaultMap) then
         ____isDefaultMap_result_0 = defaultMap:getConstructorArg()
@@ -158,7 +206,17 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
     end
     local constructorArg = ____isDefaultMap_result_0
     if serializationType == SerializationType.SERIALIZE and not isPrimitive(nil, constructorArg) then
-        return deepCopyMap(nil, defaultMap, serializationType, traversalDescription)
+        if insideMap then
+            error("Failed to deep copy a DefaultMap because it was instantiated with a factory function and was also inside of another map. You cannot use a nested DefaultMap in this way because factory functions are not serializable. (In other words, there is no way to copy the function that you are using for the DefaultMap into the \"save#.dat\" file.) Instead, refactor your data structure so that the DefaultMap is not nested.")
+        else
+            return deepCopyMap(
+                nil,
+                defaultMap,
+                serializationType,
+                traversalDescription,
+                insideMap
+            )
+        end
     end
     local newDefaultMap = getNewDefaultMap(
         nil,
@@ -167,7 +225,14 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
         traversalDescription,
         constructorArg
     )
-    local ____getCopiedEntries_result_1 = getCopiedEntries(nil, defaultMap, serializationType, traversalDescription)
+    insideMap = true
+    local ____getCopiedEntries_result_1 = getCopiedEntries(
+        nil,
+        defaultMap,
+        serializationType,
+        traversalDescription,
+        insideMap
+    )
     local entries = ____getCopiedEntries_result_1.entries
     local convertedNumberKeysToStrings = ____getCopiedEntries_result_1.convertedNumberKeysToStrings
     if convertedNumberKeysToStrings then
@@ -186,19 +251,20 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
             newDefaultMap[key] = value
         end
     end
+    insideMap = false
     return newDefaultMap
 end
 function getNewDefaultMap(self, defaultMap, serializationType, traversalDescription, constructorArg)
     repeat
-        local ____switch31 = serializationType
-        local ____cond31 = ____switch31 == SerializationType.NONE
-        if ____cond31 then
+        local ____switch33 = serializationType
+        local ____cond33 = ____switch33 == SerializationType.NONE
+        if ____cond33 then
             do
                 return __TS__New(DefaultMap, constructorArg)
             end
         end
-        ____cond31 = ____cond31 or ____switch31 == SerializationType.SERIALIZE
-        if ____cond31 then
+        ____cond33 = ____cond33 or ____switch33 == SerializationType.SERIALIZE
+        if ____cond33 then
             do
                 local newDefaultMap = {}
                 newDefaultMap[SerializationBrand.DEFAULT_MAP] = ""
@@ -206,8 +272,8 @@ function getNewDefaultMap(self, defaultMap, serializationType, traversalDescript
                 return newDefaultMap
             end
         end
-        ____cond31 = ____cond31 or ____switch31 == SerializationType.DESERIALIZE
-        if ____cond31 then
+        ____cond33 = ____cond33 or ____switch33 == SerializationType.DESERIALIZE
+        if ____cond33 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.")
@@ -221,7 +287,7 @@ function getNewDefaultMap(self, defaultMap, serializationType, traversalDescript
         end
     until true
 end
-function deepCopyMap(self, map, serializationType, traversalDescription)
+function deepCopyMap(self, map, serializationType, traversalDescription, insideMap)
     local newMap
     if serializationType == SerializationType.SERIALIZE then
         newMap = {}
@@ -229,7 +295,14 @@ function deepCopyMap(self, map, serializationType, traversalDescription)
     else
         newMap = __TS__New(Map)
     end
-    local ____getCopiedEntries_result_2 = getCopiedEntries(nil, map, serializationType, traversalDescription)
+    insideMap = true
+    local ____getCopiedEntries_result_2 = getCopiedEntries(
+        nil,
+        map,
+        serializationType,
+        traversalDescription,
+        insideMap
+    )
     local entries = ____getCopiedEntries_result_2.entries
     local convertedNumberKeysToStrings = ____getCopiedEntries_result_2.convertedNumberKeysToStrings
     if convertedNumberKeysToStrings then
@@ -248,9 +321,10 @@ function deepCopyMap(self, map, serializationType, traversalDescription)
             newMap[key] = value
         end
     end
+    insideMap = false
     return newMap
 end
-function deepCopySet(self, set, serializationType, traversalDescription)
+function deepCopySet(self, set, serializationType, traversalDescription, insideMap)
     local newSet
     if serializationType == SerializationType.SERIALIZE then
         newSet = {}
@@ -258,7 +332,13 @@ function deepCopySet(self, set, serializationType, traversalDescription)
     else
         newSet = __TS__New(Set)
     end
-    local ____getCopiedEntries_result_3 = getCopiedEntries(nil, set, serializationType, traversalDescription)
+    local ____getCopiedEntries_result_3 = getCopiedEntries(
+        nil,
+        set,
+        serializationType,
+        traversalDescription,
+        insideMap
+    )
     local entries = ____getCopiedEntries_result_3.entries
     local convertedNumberKeysToStrings = ____getCopiedEntries_result_3.convertedNumberKeysToStrings
     if convertedNumberKeysToStrings then
@@ -278,14 +358,20 @@ function deepCopySet(self, set, serializationType, traversalDescription)
     end
     return newSet
 end
-function deepCopyTSTLClass(self, tstlClass, serializationType, traversalDescription)
+function deepCopyTSTLClass(self, tstlClass, serializationType, traversalDescription, insideMap)
     local newClass
     if serializationType == SerializationType.SERIALIZE then
         newClass = {}
     else
         newClass = newTSTLClass(nil, tstlClass)
     end
-    local ____getCopiedEntries_result_4 = getCopiedEntries(nil, tstlClass, serializationType, traversalDescription)
+    local ____getCopiedEntries_result_4 = getCopiedEntries(
+        nil,
+        tstlClass,
+        serializationType,
+        traversalDescription,
+        insideMap
+    )
     local entries = ____getCopiedEntries_result_4.entries
     local convertedNumberKeysToStrings = ____getCopiedEntries_result_4.convertedNumberKeysToStrings
     if convertedNumberKeysToStrings then
@@ -298,17 +384,29 @@ function deepCopyTSTLClass(self, tstlClass, serializationType, traversalDescript
     end
     return newClass
 end
-function deepCopyArray(self, array, serializationType, traversalDescription)
+function deepCopyArray(self, array, serializationType, traversalDescription, insideMap)
     local newArray = {}
     for ____, value in ipairs(array) do
-        local newValue = ____exports.deepCopy(nil, value, serializationType, traversalDescription)
+        local newValue = ____exports.deepCopy(
+            nil,
+            value,
+            serializationType,
+            traversalDescription,
+            insideMap
+        )
         newArray[#newArray + 1] = newValue
     end
     return newArray
 end
-function deepCopyNormalLuaTable(self, luaTable, serializationType, traversalDescription)
+function deepCopyNormalLuaTable(self, luaTable, serializationType, traversalDescription, insideMap)
     local newTable = {}
-    local ____getCopiedEntries_result_5 = getCopiedEntries(nil, luaTable, serializationType, traversalDescription)
+    local ____getCopiedEntries_result_5 = getCopiedEntries(
+        nil,
+        luaTable,
+        serializationType,
+        traversalDescription,
+        insideMap
+    )
     local entries = ____getCopiedEntries_result_5.entries
     local convertedNumberKeysToStrings = ____getCopiedEntries_result_5.convertedNumberKeysToStrings
     if convertedNumberKeysToStrings then
@@ -321,7 +419,7 @@ function deepCopyNormalLuaTable(self, luaTable, serializationType, traversalDesc
     end
     return newTable
 end
-function getCopiedEntries(self, object, serializationType, traversalDescription)
+function getCopiedEntries(self, object, serializationType, traversalDescription, insideMap)
     local entries = {}
     if isTSTLMap(nil, object) or isTSTLSet(nil, object) or isDefaultMap(nil, object) then
         for ____, ____value in __TS__Iterator(object:entries()) do
@@ -353,14 +451,20 @@ function getCopiedEntries(self, object, serializationType, traversalDescription)
         local value = ____value[2]
         do
             if isSerializationBrand(nil, key) then
-                goto __continue78
+                goto __continue80
             end
             traversalDescription = getTraversalDescription(nil, key, traversalDescription)
-            local newValue = ____exports.deepCopy(nil, value, serializationType, traversalDescription)
+            local newValue = ____exports.deepCopy(
+                nil,
+                value,
+                serializationType,
+                traversalDescription,
+                insideMap
+            )
             local keyToUse = convertNumberKeysToStrings and tostring(key) or key
             copiedEntries[#copiedEntries + 1] = {keyToUse, newValue}
         end
-        ::__continue78::
+        ::__continue80::
     end
     return {entries = copiedEntries, convertedNumberKeysToStrings = convertNumberKeysToStrings}
 end

package/dist/functions/log.d.ts

@@ -64,7 +64,7 @@ export declare function logSounds(this: void): void;
  * 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 runtime error if it encounters a non-string key.
+ * instead of randomly). It will throw a run-time error if it encounters a non-string key.
  */
 export declare function logTable(this: void, luaTable: unknown, parentTables?: number): void;
 /**

package/dist/functions/log.lua

@@ -464,7 +464,7 @@ end
 -- 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 runtime error if it encounters a non-string key.
+-- instead of randomly). It will throw a run-time error if it encounters a non-string key.
 function ____exports.logTable(luaTable, parentTables)
     if parentTables == nil then
         parentTables = 0

package/dist/functions/table.d.ts

@@ -34,7 +34,7 @@ export declare function getStringsFromTable(luaTable: LuaTable<string, unknown>,
  * This function will sort the table entries based on the value of the key.
  *
  * This function will only work on tables that have number keys or string keys. It will throw a
- * runtime error if it encounters a key of another type.
+ * run-time error if it encounters a key of another type.
  *
  * @param luaTable The table to iterate over.
  * @param func The function to run for each iteration.

package/dist/functions/table.lua

@@ -96,7 +96,7 @@ end
 -- This function will sort the table entries based on the value of the key.
 -- 
 -- This function will only work on tables that have number keys or string keys. It will throw a
--- runtime error if it encounters a key of another type.
+-- run-time error if it encounters a key of another type.
 -- 
 -- @param luaTable The table to iterate over.
 -- @param func The function to run for each iteration.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "6.6.4",
+  "version": "6.6.5",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/callbacks/postCursedTeleport.ts

@@ -119,7 +119,7 @@ function incrementNumSacrifices(damageFlags: BitFlags<DamageFlag>) {
   const isSpikeDamage = hasFlag(damageFlags, DamageFlag.SPIKES);
 
   if (roomType === RoomType.SACRIFICE && isSpikeDamage) {
-    v.level.numSacrifices += 1;
+    v.level.numSacrifices++;
   }
 }
 

package/src/callbacks/postCustomDoorEnter.ts

@@ -219,7 +219,7 @@ function postRoomClearChanged(
  * The custom door is an `EntityEffect`. You can manually open or close the door by modifying its
  * state. (The values to use correspond to the `DoorState` enum.)
  *
- * This function will throw a runtime error if:
+ * This function will throw a run-time error if:
  * - the door slot already has a vanilla door
  * - the door slot already has a custom door
  * - the tile at the door slot does not have a wall

package/src/callbacks/postPlayerCollectible.ts

@@ -102,7 +102,7 @@ function collectibleCountChanged(
       } else {
         postPlayerCollectibleRemovedFire(player, collectibleType);
       }
-      numFired += 1;
+      numFired++;
     });
 
     if (numFired === numCollectiblesChanged) {

package/src/callbacks/postSacrifice.ts

@@ -56,7 +56,7 @@ function entityTakeDmgPlayer(
   const isSpikeDamage = hasFlag(damageFlags, DamageFlag.SPIKES);
 
   if (roomType === RoomType.SACRIFICE && isSpikeDamage) {
-    v.level.numSacrifices += 1;
+    v.level.numSacrifices++;
     postSacrificeFire(player, v.level.numSacrifices);
   }
 

package/src/enums/private/SerializationBrand.ts

@@ -20,10 +20,6 @@ export enum SerializationBrand {
   /**
    * This is set to the value that represents the default value (instead of an empty string like the
    * other brands are).
-   *
-   * Default maps that use a factory function are unserializable, but do not throw runtime errors
-   * because the merge function can derive the factory function from the already-instantiated
-   * object.
    */
   DEFAULT_MAP_VALUE = "__TSTL_DEFAULT_MAP_VALUE",
 

package/src/features/extraConsoleCommands/listCommands.ts

@@ -337,7 +337,7 @@ export function cards(): void {
 
       const position = gridCoordinatesToWorldPosition(x, y);
       spawnCard(cardType as Card, position);
-      cardType += 1;
+      cardType++;
     }
   }
 }
@@ -647,7 +647,7 @@ export function gridEntities(): void {
   let gridEntityTypeIndex = -1;
   for (let y = 0; y <= 6; y++) {
     for (let x = 0; x <= 12; x++) {
-      gridEntityTypeIndex += 1;
+      gridEntityTypeIndex++;
       const gridEntityType = gridEntityTypes[gridEntityTypeIndex];
       if (gridEntityType === undefined) {
         return;
@@ -884,7 +884,7 @@ export function pills(): void {
   let pillColorIndex = -1;
   for (let y = 0; y <= 6; y++) {
     for (let x = 0; x <= 12; x++) {
-      pillColorIndex += 1;
+      pillColorIndex++;
       const pillColor = pillColors[pillColorIndex];
       if (pillColor === undefined) {
         return;

package/src/features/persistentEntities.ts

@@ -123,7 +123,7 @@ export function spawnPersistentEntity(
 ): [Entity, int] {
   errorIfFeaturesNotInitialized(FEATURE_NAME);
 
-  persistentEntityIndexCounter += 1;
+  persistentEntityIndexCounter++;
 
   const entity = spawnAndTrack(
     entityType,

package/src/functions/array.ts

@@ -527,7 +527,7 @@ export function shuffleArrayInPlace<T>(
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
   while (currentIndex > 0) {
-    currentIndex -= 1;
+    currentIndex--;
 
     const randomIndex = getRandomArrayIndex(array, rng);
     swapArrayElements(array, currentIndex, randomIndex);

package/src/functions/bitwise.ts

@@ -57,7 +57,7 @@ export function countSetBits(n: int): int {
 
   while (n > 0) {
     n &= n - 1;
-    count += 1;
+    count++;
   }
 
   return count;
@@ -72,7 +72,7 @@ export function getKBitOfN(k: int, n: int): int {
 export function getNumBitsOfN(n: int): int {
   let numBits = 0;
   while (n > 0) {
-    numBits += 1;
+    numBits++;
     n >>>= 1;
   }
 

package/src/functions/deepCopy.ts

@@ -51,15 +51,19 @@ const COPYABLE_ISAAC_API_CLASS_TYPES_SET = new Set<string>(
  * - 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.
+ * @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 insideMap Optional. Tracks whether or not the deep copy function is in the process of
+ *                  recursively copying a TSTL Map. Default is false.
  */
 export function deepCopy(
   value: unknown,
   serializationType = SerializationType.NONE,
   traversalDescription = "",
+  insideMap = false,
 ): unknown {
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (SAVE_DATA_MANAGER_DEBUG) {
@@ -98,7 +102,12 @@ export function deepCopy(
 
     case "table": {
       const luaTable = value as LuaTable<AnyNotNil, unknown>;
-      return deepCopyTable(luaTable, serializationType, traversalDescription);
+      return deepCopyTable(
+        luaTable,
+        serializationType,
+        traversalDescription,
+        insideMap,
+      );
     }
 
     case "userdata": {
@@ -111,6 +120,7 @@ function deepCopyTable(
   luaTable: LuaTable<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
+  insideMap: boolean,
 ) {
   // First, handle the cases of TSTL classes or serialized TSTL classes.
   if (isDefaultMap(luaTable) || luaTable.has(SerializationBrand.DEFAULT_MAP)) {
@@ -118,15 +128,26 @@ function deepCopyTable(
       luaTable,
       serializationType,
       traversalDescription,
+      insideMap,
     );
   }
 
   if (isTSTLMap(luaTable) || luaTable.has(SerializationBrand.MAP)) {
-    return deepCopyMap(luaTable, serializationType, traversalDescription);
+    return deepCopyMap(
+      luaTable,
+      serializationType,
+      traversalDescription,
+      insideMap,
+    );
   }
 
   if (isTSTLSet(luaTable) || luaTable.has(SerializationBrand.SET)) {
-    return deepCopySet(luaTable, serializationType, traversalDescription);
+    return deepCopySet(
+      luaTable,
+      serializationType,
+      traversalDescription,
+      insideMap,
+    );
   }
 
   const className = getTSTLClassName(luaTable);
@@ -144,7 +165,12 @@ function deepCopyTable(
   }
 
   if (isUserDefinedTSTLClass(luaTable)) {
-    return deepCopyTSTLClass(luaTable, serializationType, traversalDescription);
+    return deepCopyTSTLClass(
+      luaTable,
+      serializationType,
+      traversalDescription,
+      insideMap,
+    );
   }
 
   // This is not a TSTL Map/Set/class. If it has a metatable, abort.
@@ -160,7 +186,12 @@ function deepCopyTable(
 
   // Handle the special case of an array.
   if (isArray(luaTable)) {
-    return deepCopyArray(luaTable, serializationType, traversalDescription);
+    return deepCopyArray(
+      luaTable,
+      serializationType,
+      traversalDescription,
+      insideMap,
+    );
   }
 
   // Base case: copy a normal Lua table
@@ -168,6 +199,7 @@ function deepCopyTable(
     luaTable,
     serializationType,
     traversalDescription,
+    insideMap,
   );
 }
 
@@ -175,19 +207,39 @@ function deepCopyDefaultMap(
   defaultMap: DefaultMap<AnyNotNil, unknown> | LuaTable<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
+  insideMap: boolean,
 ) {
-  // First, handle the special case of serializing a DefaultMap instantiated with a factory
-  // function. If this is the case, then we cannot serialize it, so we serialize it as a normal
-  // `Map` instead. We do not throw a runtime error because the merge function does not need to
-  // instantiate the DefaultMap class in most circumstances.
   const constructorArg = isDefaultMap(defaultMap)
     ? defaultMap.getConstructorArg()
-    : undefined;
+    : undefined; // The undefined case is handled explicitly in the "getNewDefaultMap" function.
+
+  // First, handle the special case of serializing a DefaultMap instantiated with a factory
+  // function. If this is the case, then we cannot serialize it (because there is no way to
+  // serialize a function).
   if (
     serializationType === SerializationType.SERIALIZE &&
     !isPrimitive(constructorArg)
   ) {
-    return deepCopyMap(defaultMap, serializationType, traversalDescription);
+    if (insideMap) {
+      // The case of a DefaultMap within another map is complicated. Unlike a DefaultMap attached to
+      // a "normal" object, the `merge` function will have no reference to the factory function that
+      // was used to instantiate it. Thus, there is no way to copy this object. In this case, we
+      // throw a run-time error to immediately alert the end-user that their data structure is
+      // invalid.
+      error(
+        'Failed to deep copy a DefaultMap because it was instantiated with a factory function and was also inside of another map. You cannot use a nested DefaultMap in this way because factory functions are not serializable. (In other words, there is no way to copy the function that you are using for the DefaultMap into the "save#.dat" file.) Instead, refactor your data structure so that the DefaultMap is not nested.',
+      );
+    } else {
+      // In most cases, the DefaultMap will be attached to a normal table element. In this case, if
+      // we serialize it as a normal `Map`, then everything will work out fine, because the `merge`
+      // function only needs to copy the values (and not instantiate the object itself).
+      return deepCopyMap(
+        defaultMap,
+        serializationType,
+        traversalDescription,
+        insideMap,
+      );
+    }
   }
 
   const newDefaultMap = getNewDefaultMap(
@@ -196,11 +248,13 @@ function deepCopyDefaultMap(
     traversalDescription,
     constructorArg,
   );
+  insideMap = true;
 
   const { entries, convertedNumberKeysToStrings } = getCopiedEntries(
     defaultMap,
     serializationType,
     traversalDescription,
+    insideMap,
   );
 
   if (convertedNumberKeysToStrings) {
@@ -223,12 +277,14 @@ function deepCopyDefaultMap(
     }
   }
 
+  insideMap = false;
+
   return newDefaultMap;
 }
 
 /**
- * The new default map with either be a TSTL `DefaultMap` class or a Lua table, depending on whether
- * we are serializing or not.
+ * The new copied default map with either be a TSTL `DefaultMap` class or a Lua table, depending on
+ * whether we are serializing or not.
  */
 function getNewDefaultMap(
   defaultMap: DefaultMap<AnyNotNil, unknown> | LuaTable<AnyNotNil, unknown>,
@@ -278,6 +334,7 @@ function deepCopyMap(
   map: Map<AnyNotNil, unknown> | LuaTable<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
+  insideMap: boolean,
 ) {
   let newMap: Map<AnyNotNil, unknown> | LuaTable<AnyNotNil, unknown>;
   if (serializationType === SerializationType.SERIALIZE) {
@@ -287,11 +344,13 @@ function deepCopyMap(
   } else {
     newMap = new Map();
   }
+  insideMap = true;
 
   const { entries, convertedNumberKeysToStrings } = getCopiedEntries(
     map,
     serializationType,
     traversalDescription,
+    insideMap,
   );
 
   if (convertedNumberKeysToStrings) {
@@ -314,6 +373,8 @@ function deepCopyMap(
     }
   }
 
+  insideMap = false;
+
   return newMap;
 }
 
@@ -321,6 +382,7 @@ function deepCopySet(
   set: Set<AnyNotNil> | LuaTable<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
+  insideMap: boolean,
 ) {
   let newSet: Set<AnyNotNil> | LuaTable<AnyNotNil, string>;
   if (serializationType === SerializationType.SERIALIZE) {
@@ -336,6 +398,7 @@ function deepCopySet(
     set,
     serializationType,
     traversalDescription,
+    insideMap,
   );
 
   if (convertedNumberKeysToStrings) {
@@ -368,6 +431,7 @@ function deepCopyTSTLClass(
   tstlClass: TSTLClass,
   serializationType: SerializationType,
   traversalDescription: string,
+  insideMap: boolean,
 ) {
   let newClass: TSTLClass | LuaTable<AnyNotNil, unknown>;
   if (serializationType === SerializationType.SERIALIZE) {
@@ -383,6 +447,7 @@ function deepCopyTSTLClass(
     tstlClass,
     serializationType,
     traversalDescription,
+    insideMap,
   );
 
   if (convertedNumberKeysToStrings) {
@@ -400,11 +465,17 @@ function deepCopyArray(
   array: unknown[],
   serializationType: SerializationType,
   traversalDescription: string,
+  insideMap: boolean,
 ) {
   const newArray: unknown[] = [];
 
   for (const value of array) {
-    const newValue = deepCopy(value, serializationType, traversalDescription);
+    const newValue = deepCopy(
+      value,
+      serializationType,
+      traversalDescription,
+      insideMap,
+    );
     newArray.push(newValue);
   }
 
@@ -415,12 +486,14 @@ function deepCopyNormalLuaTable(
   luaTable: LuaTable<AnyNotNil, unknown>,
   serializationType: SerializationType,
   traversalDescription: string,
+  insideMap: boolean,
 ) {
   const newTable = new LuaTable<AnyNotNil, unknown>();
   const { entries, convertedNumberKeysToStrings } = getCopiedEntries(
     luaTable,
     serializationType,
     traversalDescription,
+    insideMap,
   );
 
   if (convertedNumberKeysToStrings) {
@@ -442,6 +515,7 @@ function getCopiedEntries(
   object: unknown,
   serializationType: SerializationType,
   traversalDescription: string,
+  insideMap: boolean,
 ): {
   entries: Array<[key: AnyNotNil, value: unknown]>;
   convertedNumberKeysToStrings: boolean;
@@ -479,7 +553,12 @@ function getCopiedEntries(
     }
 
     traversalDescription = getTraversalDescription(key, traversalDescription);
-    const newValue = deepCopy(value, serializationType, traversalDescription);
+    const newValue = deepCopy(
+      value,
+      serializationType,
+      traversalDescription,
+      insideMap,
+    );
 
     const keyToUse = convertNumberKeysToStrings ? tostring(key) : key;
     copiedEntries.push([keyToUse, newValue]);

package/src/functions/deepCopyTests.ts

@@ -131,6 +131,7 @@ function copiedTableDoesNotCoerceTypes() {
   }
 }
 
+/** In this context, a reference is a pointer. */
 function copiedObjectHasNoReferencesForPrimitivesForward() {
   const originalStringValue = "abcdef";
   const originalNumberValue = 123;
@@ -181,6 +182,7 @@ function copiedObjectHasNoReferencesForPrimitivesBackward() {
   }
 }
 
+/** In this context, a reference is a pointer. */
 function copiedObjectHasNoReferencesForArray() {
   const oldObject = {
     abc: [1, 2, 3],
@@ -200,21 +202,21 @@ function copiedObjectHasNoReferencesForArray() {
     error("The copied object does not have an equal array.");
   }
 
-  oldObject.abc[0] += 1;
+  oldObject.abc[0]++;
   if (arrayEquals(oldObject.abc, newObject.abc)) {
     error(
       "The copied object has an equal array after a modification to the old array.",
     );
   }
-  oldObject.abc[0] -= 1;
+  oldObject.abc[0]--;
 
-  newObject.abc[0] += 1;
+  newObject.abc[0]++;
   if (arrayEquals(oldObject.abc, newObject.abc)) {
     error(
       "The copied object has an equal array after a modification to the new array.",
     );
   }
-  newObject.abc[0] -= 1;
+  newObject.abc[0]--;
 }
 
 function copiedObjectHasChildObject() {

package/src/functions/log.ts

@@ -228,7 +228,7 @@ export function logEntities(
       msg += `  - CanShutDoors: ${npc.CanShutDoors}\n`;
     }
 
-    numMatchedEntities += 1;
+    numMatchedEntities++;
   });
 
   if (numMatchedEntities === 0) {
@@ -404,7 +404,7 @@ export function logGridEntities(
       msg += `  - TargetRoomType: ${door.TargetRoomType}\n`;
     }
 
-    numMatchedEntities += 1;
+    numMatchedEntities++;
   });
 
   if (numMatchedEntities === 0) {
@@ -572,7 +572,7 @@ export function logSounds(this: void): void {
  * 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 runtime error if it encounters a non-string key.
+ * instead of randomly). It will throw a run-time error if it encounters a non-string key.
  */
 export function logTable(
   this: void,

package/src/functions/table.ts

@@ -134,7 +134,7 @@ export function getStringsFromTable(
  * This function will sort the table entries based on the value of the key.
  *
  * This function will only work on tables that have number keys or string keys. It will throw a
- * runtime error if it encounters a key of another type.
+ * run-time error if it encounters a key of another type.
  *
  * @param luaTable The table to iterate over.
  * @param func The function to run for each iteration.

package/src/functions/trinketGive.ts

@@ -98,7 +98,7 @@ export function temporarilyRemoveTrinket(
   let numTrinkets = 0;
   while (player.HasTrinket(trinketType)) {
     player.TryRemoveTrinket(trinketType);
-    numTrinkets += 1;
+    numTrinkets++;
   }
 
   let numSmeltedTrinkets = numTrinkets;
@@ -106,13 +106,13 @@ export function temporarilyRemoveTrinket(
     trinketType1 === trinketType ||
     trinketType1 === getGoldenTrinketType(trinketType);
   if (trinketWasInSlot1) {
-    numSmeltedTrinkets -= 1;
+    numSmeltedTrinkets--;
   }
   const trinketWasInSlot2 =
     trinketType2 === trinketType ||
     trinketType2 === getGoldenTrinketType(trinketType);
   if (trinketWasInSlot2) {
-    numSmeltedTrinkets -= 1;
+    numSmeltedTrinkets--;
   }
 
   return {

package/src/functions/tstlClass.ts

@@ -100,7 +100,7 @@ export function isUserDefinedTSTLClass(object: unknown): object is TSTLClass {
 
   let numKeys = 0;
   for (const [key] of pairs(metatable)) {
-    numKeys += 1;
+    numKeys++;
 
     if (!isString(key)) {
       return false;

package/src/functions/ui.ts

@@ -27,10 +27,10 @@ export function getHUDOffsetVector(): Vector {
   const x = hudOffset * 2;
   let y = hudOffset;
   if (y >= 4) {
-    y += 1;
+    y++;
   }
   if (y >= 9) {
-    y += 1;
+    y++;
   }
 
   return Vector(x, y);
@@ -69,7 +69,7 @@ export function getHeartsUIWidth(): int {
 
   let heartRowLength = getHeartRowLength(player);
   if (hasHolyMantleEffect) {
-    heartRowLength += 1;
+    heartRowLength++;
   }
   if (curses === LevelCurse.UNKNOWN) {
     heartRowLength = 1;