isaacscript-common 3.15.2 → 3.16.0

package/callbacks/postPlayerFatalDamage.lua

@@ -70,10 +70,10 @@ function entityTakeDmgPlayer(self, tookDamage, damageAmount, damageFlags, damage
 end
 function preUseItemBible(self, _collectibleType, _rng, player)
     if not hasSubscriptions(nil) then
-        return false
+        return nil
     end
     if not inBossRoomOf(nil, BossID.SATAN) then
-        return false
+        return nil
     end
     local shouldSustainDeath = postPlayerFatalDamageFire(
         nil,
@@ -86,7 +86,7 @@ function preUseItemBible(self, _collectibleType, _rng, player)
     if shouldSustainDeath ~= nil then
         return not shouldSustainDeath
     end
-    return false
+    return nil
 end
 v = {run = {playersLastDamageGameFrame = __TS__New(Map)}}
 ---

package/callbacks/postSlotDestroyed.lua

@@ -3,14 +3,17 @@ local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local ____exports = {}
-local hasSubscriptions, postEntityRemove, postSlotAnimationChanged, BROKEN_ANIMATIONS, PRIZE_GAME_FRAME_DELAY_UNTIL_REMOVAL, v
+local hasSubscriptions, postEntityRemove, postSlotAnimationChanged, PRIZE_GAME_FRAME_DELAY_UNTIL_REMOVAL, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____ModCallbackCustom = require("enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____SlotDestructionType = require("enums.SlotDestructionType")
+local SlotDestructionType = ____SlotDestructionType.SlotDestructionType
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____postSlotDestroyed = require("callbacks.subscriptions.postSlotDestroyed")
@@ -28,7 +31,7 @@ function postEntityRemove(self, entity)
         return
     end
     if prizeFrame + PRIZE_GAME_FRAME_DELAY_UNTIL_REMOVAL == gameFrameCount then
-        postSlotDestroyedFire(nil, slot)
+        postSlotDestroyedFire(nil, slot, SlotDestructionType.COLLECTIBLE_PAYOUT)
     end
 end
 function postSlotAnimationChanged(self, slot)
@@ -38,19 +41,18 @@ function postSlotAnimationChanged(self, slot)
     if alreadyBroken then
         return
     end
-    local sprite = slot:GetSprite()
-    local animation = sprite:GetAnimation()
-    if BROKEN_ANIMATIONS:has(animation) then
+    if slot.GridCollisionClass == EntityGridCollisionClass.GROUND then
         v.room.brokenSlots:add(ptrHash)
-        postSlotDestroyedFire(nil, slot)
+        postSlotDestroyedFire(nil, slot, SlotDestructionType.NORMAL)
     end
+    local sprite = slot:GetSprite()
+    local animation = sprite:GetAnimation()
     if animation == "Prize" then
         v.room.slotPrizeAnimationGameFrame:set(ptrHash, gameFrameCount)
     else
         v.room.slotPrizeAnimationGameFrame:delete(ptrHash)
     end
 end
-BROKEN_ANIMATIONS = __TS__New(Set, {"Broken", "Death"})
 PRIZE_GAME_FRAME_DELAY_UNTIL_REMOVAL = 3
 v = {room = {
     brokenSlots = __TS__New(Set),

package/callbacks/subscriptions/postSlotDestroyed.d.ts

@@ -1,5 +1,7 @@
 import { SlotVariant } from "isaac-typescript-definitions";
+import { SlotDestructionType } from "../../enums/SlotDestructionType";
 export declare type PostSlotDestroyedRegisterParameters = [
-    callback: (slot: EntitySlot) => void,
-    slotVariant?: SlotVariant
+    callback: (slot: EntitySlot, slotDestructionType: SlotDestructionType) => void,
+    slotVariant?: SlotVariant,
+    slotDestructionType?: SlotDestructionType
 ];

package/callbacks/subscriptions/postSlotDestroyed.lua

@@ -13,15 +13,19 @@ function ____exports.postSlotDestroyedRegister(self, ...)
 end
 ---
 -- @internal
-function ____exports.postSlotDestroyedFire(self, slot)
+function ____exports.postSlotDestroyedFire(self, slot, slotDestructionType)
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]
-        local slotVariant = ____value[2]
+        local callbackSlotVariant = ____value[2]
+        local callbackSlotDestructionType = ____value[3]
         do
-            if slotVariant ~= nil and slotVariant ~= slot.Variant then
+            if callbackSlotVariant ~= nil and callbackSlotVariant ~= slot.Variant then
                 goto __continue5
             end
-            callback(nil, slot)
+            if callbackSlotDestructionType ~= nil and callbackSlotDestructionType ~= slotDestructionType then
+                goto __continue5
+            end
+            callback(nil, slot, slotDestructionType)
         end
         ::__continue5::
     end

package/classes/DefaultMap.lua

@@ -4,6 +4,9 @@ local Map = ____lualib.Map
 local __TS__ClassExtends = ____lualib.__TS__ClassExtends
 local __TS__TypeOf = ____lualib.__TS__TypeOf
 local ____exports = {}
+local ____types = require("functions.types")
+local isFunction = ____types.isFunction
+local isPrimitive = ____types.isPrimitive
 --- `DefaultMap` is a data structure that makes working with default values easier.
 -- 
 -- It is a common pattern to look up a value in a `Map`, and then, if the value does not exist, set
@@ -87,11 +90,10 @@ local DefaultMap = ____exports.DefaultMap
 DefaultMap.name = "DefaultMap"
 __TS__ClassExtends(DefaultMap, Map)
 function DefaultMap.prototype.____constructor(self, defaultValueOrFactoryFunction, initializerArray)
-    local argType = __TS__TypeOf(defaultValueOrFactoryFunction)
-    local argIsPrimitive = argType == "boolean" or argType == "number" or argType == "string"
-    local argIsFunction = argType == "function"
+    local argIsPrimitive = isPrimitive(nil, defaultValueOrFactoryFunction)
+    local argIsFunction = isFunction(nil, defaultValueOrFactoryFunction)
     if not argIsPrimitive and not argIsFunction then
-        error(("Failed to instantiate a DefaultMap since the provided default value was of type \"" .. argType) .. "\". This error usually means that you are trying to use an array (or some other non-primitive data structure that is passed by reference) as the default value. Instead, return the data structure in a factory function, like \"() => []\". See the DefaultMap documentation for more details.")
+        error(("Failed to instantiate a DefaultMap since the provided default value was of type \"" .. __TS__TypeOf(defaultValueOrFactoryFunction)) .. "\". This error usually means that you are trying to use an array (or some other non-primitive data structure that is passed by reference) as the default value. Instead, return the data structure in a factory function, like \"() => []\". See the DefaultMap documentation for more details.")
     end
     Map.prototype.____constructor(self, initializerArray)
     if argIsFunction then

package/constants.d.ts

@@ -14,6 +14,8 @@ export declare const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125;
 export declare const BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png";
 /** Bombs explode when their frame count is equal to this value. */
 export declare const BOMB_EXPLODE_FRAME = 45;
+/** This is the initial value of the `EntityPickup.Wait` property after a collectible is spawned. */
+export declare const COLLECTIBLE_STARTING_WAIT = 20;
 export declare const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE;
 /** This is also the distance that a player spawns from the door that they enter a room from. */
 export declare const DISTANCE_OF_GRID_TILE = 40;

package/constants.lua

@@ -18,6 +18,8 @@ ____exports.AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125
 ____exports.BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png"
 --- Bombs explode when their frame count is equal to this value.
 ____exports.BOMB_EXPLODE_FRAME = 45
+--- This is the initial value of the `EntityPickup.Wait` property after a collectible is spawned.
+____exports.COLLECTIBLE_STARTING_WAIT = 20
 ____exports.DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE
 --- This is also the distance that a player spawns from the door that they enter a room from.
 ____exports.DISTANCE_OF_GRID_TILE = 40

package/enums/ModCallbackCustom.d.ts

@@ -421,7 +421,7 @@ export declare enum ModCallbackCustom {
      * ```ts
      * function postItemDischarge(
      *   player: EntityPlayer,
-     *   collectibleType: CollectibleType | int,
+     *   collectibleType: CollectibleType,
      *   activeSlot: ActiveSlot,
      * ): void {}
      * ```
@@ -692,8 +692,8 @@ export declare enum ModCallbackCustom {
      * ```ts
      * function postPlayerChangeType(
      *   player: EntityPlayer,
-     *   oldCharacter: PlayerType | int,
-     *   newCharacter: PlayerType | int,
+     *   oldCharacter: PlayerType,
+     *   newCharacter: PlayerType,
      * ) {}
      * ```
      */
@@ -734,7 +734,7 @@ export declare enum ModCallbackCustom {
      * prevent the fatal damage.
      *
      * Note that this function does properly take into account Guppy's Collar, Broken Ankh, Spirit
-     * Shackles, and Mysterious Paper.
+     * Shackles, and Mysterious Paper. It also takes into account using The Bible on Satan.
      *
      * - When registering the callback, takes an optional second argument that will make the callback
      *   only fire if the player matches the `PlayerVariant` provided.
@@ -964,11 +964,13 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_RENDER` callback when a slot plays the animation that indicates that it
      * has broken.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `SlotVariant` provided.
+     * - When registering the callback, takes an optional second argument that will make the callback
+     *   only fire if it matches the `SlotVariant` provided.
+     * - When registering the callback, takes an optional third argument that will make the callback
+     *   only fire if the destruction type matches the `SlotDestructionType` provided.
      *
      * ```ts
-     * function postSlotDestroyed(slot: Entity): void {}
+     * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
     POST_SLOT_DESTROYED = 66,
@@ -1110,7 +1112,7 @@ export declare enum ModCallbackCustom {
      * ```ts
      * function postTrinketBreak(
      *   player: EntityPlayer,
-     *   trinketType: TrinketType | int,
+     *   trinketType: TrinketType,
      * ): void {}
      * ```
      */

package/enums/SlotDestructionType.d.ts

@@ -0,0 +1,4 @@
+export declare enum SlotDestructionType {
+    NORMAL = 0,
+    COLLECTIBLE_PAYOUT = 1
+}

package/enums/SlotDestructionType.lua

@@ -0,0 +1,7 @@
+local ____exports = {}
+____exports.SlotDestructionType = {}
+____exports.SlotDestructionType.NORMAL = 0
+____exports.SlotDestructionType[____exports.SlotDestructionType.NORMAL] = "NORMAL"
+____exports.SlotDestructionType.COLLECTIBLE_PAYOUT = 1
+____exports.SlotDestructionType[____exports.SlotDestructionType.COLLECTIBLE_PAYOUT] = "COLLECTIBLE_PAYOUT"
+return ____exports

package/features/deployJSONRoom.lua

@@ -4,14 +4,16 @@ local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, v
+local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
 local EntityCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityCollisionClass
 local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
 local PitfallVariant = ____isaac_2Dtypescript_2Ddefinitions.PitfallVariant
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
@@ -23,6 +25,8 @@ local ____ModCallbackCustom = require("enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____array = require("functions.array")
+local emptyArray = ____array.emptyArray
 local ____entity = require("functions.entity")
 local removeAllMatchingEntities = ____entity.removeAllMatchingEntities
 local spawn = ____entity.spawn
@@ -35,6 +39,7 @@ local ____gridEntity = require("functions.gridEntity")
 local convertXMLGridEntityType = ____gridEntity.convertXMLGridEntityType
 local getGridEntities = ____gridEntity.getGridEntities
 local removeAllGridExcept = ____gridEntity.removeAllGridExcept
+local removeGrid = ____gridEntity.removeGrid
 local setGridEntityInvisible = ____gridEntity.setGridEntityInvisible
 local spawnGridWithVariant = ____gridEntity.spawnGridWithVariant
 local ____jsonRoom = require("functions.jsonRoom")
@@ -56,8 +61,44 @@ local ____spawnCollectible = require("functions.spawnCollectible")
 local spawnCollectible = ____spawnCollectible.spawnCollectible
 local ____utils = require("functions.utils")
 local erange = ____utils.erange
+local ____runInNFrames = require("features.runInNFrames")
+local runNextGameFrame = ____runInNFrames.runNextGameFrame
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
+function preUseItemWeNeedToGoDeeper(self, _collectibleType, _rng, player)
+    if v.room.manuallyUsingShovel then
+        return nil
+    end
+    local roomListIndex = getRoomListIndex(nil)
+    if not v.level.deployedRoomListIndexes:has(roomListIndex) then
+        return nil
+    end
+    local decorations = getGridEntities(nil, GridEntityType.DECORATION)
+    for ____, decoration in ipairs(decorations) do
+        removeGrid(nil, decoration, false)
+    end
+    local playerPtr = EntityPtr(player)
+    runNextGameFrame(
+        nil,
+        function()
+            local futureEntity = playerPtr.Ref
+            if futureEntity == nil then
+                return
+            end
+            local futurePlayer = futureEntity:ToPlayer()
+            if futurePlayer == nil then
+                return
+            end
+            v.room.manuallyUsingShovel = true
+            futurePlayer:UseActiveItem(CollectibleType.WE_NEED_TO_GO_DEEPER)
+            v.room.manuallyUsingShovel = false
+            local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
+            emptyArray(nil, decorationGridIndexes)
+            fillRoomWithDecorations(nil)
+        end
+    )
+    return true
+end
 function postNewRoomReordered(self)
     local roomListIndex = getRoomListIndex(nil)
     if not v.level.deployedRoomListIndexes:has(roomListIndex) then
@@ -124,10 +165,10 @@ function removeSpecificNPCs(self)
     for ____, npc in ipairs(getNPCs(nil)) do
         do
             if NPC_TYPES_TO_NOT_REMOVE:has(npc.Type) then
-                goto __continue25
+                goto __continue33
             end
             if npc:HasEntityFlags(EntityFlag.CHARM) or npc:HasEntityFlags(EntityFlag.FRIENDLY) or npc:HasEntityFlags(EntityFlag.PERSISTENT) then
-                goto __continue25
+                goto __continue33
             end
             npc:ClearEntityFlags(EntityFlag.APPEAR)
             npc:Remove()
@@ -136,7 +177,7 @@ function removeSpecificNPCs(self)
                 room:SetGridPath(gridIndex, 0)
             end
         end
-        ::__continue25::
+        ::__continue33::
     end
 end
 function fillRoomWithDecorations(self)
@@ -148,7 +189,7 @@ function fillRoomWithDecorations(self)
         do
             local existingGridEntity = room:GetGridEntity(gridIndex)
             if existingGridEntity ~= nil then
-                goto __continue31
+                goto __continue39
             end
             local position = room:GetGridPosition(gridIndex)
             local decoration = Isaac.GridSpawn(GridEntityType.DECORATION, 0, position)
@@ -157,7 +198,7 @@ function fillRoomWithDecorations(self)
             end
             decorationGridIndexes[#decorationGridIndexes + 1] = gridIndex
         end
-        ::__continue31::
+        ::__continue39::
     end
 end
 function spawnAllEntities(self, jsonRoom, rng, verbose)
@@ -413,21 +454,25 @@ end
 FEATURE_NAME = "JSON room deployer"
 NPC_TYPES_TO_NOT_REMOVE = __TS__New(Set, {EntityType.DARK_ESAU})
 PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
-v = {level = {
-    deployedRoomListIndexes = __TS__New(Set),
-    roomToPersistentEntitiesMap = __TS__New(
-        DefaultMap,
-        function() return {} end
-    ),
-    roomToDecorationGridIndexesMap = __TS__New(
-        DefaultMap,
-        function() return {} end
-    )
-}}
+v = {
+    level = {
+        deployedRoomListIndexes = __TS__New(Set),
+        roomToPersistentEntitiesMap = __TS__New(
+            DefaultMap,
+            function() return {} end
+        ),
+        roomToDecorationGridIndexesMap = __TS__New(
+            DefaultMap,
+            function() return {} end
+        )
+    },
+    room = {manuallyUsingShovel = false}
+}
 ---
 -- @internal
 function ____exports.deployJSONRoomInit(self, mod)
     saveDataManager(nil, "deployJSONRoom", v)
+    mod:AddCallback(ModCallback.PRE_USE_ITEM, preUseItemWeNeedToGoDeeper, CollectibleType.WE_NEED_TO_GO_DEEPER)
     mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
 end
 --- Helper function to deconstruct a vanilla room and set up a custom room in its place.

package/features/saveDataManager/exports.lua

@@ -1,5 +1,6 @@
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
+local __TS__TypeOf = ____lualib.__TS__TypeOf
 local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
 local ____exports = {}
 local ____SerializationType = require("enums.SerializationType")
@@ -8,6 +9,8 @@ local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
 local ____deepCopy = require("functions.deepCopy")
 local deepCopy = ____deepCopy.deepCopy
+local ____types = require("functions.types")
+local isString = ____types.isString
 local ____constants = require("features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
 local ____main = require("features.saveDataManager.main")
@@ -103,9 +106,8 @@ local saveDataMap = ____maps.saveDataMap
 -- not clutter the the "save#.dat" file with unnecessary keys.
 function ____exports.saveDataManager(self, key, v, conditionalFunc)
     errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
-    local keyType = type(key)
-    if keyType ~= "string" then
-        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " requires that keys are strings. You tried to use a key of type: ") .. keyType)
+    if not isString(nil, key) then
+        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " requires that keys are strings. You tried to use a key of type: ") .. __TS__TypeOf(key))
     end
     if saveDataMap[key] ~= nil then
         error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " is already managing save data for a key of: ") .. key)
@@ -168,9 +170,8 @@ end
 -- ```
 function ____exports.saveDataManagerReset(self, key, childObjectKey)
     errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
-    local keyType = type(key)
-    if keyType ~= "string" then
-        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " requires that keys are strings. You tried to use a key of type: ") .. keyType)
+    if not isString(nil, key) then
+        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " requires that keys are strings. You tried to use a key of type: ") .. __TS__TypeOf(key))
     end
     local saveData = saveDataMap[key]
     if saveData == nil then

package/features/saveDataManager/load.lua

@@ -8,7 +8,10 @@ local ____log = require("functions.log")
 local log = ____log.log
 local logError = ____log.logError
 local ____table = require("functions.table")
-local iterateTableDeterministically = ____table.iterateTableDeterministically
+local iterateTableInOrder = ____table.iterateTableInOrder
+local ____types = require("functions.types")
+local isString = ____types.isString
+local isTable = ____types.isTable
 local ____constants = require("features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
@@ -43,15 +46,14 @@ function ____exports.loadFromDisk(self, mod, oldSaveData)
     if SAVE_DATA_MANAGER_DEBUG then
         log("Converted data from the \"save#.dat\" to a Lua table.")
     end
-    iterateTableDeterministically(
+    iterateTableInOrder(
         nil,
         newSaveData,
         function(____, key, value)
-            if type(key) ~= "string" then
+            if not isString(nil, key) then
                 return
             end
-            local valueType = type(value)
-            if valueType ~= "table" then
+            if not isTable(nil, value) then
                 return
             end
             local oldSaveDataForSubscriber = oldSaveData[key]

package/features/saveDataManager/main.lua

@@ -19,7 +19,7 @@ local ____log = require("functions.log")
 local logError = ____log.logError
 local ____table = require("functions.table")
 local clearTable = ____table.clearTable
-local iterateTableDeterministically = ____table.iterateTableDeterministically
+local iterateTableInOrder = ____table.iterateTableInOrder
 local ____constants = require("features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
@@ -66,7 +66,7 @@ function restoreDefaultsAll(self)
     restoreDefaults(nil, SaveDataKey.ROOM)
 end
 function restoreDefaults(self, saveDataKey)
-    iterateTableDeterministically(
+    iterateTableInOrder(
         nil,
         saveDataMap,
         function(____, subscriberName, saveData)

package/features/saveDataManager/merge.lua

@@ -18,10 +18,12 @@ local deserializeIsaacAPIClass = ____serialization.deserializeIsaacAPIClass
 local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
 local ____table = require("functions.table")
 local clearTable = ____table.clearTable
-local iterateTableDeterministically = ____table.iterateTableDeterministically
+local iterateTableInOrder = ____table.iterateTableInOrder
 local ____tstlClass = require("functions.tstlClass")
 local isTSTLMap = ____tstlClass.isTSTLMap
 local isTSTLSet = ____tstlClass.isTSTLSet
+local ____types = require("functions.types")
+local isTable = ____types.isTable
 local ____utils = require("functions.utils")
 local getTraversalDescription = ____utils.getTraversalDescription
 local ____constants = require("features.saveDataManager.constants")
@@ -52,17 +54,14 @@ function ____exports.merge(self, oldObject, newTable, traversalDescription)
     if SAVE_DATA_MANAGER_DEBUG then
         log("merge is traversing: " .. traversalDescription)
     end
-    local oldObjectType = type(oldObject)
-    if oldObjectType ~= "table" then
+    if not isTable(nil, oldObject) then
         error("The first argument given to the merge function is not a table.")
     end
-    local newTableType = type(newTable)
-    if newTableType ~= "table" then
+    if not isTable(nil, newTable) then
         error("The second argument given to the merge function is not a table.")
     end
     if isArray(nil, oldObject) and isArray(nil, newTable) then
-        local oldTable = oldObject
-        mergeArray(nil, oldTable, newTable)
+        mergeArray(nil, oldObject, newTable)
         return
     end
     if isTSTLMap(nil, oldObject) or isTSTLSet(nil, oldObject) then
@@ -73,7 +72,7 @@ function ____exports.merge(self, oldObject, newTable, traversalDescription)
 end
 function mergeArray(self, oldArray, newArray)
     clearTable(nil, oldArray)
-    iterateTableDeterministically(
+    iterateTableInOrder(
         nil,
         newArray,
         function(____, key, value)
@@ -85,7 +84,7 @@ end
 function mergeTSTLObject(self, oldObject, newTable, traversalDescription)
     oldObject:clear()
     local convertStringKeysToNumbers = newTable[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] ~= nil
-    iterateTableDeterministically(
+    iterateTableInOrder(
         nil,
         newTable,
         function(____, key, value)
@@ -101,9 +100,8 @@ function mergeTSTLObject(self, oldObject, newTable, traversalDescription)
                 keyToUse = numberKey
             end
             if isTSTLMap(nil, oldObject) then
-                local valueType = type(value)
                 local valueCopy
-                if valueType == "table" then
+                if isTable(nil, value) then
                     valueCopy = deepCopy(nil, value, SerializationType.DESERIALIZE, traversalDescription)
                 else
                     valueCopy = value
@@ -117,7 +115,7 @@ function mergeTSTLObject(self, oldObject, newTable, traversalDescription)
     )
 end
 function mergeTable(self, oldTable, newTable, traversalDescription)
-    iterateTableDeterministically(
+    iterateTableInOrder(
         nil,
         newTable,
         function(____, key, value)
@@ -136,11 +134,9 @@ function mergeTable(self, oldTable, newTable, traversalDescription)
                 oldTable[key] = deserializedObject
                 return
             end
-            local valueType = type(value)
-            if valueType == "table" then
+            if isTable(nil, value) then
                 local oldValue = oldTable[key]
-                local oldValueType = type(oldValue)
-                if oldValueType ~= "table" then
+                if not isTable(nil, oldValue) then
                     oldValue = {}
                     oldTable[key] = oldValue
                 end

package/features/saveDataManager/save.lua

@@ -12,13 +12,13 @@ local jsonEncode = ____jsonHelpers.jsonEncode
 local ____log = require("functions.log")
 local log = ____log.log
 local ____table = require("functions.table")
-local iterateTableDeterministically = ____table.iterateTableDeterministically
+local iterateTableInOrder = ____table.iterateTableInOrder
 local ____constants = require("features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
 function getAllSaveDataToWriteToDisk(self, saveDataMap, saveDataConditionalFuncMap)
     local allSaveData = {}
-    iterateTableDeterministically(
+    iterateTableInOrder(
         nil,
         saveDataMap,
         function(____, subscriberName, saveData)

package/features/saveDataManager/serializationBrand.lua

@@ -6,10 +6,12 @@ local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
+local ____types = require("functions.types")
+local isString = ____types.isString
 local SERIALIZATION_BRANDS = getEnumValues(nil, SerializationBrand)
 local SERIALIZATION_BRAND_SET = __TS__New(Set, SERIALIZATION_BRANDS)
 function ____exports.isSerializationBrand(self, key)
-    if type(key) ~= "string" then
+    if not isString(nil, key) then
         return false
     end
     return SERIALIZATION_BRAND_SET:has(key)

package/functions/array.d.ts

@@ -54,6 +54,7 @@ export declare function combineArrays<T>(...arrays: Array<T[] | readonly T[]>):
  *                    entire array will be copied.
  */
 export declare function copyArray<T>(oldArray: T[] | readonly T[], numElements?: int): T[];
+/** Helper function to remove all of the elements in an array in-place. */
 export declare function emptyArray<T>(array: T[]): void;
 /**
  * Helper function to get an array containing the indexes of an array.