isaacscript-common 25.3.0 → 25.4.0

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

@@ -12,17 +12,19 @@ import { PlayerIndex } from "../../../types/PlayerIndex";
 import { DefaultMap } from "../../DefaultMap";
 import { Feature } from "../../private/Feature";
 
+const v = {
+  run: {
+    playersInventory: new DefaultMap<
+      PlayerIndex,
+      CollectibleType[],
+      [player: EntityPlayer]
+    >(() => []),
+  },
+};
+
 export class PlayerInventory extends Feature {
   /** @internal */
-  public override v = {
-    run: {
-      playersInventory: new DefaultMap<
-        PlayerIndex,
-        CollectibleType[],
-        [player: EntityPlayer]
-      >(() => []),
-    },
-  };
+  public override v = v;
 
   /** @internal */
   constructor() {
@@ -46,7 +48,7 @@ export class PlayerInventory extends Feature {
     collectibleType: CollectibleType,
   ) => {
     const inventory = defaultMapGetPlayer(
-      this.v.run.playersInventory,
+      v.run.playersInventory,
       player,
       player,
     );
@@ -59,7 +61,7 @@ export class PlayerInventory extends Feature {
     collectibleType: CollectibleType,
   ) => {
     const inventory = defaultMapGetPlayer(
-      this.v.run.playersInventory,
+      v.run.playersInventory,
       player,
       player,
     );
@@ -94,7 +96,7 @@ export class PlayerInventory extends Feature {
     includeActiveCollectibles = true,
   ): CollectibleType[] {
     const inventory = defaultMapGetPlayer(
-      this.v.run.playersInventory,
+      v.run.playersInventory,
       player,
       player,
     );

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

@@ -17,13 +17,15 @@ const FLAGS_WHEN_PONY_IS_ACTIVE = [
   EntityFlag.NO_DAMAGE_BLINK, // 1 << 36
 ] as const;
 
+const v = {
+  run: {
+    playersIsPonyActive: new Set<PlayerIndex>(),
+  },
+};
+
 export class PonyDetection extends Feature {
   /** @internal */
-  public override v = {
-    run: {
-      playersIsPonyActive: new Set<PlayerIndex>(),
-    },
-  };
+  public override v = v;
 
   /** @internal */
   constructor() {
@@ -45,7 +47,7 @@ export class PonyDetection extends Feature {
       effects.HasCollectibleEffect(CollectibleType.PONY) ||
       effects.HasCollectibleEffect(CollectibleType.WHITE_PONY);
     const isPonyActiveOnPreviousFrame = setHasPlayer(
-      this.v.run.playersIsPonyActive,
+      v.run.playersIsPonyActive,
       player,
     );
     const hasPonyFlags = hasFlag(entityFlags, ...FLAGS_WHEN_PONY_IS_ACTIVE);
@@ -53,9 +55,9 @@ export class PonyDetection extends Feature {
     const isPonyActiveNow =
       hasPonyCollectibleEffect || (isPonyActiveOnPreviousFrame && hasPonyFlags);
     if (isPonyActiveNow) {
-      setAddPlayer(this.v.run.playersIsPonyActive, player);
+      setAddPlayer(v.run.playersIsPonyActive, player);
     } else {
-      setDeletePlayer(this.v.run.playersIsPonyActive, player);
+      setDeletePlayer(v.run.playersIsPonyActive, player);
     }
   };
 
@@ -67,7 +69,7 @@ export class PonyDetection extends Feature {
    */
   @Exported
   public isPlayerUsingPony(player: EntityPlayer): boolean {
-    return setHasPlayer(this.v.run.playersIsPonyActive, player);
+    return setHasPlayer(v.run.playersIsPonyActive, player);
   }
 
   /**

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

@@ -8,13 +8,15 @@ import { getPlayerIndex } from "../../../functions/playerIndex";
 import { PlayerIndex } from "../../../types/PlayerIndex";
 import { Feature } from "../../private/Feature";
 
+const v = {
+  run: {
+    buttonActionTuples: [] as Array<[PlayerIndex, ButtonAction]>,
+  },
+};
+
 export class PressInput extends Feature {
   /** @internal */
-  public override v = {
-    run: {
-      buttonActionTuples: [] as Array<[PlayerIndex, ButtonAction]>,
-    },
-  };
+  public override v = v;
 
   /** @internal */
   constructor() {
@@ -48,16 +50,16 @@ export class PressInput extends Feature {
 
     const playerIndex = getPlayerIndex(player);
 
-    for (let i = this.v.run.buttonActionTuples.length - 1; i >= 0; i--) {
+    for (let i = v.run.buttonActionTuples.length - 1; i >= 0; i--) {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      const tuple = this.v.run.buttonActionTuples[i]!;
+      const tuple = v.run.buttonActionTuples[i]!;
       const [tuplePlayerIndex, tupleButtonAction] = tuple;
 
       if (
         tuplePlayerIndex === playerIndex &&
         tupleButtonAction === buttonAction
       ) {
-        this.v.run.buttonActionTuples.splice(i);
+        v.run.buttonActionTuples.splice(i);
         return true;
       }
     }
@@ -75,6 +77,6 @@ export class PressInput extends Feature {
   @Exported
   public pressInput(player: EntityPlayer, buttonAction: ButtonAction): void {
     const playerIndex = getPlayerIndex(player);
-    this.v.run.buttonActionTuples.push([playerIndex, buttonAction]);
+    v.run.buttonActionTuples.push([playerIndex, buttonAction]);
   }
 }

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

@@ -2,13 +2,15 @@ import { ModCallback } from "isaac-typescript-definitions";
 import { Exported } from "../../../decorators";
 import { Feature } from "../../private/Feature";
 
+const v = {
+  room: {
+    preventingEntities: new Set<PtrHash>(),
+  },
+};
+
 export class PreventChildEntities extends Feature {
   /** @internal */
-  public override v = {
-    room: {
-      preventingEntities: new Set<PtrHash>(),
-    },
-  };
+  public override v = v;
 
   /** @internal */
   constructor() {
@@ -24,11 +26,11 @@ export class PreventChildEntities extends Feature {
   private postNPCInit = (npc: EntityNPC) => {
     const spawnerEntityMatch =
       npc.SpawnerEntity !== undefined &&
-      this.v.room.preventingEntities.has(GetPtrHash(npc.SpawnerEntity));
+      v.room.preventingEntities.has(GetPtrHash(npc.SpawnerEntity));
 
     const parentMatch =
       npc.Parent !== undefined &&
-      this.v.room.preventingEntities.has(GetPtrHash(npc.Parent));
+      v.room.preventingEntities.has(GetPtrHash(npc.Parent));
 
     if (spawnerEntityMatch || parentMatch) {
       npc.Remove();
@@ -49,6 +51,6 @@ export class PreventChildEntities extends Feature {
   @Exported
   public preventChildEntities(entity: Entity): void {
     const ptrHash = GetPtrHash(entity);
-    this.v.room.preventingEntities.add(ptrHash);
+    v.room.preventingEntities.add(ptrHash);
   }
 }

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

@@ -11,23 +11,25 @@ import { getEntityID } from "../../../functions/entities";
 import { isCollectible } from "../../../functions/pickupVariants";
 import { Feature } from "../../private/Feature";
 
+const v = {
+  room: {
+    /**
+     * Index is a string containing the grid index and the InitSeed of the collectible.
+     * (e.g. "12,1123579202")
+     *
+     * (We cannot simply use the InitSeed of the collectible because Diplopia can cause multiple
+     * collectibles in the room to have the same InitSeed. However, no two collectibles should ever
+     * be on the same grid index.)
+     *
+     * (We cannot use PtrHash as an index because that stays the same when the item is rolled.)
+     */
+    trackedCollectibles: new Map<string, CollectibleType>(),
+  },
+};
+
 export class PreventCollectibleRotation extends Feature {
   /** @internal */
-  public override v = {
-    room: {
-      /**
-       * Index is a string containing the grid index and the InitSeed of the collectible.
-       * (e.g. "12,1123579202")
-       *
-       * (We cannot simply use the InitSeed of the collectible because Diplopia can cause multiple
-       * collectibles in the room to have the same InitSeed. However, no two collectibles should
-       * ever be on the same grid index.)
-       *
-       * (We cannot use PtrHash as an index because that stays the same when the item is rolled.)
-       */
-      trackedCollectibles: new Map<string, CollectibleType>(),
-    },
-  };
+  public override v = v;
 
   /** @internal */
   constructor() {
@@ -55,7 +57,7 @@ export class PreventCollectibleRotation extends Feature {
   private useCardSoulOfIsaac = () => {
     // Soul of Isaac causes items to flip. Delete all tracked items (assuming that the player
     // deliberately wants to roll a quest item).
-    this.v.room.trackedCollectibles.clear();
+    v.room.trackedCollectibles.clear();
   };
 
   // ModCallback.POST_PICKUP_UPDATE (35)
@@ -73,7 +75,7 @@ export class PreventCollectibleRotation extends Feature {
     }
 
     const index = getMapIndex(collectible);
-    const trackedCollectibleType = this.v.room.trackedCollectibles.get(index);
+    const trackedCollectibleType = v.room.trackedCollectibles.get(index);
     if (
       trackedCollectibleType !== undefined &&
       collectible.SubType !== trackedCollectibleType
@@ -108,7 +110,7 @@ export class PreventCollectibleRotation extends Feature {
     }
 
     const index = getMapIndex(collectible);
-    this.v.room.trackedCollectibles.set(index, collectibleType);
+    v.room.trackedCollectibles.set(index, collectibleType);
 
     // The item might have already shifted on the first frame that it spawns, so change it back if
     // necessary.

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

@@ -23,19 +23,19 @@ import { DefaultMap } from "../../DefaultMap";
 import { Feature } from "../../private/Feature";
 import { RunInNFrames } from "./RunInNFrames";
 
+const v = {
+  level: {
+    roomListIndexToDecorationGridIndexes: new DefaultMap<int, int[]>(() => []),
+  },
+
+  room: {
+    manuallyUsingShovel: false,
+  },
+};
+
 export class PreventGridEntityRespawn extends Feature {
   /** @internal */
-  public override v = {
-    level: {
-      roomListIndexToDecorationGridIndexes: new DefaultMap<int, int[]>(
-        () => [],
-      ),
-    },
-
-    room: {
-      manuallyUsingShovel: false,
-    },
-  };
+  public override v = v;
 
   private runInNFrames: RunInNFrames;
 
@@ -71,12 +71,12 @@ export class PreventGridEntityRespawn extends Feature {
     _activeSlot: ActiveSlot,
     _customVarData: int,
   ): boolean | undefined => {
-    if (this.v.room.manuallyUsingShovel) {
+    if (v.room.manuallyUsingShovel) {
       return undefined;
     }
 
     const roomListIndex = getRoomListIndex();
-    if (!this.v.level.roomListIndexToDecorationGridIndexes.has(roomListIndex)) {
+    if (!v.level.roomListIndexToDecorationGridIndexes.has(roomListIndex)) {
       return;
     }
 
@@ -102,12 +102,12 @@ export class PreventGridEntityRespawn extends Feature {
         return;
       }
 
-      this.v.room.manuallyUsingShovel = true;
+      v.room.manuallyUsingShovel = true;
       futurePlayer.UseActiveItem(CollectibleType.WE_NEED_TO_GO_DEEPER);
-      this.v.room.manuallyUsingShovel = false;
+      v.room.manuallyUsingShovel = false;
 
       const decorationGridIndexes =
-        this.v.level.roomListIndexToDecorationGridIndexes.getAndSetDefault(
+        v.level.roomListIndexToDecorationGridIndexes.getAndSetDefault(
           roomListIndex,
         );
       emptyArray(decorationGridIndexes);
@@ -131,7 +131,7 @@ export class PreventGridEntityRespawn extends Feature {
     const room = game.GetRoom();
     const roomListIndex = getRoomListIndex();
     const decorationGridIndexes =
-      this.v.level.roomListIndexToDecorationGridIndexes.get(roomListIndex);
+      v.level.roomListIndexToDecorationGridIndexes.get(roomListIndex);
     if (decorationGridIndexes === undefined) {
       return;
     }
@@ -178,7 +178,7 @@ export class PreventGridEntityRespawn extends Feature {
     const roomListIndex = getRoomListIndex();
 
     const decorationGridIndexes =
-      this.v.level.roomListIndexToDecorationGridIndexes.getAndSetDefault(
+      v.level.roomListIndexToDecorationGridIndexes.getAndSetDefault(
         roomListIndex,
       );
 

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

@@ -3,14 +3,16 @@ import { Exported } from "../../../decorators";
 import { ModCallbackCustom } from "../../../enums/ModCallbackCustom";
 import { Feature } from "../../private/Feature";
 
+const v = {
+  room: {
+    roomClearGameFrame: undefined as int | undefined,
+    roomClearRoomFrame: undefined as int | undefined,
+  },
+};
+
 export class RoomClearFrame extends Feature {
   /** @internal */
-  public override v = {
-    room: {
-      roomClearGameFrame: undefined as int | undefined,
-      roomClearRoomFrame: undefined as int | undefined,
-    },
-  };
+  public override v = v;
 
   /** @internal */
   constructor() {
@@ -31,8 +33,8 @@ export class RoomClearFrame extends Feature {
     const room = game.GetRoom();
     const roomFrameCount = room.GetFrameCount();
 
-    this.v.room.roomClearGameFrame = gameFrameCount;
-    this.v.room.roomClearRoomFrame = roomFrameCount;
+    v.room.roomClearGameFrame = gameFrameCount;
+    v.room.roomClearRoomFrame = roomFrameCount;
   };
 
   /**
@@ -43,7 +45,7 @@ export class RoomClearFrame extends Feature {
    */
   @Exported
   public getRoomClearGameFrame(): int | undefined {
-    return this.v.room.roomClearGameFrame;
+    return v.room.roomClearGameFrame;
   }
 
   /**
@@ -54,6 +56,6 @@ export class RoomClearFrame extends Feature {
    */
   @Exported
   public getRoomClearRoomFrame(): int | undefined {
-    return this.v.room.roomClearGameFrame;
+    return v.room.roomClearGameFrame;
   }
 }

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

@@ -15,13 +15,15 @@ import {
 import { RoomDescription } from "../../../interfaces/RoomDescription";
 import { Feature } from "../../private/Feature";
 
+const v = {
+  run: {
+    roomHistory: [] as Array<Readonly<RoomDescription>>,
+  },
+};
+
 export class RoomHistory extends Feature {
   /** @internal */
-  public override v = {
-    run: {
-      roomHistory: [] as Array<Readonly<RoomDescription>>,
-    },
-  };
+  public override v = v;
 
   /** @internal */
   constructor() {
@@ -64,7 +66,7 @@ export class RoomHistory extends Feature {
       roomListIndex,
       roomVisitedCount,
     };
-    this.v.run.roomHistory.push(roomDescription);
+    v.run.roomHistory.push(roomDescription);
   };
 
   /**
@@ -75,7 +77,7 @@ export class RoomHistory extends Feature {
    */
   @Exported
   public getNumRoomsEntered(): int {
-    return this.v.run.roomHistory.length;
+    return v.run.roomHistory.length;
   }
 
   /**
@@ -86,7 +88,7 @@ export class RoomHistory extends Feature {
    */
   @Exported
   public getRoomHistory(): ReadonlyArray<Readonly<RoomDescription>> {
-    return this.v.run.roomHistory;
+    return v.run.roomHistory;
   }
 
   /**
@@ -100,12 +102,12 @@ export class RoomHistory extends Feature {
   @Exported
   public getPreviousRoomDescription(): Readonly<RoomDescription> {
     const previousRoomDescription =
-      this.v.run.roomHistory[this.v.run.roomHistory.length - 2];
+      v.run.roomHistory[v.run.roomHistory.length - 2];
     if (previousRoomDescription !== undefined) {
       return previousRoomDescription;
     }
 
-    const startingRoomDescription = this.v.run.roomHistory[0];
+    const startingRoomDescription = v.run.roomHistory[0];
     if (startingRoomDescription !== undefined) {
       return startingRoomDescription;
     }
@@ -128,7 +130,7 @@ export class RoomHistory extends Feature {
    */
   @Exported
   public getLatestRoomDescription(): Readonly<RoomDescription> | undefined {
-    return getLastElement(this.v.run.roomHistory);
+    return getLastElement(v.run.roomHistory);
   }
 
   /**

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

@@ -25,17 +25,19 @@ interface IntervalFunction extends QueuedFunction {
   numIntervalFrames: int;
 }
 
+const v = {
+  run: {
+    queuedGameFunctions: [] as QueuedFunction[],
+    queuedRenderFunctions: [] as QueuedFunction[],
+
+    intervalGameFunctions: [] as IntervalFunction[],
+    intervalRenderFunctions: [] as IntervalFunction[],
+  },
+};
+
 export class RunInNFrames extends Feature {
   /** @internal */
-  public override v = {
-    run: {
-      queuedGameFunctions: [] as QueuedFunction[],
-      queuedRenderFunctions: [] as QueuedFunction[],
-
-      intervalGameFunctions: [] as IntervalFunction[],
-      intervalRenderFunctions: [] as IntervalFunction[],
-    },
-  };
+  public override v = v;
 
   public override vConditionalFunc = (): boolean => false;
 
@@ -64,12 +66,12 @@ export class RunInNFrames extends Feature {
     const numRoomsEntered = this.roomHistory.getNumRoomsEntered();
 
     checkExecuteQueuedFunctions(
-      this.v.run.queuedGameFunctions,
+      v.run.queuedGameFunctions,
       gameFrameCount,
       numRoomsEntered,
     );
     checkExecuteIntervalFunctions(
-      this.v.run.intervalGameFunctions,
+      v.run.intervalGameFunctions,
       gameFrameCount,
       numRoomsEntered,
     );
@@ -81,12 +83,12 @@ export class RunInNFrames extends Feature {
     const numRoomsEntered = this.roomHistory.getNumRoomsEntered();
 
     checkExecuteQueuedFunctions(
-      this.v.run.queuedRenderFunctions,
+      v.run.queuedRenderFunctions,
       renderFrameCount,
       numRoomsEntered,
     );
     checkExecuteIntervalFunctions(
-      this.v.run.intervalRenderFunctions,
+      v.run.intervalRenderFunctions,
       renderFrameCount,
       numRoomsEntered,
     );
@@ -141,7 +143,7 @@ export class RunInNFrames extends Feature {
       numRoomsEntered,
       cancelIfRoomChanges,
     };
-    this.v.run.queuedGameFunctions.push(queuedFunction);
+    v.run.queuedGameFunctions.push(queuedFunction);
   }
 
   /**
@@ -177,7 +179,7 @@ export class RunInNFrames extends Feature {
       numRoomsEntered,
       cancelIfRoomChanges,
     };
-    this.v.run.queuedRenderFunctions.push(queuedFunction);
+    v.run.queuedRenderFunctions.push(queuedFunction);
   }
 
   /**
@@ -285,7 +287,7 @@ export class RunInNFrames extends Feature {
       cancelIfRoomChanges,
       numIntervalFrames: numGameFrames,
     };
-    this.v.run.intervalGameFunctions.push(intervalFunction);
+    v.run.intervalGameFunctions.push(intervalFunction);
   }
 
   /**
@@ -332,7 +334,7 @@ export class RunInNFrames extends Feature {
       cancelIfRoomChanges,
       numIntervalFrames: numRenderFrames,
     };
-    this.v.run.intervalRenderFunctions.push(intervalFunction);
+    v.run.intervalRenderFunctions.push(intervalFunction);
   }
 }
 

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

@@ -3,13 +3,15 @@ import { ModCallbackCustom } from "../../../enums/ModCallbackCustom";
 import { emptyArray } from "../../../functions/array";
 import { Feature } from "../../private/Feature";
 
+const v = {
+  run: {
+    queuedFunctions: [] as Array<() => void>,
+  },
+};
+
 export class RunNextRoom extends Feature {
   /** @internal */
-  public override v = {
-    run: {
-      queuedFunctions: [] as Array<() => void>,
-    },
-  };
+  public override v = v;
 
   public override vConditionalFunc = (): boolean => false;
 
@@ -24,11 +26,11 @@ export class RunNextRoom extends Feature {
 
   // ModCallbackCustom.POST_NEW_ROOM_REORDERED
   private postNewRoomReordered = () => {
-    for (const func of this.v.run.queuedFunctions) {
+    for (const func of v.run.queuedFunctions) {
       func();
     }
 
-    emptyArray(this.v.run.queuedFunctions);
+    emptyArray(v.run.queuedFunctions);
   };
 
   /**
@@ -42,6 +44,6 @@ export class RunNextRoom extends Feature {
    */
   @Exported
   public runNextRoom(func: () => void): void {
-    this.v.run.queuedFunctions.push(func);
+    v.run.queuedFunctions.push(func);
   }
 }

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

@@ -10,6 +10,7 @@ import { ModCallbackCustom } from "../../../enums/ModCallbackCustom";
 import { SaveDataKey } from "../../../enums/SaveDataKey";
 import { SerializationType } from "../../../enums/SerializationType";
 import { deepCopy } from "../../../functions/deepCopy";
+import { log } from "../../../functions/log";
 import { onFirstFloor } from "../../../functions/stage";
 import { getTSTLClassName, isTSTLClass } from "../../../functions/tstlClass";
 import { isString, isTable } from "../../../functions/types";
@@ -559,4 +560,14 @@ export class SaveDataManager extends Feature {
   public saveDataManagerInMenu(): boolean {
     return !this.loadedDataOnThisRun;
   }
+
+  @Exported
+  public saveDataManagerLogSubscribers(): void {
+    log("List of save data manager subscribers:");
+    const keys = Object.keys(this.saveDataMap);
+    keys.sort();
+    for (const key of keys) {
+      log(`- ${key}`);
+    }
+  }
 }

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

@@ -14,13 +14,15 @@ import {
 import { asNumber } from "../../../functions/types";
 import { Feature } from "../../private/Feature";
 
+const v = {
+  run: {
+    stageHistory: [] as Array<[stage: LevelStage, stageType: StageType]>,
+  },
+};
+
 export class StageHistory extends Feature {
   /** @internal */
-  public override v = {
-    run: {
-      stageHistory: [] as Array<[stage: LevelStage, stageType: StageType]>,
-    },
-  };
+  public override v = v;
 
   /** @internal */
   constructor() {
@@ -37,7 +39,7 @@ export class StageHistory extends Feature {
     const stage = level.GetStage();
     const stageType = level.GetStageType();
 
-    this.v.run.stageHistory.push([stage, stageType]);
+    v.run.stageHistory.push([stage, stageType]);
   };
 
   /**
@@ -297,7 +299,7 @@ export class StageHistory extends Feature {
   public getStageHistory(): ReadonlyArray<
     [stage: LevelStage, stageType: StageType]
   > {
-    return this.v.run.stageHistory;
+    return v.run.stageHistory;
   }
 
   /**
@@ -313,12 +315,12 @@ export class StageHistory extends Feature {
   @Exported
   public hasVisitedStage(stage: LevelStage, stageType?: StageType): boolean {
     if (stageType === undefined) {
-      return this.v.run.stageHistory.some(
+      return v.run.stageHistory.some(
         ([previousStage]) => previousStage === stage,
       );
     }
 
-    return this.v.run.stageHistory.some(
+    return v.run.stageHistory.some(
       ([previousStage, previousStageType]) =>
         previousStage === stage && previousStageType === stageType,
     );