isaacscript-common 17.7.2 → 17.7.3

package/src/classes/features/other/DisableAllSound.ts

@@ -19,7 +19,8 @@ export class DisableAllSound extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_RENDER, [this.postRender]], // 2
+      // 2
+      [ModCallback.POST_RENDER, [this.postRender]],
     ];
   }
 

package/src/classes/features/other/DisableInputs.ts

@@ -40,18 +40,23 @@ export class DisableInputs extends Feature {
     super();
 
     this.callbacksUsed = [
+      // 13
       [
         ModCallback.INPUT_ACTION,
-        [this.isActionPressed, InputHook.IS_ACTION_PRESSED],
-      ], // 13
+        [this.isActionPressed, InputHook.IS_ACTION_PRESSED], // 0
+      ],
+
+      // 13
       [
         ModCallback.INPUT_ACTION,
-        [this.isActionTriggered, InputHook.IS_ACTION_TRIGGERED],
-      ], // 13
+        [this.isActionTriggered, InputHook.IS_ACTION_TRIGGERED], // 1
+      ],
+
+      // 13
       [
         ModCallback.INPUT_ACTION,
-        [this.getActionValue, InputHook.GET_ACTION_VALUE],
-      ], // 13
+        [this.getActionValue, InputHook.GET_ACTION_VALUE], // 2
+      ],
     ];
   }
 

package/src/classes/features/other/ExtraConsoleCommands.ts

@@ -29,30 +29,47 @@ export class ExtraConsoleCommands extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_UPDATE, [this.postUpdate]], // 1
+      // 1
+      [ModCallback.POST_UPDATE, [this.postUpdate]],
+
+      // 8
       [
         ModCallback.EVALUATE_CACHE,
         [this.evaluateCacheDamage, CacheFlag.DAMAGE], // 1 << 0
-      ], // 8
+      ],
+
+      // 8
       [
         ModCallback.EVALUATE_CACHE,
         [this.evaluateCacheFireDelay, CacheFlag.FIRE_DELAY], // 1 << 1
-      ], // 8
+      ],
+
+      // 8
       [
         ModCallback.EVALUATE_CACHE,
         [this.evaluateCacheSpeed, CacheFlag.SPEED], // 1 << 4
-      ], // 8
+      ],
+
+      // 8
       [
         ModCallback.EVALUATE_CACHE,
         [this.evaluateCacheFlying, CacheFlag.FLYING], // 1 << 7
-      ], // 8
+      ],
+
+      // 11
       [
         ModCallback.ENTITY_TAKE_DMG,
         [this.entityTakeDmgPlayer, EntityType.PLAYER],
-      ], // 11
-      [ModCallback.POST_CURSE_EVAL, [this.postCurseEval]], // 12
-      [ModCallback.EXECUTE_CMD, [this.executeCmd]], // 22
-      [ModCallback.POST_FIRE_TEAR, [this.postFireTear]], // 61
+      ],
+
+      // 12
+      [ModCallback.POST_CURSE_EVAL, [this.postCurseEval]],
+
+      // 22
+      [ModCallback.EXECUTE_CMD, [this.executeCmd]],
+
+      // 61
+      [ModCallback.POST_FIRE_TEAR, [this.postFireTear]],
     ];
 
     for (const [funcName, func] of Object.entries(commands)) {

package/src/classes/features/other/FadeInRemover.ts

@@ -13,7 +13,8 @@ export class FadeInRemover extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_GAME_STARTED, [this.postGameStarted]], // 15
+      // 15
+      [ModCallback.POST_GAME_STARTED, [this.postGameStarted]],
     ];
   }
 

package/src/classes/features/other/FastReset.ts

@@ -19,7 +19,8 @@ export class FastReset extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_RENDER, [this.postRender]], // 2
+      // 2
+      [ModCallback.POST_RENDER, [this.postRender]],
     ];
   }
 

package/src/classes/features/other/ModdedElementDetection.ts

@@ -48,7 +48,8 @@ export class ModdedElementDetection extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_PLAYER_INIT, [this.postPlayerInit]], // 9
+      // 9
+      [ModCallback.POST_PLAYER_INIT, [this.postPlayerInit]],
     ];
   }
 

package/src/classes/features/other/NoSirenSteal.ts

@@ -21,10 +21,11 @@ export class NoSirenSteal extends Feature {
     super();
 
     this.callbacksUsed = [
+      // 27
       [
         ModCallback.POST_NPC_INIT,
         [this.postNPCInitSirenHelper, EntityType.SIREN_HELPER],
-      ], // 27
+      ],
     ];
   }
 

package/src/classes/features/other/Pause.ts

@@ -46,11 +46,14 @@ export class Pause extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_UPDATE, [this.postUpdate]], // 1
+      // 1
+      [ModCallback.POST_UPDATE, [this.postUpdate]],
+
+      // 13
       [
         ModCallback.INPUT_ACTION,
         [this.inputActionGetActionValue, InputHook.GET_ACTION_VALUE],
-      ], // 13
+      ],
     ];
 
     this.disableInputs = disableInputs;

package/src/classes/features/other/PersistentEntities.ts

@@ -55,7 +55,8 @@ export class PersistentEntities extends Feature {
     this.featuresUsed = [ISCFeature.ROOM_HISTORY];
 
     this.callbacksUsed = [
-      [ModCallback.POST_ENTITY_REMOVE, [this.postEntityRemove]], // 67
+      // 67
+      [ModCallback.POST_ENTITY_REMOVE, [this.postEntityRemove]],
     ];
 
     this.customCallbacksUsed = [

package/src/classes/features/other/PickupIndexCreation.ts

@@ -14,6 +14,7 @@ import { PickupIndex } from "../../../types/PickupIndex";
 import { DefaultMap } from "../../DefaultMap";
 import { Feature } from "../../private/Feature";
 import { RoomHistory } from "./RoomHistory";
+import { SaveDataManager } from "./SaveDataManager";
 
 interface PickupDescription {
   position: Vector;
@@ -24,6 +25,7 @@ export class PickupIndexCreation extends Feature {
   /** @internal */
   public override v = {
     run: {
+      /** Is incremented before assignment. Thus, the first pickup will have an index of 1. */
       pickupCounter: 0 as PickupIndex,
 
       pickupDataTreasureRooms: new Map<PickupIndex, PickupDescription>(),
@@ -43,22 +45,27 @@ export class PickupIndexCreation extends Feature {
   };
 
   private roomHistory: RoomHistory;
+  private saveDataManager: SaveDataManager;
 
   /** @internal */
-  constructor(roomHistory: RoomHistory) {
+  constructor(roomHistory: RoomHistory, saveDataManager: SaveDataManager) {
     super();
 
-    this.featuresUsed = [ISCFeature.ROOM_HISTORY];
+    this.featuresUsed = [ISCFeature.ROOM_HISTORY, ISCFeature.SAVE_DATA_MANAGER];
 
     this.callbacksUsed = [
-      [ModCallback.POST_PICKUP_INIT, [this.postPickupInit]], // 34
+      // 34
+      [ModCallback.POST_PICKUP_INIT, [this.postPickupInit]],
+
+      // 67
       [
         ModCallback.POST_ENTITY_REMOVE,
         [this.postEntityRemovePickup, EntityType.PICKUP],
-      ], // 67
+      ],
     ];
 
     this.roomHistory = roomHistory;
+    this.saveDataManager = saveDataManager;
   }
 
   // ModCallback.POST_PICKUP_INIT (34)
@@ -159,11 +166,28 @@ export class PickupIndexCreation extends Feature {
     };
     pickupDescriptions.set(pickupIndex, pickupDescription);
 
-    // If the despawning pickup was in a Treasure Room or Boss Room, then it is possible that the
-    // pickup could re-appear during The Ascent. If this is the case, we store the metadata on a
-    // separate map to reference later.
+    const pickupDataMapForCurrentRoom = this.getPickupDataMapForCurrentRoom();
+    if (pickupDataMapForCurrentRoom !== undefined) {
+      pickupDataMapForCurrentRoom.set(pickupIndex, pickupDescription);
+    }
+
+    // Since the `POST_ENTITY_REMOVE` callback fires after the `PRE_GAME_EXIT` callback, we need to
+    // explicitly save data again if the player is in the process of saving and quitting the run.
+    if (this.saveDataManager.saveDataManagerInMenu()) {
+      this.saveDataManager.saveDataManagerSave();
+    }
+  }
+
+  /**
+   * If the despawning pickup was in a Treasure Room or Boss Room, then it is possible that the
+   * pickup could re-appear during The Ascent. If this is the case, we store the metadata on a
+   * separate map to reference later.
+   */
+  private getPickupDataMapForCurrentRoom():
+    | Map<PickupIndex, PickupDescription>
+    | undefined {
     if (onAscent()) {
-      return;
+      return undefined;
     }
 
     const room = game.GetRoom();
@@ -171,17 +195,15 @@ export class PickupIndexCreation extends Feature {
 
     switch (roomType) {
       case RoomType.TREASURE: {
-        this.v.run.pickupDataTreasureRooms.set(pickupIndex, pickupDescription);
-        break;
+        return this.v.run.pickupDataTreasureRooms;
       }
 
       case RoomType.BOSS: {
-        this.v.run.pickupDataBossRooms.set(pickupIndex, pickupDescription);
-        break;
+        return this.v.run.pickupDataBossRooms;
       }
 
       default: {
-        break;
+        return undefined;
       }
     }
   }

package/src/classes/features/other/PressInput.ts

@@ -21,10 +21,11 @@ export class PressInput extends Feature {
     super();
 
     this.callbacksUsed = [
+      // 13
       [
         ModCallback.INPUT_ACTION,
         [this.isActionTriggered, InputHook.IS_ACTION_TRIGGERED],
-      ], // 13
+      ],
     ];
   }
 

package/src/classes/features/other/PreventChildEntities.ts

@@ -15,7 +15,8 @@ export class PreventChildEntities extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_NPC_INIT, [this.postNPCInit]], // 27
+      // 27
+      [ModCallback.POST_NPC_INIT, [this.postNPCInit]],
     ];
   }
 

package/src/classes/features/other/PreventCollectibleRotation.ts

@@ -34,14 +34,17 @@ export class PreventCollectibleRotation extends Feature {
     super();
 
     this.callbacksUsed = [
+      // 5
       [
         ModCallback.POST_USE_CARD,
         [this.useCardSoulOfIsaac, CardType.SOUL_ISAAC],
-      ], // 5
+      ],
+
+      // 35
       [
         ModCallback.POST_PICKUP_UPDATE,
         [this.postPickupUpdateCollectible, PickupVariant.COLLECTIBLE],
-      ], // 35
+      ],
     ];
   }
 

package/src/classes/features/other/PreventGridEntityRespawn.ts

@@ -46,10 +46,11 @@ export class PreventGridEntityRespawn extends Feature {
     this.featuresUsed = [ISCFeature.RUN_IN_N_FRAMES];
 
     this.callbacksUsed = [
+      // 23
       [
         ModCallback.PRE_USE_ITEM,
         [this.preUseItemWeNeedToGoDeeper, CollectibleType.WE_NEED_TO_GO_DEEPER],
-      ], // 23
+      ],
     ];
 
     this.customCallbacksUsed = [

package/src/classes/features/other/RunInNFrames.ts

@@ -39,8 +39,11 @@ export class RunInNFrames extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_UPDATE, [this.postUpdate]], // 1
-      [ModCallback.POST_RENDER, [this.postRender]], // 2
+      // 1
+      [ModCallback.POST_UPDATE, [this.postUpdate]],
+
+      // 2
+      [ModCallback.POST_RENDER, [this.postRender]],
     ];
   }
 

package/src/classes/features/other/SaveDataManager.ts

@@ -87,13 +87,20 @@ export class SaveDataManager extends Feature {
     super();
 
     this.callbacksUsed = [
+      // 3
       [
         ModCallback.POST_USE_ITEM,
         [this.postUseItemGlowingHourGlass, CollectibleType.GLOWING_HOUR_GLASS],
-      ], // 3
-      [ModCallback.POST_PLAYER_INIT, [this.postPlayerInit]], // 9
-      [ModCallback.PRE_GAME_EXIT, [this.preGameExit]], // 17
-      [ModCallback.POST_NEW_LEVEL, [this.postNewLevel]], // 18
+      ],
+
+      // 9
+      [ModCallback.POST_PLAYER_INIT, [this.postPlayerInit]],
+
+      // 17
+      [ModCallback.PRE_GAME_EXIT, [this.preGameExit]],
+
+      // 18
+      [ModCallback.POST_NEW_LEVEL, [this.postNewLevel]],
     ];
 
     this.customCallbacksUsed = [
@@ -152,11 +159,14 @@ export class SaveDataManager extends Feature {
     // persistent variables should be recorded).
     saveToDisk(this.mod, this.saveDataMap, this.saveDataConditionalFuncMap);
 
-    restoreDefaultsForAllFeaturesAndKeys(
-      this.saveDataMap,
-      this.saveDataDefaultsMap,
-    );
+    // Mark that we are going to the menu. (Technically, the `POST_ENTITY_REMOVE` callback may fire
+    // before actually going to the menu, but that must be explicitly handled.)
     this.loadedDataOnThisRun = false;
+
+    // At this point, we could blow away the existing save data or restore defaults, but it is not
+    // necessary since we will have to do it again in the `POST_PLAYER_INIT` callback. Furthermore,
+    // the `POST_ENTITY_REMOVE` callback may fire after the `PRE_GAME_EXIT` callback, so wiping data
+    // now could result in bugs for features that depend on that (e.g. `PickupIndexCreation`).
   };
 
   // ModCallback.POST_NEW_LEVEL (18)
@@ -514,4 +524,22 @@ export class SaveDataManager extends Feature {
       childObjectKey,
     );
   }
+
+  /**
+   * Helper function to check to see if the game is in the menu, as far as the save data manager is
+   * concerned. This function will return true when the game is first opened until the
+   * `POST_PLAYER_INIT` callback fires. It will also return true in between the `PRE_GAME_EXIT`
+   * callback firing and the `POST_PLAYER_INIT` callback firing.
+   *
+   * This function is useful because the `POST_ENTITY_REMOVE` callback fires after the
+   * `PRE_GAME_EXIT` callback. Thus, if save data needs to be updated from the `POST_ENTITY_REMOVE`
+   * callback and the player is in the process of saving and quitting, the feature will have to
+   * explicitly call the `saveDataManagerSave` function.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+   */
+  @Exported
+  public saveDataManagerInMenu(): boolean {
+    return !this.loadedDataOnThisRun;
+  }
 }

package/src/classes/features/other/TaintedLazarusPlayers.ts

@@ -39,7 +39,8 @@ export class TaintedLazarusPlayers extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_PLAYER_INIT, [this.postPlayerInit]], // 9
+      // 9
+      [ModCallback.POST_PLAYER_INIT, [this.postPlayerInit]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayBomb.ts

@@ -10,7 +10,8 @@ export class DebugDisplayBomb extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_BOMB_RENDER, [this.postBombRender]], // 59
+      // 59
+      [ModCallback.POST_BOMB_RENDER, [this.postBombRender]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayEffect.ts

@@ -10,7 +10,8 @@ export class DebugDisplayEffect extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_EFFECT_RENDER, [this.postEffectRender]], // 56
+      // 56
+      [ModCallback.POST_EFFECT_RENDER, [this.postEffectRender]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayFamiliar.ts

@@ -10,7 +10,8 @@ export class DebugDisplayFamiliar extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_FAMILIAR_RENDER, [this.postFamiliarRender]], // 25
+      // 25
+      [ModCallback.POST_FAMILIAR_RENDER, [this.postFamiliarRender]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayKnife.ts

@@ -10,7 +10,8 @@ export class DebugDisplayKnife extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_KNIFE_RENDER, [this.postKnifeRender]], // 52
+      // 52
+      [ModCallback.POST_KNIFE_RENDER, [this.postKnifeRender]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayLaser.ts

@@ -10,7 +10,8 @@ export class DebugDisplayLaser extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_LASER_RENDER, [this.postLaserRender]], // 49
+      // 49
+      [ModCallback.POST_LASER_RENDER, [this.postLaserRender]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayNPC.ts

@@ -10,7 +10,8 @@ export class DebugDisplayNPC extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_NPC_RENDER, [this.postNPCRender]], // 28
+      // 28
+      [ModCallback.POST_NPC_RENDER, [this.postNPCRender]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayPickup.ts

@@ -10,7 +10,8 @@ export class DebugDisplayPickup extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_PICKUP_RENDER, [this.postPickupRender]], // 36
+      // 36
+      [ModCallback.POST_PICKUP_RENDER, [this.postPickupRender]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayPlayer.ts

@@ -10,7 +10,8 @@ export class DebugDisplayPlayer extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_PLAYER_RENDER, [this.postPlayerRender]], // 32
+      // 32
+      [ModCallback.POST_PLAYER_RENDER, [this.postPlayerRender]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayProjectile.ts

@@ -10,7 +10,8 @@ export class DebugDisplayProjectile extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_PROJECTILE_RENDER, [this.postProjectileRender]], // 45
+      // 45
+      [ModCallback.POST_PROJECTILE_RENDER, [this.postProjectileRender]],
     ];
   }
 

package/src/classes/features/other/debugDisplay/DebugDisplayTear.ts

@@ -10,7 +10,8 @@ export class DebugDisplayTear extends Feature {
     super();
 
     this.callbacksUsed = [
-      [ModCallback.POST_TEAR_RENDER, [this.postTearRender]], // 41
+      // 41
+      [ModCallback.POST_TEAR_RENDER, [this.postTearRender]],
     ];
   }
 

package/src/enums/ModCallbackCustom.ts

@@ -954,6 +954,9 @@ export enum ModCallbackCustom {
    *
    * Use this callback to know when a pickup is added to the player's inventory or health.
    *
+   * Note that this will not fire when the player takes a collectible; use either the
+   * `POST_PLAYER_COLLECTIBLE_ADDED` or the `PRE_ITEM_PICKUP` callback for that.
+   *
    * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
    * - You can provide an optional third argument that will make the callback only fire if it
    *   matches the `PickupVariant` provided.

package/src/features.ts

@@ -144,13 +144,17 @@ export function getFeatures(
   const roomHistory = new RoomHistory();
   const runInNFrames = new RunInNFrames();
   const runNextRoom = new RunNextRoom();
+  const saveDataManager = new SaveDataManager(mod);
   const stageHistory = new StageHistory();
 
   const customGridEntities = new CustomGridEntities(runInNFrames);
   const moddedElementSets = new ModdedElementSets(moddedElementDetection);
   const itemPoolDetection = new ItemPoolDetection(moddedElementSets);
   const pause = new Pause(disableInputs);
-  const pickupIndexCreation = new PickupIndexCreation(roomHistory);
+  const pickupIndexCreation = new PickupIndexCreation(
+    roomHistory,
+    saveDataManager,
+  );
   const preventGridEntityRespawn = new PreventGridEntityRespawn(runInNFrames);
   const spawnCollectible = new SpawnCollectible(preventCollectibleRotation);
 
@@ -276,7 +280,7 @@ export function getFeatures(
     [ISCFeature.ROOM_HISTORY]: roomHistory,
     [ISCFeature.RUN_IN_N_FRAMES]: runInNFrames,
     [ISCFeature.RUN_NEXT_ROOM]: runNextRoom,
-    [ISCFeature.SAVE_DATA_MANAGER]: new SaveDataManager(mod),
+    [ISCFeature.SAVE_DATA_MANAGER]: saveDataManager,
     [ISCFeature.SPAWN_ALT_ROCK_REWARDS]: new SpawnRockAltRewards(
       itemPoolDetection,
     ),