isaacscript-common 11.2.4 → 12.1.0

package/src/features/extraConsoleCommands/listCommands.ts

@@ -67,7 +67,7 @@ import {
 import { HealthType } from "../../enums/HealthType";
 import { getCardName } from "../../functions/cards";
 import { getCharacterName } from "../../functions/characters";
-import { addCharge } from "../../functions/charge";
+import { addCharge, getTotalCharge } from "../../functions/charge";
 import { isValidCollectibleType } from "../../functions/collectibles";
 import { runDeepCopyTests } from "../../functions/deepCopyTests";
 import { getNPCs } from "../../functions/entitiesSpecific";
@@ -655,6 +655,26 @@ export function getChallenge(): void {
   printConsole(`The current challenge is: ${challengeDescription}`);
 }
 
+/** Prints the charge for the specified slot. By default, will use `ActiveSlot.PRIMARY`. */
+export function getCharge(params: string): void {
+  let activeSlot = ActiveSlot.PRIMARY;
+  if (params !== "") {
+    const num = tonumber(params) as ActiveSlot | undefined;
+    if (num === undefined) {
+      printConsole(`The provided slot number is invalid: ${params}`);
+      return;
+    }
+
+    activeSlot = num;
+  }
+
+  const player = Isaac.GetPlayer();
+  const totalCharge = getTotalCharge(player, activeSlot);
+  printConsole(
+    `Total charge for ActiveSlot.${ActiveSlot[activeSlot]} (${activeSlot}) is: ${totalCharge}`,
+  );
+}
+
 /** Prints the current position of all players. */
 export function getPosition(): void {
   for (const player of getPlayers()) {

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,
   );

package/src/features/saveDataManager/main.ts

@@ -9,17 +9,20 @@ import { logError } from "../../functions/log";
 import { onFirstFloor } from "../../functions/stage";
 import { clearTable, iterateTableInOrder } from "../../functions/table";
 import { SaveData } from "../../interfaces/SaveData";
+import {
+  SAVE_DATA_MANAGER_DEBUG,
+  SAVE_DATA_MANAGER_FEATURE_NAME,
+  SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS,
+} from "./constants";
 import { loadFromDisk } from "./load";
 import {
   saveDataConditionalFuncMap,
   saveDataDefaultsMap,
+  saveDataGlowingHourGlassMap,
   saveDataMap,
 } from "./maps";
+import { merge } from "./merge";
 import { saveToDisk } from "./save";
-import {
-  SAVE_DATA_MANAGER_DEBUG,
-  SAVE_DATA_MANAGER_FEATURE_NAME,
-} from "./saveDataManagerConstants";
 
 const RESETTABLE_SAVE_DATA_KEYS: ReadonlySet<SaveDataKey> = new Set([
   SaveDataKey.RUN,
@@ -29,6 +32,7 @@ const RESETTABLE_SAVE_DATA_KEYS: ReadonlySet<SaveDataKey> = new Set([
 
 let mod: ModUpgraded | null = null;
 let loadedDataOnThisRun = false;
+let restoreGlowingHourGlassDataOnNextRoom = false;
 
 export function saveDataManagerInit(incomingMod: ModUpgraded): void {
   mod = incomingMod;
@@ -50,6 +54,7 @@ export function saveDataManagerInit(incomingMod: ModUpgraded): void {
 // ModCallback.POST_USE_ITEM (3)
 // CollectibleType.GLOWING_HOUR_GLASS (422)
 function postUseItemGlowingHourGlass() {
+  restoreGlowingHourGlassDataOnNextRoom = true;
   return undefined;
 }
 
@@ -118,6 +123,75 @@ function postNewLevel() {
 // ModCallbackCustom.POST_NEW_ROOM_EARLY
 function postNewRoomEarly() {
   restoreDefaults(SaveDataKey.ROOM);
+
+  // Handle the Glowing Hour Glass.
+  if (restoreGlowingHourGlassDataOnNextRoom) {
+    restoreGlowingHourGlassDataOnNextRoom = false;
+    restoreGlowingHourGlassBackup();
+  } else {
+    makeGlowingHourGlassBackup();
+  }
+}
+
+function makeGlowingHourGlassBackup() {
+  iterateTableInOrder(
+    saveDataMap,
+    (subscriberName, saveData) => {
+      for (const saveDataKey of SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS) {
+        const childTable = saveData[saveDataKey];
+        if (childTable === undefined) {
+          // This feature does not happen to store any variables on this particular child table.
+          continue;
+        }
+
+        let saveDataGlowingHourGlass =
+          saveDataGlowingHourGlassMap.get(subscriberName);
+        if (saveDataGlowingHourGlass === undefined) {
+          saveDataGlowingHourGlass = new LuaMap<string, unknown>() as SaveData;
+        }
+
+        const copiedChildTable = deepCopy(childTable);
+        saveDataGlowingHourGlass[saveDataKey] = copiedChildTable;
+      }
+    },
+    SAVE_DATA_MANAGER_DEBUG,
+  );
+}
+
+function restoreGlowingHourGlassBackup() {
+  iterateTableInOrder(
+    saveDataMap,
+    (subscriberName, saveData) => {
+      for (const saveDataKey of SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS) {
+        const childTable = saveData[saveDataKey];
+        if (childTable === undefined) {
+          // This feature does not happen to store any variables on this particular child table.
+          continue;
+        }
+
+        const saveDataGlowingHourGlass =
+          saveDataGlowingHourGlassMap.get(subscriberName);
+        if (saveDataGlowingHourGlass === undefined) {
+          // This should never happen.
+          continue;
+        }
+
+        const childTableBackup = saveDataGlowingHourGlass[saveDataKey];
+        if (childTableBackup === undefined) {
+          // This should never happen.
+          continue;
+        }
+
+        merge(
+          childTable as LuaMap<AnyNotNil, unknown>,
+          childTableBackup as LuaMap<AnyNotNil, unknown>,
+          // Append an arbitrary suffix for better error messages.
+          `${subscriberName}__glowingHourGlass`,
+        );
+      }
+    },
+    SAVE_DATA_MANAGER_DEBUG,
+  );
 }
 
 function restoreDefaultsAll() {

package/src/features/saveDataManager/maps.ts

@@ -9,3 +9,9 @@ export const saveDataMap = new LuaMap<string, SaveData>();
 
 export const saveDataDefaultsMap = new LuaMap<string, SaveData>();
 export const saveDataConditionalFuncMap = new 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 const saveDataGlowingHourGlassMap = new LuaMap<string, SaveData>();

package/src/features/saveDataManager/merge.ts

@@ -11,7 +11,7 @@ import { clearTable, iterateTableInOrder } from "../../functions/table";
 import { isDefaultMap, isTSTLMap, isTSTLSet } from "../../functions/tstlClass";
 import { isTable } from "../../functions/types";
 import { getTraversalDescription } from "../../functions/utils";
-import { SAVE_DATA_MANAGER_DEBUG } from "./saveDataManagerConstants";
+import { SAVE_DATA_MANAGER_DEBUG } from "./constants";
 import { isSerializationBrand } from "./serializationBrands";
 
 /**

package/src/features/saveDataManager/save.ts

@@ -7,7 +7,7 @@ import { SaveData } from "../../interfaces/SaveData";
 import {
   SAVE_DATA_MANAGER_DEBUG,
   SAVE_DATA_MANAGER_FEATURE_NAME,
-} from "./saveDataManagerConstants";
+} from "./constants";
 
 export function saveToDisk(
   mod: Mod,

package/src/functions/deepCopy.ts

@@ -1,7 +1,7 @@
 import { DefaultMap } from "../classes/DefaultMap";
 import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { SerializationType } from "../enums/SerializationType";
-import { SAVE_DATA_MANAGER_DEBUG } from "../features/saveDataManager/saveDataManagerConstants";
+import { SAVE_DATA_MANAGER_DEBUG } from "../features/saveDataManager/constants";
 import { isSerializationBrand } from "../features/saveDataManager/serializationBrands";
 import { TSTLClass } from "../types/TSTLClass";
 import { isArray } from "./array";

package/dist/src/features/customStage/customStageConstants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"customStageConstants.d.ts","sourceRoot":"","sources":["../../../../src/features/customStage/customStageConstants.ts"],"names":[],"mappings":";AAAA,eAAO,MAAM,yBAAyB,gBAAgB,CAAC;AAEvD,eAAO,MAAM,iCAAiC,iCAAiC,CAAC;AAEhF,uCAAuC;AACvC,oBAAY,iBAAiB;IAC3B,IAAI,IAAA;IACJ,IAAI,IAAA;IACJ,SAAS,IAAA;CACV;AAED,uCAAuC;AACvC,eAAO,MAAM,8BAA8B,EAAE;IAC3C,QAAQ,EAAE,GAAG,IAAI,iBAAiB,GAAG,GAAG;CAKhC,CAAC"}

package/dist/src/features/customTrapdoor/customTrapdoorConstants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"customTrapdoorConstants.d.ts","sourceRoot":"","sources":["../../../../src/features/customTrapdoor/customTrapdoorConstants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE9D,eAAO,MAAM,4BAA4B,mBAAmB,CAAC;AAE7D,eAAO,MAAM,oBAAoB;IAC/B;;;OAGG;;CAEK,CAAC;AAEX,2FAA2F;AAC3F,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,eAAO,MAAM,iCAAiC,QAA+B,CAAC;AAC9E,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAEhD,eAAO,MAAM,uBAAuB,OAAO,CAAC;AAE5C,eAAO,MAAM,oCAAoC,EAAE,WAAW,CAAC,MAAM,CAClC,CAAC;AAEpC,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAE7C,eAAO,MAAM,4CAA4C,IAAI,CAAC;AAC9D,eAAO,MAAM,+CAA+C,IAAI,CAAC"}

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

@@ -1,4 +0,0 @@
-/** 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";
-//# sourceMappingURL=saveDataManagerConstants.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"saveDataManagerConstants.d.ts","sourceRoot":"","sources":["../../../../src/features/saveDataManager/saveDataManagerConstants.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,eAAO,MAAM,uBAAuB,SAAmB,CAAC;AAExD,eAAO,MAAM,8BAA8B,sBAAsB,CAAC"}

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

@@ -1,5 +0,0 @@
-local ____exports = {}
---- 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"
-return ____exports

package/src/features/saveDataManager/saveDataManagerConstants.ts

@@ -1,4 +0,0 @@
-/** 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";