isaacscript-common 12.2.0 → 12.3.1

package/dist/index.d.ts

@@ -10422,7 +10422,8 @@ export declare enum SaveDataKey {
  * 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.
+ * your mod features that use the save data manager. If this is undesired for your specific
+ * use-case, then add a key of `__ignoreGlowingHourGlass: true` to your "run" or "level" object.
  *
  * @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/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 12.2.0
+isaacscript-common 12.3.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -25,6 +25,8 @@ information about using TypeScript, see the website: https://isaacscript.github.
 
 --]]
 
+---@diagnostic disable: deprecated
+
 
 local ____modules = {}
 local ____moduleCache = {}
@@ -26950,6 +26952,7 @@ ____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}
+____exports.SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY = "__ignoreGlowingHourGlass"
 return ____exports
  end,
 ["src.features.saveDataManager.serializationBrands"] = function(...) 
@@ -31673,6 +31676,7 @@ 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 SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY = ____constants.SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY
 local ____load = require("src.features.saveDataManager.load")
 local loadFromDisk = ____load.loadFromDisk
 local ____maps = require("src.features.saveDataManager.maps")
@@ -31740,9 +31744,14 @@ function makeGlowingHourGlassBackup(self)
                     if childTable == nil then
                         goto __continue18
                     end
+                    local childTableLuaMap = childTable
+                    if childTableLuaMap[SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY] ~= nil then
+                        goto __continue18
+                    end
                     local saveDataGlowingHourGlass = saveDataGlowingHourGlassMap[subscriberName]
                     if saveDataGlowingHourGlass == nil then
                         saveDataGlowingHourGlass = {}
+                        saveDataGlowingHourGlassMap[subscriberName] = saveDataGlowingHourGlass
                     end
                     local copiedChildTable = deepCopy(nil, childTable)
                     saveDataGlowingHourGlass[saveDataKey] = copiedChildTable
@@ -31762,19 +31771,23 @@ function restoreGlowingHourGlassBackup(self)
                 do
                     local childTable = saveData[saveDataKey]
                     if childTable == nil then
-                        goto __continue24
+                        goto __continue25
+                    end
+                    local childTableLuaMap = childTable
+                    if childTableLuaMap[SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY] ~= nil then
+                        goto __continue25
                     end
                     local saveDataGlowingHourGlass = saveDataGlowingHourGlassMap[subscriberName]
                     if saveDataGlowingHourGlass == nil then
-                        goto __continue24
+                        goto __continue25
                     end
                     local childTableBackup = saveDataGlowingHourGlass[saveDataKey]
                     if childTableBackup == nil then
-                        goto __continue24
+                        goto __continue25
                     end
                     merge(nil, childTable, childTableBackup, subscriberName .. "__glowingHourGlass")
                 end
-                ::__continue24::
+                ::__continue25::
             end
         end,
         SAVE_DATA_MANAGER_DEBUG
@@ -31949,7 +31962,8 @@ local saveDataMap = ____maps.saveDataMap
 -- 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.
+-- your mod features that use the save data manager. If this is undesired for your specific
+-- use-case, then add a key of `__ignoreGlowingHourGlass: true` to your "run" or "level" object.
 -- 
 -- @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.
@@ -33494,7 +33508,7 @@ function logStateChanged(self)
     end
 end
 DEBUG = false
-CustomReviveState = CustomReviveState or ({})
+CustomReviveState = {}
 CustomReviveState.DISABLED = 0
 CustomReviveState[CustomReviveState.DISABLED] = "DISABLED"
 CustomReviveState.WAITING_FOR_ROOM_TRANSITION = 1
@@ -39886,7 +39900,7 @@ function getNumFloorLayers(self, roomShape)
         end
     until true
 end
-BackdropKind = BackdropKind or ({})
+BackdropKind = {}
 BackdropKind.N_FLOOR = "nFloors"
 BackdropKind.L_FLOOR = "lFloors"
 BackdropKind.WALL = "walls"
@@ -47052,7 +47066,7 @@ return ____exports
 ["package"] = function(...) 
 return {
     name = "isaacscript-common",
-    version = "12.2.0",
+    version = "12.3.1",
     description = "Helper functions and features for IsaacScript mods.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",

package/dist/package.lua

@@ -1,6 +1,6 @@
 return {
     name = "isaacscript-common",
-    version = "12.2.0",
+    version = "12.3.1",
     description = "Helper functions and features for IsaacScript mods.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",

package/dist/src/callbacks/customRevive.lua

@@ -130,7 +130,7 @@ function logStateChanged(self)
     end
 end
 DEBUG = false
-CustomReviveState = CustomReviveState or ({})
+CustomReviveState = {}
 CustomReviveState.DISABLED = 0
 CustomReviveState[CustomReviveState.DISABLED] = "DISABLED"
 CustomReviveState.WAITING_FOR_ROOM_TRANSITION = 1

package/dist/src/features/customStage/backdrop.lua

@@ -149,7 +149,7 @@ function getNumFloorLayers(self, roomShape)
         end
     until true
 end
-BackdropKind = BackdropKind or ({})
+BackdropKind = {}
 BackdropKind.N_FLOOR = "nFloors"
 BackdropKind.L_FLOOR = "lFloors"
 BackdropKind.WALL = "walls"

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

@@ -7,4 +7,5 @@ export declare const SAVE_DATA_MANAGER_FEATURE_NAME = "save data manager";
  * backup.
  */
 export declare const SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS: SaveDataKey[];
+export declare const SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY = "__ignoreGlowingHourGlass";
 //# sourceMappingURL=constants.d.ts.map

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

@@ -1 +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"}
+{"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;AAEF,eAAO,MAAM,+CAA+C,6BAChC,CAAC"}

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

@@ -7,4 +7,5 @@ ____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}
+____exports.SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY = "__ignoreGlowingHourGlass"
 return ____exports

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

@@ -79,7 +79,8 @@ import { SaveData } from "../../interfaces/SaveData";
  * 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.
+ * your mod features that use the save data manager. If this is undesired for your specific
+ * use-case, then add a key of `__ignoreGlowingHourGlass: true` to your "run" or "level" object.
  *
  * @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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}
+{"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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+FG;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

@@ -98,7 +98,8 @@ local saveDataMap = ____maps.saveDataMap
 -- 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.
+-- your mod features that use the save data manager. If this is undesired for your specific
+-- use-case, then add a key of `__ignoreGlowingHourGlass: true` to your "run" or "level" object.
 -- 
 -- @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/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;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"}
+{"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;AA2BrD,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAelE;AAqLD,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

@@ -27,6 +27,7 @@ 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 SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY = ____constants.SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY
 local ____load = require("src.features.saveDataManager.load")
 local loadFromDisk = ____load.loadFromDisk
 local ____maps = require("src.features.saveDataManager.maps")
@@ -94,9 +95,14 @@ function makeGlowingHourGlassBackup(self)
                     if childTable == nil then
                         goto __continue18
                     end
+                    local childTableLuaMap = childTable
+                    if childTableLuaMap[SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY] ~= nil then
+                        goto __continue18
+                    end
                     local saveDataGlowingHourGlass = saveDataGlowingHourGlassMap[subscriberName]
                     if saveDataGlowingHourGlass == nil then
                         saveDataGlowingHourGlass = {}
+                        saveDataGlowingHourGlassMap[subscriberName] = saveDataGlowingHourGlass
                     end
                     local copiedChildTable = deepCopy(nil, childTable)
                     saveDataGlowingHourGlass[saveDataKey] = copiedChildTable
@@ -116,19 +122,23 @@ function restoreGlowingHourGlassBackup(self)
                 do
                     local childTable = saveData[saveDataKey]
                     if childTable == nil then
-                        goto __continue24
+                        goto __continue25
+                    end
+                    local childTableLuaMap = childTable
+                    if childTableLuaMap[SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY] ~= nil then
+                        goto __continue25
                     end
                     local saveDataGlowingHourGlass = saveDataGlowingHourGlassMap[subscriberName]
                     if saveDataGlowingHourGlass == nil then
-                        goto __continue24
+                        goto __continue25
                     end
                     local childTableBackup = saveDataGlowingHourGlass[saveDataKey]
                     if childTableBackup == nil then
-                        goto __continue24
+                        goto __continue25
                     end
                     merge(nil, childTable, childTableBackup, subscriberName .. "__glowingHourGlass")
                 end
-                ::__continue24::
+                ::__continue25::
             end
         end,
         SAVE_DATA_MANAGER_DEBUG

package/package.json

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

package/src/features/saveDataManager/constants.ts

@@ -13,3 +13,6 @@ export const SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS = [
   SaveDataKey.RUN,
   SaveDataKey.LEVEL,
 ];
+
+export const SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY =
+  "__ignoreGlowingHourGlass";

package/src/features/saveDataManager/exports.ts

@@ -95,7 +95,8 @@ import {
  * 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.
+ * your mod features that use the save data manager. If this is undesired for your specific
+ * use-case, then add a key of `__ignoreGlowingHourGlass: true` to your "run" or "level" object.
  *
  * @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/main.ts

@@ -13,6 +13,7 @@ import {
   SAVE_DATA_MANAGER_DEBUG,
   SAVE_DATA_MANAGER_FEATURE_NAME,
   SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS,
+  SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY,
 } from "./constants";
 import { loadFromDisk } from "./load";
 import {
@@ -144,10 +145,22 @@ function makeGlowingHourGlassBackup() {
           continue;
         }
 
+        // Ignore child tables that the end-user has explicitly annotated.
+        const childTableLuaMap = childTable as LuaMap<AnyNotNil, unknown>;
+        if (
+          childTableLuaMap.has(SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY)
+        ) {
+          continue;
+        }
+
         let saveDataGlowingHourGlass =
           saveDataGlowingHourGlassMap.get(subscriberName);
         if (saveDataGlowingHourGlass === undefined) {
           saveDataGlowingHourGlass = new LuaMap<string, unknown>() as SaveData;
+          saveDataGlowingHourGlassMap.set(
+            subscriberName,
+            saveDataGlowingHourGlass,
+          );
         }
 
         const copiedChildTable = deepCopy(childTable);
@@ -169,6 +182,14 @@ function restoreGlowingHourGlassBackup() {
           continue;
         }
 
+        // Ignore child tables that the end-user has explicitly annotated.
+        const childTableLuaMap = childTable as LuaMap<AnyNotNil, unknown>;
+        if (
+          childTableLuaMap.has(SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY)
+        ) {
+          continue;
+        }
+
         const saveDataGlowingHourGlass =
           saveDataGlowingHourGlassMap.get(subscriberName);
         if (saveDataGlowingHourGlass === undefined) {

package/src/functions/rooms.ts

@@ -492,10 +492,10 @@ export function inStartingRoom(): boolean {
  */
 export function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean {
   const roomTypeWhitelist =
-    onlyCheckRoomTypes === undefined ? null : new Set(onlyCheckRoomTypes);
+    onlyCheckRoomTypes === undefined ? undefined : new Set(onlyCheckRoomTypes);
   const rooms = getRoomsInsideGrid();
   const matchingRooms =
-    roomTypeWhitelist === null
+    roomTypeWhitelist === undefined
       ? rooms
       : rooms.filter(
           (roomDescriptor) =>