isaacscript-common 87.9.6 → 87.9.7

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

@@ -19,25 +19,6 @@ const v = {
 };
 
 export class PlayerCollectibleTracking extends Feature {
-  /** @internal */
-  public override v = v;
-
-  /** @internal */
-  constructor() {
-    super();
-
-    this.customCallbacksUsed = [
-      [
-        ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED,
-        this.postPlayerCollectibleAdded,
-      ],
-      [
-        ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED,
-        this.postPlayerCollectibleRemoved,
-      ],
-    ];
-  }
-
   // ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED
   private readonly postPlayerCollectibleAdded = (
     player: EntityPlayer,
@@ -64,6 +45,25 @@ export class PlayerCollectibleTracking extends Feature {
     arrayRemoveInPlace(collectibleTypes, collectibleType);
   };
 
+  /** @internal */
+  public override v = v;
+
+  /** @internal */
+  constructor() {
+    super();
+
+    this.customCallbacksUsed = [
+      [
+        ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED,
+        this.postPlayerCollectibleAdded,
+      ],
+      [
+        ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED,
+        this.postPlayerCollectibleRemoved,
+      ],
+    ];
+  }
+
   /**
    * Helper function to get all of the collectible types that the player has gotten so far on this
    * run, in order.

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

@@ -24,21 +24,6 @@ const v = {
 };
 
 export class PonyDetection extends Feature {
-  /** @internal */
-  public override v = v;
-
-  /** @internal */
-  constructor() {
-    super();
-
-    this.customCallbacksUsed = [
-      [
-        ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED,
-        this.postPEffectUpdateReordered,
-      ],
-    ];
-  }
-
   // ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED
   private readonly postPEffectUpdateReordered = (player: EntityPlayer) => {
     const effects = player.GetEffects();
@@ -61,6 +46,21 @@ export class PonyDetection extends Feature {
     }
   };
 
+  /** @internal */
+  public override v = v;
+
+  /** @internal */
+  constructor() {
+    super();
+
+    this.customCallbacksUsed = [
+      [
+        ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED,
+        this.postPEffectUpdateReordered,
+      ],
+    ];
+  }
+
   /**
    * Helper function to see if the player is under the effects of A Pony or White Pony charge.
    * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.

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

@@ -15,23 +15,6 @@ const v = {
 };
 
 export class PressInput extends Feature {
-  /** @internal */
-  public override v = v;
-
-  /** @internal */
-  constructor() {
-    super();
-
-    this.callbacksUsed = [
-      // 13
-      [
-        ModCallback.INPUT_ACTION,
-        this.isActionTriggered,
-        [InputHook.IS_ACTION_TRIGGERED],
-      ],
-    ];
-  }
-
   // ModCallback.INPUT_ACTION (13)
   // InputHook.IS_ACTION_TRIGGERED (1)
   private readonly isActionTriggered = (
@@ -66,6 +49,23 @@ export class PressInput extends Feature {
     return undefined;
   };
 
+  /** @internal */
+  public override v = v;
+
+  /** @internal */
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      // 13
+      [
+        ModCallback.INPUT_ACTION,
+        this.isActionTriggered,
+        [InputHook.IS_ACTION_TRIGGERED],
+      ],
+    ];
+  }
+
   /**
    * Helper function to press an arbitrary `ButtonAction` on the next possible input poll. In most
    * cases, this will be equivalent to if the first player pressed the corresponding input. It
@@ -76,6 +76,9 @@ export class PressInput extends Feature {
   @Exported
   public pressInput(player: EntityPlayer, buttonAction: ButtonAction): void {
     const playerIndex = getPlayerIndex(player);
-    v.run.buttonActionPairs.push({ playerIndex, buttonAction });
+    v.run.buttonActionPairs.push({
+      playerIndex,
+      buttonAction,
+    });
   }
 }

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

@@ -9,19 +9,6 @@ const v = {
 };
 
 export class PreventChildEntities extends Feature {
-  /** @internal */
-  public override v = v;
-
-  /** @internal */
-  constructor() {
-    super();
-
-    this.callbacksUsed = [
-      // 27
-      [ModCallback.POST_NPC_INIT, this.postNPCInit],
-    ];
-  }
-
   // ModCallback.POST_NPC_INIT (27)
   private readonly postNPCInit = (npc: EntityNPC) => {
     const spawnerEntityMatch =
@@ -37,6 +24,19 @@ export class PreventChildEntities extends Feature {
     }
   };
 
+  /** @internal */
+  public override v = v;
+
+  /** @internal */
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      // 27
+      [ModCallback.POST_NPC_INIT, this.postNPCInit],
+    ];
+  }
+
   /**
    * Helper function to prevent an entity from spawning any other entities. Meant to be used on NPCs
    * like Squirts. This behavior will only last for the current room.

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

@@ -33,33 +33,8 @@ const v = {
 };
 
 export class PreventGridEntityRespawn extends Feature {
-  /** @internal */
-  public override v = v;
-
   private readonly runInNFrames: RunInNFrames;
 
-  /** @internal */
-  constructor(runInNFrames: RunInNFrames) {
-    super();
-
-    this.featuresUsed = [ISCFeature.RUN_IN_N_FRAMES];
-
-    this.callbacksUsed = [
-      // 23
-      [
-        ModCallback.PRE_USE_ITEM,
-        this.preUseItemWeNeedToGoDeeper,
-        [CollectibleType.WE_NEED_TO_GO_DEEPER],
-      ],
-    ];
-
-    this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_NEW_ROOM_REORDERED, this.postNewRoomReordered],
-    ];
-
-    this.runInNFrames = runInNFrames;
-  }
-
   // ModCallback.PRE_USE_ITEM (23)
   // CollectibleType.WE_NEED_TO_GO_DEEPER (84)
   private readonly preUseItemWeNeedToGoDeeper = (
@@ -122,6 +97,31 @@ export class PreventGridEntityRespawn extends Feature {
     this.setDecorationsInvisible();
   };
 
+  /** @internal */
+  public override v = v;
+
+  /** @internal */
+  constructor(runInNFrames: RunInNFrames) {
+    super();
+
+    this.featuresUsed = [ISCFeature.RUN_IN_N_FRAMES];
+
+    this.callbacksUsed = [
+      // 23
+      [
+        ModCallback.PRE_USE_ITEM,
+        this.preUseItemWeNeedToGoDeeper,
+        [CollectibleType.WE_NEED_TO_GO_DEEPER],
+      ],
+    ];
+
+    this.customCallbacksUsed = [
+      [ModCallbackCustom.POST_NEW_ROOM_REORDERED, this.postNewRoomReordered],
+    ];
+
+    this.runInNFrames = runInNFrames;
+  }
+
   /**
    * Every time we re-enter the room, the sprites for all of the decorations will come back, so we
    * have to remove them again.

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

@@ -13,22 +13,6 @@ const v = {
 };
 
 export class RerunDetection extends Feature {
-  /** @internal */
-  public override v = v;
-
-  /** @internal */
-  constructor() {
-    super();
-
-    this.customCallbacksUsed = [
-      [
-        ModCallbackCustom.POST_GAME_STARTED_REORDERED,
-        this.postGameStartedReordered,
-      ],
-      [ModCallbackCustom.POST_NEW_LEVEL_REORDERED, this.postNewLevelReordered],
-    ];
-  }
-
   // ModCallbackCustom.POST_GAME_STARTED_REORDERED
   private readonly postGameStartedReordered = (isContinued: boolean) => {
     if (isContinued) {
@@ -45,6 +29,22 @@ export class RerunDetection extends Feature {
     v.persistent.pastFirstFloor = !onFirstFloor();
   };
 
+  /** @internal */
+  public override v = v;
+
+  /** @internal */
+  constructor() {
+    super();
+
+    this.customCallbacksUsed = [
+      [
+        ModCallbackCustom.POST_GAME_STARTED_REORDERED,
+        this.postGameStartedReordered,
+      ],
+      [ModCallbackCustom.POST_NEW_LEVEL_REORDERED, this.postNewLevelReordered],
+    ];
+  }
+
   /**
    * Helper function to detect if the current run was starting using the "Rerun" option from the
    * main menu.

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

@@ -12,6 +12,19 @@ const v = {
 };
 
 export class RoomClearFrame extends Feature {
+  // ModCallbackCustom.POST_ROOM_CLEAR_CHANGED
+  // true
+  private readonly postRoomClearChangedTrue = () => {
+    const gameFrameCount = game.GetFrameCount();
+    const room = game.GetRoom();
+    const roomFrameCount = room.GetFrameCount();
+    const renderFrameCount = Isaac.GetFrameCount();
+
+    v.room.roomClearGameFrame = gameFrameCount;
+    v.room.roomClearRenderFrame = renderFrameCount;
+    v.room.roomClearRoomFrame = roomFrameCount;
+  };
+
   /** @internal */
   public override v = v;
 
@@ -27,19 +40,6 @@ export class RoomClearFrame extends Feature {
     ];
   }
 
-  // ModCallbackCustom.POST_ROOM_CLEAR_CHANGED
-  // true
-  private readonly postRoomClearChangedTrue = () => {
-    const gameFrameCount = game.GetFrameCount();
-    const room = game.GetRoom();
-    const roomFrameCount = room.GetFrameCount();
-    const renderFrameCount = Isaac.GetFrameCount();
-
-    v.room.roomClearGameFrame = gameFrameCount;
-    v.room.roomClearRenderFrame = renderFrameCount;
-    v.room.roomClearRoomFrame = roomFrameCount;
-  };
-
   /**
    * Helper function to get the game frame (i.e. `Game.GetFrameCount`) of the last time that this
    * room was cleared. Returns undefined if the room has never been cleared.

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

@@ -21,18 +21,6 @@ const v = {
 };
 
 export class RoomHistory extends Feature {
-  /** @internal */
-  public override v = v;
-
-  /** @internal */
-  constructor() {
-    super();
-
-    this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_NEW_ROOM_EARLY, this.postNewRoomEarly],
-    ];
-  }
-
   // ModCallbackCustom.POST_NEW_ROOM_EARLY
   private readonly postNewRoomEarly = () => {
     const level = game.GetLevel();
@@ -68,6 +56,18 @@ export class RoomHistory extends Feature {
     v.run.roomHistory.push(roomDescription);
   };
 
+  /** @internal */
+  public override v = v;
+
+  /** @internal */
+  constructor() {
+    super();
+
+    this.customCallbacksUsed = [
+      [ModCallbackCustom.POST_NEW_ROOM_EARLY, this.postNewRoomEarly],
+    ];
+  }
+
   /**
    * Helper function to manually delete the last room description from the internal array. This is
    * useful if a mod needs to send the player to a room temporarily and the room should not count as

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

@@ -10,10 +10,10 @@ import type { RoomHistory } from "./RoomHistory";
 
 /** Used for `runInNFrames` functions. */
 interface QueuedFunction {
-  func: () => void;
-  frameCountToFire: int;
-  numRoomsEntered: int;
-  cancelIfRoomChanges: boolean;
+  readonly func: () => void;
+  readonly frameCountToFire: int;
+  readonly numRoomsEntered: int;
+  readonly cancelIfRoomChanges: boolean;
 }
 
 /**
@@ -22,8 +22,8 @@ interface QueuedFunction {
  * The return value is whether to continue the function from firing.
  */
 interface IntervalFunction extends QueuedFunction {
-  func: () => boolean;
-  numIntervalFrames: int;
+  readonly func: () => boolean;
+  readonly numIntervalFrames: int;
 }
 
 const v = {
@@ -37,30 +37,8 @@ const v = {
 };
 
 export class RunInNFrames extends Feature {
-  /** @internal */
-  public override v = v;
-
-  public override vConditionalFunc = (): boolean => false;
-
   private readonly roomHistory: RoomHistory;
 
-  /** @internal */
-  constructor(roomHistory: RoomHistory) {
-    super();
-
-    this.featuresUsed = [ISCFeature.ROOM_HISTORY];
-
-    this.callbacksUsed = [
-      // 1
-      [ModCallback.POST_UPDATE, this.postUpdate],
-
-      // 2
-      [ModCallback.POST_RENDER, this.postRender],
-    ];
-
-    this.roomHistory = roomHistory;
-  }
-
   // ModCallback.POST_UPDATE (1)
   private readonly postUpdate = (): void => {
     const gameFrameCount = game.GetFrameCount();
@@ -95,6 +73,28 @@ export class RunInNFrames extends Feature {
     );
   };
 
+  /** @internal */
+  public override v = v;
+
+  public override vConditionalFunc = (): boolean => false;
+
+  /** @internal */
+  constructor(roomHistory: RoomHistory) {
+    super();
+
+    this.featuresUsed = [ISCFeature.ROOM_HISTORY];
+
+    this.callbacksUsed = [
+      // 1
+      [ModCallback.POST_UPDATE, this.postUpdate],
+
+      // 2
+      [ModCallback.POST_RENDER, this.postRender],
+    ];
+
+    this.roomHistory = roomHistory;
+  }
+
   /**
    * Helper function to restart on the next render frame. Useful because it is impossible to restart
    * the game inside of the `POST_NEW_ROOM`, `POST_NEW_LEVEL`, or `POST_GAME_STARTED` callbacks when
@@ -357,7 +357,7 @@ function checkExecuteQueuedFunctions(
   );
 
   for (const firingFunction of firingFunctions) {
-    const { func, cancelIfRoomChanges, numRoomsEntered } = firingFunction;
+    const { func, numRoomsEntered, cancelIfRoomChanges } = firingFunction;
 
     if (!cancelIfRoomChanges || numRoomsEntered === newNumRoomsEntered) {
       func();
@@ -378,13 +378,13 @@ function checkExecuteIntervalFunctions(
   );
 
   for (const firingFunction of firingFunctions) {
-    const { func, cancelIfRoomChanges, numRoomsEntered, numIntervalFrames } =
+    const { func, numIntervalFrames, numRoomsEntered, cancelIfRoomChanges } =
       firingFunction;
 
-    let returnValue = false;
-    if (!cancelIfRoomChanges || numRoomsEntered === newNumRoomsEntered) {
-      returnValue = func();
-    }
+    const returnValue =
+      !cancelIfRoomChanges || numRoomsEntered === newNumRoomsEntered
+        ? func()
+        : false;
 
     arrayRemoveInPlace(intervalFunctions, firingFunction);
 

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

@@ -10,6 +10,15 @@ const v = {
 };
 
 export class RunNextRoom extends Feature {
+  // ModCallbackCustom.POST_NEW_ROOM_REORDERED
+  private readonly postNewRoomReordered = () => {
+    for (const func of v.run.queuedFunctions) {
+      func();
+    }
+
+    emptyArray(v.run.queuedFunctions);
+  };
+
   /** @internal */
   public override v = v;
 
@@ -24,15 +33,6 @@ export class RunNextRoom extends Feature {
     ];
   }
 
-  // ModCallbackCustom.POST_NEW_ROOM_REORDERED
-  private readonly postNewRoomReordered = () => {
-    for (const func of v.run.queuedFunctions) {
-      func();
-    }
-
-    emptyArray(v.run.queuedFunctions);
-  };
-
   /**
    * Supply a function to run on the next `POST_NEW_ROOM` callback.
    *

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

@@ -10,6 +10,16 @@ const v = {
 };
 
 export class RunNextRun extends Feature {
+  // ModCallbackCustom.POST_GAME_STARTED_REORDERED
+  // false
+  private readonly postGameStartedReorderedFalse = () => {
+    for (const func of v.persistent.queuedFunctions) {
+      func();
+    }
+
+    emptyArray(v.persistent.queuedFunctions);
+  };
+
   /** @internal */
   public override v = v;
 
@@ -28,16 +38,6 @@ export class RunNextRun extends Feature {
     ];
   }
 
-  // ModCallbackCustom.POST_GAME_STARTED_REORDERED
-  // false
-  private readonly postGameStartedReorderedFalse = () => {
-    for (const func of v.persistent.queuedFunctions) {
-      func();
-    }
-
-    emptyArray(v.persistent.queuedFunctions);
-  };
-
   /**
    * Supply a function to run on the next `POST_GAME_STARTED` callback.
    *

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

@@ -84,37 +84,6 @@ export class SaveDataManager extends Feature {
   private inARun = false;
   private restoreGlowingHourGlassDataOnNextRoom = false;
 
-  /** @internal */
-  constructor(mod: Mod) {
-    super();
-
-    this.callbacksUsed = [
-      // 3
-      [
-        ModCallback.POST_USE_ITEM,
-        this.postUseItemGlowingHourGlass,
-        [CollectibleType.GLOWING_HOUR_GLASS],
-      ],
-
-      // 9
-      [ModCallback.POST_PLAYER_INIT, this.postPlayerInit],
-
-      // 17
-      [ModCallback.PRE_GAME_EXIT, this.preGameExit],
-
-      // 18
-      // We want to avoid a needless dependency on the `GameReorderedCallbacks` feature.
-      // eslint-disable-next-line @typescript-eslint/no-deprecated
-      [ModCallback.POST_NEW_LEVEL, this.postNewLevel],
-    ];
-
-    this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_NEW_ROOM_EARLY, this.postNewRoomEarly],
-    ];
-
-    this.mod = mod;
-  }
-
   // ModCallback.POST_USE_ITEM (3)
   // CollectibleType.GLOWING_HOUR_GLASS (422)
   private readonly postUseItemGlowingHourGlass = (
@@ -214,6 +183,56 @@ export class SaveDataManager extends Feature {
     }
   };
 
+  /** @internal */
+  constructor(mod: Mod) {
+    super();
+
+    this.callbacksUsed = [
+      // 3
+      [
+        ModCallback.POST_USE_ITEM,
+        this.postUseItemGlowingHourGlass,
+        [CollectibleType.GLOWING_HOUR_GLASS],
+      ],
+
+      // 9
+      [ModCallback.POST_PLAYER_INIT, this.postPlayerInit],
+
+      // 17
+      [ModCallback.PRE_GAME_EXIT, this.preGameExit],
+
+      // 18
+      // We want to avoid a needless dependency on the `GameReorderedCallbacks` feature.
+      // eslint-disable-next-line @typescript-eslint/no-deprecated
+      [ModCallback.POST_NEW_LEVEL, this.postNewLevel],
+    ];
+
+    this.customCallbacksUsed = [
+      [ModCallbackCustom.POST_NEW_ROOM_EARLY, this.postNewRoomEarly],
+    ];
+
+    this.mod = mod;
+  }
+
+  /**
+   * Recursively traverses an object, collecting all of the class constructors that it encounters.
+   */
+  private storeClassConstructorsFromObject(luaMap: LuaMap<AnyNotNil, unknown>) {
+    const tstlClassName = getTSTLClassName(luaMap);
+    if (
+      tstlClassName !== undefined
+      && !NON_USER_DEFINED_CLASS_NAMES.has(tstlClassName)
+    ) {
+      this.classConstructors.set(tstlClassName, luaMap as unknown as AnyClass);
+    }
+
+    for (const [_key, value] of luaMap) {
+      if (isTable(value)) {
+        this.storeClassConstructorsFromObject(value);
+      }
+    }
+  }
+
   /**
    * This is the entry point to the save data manager, a system which provides two major features:
    *
@@ -387,25 +406,6 @@ export class SaveDataManager extends Feature {
     }
   }
 
-  /**
-   * Recursively traverses an object, collecting all of the class constructors that it encounters.
-   */
-  private storeClassConstructorsFromObject(luaMap: LuaMap<AnyNotNil, unknown>) {
-    const tstlClassName = getTSTLClassName(luaMap);
-    if (
-      tstlClassName !== undefined
-      && !NON_USER_DEFINED_CLASS_NAMES.has(tstlClassName)
-    ) {
-      this.classConstructors.set(tstlClassName, luaMap as unknown as AnyClass);
-    }
-
-    for (const [_key, value] of luaMap) {
-      if (isTable(value)) {
-        this.storeClassConstructorsFromObject(value);
-      }
-    }
-  }
-
   /**
    * The save data manager will automatically load variables from disk at the appropriate times
    * (i.e. when a new run is started). Use this function to explicitly force the save data manager
@@ -449,6 +449,7 @@ export class SaveDataManager extends Feature {
    */
   @Exported
   public saveDataManagerSetGlobal(): void {
+    // eslint-disable-next-line unicorn/no-top-level-assignment-in-function
     g = this.saveDataMap;
   }