isaacscript-common 11.2.4 → 12.0.0

package/dist/src/features/customTrapdoor/spawn.lua

@@ -13,8 +13,8 @@ local ____vector = require("src.functions.vector")
 local isVector = ____vector.isVector
 local ____customGridEntity = require("src.features.customGridEntity")
 local spawnCustomGridEntity = ____customGridEntity.spawnCustomGridEntity
-local ____customTrapdoorConstants = require("src.features.customTrapdoor.customTrapdoorConstants")
-local GridEntityTypeCustom = ____customTrapdoorConstants.GridEntityTypeCustom
+local ____constants = require("src.features.customTrapdoor.constants")
+local GridEntityTypeCustom = ____constants.GridEntityTypeCustom
 local ____openClose = require("src.features.customTrapdoor.openClose")
 local shouldTrapdoorSpawnOpen = ____openClose.shouldTrapdoorSpawnOpen
 local ____v = require("src.features.customTrapdoor.v")

package/dist/src/features/customTrapdoor/touched.lua

@@ -29,12 +29,12 @@ local isPlayerUsingPony = ____ponyDetection.isPlayerUsingPony
 local ____runInNFrames = require("src.features.runInNFrames")
 local runInNGameFrames = ____runInNFrames.runInNGameFrames
 local runNextRenderFrame = ____runInNFrames.runNextRenderFrame
-local ____customTrapdoorConstants = require("src.features.customTrapdoor.customTrapdoorConstants")
-local ANIMATIONS_THAT_PREVENT_STAGE_TRAVEL = ____customTrapdoorConstants.ANIMATIONS_THAT_PREVENT_STAGE_TRAVEL
-local CUSTOM_TRAPDOOR_FEATURE_NAME = ____customTrapdoorConstants.CUSTOM_TRAPDOOR_FEATURE_NAME
-local OTHER_PLAYER_TRAPDOOR_JUMP_DELAY_GAME_FRAMES = ____customTrapdoorConstants.OTHER_PLAYER_TRAPDOOR_JUMP_DELAY_GAME_FRAMES
-local OTHER_PLAYER_TRAPDOOR_JUMP_DURATION_GAME_FRAMES = ____customTrapdoorConstants.OTHER_PLAYER_TRAPDOOR_JUMP_DURATION_GAME_FRAMES
-local TRAPDOOR_TOUCH_DISTANCE = ____customTrapdoorConstants.TRAPDOOR_TOUCH_DISTANCE
+local ____constants = require("src.features.customTrapdoor.constants")
+local ANIMATIONS_THAT_PREVENT_STAGE_TRAVEL = ____constants.ANIMATIONS_THAT_PREVENT_STAGE_TRAVEL
+local CUSTOM_TRAPDOOR_FEATURE_NAME = ____constants.CUSTOM_TRAPDOOR_FEATURE_NAME
+local OTHER_PLAYER_TRAPDOOR_JUMP_DELAY_GAME_FRAMES = ____constants.OTHER_PLAYER_TRAPDOOR_JUMP_DELAY_GAME_FRAMES
+local OTHER_PLAYER_TRAPDOOR_JUMP_DURATION_GAME_FRAMES = ____constants.OTHER_PLAYER_TRAPDOOR_JUMP_DURATION_GAME_FRAMES
+local TRAPDOOR_TOUCH_DISTANCE = ____constants.TRAPDOOR_TOUCH_DISTANCE
 local ____v = require("src.features.customTrapdoor.v")
 local v = ____v.default
 function canPlayerInteractWithTrapdoor(self, player)

package/dist/src/features/saveDataManager/constants.d.ts

@@ -0,0 +1,10 @@
+import { SaveDataKey } from "../../enums/SaveDataKey";
+/** Set this to true to enable more verbosity in the save data manger. */
+export declare const SAVE_DATA_MANAGER_DEBUG: boolean;
+export declare const SAVE_DATA_MANAGER_FEATURE_NAME = "save data manager";
+/**
+ * When the Glowing Hour Glass is used, certain save data keys will automatically be restored to a
+ * backup.
+ */
+export declare const SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS: SaveDataKey[];
+//# sourceMappingURL=constants.d.ts.map

package/dist/src/features/saveDataManager/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,yEAAyE;AACzE,eAAO,MAAM,uBAAuB,SAAmB,CAAC;AAExD,eAAO,MAAM,8BAA8B,sBAAsB,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,gDAAgD,eAG5D,CAAC"}

package/dist/src/features/saveDataManager/constants.lua

@@ -0,0 +1,10 @@
+local ____exports = {}
+local ____SaveDataKey = require("src.enums.SaveDataKey")
+local SaveDataKey = ____SaveDataKey.SaveDataKey
+--- Set this to true to enable more verbosity in the save data manger.
+____exports.SAVE_DATA_MANAGER_DEBUG = false
+____exports.SAVE_DATA_MANAGER_FEATURE_NAME = "save data manager"
+--- When the Glowing Hour Glass is used, certain save data keys will automatically be restored to a
+-- backup.
+____exports.SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS = {SaveDataKey.RUN, SaveDataKey.LEVEL}
+return ____exports

package/dist/src/features/saveDataManager/exports.d.ts

@@ -72,9 +72,14 @@ import { SaveData } from "../../interfaces/SaveData";
  * data manager cannot do this on its own because it cannot know when your mod features are finished
  * initializing.)
  *
- * Finally, some features may have variables that need to be automatically reset per run/level, but
- * not saved to disk on game exit. (For example, if they contain functions or other non-serializable
- * data.) For these cases, set the second argument to `() => false`.
+ * Some features may have variables that need to be automatically reset per run/level, but not saved
+ * to disk on game exit. (For example, if they contain functions or other non-serializable data.)
+ * For these cases, set the second argument to `() => false`.
+ *
+ * Note that when the player uses Glowing Hour Glass, the save data manager will automatically
+ * restore any variables on a "run" or "level" object with a backup that was created when the room
+ * was entered. Thus, you should not have to explicitly program support for Glowing Hour Glass into
+ * your mod features that use the save data manager.
  *
  * @param key The name of the file or feature that is submitting data to be managed by the save data
  *            manager. The save data manager will throw an error if the key is already registered.

package/dist/src/features/saveDataManager/exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/exports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAKtD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAarD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EACpD,GAAG,EAAE,MAAM,EAAE,qEAAqE;AAClF,CAAC,EAAE,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,CAAC,EACnC,eAAe,CAAC,EAAE,MAAM,OAAO,GAC9B,IAAI,CAAC;AACR,wBAAgB,eAAe,CAC7B,GAAG,EAAE,MAAM,EAAE,kEAAkE;AAC/E,CAAC,EAAE,QAAQ,EACX,eAAe,EAAE,KAAK,GACrB,IAAI,CAAC;AA+CR;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAQD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,IAAI,IAAI,CAK/C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,WAAW,GAC1B,IAAI,CAiBN"}
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/exports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAKtD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAarD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8FG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EACpD,GAAG,EAAE,MAAM,EAAE,qEAAqE;AAClF,CAAC,EAAE,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,CAAC,EACnC,eAAe,CAAC,EAAE,MAAM,OAAO,GAC9B,IAAI,CAAC;AACR,wBAAgB,eAAe,CAC7B,GAAG,EAAE,MAAM,EAAE,kEAAkE;AAC/E,CAAC,EAAE,QAAQ,EACX,eAAe,EAAE,KAAK,GACrB,IAAI,CAAC;AA+CR;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAQD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,IAAI,IAAI,CAK/C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,WAAW,GAC1B,IAAI,CAiBN"}

package/dist/src/features/saveDataManager/exports.lua

@@ -10,6 +10,8 @@ local ____deepCopy = require("src.functions.deepCopy")
 local deepCopy = ____deepCopy.deepCopy
 local ____types = require("src.functions.types")
 local isString = ____types.isString
+local ____constants = require("src.features.saveDataManager.constants")
+local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
 local ____main = require("src.features.saveDataManager.main")
 local forceSaveDataManagerLoad = ____main.forceSaveDataManagerLoad
 local forceSaveDataManagerSave = ____main.forceSaveDataManagerSave
@@ -18,8 +20,6 @@ local ____maps = require("src.features.saveDataManager.maps")
 local saveDataConditionalFuncMap = ____maps.saveDataConditionalFuncMap
 local saveDataDefaultsMap = ____maps.saveDataDefaultsMap
 local saveDataMap = ____maps.saveDataMap
-local ____saveDataManagerConstants = require("src.features.saveDataManager.saveDataManagerConstants")
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
 --- This is the entry point to the save data manager, a system which provides two major features:
 -- 
 -- 1. automatic resetting of variables on a new run, on a new level, or on a new room (as desired)
@@ -91,9 +91,14 @@ local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MA
 -- data manager cannot do this on its own because it cannot know when your mod features are finished
 -- initializing.)
 -- 
--- Finally, some features may have variables that need to be automatically reset per run/level, but
--- not saved to disk on game exit. (For example, if they contain functions or other non-serializable
--- data.) For these cases, set the second argument to `() => false`.
+-- Some features may have variables that need to be automatically reset per run/level, but not saved
+-- to disk on game exit. (For example, if they contain functions or other non-serializable data.)
+-- For these cases, set the second argument to `() => false`.
+-- 
+-- Note that when the player uses Glowing Hour Glass, the save data manager will automatically
+-- restore any variables on a "run" or "level" object with a backup that was created when the room
+-- was entered. Thus, you should not have to explicitly program support for Glowing Hour Glass into
+-- your mod features that use the save data manager.
 -- 
 -- @param key The name of the file or feature that is submitting data to be managed by the save data
 -- manager. The save data manager will throw an error if the key is already registered.

package/dist/src/features/saveDataManager/load.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/load.ts"],"names":[],"mappings":";;AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AASrD,wBAAgB,YAAY,CAC1B,GAAG,EAAE,GAAG,EACR,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GACpC,IAAI,CAmDN"}
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/load.ts"],"names":[],"mappings":";;AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AASrD,wBAAgB,YAAY,CAC1B,GAAG,EAAE,GAAG,EACR,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GACpC,IAAI,CAuDN"}

package/dist/src/features/saveDataManager/load.lua

@@ -12,11 +12,11 @@ local iterateTableInOrder = ____table.iterateTableInOrder
 local ____types = require("src.functions.types")
 local isString = ____types.isString
 local isTable = ____types.isTable
+local ____constants = require("src.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
 local ____merge = require("src.features.saveDataManager.merge")
 local merge = ____merge.merge
-local ____saveDataManagerConstants = require("src.features.saveDataManager.saveDataManagerConstants")
-local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
 function readSaveDatFile(self, mod)
     local renderFrameCount = Isaac.GetFrameCount()
     local ok, jsonStringOrErrMsg = pcall(tryLoadModData, mod)
@@ -52,21 +52,21 @@ function ____exports.loadFromDisk(self, mod, oldSaveData)
     iterateTableInOrder(
         nil,
         newSaveData,
-        function(____, key, value)
-            if not isString(nil, key) then
+        function(____, subscriberName, saveData)
+            if not isString(nil, subscriberName) then
                 return
             end
-            if not isTable(nil, value) then
+            if not isTable(nil, saveData) then
                 return
             end
-            local oldSaveDataForSubscriber = oldSaveData[key]
+            local oldSaveDataForSubscriber = oldSaveData[subscriberName]
             if oldSaveDataForSubscriber == nil then
                 return
             end
             if SAVE_DATA_MANAGER_DEBUG then
-                log(nil, "Merging in stored data for feature: " .. key)
+                log(nil, "Merging in stored data for feature: " .. subscriberName)
             end
-            merge(nil, oldSaveDataForSubscriber, value, key)
+            merge(nil, oldSaveDataForSubscriber, saveData, subscriberName)
         end,
         SAVE_DATA_MANAGER_DEBUG
     )

package/dist/src/features/saveDataManager/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAGxD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAMtD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAsBrD,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAelE;AA2FD,wBAAgB,sBAAsB,CACpC,cAAc,EAAE,MAAM,EACtB,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,WAAW,GACvB,IAAI,CA4CN;AAiBD,wBAAgB,wBAAwB,IAAI,IAAI,CAM/C;AAED,wBAAgB,wBAAwB,IAAI,IAAI,CAM/C"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAGxD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAMtD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AA0BrD,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAelE;AAiKD,wBAAgB,sBAAsB,CACpC,cAAc,EAAE,MAAM,EACtB,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,WAAW,GACvB,IAAI,CA4CN;AAiBD,wBAAgB,wBAAwB,IAAI,IAAI,CAM/C;AAED,wBAAgB,wBAAwB,IAAI,IAAI,CAM/C"}

package/dist/src/features/saveDataManager/main.lua

@@ -2,7 +2,7 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local postUseItemGlowingHourGlass, postPlayerInit, preGameExit, postNewLevel, postNewRoomEarly, restoreDefaultsAll, restoreDefaults, clearAndCopyAllElements, RESETTABLE_SAVE_DATA_KEYS, mod, loadedDataOnThisRun
+local postUseItemGlowingHourGlass, postPlayerInit, preGameExit, postNewLevel, postNewRoomEarly, makeGlowingHourGlassBackup, restoreGlowingHourGlassBackup, restoreDefaultsAll, restoreDefaults, clearAndCopyAllElements, RESETTABLE_SAVE_DATA_KEYS, mod, loadedDataOnThisRun, restoreGlowingHourGlassDataOnNextRoom
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
@@ -23,18 +23,23 @@ local onFirstFloor = ____stage.onFirstFloor
 local ____table = require("src.functions.table")
 local clearTable = ____table.clearTable
 local iterateTableInOrder = ____table.iterateTableInOrder
+local ____constants = require("src.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
+local SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS = ____constants.SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS
 local ____load = require("src.features.saveDataManager.load")
 local loadFromDisk = ____load.loadFromDisk
 local ____maps = require("src.features.saveDataManager.maps")
 local saveDataConditionalFuncMap = ____maps.saveDataConditionalFuncMap
 local saveDataDefaultsMap = ____maps.saveDataDefaultsMap
+local saveDataGlowingHourGlassMap = ____maps.saveDataGlowingHourGlassMap
 local saveDataMap = ____maps.saveDataMap
+local ____merge = require("src.features.saveDataManager.merge")
+local merge = ____merge.merge
 local ____save = require("src.features.saveDataManager.save")
 local saveToDisk = ____save.saveToDisk
-local ____saveDataManagerConstants = require("src.features.saveDataManager.saveDataManagerConstants")
-local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
 function postUseItemGlowingHourGlass(self)
+    restoreGlowingHourGlassDataOnNextRoom = true
     return nil
 end
 function postPlayerInit(self)
@@ -71,6 +76,63 @@ function postNewLevel(self)
 end
 function postNewRoomEarly(self)
     restoreDefaults(nil, SaveDataKey.ROOM)
+    if restoreGlowingHourGlassDataOnNextRoom then
+        restoreGlowingHourGlassDataOnNextRoom = false
+        restoreGlowingHourGlassBackup(nil)
+    else
+        makeGlowingHourGlassBackup(nil)
+    end
+end
+function makeGlowingHourGlassBackup(self)
+    iterateTableInOrder(
+        nil,
+        saveDataMap,
+        function(____, subscriberName, saveData)
+            for ____, saveDataKey in ipairs(SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS) do
+                do
+                    local childTable = saveData[saveDataKey]
+                    if childTable == nil then
+                        goto __continue18
+                    end
+                    local saveDataGlowingHourGlass = saveDataGlowingHourGlassMap[subscriberName]
+                    if saveDataGlowingHourGlass == nil then
+                        saveDataGlowingHourGlass = {}
+                    end
+                    local copiedChildTable = deepCopy(nil, childTable)
+                    saveDataGlowingHourGlass[saveDataKey] = copiedChildTable
+                end
+                ::__continue18::
+            end
+        end,
+        SAVE_DATA_MANAGER_DEBUG
+    )
+end
+function restoreGlowingHourGlassBackup(self)
+    iterateTableInOrder(
+        nil,
+        saveDataMap,
+        function(____, subscriberName, saveData)
+            for ____, saveDataKey in ipairs(SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS) do
+                do
+                    local childTable = saveData[saveDataKey]
+                    if childTable == nil then
+                        goto __continue24
+                    end
+                    local saveDataGlowingHourGlass = saveDataGlowingHourGlassMap[subscriberName]
+                    if saveDataGlowingHourGlass == nil then
+                        goto __continue24
+                    end
+                    local childTableBackup = saveDataGlowingHourGlass[saveDataKey]
+                    if childTableBackup == nil then
+                        goto __continue24
+                    end
+                    merge(nil, childTable, childTableBackup, subscriberName .. "__glowingHourGlass")
+                end
+                ::__continue24::
+            end
+        end,
+        SAVE_DATA_MANAGER_DEBUG
+    )
 end
 function restoreDefaultsAll(self)
     restoreDefaults(nil, SaveDataKey.RUN)
@@ -117,6 +179,7 @@ end
 RESETTABLE_SAVE_DATA_KEYS = __TS__New(Set, {SaveDataKey.RUN, SaveDataKey.LEVEL, SaveDataKey.ROOM})
 mod = nil
 loadedDataOnThisRun = false
+restoreGlowingHourGlassDataOnNextRoom = false
 function ____exports.saveDataManagerInit(self, incomingMod)
     mod = incomingMod
     mod:AddCallback(ModCallback.POST_USE_ITEM, postUseItemGlowingHourGlass, CollectibleType.GLOWING_HOUR_GLASS)

package/dist/src/features/saveDataManager/maps.d.ts

@@ -8,4 +8,9 @@ import { SaveData } from "../../interfaces/SaveData";
 export declare const saveDataMap: LuaMap<string, SaveData<unknown, unknown, unknown>>;
 export declare const saveDataDefaultsMap: LuaMap<string, SaveData<unknown, unknown, unknown>>;
 export declare const saveDataConditionalFuncMap: LuaMap<string, () => boolean>;
+/**
+ * We backup some save data keys on every new room for the purposes of restoring it when Glowing
+ * Hour Glass is used.
+ */
+export declare const saveDataGlowingHourGlassMap: LuaMap<string, SaveData<unknown, unknown, unknown>>;
 //# sourceMappingURL=maps.d.ts.map

package/dist/src/features/saveDataManager/maps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"maps.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/maps.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAErD;;;;GAIG;AACH,eAAO,MAAM,WAAW,qDAAiC,CAAC;AAE1D,eAAO,MAAM,mBAAmB,qDAAiC,CAAC;AAClE,eAAO,MAAM,0BAA0B,uBAA4B,OAAO,CAAG,CAAC"}
+{"version":3,"file":"maps.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/maps.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAErD;;;;GAIG;AACH,eAAO,MAAM,WAAW,qDAAiC,CAAC;AAE1D,eAAO,MAAM,mBAAmB,qDAAiC,CAAC;AAClE,eAAO,MAAM,0BAA0B,uBAA4B,OAAO,CAAG,CAAC;AAE9E;;;GAGG;AACH,eAAO,MAAM,2BAA2B,qDAAiC,CAAC"}

package/dist/src/features/saveDataManager/maps.lua

@@ -5,4 +5,7 @@ local ____exports = {}
 ____exports.saveDataMap = {}
 ____exports.saveDataDefaultsMap = {}
 ____exports.saveDataConditionalFuncMap = {}
+--- We backup some save data keys on every new room for the purposes of restoring it when Glowing
+-- Hour Glass is used.
+____exports.saveDataGlowingHourGlassMap = {}
 return ____exports

package/dist/src/features/saveDataManager/merge.lua

@@ -27,8 +27,8 @@ local ____types = require("src.functions.types")
 local isTable = ____types.isTable
 local ____utils = require("src.functions.utils")
 local getTraversalDescription = ____utils.getTraversalDescription
-local ____saveDataManagerConstants = require("src.features.saveDataManager.saveDataManagerConstants")
-local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
+local ____constants = require("src.features.saveDataManager.constants")
+local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 local ____serializationBrands = require("src.features.saveDataManager.serializationBrands")
 local isSerializationBrand = ____serializationBrands.isSerializationBrand
 --- `merge` takes the values from a new table and recursively merges them into an old object (while

package/dist/src/features/saveDataManager/save.lua

@@ -12,9 +12,9 @@ local ____log = require("src.functions.log")
 local log = ____log.log
 local ____table = require("src.functions.table")
 local iterateTableInOrder = ____table.iterateTableInOrder
-local ____saveDataManagerConstants = require("src.features.saveDataManager.saveDataManagerConstants")
-local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
+local ____constants = require("src.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 = {}
     iterateTableInOrder(

package/dist/src/functions/deepCopy.lua

@@ -13,8 +13,8 @@ local ____SerializationBrand = require("src.enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____SerializationType = require("src.enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
-local ____saveDataManagerConstants = require("src.features.saveDataManager.saveDataManagerConstants")
-local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
+local ____constants = require("src.features.saveDataManager.constants")
+local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 local ____serializationBrands = require("src.features.saveDataManager.serializationBrands")
 local isSerializationBrand = ____serializationBrands.isSerializationBrand
 local ____array = require("src.functions.array")

package/package.json

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

package/src/features/customStage/backdrop.ts

@@ -17,7 +17,7 @@ import { isLRoom, isNarrowRoom } from "../../functions/roomShape";
 import { removeCharactersBefore, trimPrefix } from "../../functions/string";
 import { erange, irange } from "../../functions/utils";
 import { CustomStage } from "../../interfaces/private/CustomStage";
-import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./customStageConstants";
+import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./constants";
 
 enum BackdropKind {
   /** The "N" stands for narrow rooms. */

package/src/features/customStage/init.ts

@@ -17,7 +17,7 @@ import {
 import { CustomStage, RoomTypeMap } from "../../interfaces/private/CustomStage";
 import { saveDataManager } from "../saveDataManager/exports";
 import { setCustomStageBackdrop } from "./backdrop";
-import { CUSTOM_STAGE_FEATURE_NAME } from "./customStageConstants";
+import { CUSTOM_STAGE_FEATURE_NAME } from "./constants";
 import {
   convertVanillaTrapdoors,
   removeUrnRewards,

package/src/features/customStage/shadows.ts

@@ -4,7 +4,7 @@ import { getRandomArrayElement } from "../../functions/array";
 import { spawnEffectWithSeed } from "../../functions/entitiesSpecific";
 import { removeCharactersBefore } from "../../functions/string";
 import { CustomStage } from "../../interfaces/private/CustomStage";
-import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./customStageConstants";
+import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./constants";
 import v from "./v";
 
 type ShadowAnimation = "1x1" | "1x2" | "2x1" | "2x2";

package/src/features/customStage/streakText.ts

@@ -7,10 +7,7 @@ import {
   getScreenTopCenterPos,
 } from "../../functions/ui";
 import { CustomStage } from "../../interfaces/private/CustomStage";
-import {
-  UIStreakAnimation,
-  UI_STREAK_ANIMATION_END_FRAMES,
-} from "./customStageConstants";
+import { UIStreakAnimation, UI_STREAK_ANIMATION_END_FRAMES } from "./constants";
 import v from "./v";
 
 /** This must match the name of the shader in "shaders.xml". */

package/src/features/customStage/v.ts

@@ -1,6 +1,6 @@
 import { ControllerIndex } from "isaac-typescript-definitions";
 import { CustomStage } from "../../interfaces/private/CustomStage";
-import { UIStreakAnimation } from "./customStageConstants";
+import { UIStreakAnimation } from "./constants";
 
 const v = {
   run: {

package/src/features/customStage/versusScreen.ts

@@ -24,7 +24,7 @@ import { runNextGameFrame } from "../runInNFrames";
 import {
   CUSTOM_STAGE_FEATURE_NAME,
   ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH,
-} from "./customStageConstants";
+} from "./constants";
 import {
   CUSTOM_FLOOR_STAGE,
   CUSTOM_FLOOR_STAGE_TYPE,

package/src/features/customTrapdoor/exports.ts

@@ -2,7 +2,7 @@ import { LevelStage, StageType } from "isaac-typescript-definitions";
 import { errorIfFeaturesNotInitialized } from "../../featuresInitialized";
 import { getNextStage, getNextStageType } from "../../functions/nextStage";
 import { CustomTrapdoorDestination } from "../../interfaces/private/CustomTrapdoorDestination";
-import { CUSTOM_TRAPDOOR_FEATURE_NAME } from "./customTrapdoorConstants";
+import { CUSTOM_TRAPDOOR_FEATURE_NAME } from "./constants";
 import { spawnCustomTrapdoorToDestination } from "./spawn";
 
 /**

package/src/features/customTrapdoor/init.ts

@@ -25,7 +25,7 @@ import {
   CUSTOM_TRAPDOOR_FEATURE_NAME,
   GridEntityTypeCustom,
   PIXELATION_TO_BLACK_FRAMES,
-} from "./customTrapdoorConstants";
+} from "./constants";
 import { checkCustomTrapdoorOpenClose } from "./openClose";
 import { checkCustomTrapdoorPlayerTouched } from "./touched";
 import v from "./v";

package/src/features/customTrapdoor/openClose.ts

@@ -8,7 +8,7 @@ import {
   TRAPDOOR_BOSS_REACTION_FRAMES,
   TRAPDOOR_OPEN_DISTANCE,
   TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS,
-} from "./customTrapdoorConstants";
+} from "./constants";
 
 export function checkCustomTrapdoorOpenClose(
   gridEntity: GridEntity,

package/src/features/customTrapdoor/spawn.ts

@@ -6,7 +6,7 @@ import { isVector } from "../../functions/vector";
 import { CustomTrapdoorDescription } from "../../interfaces/private/CustomTrapdoorDescription";
 import { CustomTrapdoorDestination } from "../../interfaces/private/CustomTrapdoorDestination";
 import { spawnCustomGridEntity } from "../customGridEntity";
-import { GridEntityTypeCustom } from "./customTrapdoorConstants";
+import { GridEntityTypeCustom } from "./constants";
 import { shouldTrapdoorSpawnOpen } from "./openClose";
 import v from "./v";
 

package/src/features/customTrapdoor/touched.ts

@@ -24,7 +24,7 @@ import {
   OTHER_PLAYER_TRAPDOOR_JUMP_DELAY_GAME_FRAMES,
   OTHER_PLAYER_TRAPDOOR_JUMP_DURATION_GAME_FRAMES,
   TRAPDOOR_TOUCH_DISTANCE,
-} from "./customTrapdoorConstants";
+} from "./constants";
 import v from "./v";
 
 export function checkCustomTrapdoorPlayerTouched(

package/src/features/saveDataManager/constants.ts

@@ -0,0 +1,15 @@
+import { SaveDataKey } from "../../enums/SaveDataKey";
+
+/** Set this to true to enable more verbosity in the save data manger. */
+export const SAVE_DATA_MANAGER_DEBUG = false as boolean;
+
+export const SAVE_DATA_MANAGER_FEATURE_NAME = "save data manager";
+
+/**
+ * When the Glowing Hour Glass is used, certain save data keys will automatically be restored to a
+ * backup.
+ */
+export const SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS = [
+  SaveDataKey.RUN,
+  SaveDataKey.LEVEL,
+];

package/src/features/saveDataManager/exports.ts

@@ -4,6 +4,7 @@ import { errorIfFeaturesNotInitialized } from "../../featuresInitialized";
 import { deepCopy } from "../../functions/deepCopy";
 import { isString } from "../../functions/types";
 import { SaveData } from "../../interfaces/SaveData";
+import { SAVE_DATA_MANAGER_FEATURE_NAME } from "./constants";
 import {
   forceSaveDataManagerLoad,
   forceSaveDataManagerSave,
@@ -14,7 +15,6 @@ import {
   saveDataDefaultsMap,
   saveDataMap,
 } from "./maps";
-import { SAVE_DATA_MANAGER_FEATURE_NAME } from "./saveDataManagerConstants";
 
 /**
  * This is the entry point to the save data manager, a system which provides two major features:
@@ -88,9 +88,14 @@ import { SAVE_DATA_MANAGER_FEATURE_NAME } from "./saveDataManagerConstants";
  * data manager cannot do this on its own because it cannot know when your mod features are finished
  * initializing.)
  *
- * Finally, some features may have variables that need to be automatically reset per run/level, but
- * not saved to disk on game exit. (For example, if they contain functions or other non-serializable
- * data.) For these cases, set the second argument to `() => false`.
+ * Some features may have variables that need to be automatically reset per run/level, but not saved
+ * to disk on game exit. (For example, if they contain functions or other non-serializable data.)
+ * For these cases, set the second argument to `() => false`.
+ *
+ * Note that when the player uses Glowing Hour Glass, the save data manager will automatically
+ * restore any variables on a "run" or "level" object with a backup that was created when the room
+ * was entered. Thus, you should not have to explicitly program support for Glowing Hour Glass into
+ * your mod features that use the save data manager.
  *
  * @param key The name of the file or feature that is submitting data to be managed by the save data
  *            manager. The save data manager will throw an error if the key is already registered.

package/src/features/saveDataManager/load.ts

@@ -3,11 +3,11 @@ import { log, logError } from "../../functions/log";
 import { iterateTableInOrder } from "../../functions/table";
 import { isString, isTable } from "../../functions/types";
 import { SaveData } from "../../interfaces/SaveData";
-import { merge } from "./merge";
 import {
   SAVE_DATA_MANAGER_DEBUG,
   SAVE_DATA_MANAGER_FEATURE_NAME,
-} from "./saveDataManagerConstants";
+} from "./constants";
+import { merge } from "./merge";
 
 const DEFAULT_MOD_DATA = "{}";
 
@@ -31,33 +31,37 @@ export function loadFromDisk(
   // Second, iterate over all the fields of the new table.)
   iterateTableInOrder(
     newSaveData,
-    (key, value) => {
+    (subscriberName, saveData) => {
       // All elements of loaded save data should have keys that are strings equal to the name of the
       // subscriber/feature. Ignore elements with other types of keys.
-      if (!isString(key)) {
+      if (!isString(subscriberName)) {
         return;
       }
 
       // All elements of loaded save data should be tables that contain fields corresponding to the
-      // SaveData interface. Ignore elements that are not tables.
-      if (!isTable(value)) {
+      // `SaveData` interface. Ignore elements that are not tables.
+      if (!isTable(saveData)) {
         return;
       }
 
       // Ignore elements that represent subscriptions that no longer exist in the current save data.
-      const oldSaveDataForSubscriber = oldSaveData.get(key);
+      const oldSaveDataForSubscriber = oldSaveData.get(subscriberName);
       if (oldSaveDataForSubscriber === undefined) {
         return;
       }
 
       if (SAVE_DATA_MANAGER_DEBUG) {
-        log(`Merging in stored data for feature: ${key}`);
+        log(`Merging in stored data for feature: ${subscriberName}`);
       }
 
       // We do not want to blow away the child tables of the existing map, because save data could
       // contain out-of-date fields. Instead, merge it one field at a time in a recursive way (and
       // convert Lua tables back to TypeScriptToLua Maps, if necessary).
-      merge(oldSaveDataForSubscriber as LuaMap<AnyNotNil, unknown>, value, key);
+      merge(
+        oldSaveDataForSubscriber as LuaMap<AnyNotNil, unknown>,
+        saveData,
+        subscriberName,
+      );
     },
     SAVE_DATA_MANAGER_DEBUG,
   );