isaacscript-common 12.3.5 → 12.3.7

package/package.json

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

package/src/features/saveDataManager/main.ts

@@ -163,7 +163,12 @@ function makeGlowingHourGlassBackup() {
           );
         }
 
-        const copiedChildTable = deepCopy(childTable);
+        // We serialize the table so that we can use the `merge` function later on with no other
+        // modifications.
+        const copiedChildTable = deepCopy(
+          childTable,
+          SerializationType.SERIALIZE,
+        ) as Record<string, unknown>;
         saveDataGlowingHourGlass[saveDataKey] = copiedChildTable;
       }
     },

package/src/features/saveDataManager/maps.ts

@@ -13,5 +13,8 @@ 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.
+ *
+ * Note that the save data is backed up in serialized form so that we can use the `merge` function
+ * to restore it.
  */
 export const saveDataGlowingHourGlassMap = new LuaMap<string, SaveData>();

package/src/features/saveDataManager/merge.ts

@@ -59,23 +59,28 @@ export function merge(
 
   // First, handle the special case of an array with a shallow copy.
   if (isArray(oldObject) && isArray(newTable)) {
-    mergeArray(oldObject, newTable);
+    mergeSerializedArray(oldObject, newTable, traversalDescription);
     return;
   }
 
   // Depending on whether we are working on a Lua table or a TypeScriptToLua object, we need to
   // iterate in a specific way.
   if (isTSTLMap(oldObject) || isTSTLSet(oldObject) || isDefaultMap(oldObject)) {
-    mergeTSTLObject(oldObject, newTable, traversalDescription);
+    mergeSerializedTSTLObject(oldObject, newTable, traversalDescription);
   } else {
-    mergeTable(oldObject, newTable, traversalDescription);
+    mergeSerializedTable(oldObject, newTable, traversalDescription);
   }
 }
 
-function mergeArray(
+function mergeSerializedArray(
   oldArray: LuaMap<AnyNotNil, unknown>,
   newArray: LuaMap<AnyNotNil, unknown>,
+  traversalDescription: string,
 ) {
+  if (SAVE_DATA_MANAGER_DEBUG) {
+    log(`merge encountered an array: ${traversalDescription}`);
+  }
+
   // Assume that we should blow away all array values with whatever is present in the incoming
   // array.
   clearTable(oldArray);
@@ -88,11 +93,15 @@ function mergeArray(
   );
 }
 
-function mergeTSTLObject(
+function mergeSerializedTSTLObject(
   oldObject: Map<AnyNotNil, unknown> | Set<AnyNotNil>,
   newTable: LuaMap<AnyNotNil, unknown>,
   traversalDescription: string,
 ) {
+  if (SAVE_DATA_MANAGER_DEBUG) {
+    log(`merge encountered a TSTL object: ${traversalDescription}`);
+  }
+
   // We blow away the old object and recursively copy over all of the incoming values.
   oldObject.clear();
 
@@ -139,11 +148,15 @@ function mergeTSTLObject(
   );
 }
 
-function mergeTable(
+function mergeSerializedTable(
   oldTable: LuaMap<AnyNotNil, unknown>,
   newTable: LuaMap<AnyNotNil, unknown>,
   traversalDescription: string,
 ) {
+  if (SAVE_DATA_MANAGER_DEBUG) {
+    log(`merge encountered a Lua table: ${traversalDescription}`);
+  }
+
   iterateTableInOrder(
     newTable,
     (key, value) => {

package/src/functions/collectibles.ts

@@ -9,6 +9,7 @@ import {
   ItemType,
   PickupPrice,
   PickupVariant,
+  RenderMode,
   RoomType,
 } from "isaac-typescript-definitions";
 import { game, itemConfig } from "../core/cachedClasses";
@@ -408,7 +409,12 @@ export function isActiveCollectible(collectibleType: CollectibleType): boolean {
   return itemType === ItemType.ACTIVE;
 }
 
-/** Returns true if the collectible has a red question mark sprite. */
+/**
+ * Returns true if the collectible has a red question mark sprite.
+ *
+ * Note that this function will not work properly in a render callback with the `RenderMode` set to
+ * `RenderMode.WATER_REFLECT`. If this is detected, this function will throw a run-time error.
+ */
 export function isBlindCollectible(collectible: EntityPickup): boolean {
   if (!isCollectible(collectible)) {
     const entityID = getEntityID(collectible);
@@ -417,6 +423,14 @@ export function isBlindCollectible(collectible: EntityPickup): boolean {
     );
   }
 
+  const room = game.GetRoom();
+  const renderMode = room.GetRenderMode();
+  if (renderMode === RenderMode.WATER_REFLECT) {
+    error(
+      'The "isBlindCollectible" function will not work properly in a render callback with the render mode equal to "RenderMode.WATER_REFLECT". Make sure that you properly account for this case if you are calling this function in a render callback.',
+    );
+  }
+
   const sprite = collectible.GetSprite();
   const animation = sprite.GetAnimation();
   const frame = sprite.GetFrame();

package/src/functions/log.ts

@@ -365,9 +365,7 @@ export function logTable(luaTable: unknown, parentTables = 0): void {
     // Put it in an IIFE so that it will show as "func" instead of "logTable" and align with the
     // other text. We have to use a non-arrow function to prevent Lua language server errors with
     // the self argument.
-    /** @noSelf */
-    // eslint-disable-next-line func-names
-    (function () {
+    (function func() {
       log(
         `${indentation}n/a (encountered a variable of type "${typeof luaTable}" instead of a table)`,
       );
@@ -397,9 +395,7 @@ export function logTable(luaTable: unknown, parentTables = 0): void {
   // Put it in an IIFE so that it will show as "func" instead of "logTable" and align with the other
   // text. We have to use a non-arrow function to prevent Lua language server errors with the self
   // argument.
-  /** @noSelf */
-  // eslint-disable-next-line func-names
-  (function () {
+  (function func() {
     log(`${indentation}The size of the table was: ${numElements}`);
   })();
 }