isaacscript-common 87.9.5 → 87.9.7

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

@@ -19,8 +19,7 @@ import { v } from "./extraConsoleCommands/v";
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 declare let __ISAACSCRIPT_COMMON_EXTRA_CONSOLE_COMMANDS_FEATURE:
-  | ExtraConsoleCommands
-  | undefined;
+  ExtraConsoleCommands | undefined;
 
 /**
  * When you enable this feature, many custom commands will be added to the in-game console. See the
@@ -35,9 +34,6 @@ declare let __ISAACSCRIPT_COMMON_EXTRA_CONSOLE_COMMANDS_FEATURE:
  * you might need to get another mod author to update their version of `isaacscript-common`.
  */
 export class ExtraConsoleCommands extends Feature {
-  /** @internal */
-  public override v = v;
-
   private readonly isMainFeature: boolean;
 
   private readonly commandFunctionMap = new Map<
@@ -45,77 +41,14 @@ export class ExtraConsoleCommands extends Feature {
     (params: string) => void
   >();
 
-  /** @internal */
-  constructor() {
-    super();
-
-    // Only one instance of this feature can be instantiated across all mods.
-    this.isMainFeature =
-      __ISAACSCRIPT_COMMON_EXTRA_CONSOLE_COMMANDS_FEATURE === undefined;
-    if (!this.isMainFeature) {
-      return;
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
-    __ISAACSCRIPT_COMMON_EXTRA_CONSOLE_COMMANDS_FEATURE = this;
-
-    this.callbacksUsed = [
-      // 1
-      [ModCallback.POST_UPDATE, this.postUpdate],
-
-      // 8
-      [
-        ModCallback.EVALUATE_CACHE,
-        this.evaluateCacheDamage,
-        [CacheFlag.DAMAGE], // 1 << 0
-      ],
-
-      // 8
-      [
-        ModCallback.EVALUATE_CACHE,
-        this.evaluateCacheFireDelay,
-        [CacheFlag.FIRE_DELAY], // 1 << 1
-      ],
-
-      // 8
-      [
-        ModCallback.EVALUATE_CACHE,
-        this.evaluateCacheSpeed,
-        [CacheFlag.SPEED], // 1 << 4
-      ],
-
-      // 8
-      [
-        ModCallback.EVALUATE_CACHE,
-        this.evaluateCacheFlying,
-        [CacheFlag.FLYING], // 1 << 7
-      ],
-
-      // 12
-      [ModCallback.POST_CURSE_EVAL, this.postCurseEval],
-
-      // 22
-      [ModCallback.EXECUTE_CMD, this.executeCmd],
-
-      // 61
-      [ModCallback.POST_FIRE_TEAR, this.postFireTear],
-    ];
-
-    this.customCallbacksUsed = [
-      [ModCallbackCustom.ENTITY_TAKE_DMG_PLAYER, this.entityTakeDmgPlayer],
-    ];
-
-    for (const [funcName, func] of Object.entries(commands)) {
-      this.commandFunctionMap.set(funcName, func);
-    }
-  }
-
   // ModCallback.POST_UPDATE (1)
   private readonly postUpdate = () => {
-    if (v.persistent.spamBloodRights) {
-      const player = Isaac.GetPlayer();
-      player.UseActiveItem(CollectibleType.BLOOD_RIGHTS);
+    if (!v.persistent.spamBloodRights) {
+      return;
     }
+
+    const player = Isaac.GetPlayer();
+    player.UseActiveItem(CollectibleType.BLOOD_RIGHTS);
   };
 
   // ModCallback.EVALUATE_CACHE (8)
@@ -239,6 +172,74 @@ export class ExtraConsoleCommands extends Feature {
     return undefined;
   };
 
+  /** @internal */
+  public override v = v;
+
+  /** @internal */
+  constructor() {
+    super();
+
+    // Only one instance of this feature can be instantiated across all mods.
+    this.isMainFeature =
+      __ISAACSCRIPT_COMMON_EXTRA_CONSOLE_COMMANDS_FEATURE === undefined;
+    if (!this.isMainFeature) {
+      return;
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this, unicorn/no-top-level-assignment-in-function
+    __ISAACSCRIPT_COMMON_EXTRA_CONSOLE_COMMANDS_FEATURE = this;
+
+    this.callbacksUsed = [
+      // 1
+      [ModCallback.POST_UPDATE, this.postUpdate],
+
+      // 8
+      [
+        ModCallback.EVALUATE_CACHE,
+        this.evaluateCacheDamage,
+        [CacheFlag.DAMAGE], // 1 << 0
+      ],
+
+      // 8
+      [
+        ModCallback.EVALUATE_CACHE,
+        this.evaluateCacheFireDelay,
+        [CacheFlag.FIRE_DELAY], // 1 << 1
+      ],
+
+      // 8
+      [
+        ModCallback.EVALUATE_CACHE,
+        this.evaluateCacheSpeed,
+        [CacheFlag.SPEED], // 1 << 4
+      ],
+
+      // 8
+      [
+        ModCallback.EVALUATE_CACHE,
+        this.evaluateCacheFlying,
+        [CacheFlag.FLYING], // 1 << 7
+      ],
+
+      // 12
+      [ModCallback.POST_CURSE_EVAL, this.postCurseEval],
+
+      // 22
+      [ModCallback.EXECUTE_CMD, this.executeCmd],
+
+      // 61
+      [ModCallback.POST_FIRE_TEAR, this.postFireTear],
+    ];
+
+    this.customCallbacksUsed = [
+      [ModCallbackCustom.ENTITY_TAKE_DMG_PLAYER, this.entityTakeDmgPlayer],
+    ];
+
+    for (const [funcName, func] of Object.entries(commands)) {
+      this.commandFunctionMap.set(funcName, func);
+    }
+  }
+
   /**
    * Helper function to add a custom console command.
    *

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

@@ -8,6 +8,13 @@ const INSTANT_FADE_IN_SPEED = 1;
 export class FadeInRemover extends Feature {
   private enabled = false;
 
+  // ModCallbackCustom.POST_GAME_STARTED_REORDERED
+  private readonly postGameStartedReordered = () => {
+    if (this.enabled) {
+      game.Fadein(INSTANT_FADE_IN_SPEED);
+    }
+  };
+
   /** @internal */
   constructor() {
     super();
@@ -21,13 +28,6 @@ export class FadeInRemover extends Feature {
     ];
   }
 
-  // ModCallbackCustom.POST_GAME_STARTED_REORDERED
-  private readonly postGameStartedReordered = () => {
-    if (this.enabled) {
-      game.Fadein(INSTANT_FADE_IN_SPEED);
-    }
-  };
-
   /**
    * Removes the fade-in that occurs at the beginning of a run. If this behavior is desired, call
    * this function once at the beginning of your mod.

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

@@ -15,6 +15,15 @@ declare let AwaitingTextInput: boolean;
 export class FastReset extends Feature {
   private enabled = false;
 
+  // ModCallback.POST_RENDER (2)
+  private readonly postRender = () => {
+    if (!this.enabled) {
+      return;
+    }
+
+    checkResetInput();
+  };
+
   /** @internal */
   constructor() {
     super();
@@ -25,15 +34,6 @@ export class FastReset extends Feature {
     ];
   }
 
-  // ModCallback.POST_RENDER (2)
-  private readonly postRender = () => {
-    if (!this.enabled) {
-      return;
-    }
-
-    checkResetInput();
-  };
-
   /**
    * Enables the fast-reset feature, which allows you to restart the game instantaneously. If this
    * behavior is desired, call this function once at the beginning of your mod.

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

@@ -5,6 +5,8 @@ import { Feature } from "../../private/Feature";
 import type { PressInput } from "./PressInput";
 
 export class ForgottenSwitch extends Feature {
+  private readonly pressInput: PressInput;
+
   /** @internal */
   public override v = {
     run: {
@@ -12,8 +14,6 @@ export class ForgottenSwitch extends Feature {
     },
   };
 
-  private readonly pressInput: PressInput;
-
   /** @internal */
   constructor(pressInput: PressInput) {
     super();

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

@@ -199,19 +199,24 @@ function removeItemsAndTrinketsThatAffectItemPools(): {
 
     const removedTrinkets: TrinketType[] = [];
     for (const trinketToRemove of TRINKETS_THAT_AFFECT_ITEM_POOLS) {
-      if (player.HasTrinket(trinketToRemove)) {
-        const numTrinkets = player.GetTrinketMultiplier(trinketToRemove);
-        repeat(numTrinkets, () => {
-          player.TryRemoveTrinket(trinketToRemove);
-          removedTrinkets.push(trinketToRemove);
-        });
+      if (!player.HasTrinket(trinketToRemove)) {
+        continue;
       }
+
+      const numTrinkets = player.GetTrinketMultiplier(trinketToRemove);
+      repeat(numTrinkets, () => {
+        player.TryRemoveTrinket(trinketToRemove);
+        removedTrinkets.push(trinketToRemove);
+      });
     }
 
     mapSetPlayer(removedTrinketsMap, player, removedTrinkets);
   }
 
-  return { removedItemsMap, removedTrinketsMap };
+  return {
+    removedItemsMap,
+    removedTrinketsMap,
+  };
 }
 
 function restoreItemsAndTrinketsThatAffectItemPools(

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

@@ -45,6 +45,11 @@ const FIRST_MODDED_PILL_EFFECT: PillEffect = LAST_VANILLA_PILL_EFFECT + 1;
 export class ModdedElementDetection extends Feature {
   private atLeastOneCallbackFired = false;
 
+  // ModCallback.POST_PLAYER_INIT (9)
+  private readonly postPlayerInit = () => {
+    this.atLeastOneCallbackFired = true;
+  };
+
   /** @internal */
   constructor() {
     super();
@@ -55,11 +60,6 @@ export class ModdedElementDetection extends Feature {
     ];
   }
 
-  // ModCallback.POST_PLAYER_INIT (9)
-  private readonly postPlayerInit = () => {
-    this.atLeastOneCallbackFired = true;
-  };
-
   private errorIfNoCallbacksFired(constantType: string) {
     if (!this.atLeastOneCallbackFired) {
       error(

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

@@ -12,6 +12,12 @@ const v = {
 };
 
 export class NoSirenSteal extends Feature {
+  // ModCallback.POST_NPC_INIT (27)
+  // EntityType.SIREN_HELPER (966)
+  private readonly postNPCInitSirenHelper = (npc: EntityNPC) => {
+    this.checkReturnFamiliarToPlayer(npc);
+  };
+
   /** @internal */
   public override v = v;
 
@@ -29,12 +35,6 @@ export class NoSirenSteal extends Feature {
     ];
   }
 
-  // ModCallback.POST_NPC_INIT (27)
-  // EntityType.SIREN_HELPER (966)
-  private readonly postNPCInitSirenHelper = (npc: EntityNPC) => {
-    this.checkReturnFamiliarToPlayer(npc);
-  };
-
   private checkReturnFamiliarToPlayer(npc: EntityNPC) {
     if (npc.Target === undefined) {
       return;

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

@@ -25,12 +25,12 @@ import { Feature } from "../../private/Feature";
 import type { DisableInputs } from "./DisableInputs";
 
 interface InitialDescription {
-  position: Vector;
-  positionOffset: Vector;
-  velocity: Vector;
-  height: float;
-  fallingSpeed: float;
-  fallingAcceleration: float;
+  readonly position: Readonly<Vector>;
+  readonly positionOffset: Readonly<Vector>;
+  readonly velocity: Readonly<Vector>;
+  readonly height: float;
+  readonly fallingSpeed: float;
+  readonly fallingAcceleration: float;
 }
 
 const v = {
@@ -42,11 +42,48 @@ const v = {
 };
 
 export class Pause extends Feature {
+  private readonly disableInputs: DisableInputs;
+
+  // ModCallback.POST_UPDATE (1)
+  private readonly postUpdate = () => {
+    if (!v.run.isPseudoPaused) {
+      return;
+    }
+
+    const firstPlayer = Isaac.GetPlayer();
+    useActiveItemTemp(firstPlayer, CollectibleType.PAUSE);
+
+    if (isRepentancePlus()) {
+      sfxManager.Stop(SoundEffect.PAUSE_FREEZE);
+    }
+
+    this.stopTearsAndProjectilesFromMoving();
+  };
+
+  // ModCallback.INPUT_ACTION (13)
+  // InputHook.GET_ACTION_VALUE (2)
+  private readonly inputActionGetActionValue = (
+    _entity: Entity | undefined,
+    _inputHook: InputHook,
+    buttonAction: ButtonAction,
+  ): boolean | float | undefined => {
+    if (buttonAction !== ButtonAction.SHOOT_RIGHT) {
+      return undefined;
+    }
+
+    if (!v.run.shouldUnpause) {
+      return undefined;
+    }
+    v.run.shouldUnpause = false;
+
+    // Returning a value of 1 for a single sub-frame will be enough for the game to register an
+    // unpause but not enough for a tear to actually be fired.
+    return 1;
+  };
+
   /** @internal */
   public override v = v;
 
-  private readonly disableInputs: DisableInputs;
-
   /** @internal */
   constructor(disableInputs: DisableInputs) {
     super();
@@ -66,22 +103,6 @@ export class Pause extends Feature {
     this.disableInputs = disableInputs;
   }
 
-  // ModCallback.POST_UPDATE (1)
-  private readonly postUpdate = () => {
-    if (!v.run.isPseudoPaused) {
-      return;
-    }
-
-    const firstPlayer = Isaac.GetPlayer();
-    useActiveItemTemp(firstPlayer, CollectibleType.PAUSE);
-
-    if (isRepentancePlus()) {
-      sfxManager.Stop(SoundEffect.PAUSE_FREEZE);
-    }
-
-    this.stopTearsAndProjectilesFromMoving();
-  };
-
   private stopTearsAndProjectilesFromMoving() {
     const tearsAndProjectiles = [...getTears(), ...getProjectiles()];
 
@@ -106,27 +127,6 @@ export class Pause extends Feature {
     }
   }
 
-  // ModCallback.INPUT_ACTION (13)
-  // InputHook.GET_ACTION_VALUE (2)
-  private readonly inputActionGetActionValue = (
-    _entity: Entity | undefined,
-    _inputHook: InputHook,
-    buttonAction: ButtonAction,
-  ): boolean | float | undefined => {
-    if (buttonAction !== ButtonAction.SHOOT_RIGHT) {
-      return undefined;
-    }
-
-    if (!v.run.shouldUnpause) {
-      return undefined;
-    }
-    v.run.shouldUnpause = false;
-
-    // Returning a value of 1 for a single sub-frame will be enough for the game to register an
-    // unpause but not enough for a tear to actually be fired.
-    return 1;
-  };
-
   /**
    * Helper function to check if the pause feature from `isaacscript-common` is currently
    * pseudo-pausing the game.

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

@@ -9,12 +9,12 @@ import { Feature } from "../../private/Feature";
 import type { RoomHistory } from "./RoomHistory";
 
 interface PersistentEntityDescription {
-  entityType: EntityType;
-  variant: int;
-  subType: int;
-  dimension: Dimension;
-  roomListIndex: int;
-  position: Readonly<Vector>;
+  readonly entityType: EntityType;
+  readonly variant: int;
+  readonly subType: int;
+  readonly dimension: Dimension;
+  readonly roomListIndex: int;
+  readonly position: Readonly<Vector>;
 }
 
 type PersistentEntityTuple = [index: int, entityPtr: EntityPtr];
@@ -41,29 +41,8 @@ const v = {
 };
 
 export class PersistentEntities extends Feature {
-  /** @internal */
-  public override v = v;
-
   private readonly roomHistory: RoomHistory;
 
-  /** @internal */
-  constructor(roomHistory: RoomHistory) {
-    super();
-
-    this.featuresUsed = [ISCFeature.ROOM_HISTORY];
-
-    this.callbacksUsed = [
-      // 67
-      [ModCallback.POST_ENTITY_REMOVE, this.postEntityRemove],
-    ];
-
-    this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_NEW_ROOM_REORDERED, this.postNewRoomReordered],
-    ];
-
-    this.roomHistory = roomHistory;
-  }
-
   // ModCallback.POST_ENTITY_REMOVE (67)
   private readonly postEntityRemove = (entity: Entity) => {
     const ptrHash = GetPtrHash(entity);
@@ -83,6 +62,48 @@ export class PersistentEntities extends Feature {
     }
   };
 
+  // ModCallbackCustom.POST_NEW_ROOM_REORDERED
+  private readonly postNewRoomReordered = () => {
+    const roomListIndex = getRoomListIndex();
+    const persistentEntities = [...v.level.persistentEntities];
+    const persistentEntitiesInThisRoom = persistentEntities.filter(
+      ([_index, description]) => roomListIndex === description.roomListIndex,
+    );
+
+    for (const [index, description] of persistentEntitiesInThisRoom) {
+      v.level.persistentEntities.delete(index);
+      this.spawnAndTrack(
+        description.entityType,
+        description.variant,
+        description.subType,
+        description.position,
+        index,
+        true,
+      );
+    }
+  };
+
+  /** @internal */
+  public override v = v;
+
+  /** @internal */
+  constructor(roomHistory: RoomHistory) {
+    super();
+
+    this.featuresUsed = [ISCFeature.ROOM_HISTORY];
+
+    this.callbacksUsed = [
+      // 67
+      [ModCallback.POST_ENTITY_REMOVE, this.postEntityRemove],
+    ];
+
+    this.customCallbacksUsed = [
+      [ModCallbackCustom.POST_NEW_ROOM_REORDERED, this.postNewRoomReordered],
+    ];
+
+    this.roomHistory = roomHistory;
+  }
+
   /**
    * The persistent entity is despawning because the player is in the process of leaving the room.
    * Keep track of the position for later.
@@ -106,27 +127,6 @@ export class PersistentEntities extends Feature {
     v.level.persistentEntities.set(index, persistentEntityDescription);
   }
 
-  // ModCallbackCustom.POST_NEW_ROOM_REORDERED
-  private readonly postNewRoomReordered = () => {
-    const roomListIndex = getRoomListIndex();
-    const persistentEntities = [...v.level.persistentEntities.entries()];
-    const persistentEntitiesInThisRoom = persistentEntities.filter(
-      ([_index, description]) => roomListIndex === description.roomListIndex,
-    );
-
-    for (const [index, description] of persistentEntitiesInThisRoom) {
-      v.level.persistentEntities.delete(index);
-      this.spawnAndTrack(
-        description.entityType,
-        description.variant,
-        description.subType,
-        description.position,
-        index,
-        true,
-      );
-    }
-  };
-
   private spawnAndTrack(
     entityType: EntityType,
     variant: int,
@@ -157,15 +157,15 @@ export class PersistentEntities extends Feature {
    *
    * @param persistentEntityIndex The index that was returned by the `spawnPersistentEntity`
    *                              function.
-   * @param removeEntity Optional. True by default. Set to false if you want to stop an entity from
-   *                     being persistent but you don't want to actually remove the
-   *                     currently-spawned entity from the room.
+   * @param shouldRemoveEntity Optional. True by default. Set to false if you want to stop an entity
+   *                           from being persistent but you don't want to actually remove the
+   *                           currently-spawned entity from the room.
    * @public
    */
   @Exported
   public removePersistentEntity(
     persistentEntityIndex: int,
-    removeEntity = true,
+    shouldRemoveEntity = true,
   ): void {
     v.level.persistentEntities.delete(persistentEntityIndex);
 
@@ -177,7 +177,7 @@ export class PersistentEntities extends Feature {
 
       v.room.spawnedPersistentEntities.delete(ptrHash);
 
-      if (removeEntity && entityPtr.Ref !== undefined) {
+      if (shouldRemoveEntity && entityPtr.Ref !== undefined) {
         entityPtr.Ref.Remove();
       }
     }
@@ -219,6 +219,9 @@ export class PersistentEntities extends Feature {
       v.run.persistentEntityIndexCounter,
     );
 
-    return { entity, persistentIndex: v.run.persistentEntityIndexCounter };
+    return {
+      entity,
+      persistentIndex: v.run.persistentEntityIndexCounter,
+    };
   }
 }

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

@@ -18,8 +18,8 @@ import type { RoomHistory } from "./RoomHistory";
 import type { SaveDataManager } from "./SaveDataManager";
 
 interface PickupDescription {
-  position: Vector;
-  initSeed: Seed;
+  readonly position: Readonly<Vector>;
+  readonly initSeed: Seed;
 }
 
 const v = {
@@ -44,12 +44,23 @@ const v = {
 };
 
 export class PickupIndexCreation extends Feature {
-  /** @internal */
-  public override v = v;
-
   private readonly roomHistory: RoomHistory;
   private readonly saveDataManager: SaveDataManager;
 
+  // ModCallback.POST_PICKUP_INIT (34)
+  private readonly postPickupInit = (pickup: EntityPickup) => {
+    this.setPickupIndex(pickup);
+  };
+
+  // ModCallback.POST_ENTITY_REMOVE (67)
+  // EntityType.PICKUP (5)
+  private readonly postEntityRemovePickup = (entity: Entity) => {
+    this.checkDespawningFromPlayerLeavingRoom(entity);
+  };
+
+  /** @internal */
+  public override v = v;
+
   /** @internal */
   constructor(roomHistory: RoomHistory, saveDataManager: SaveDataManager) {
     super();
@@ -72,11 +83,6 @@ export class PickupIndexCreation extends Feature {
     this.saveDataManager = saveDataManager;
   }
 
-  // ModCallback.POST_PICKUP_INIT (34)
-  private readonly postPickupInit = (pickup: EntityPickup) => {
-    this.setPickupIndex(pickup);
-  };
-
   private setPickupIndex(pickup: EntityPickup): void {
     const ptrHash = GetPtrHash(pickup);
 
@@ -121,12 +127,6 @@ export class PickupIndexCreation extends Feature {
     return pickupIndex;
   }
 
-  // ModCallback.POST_ENTITY_REMOVE (67)
-  // EntityType.PICKUP (5)
-  private readonly postEntityRemovePickup = (entity: Entity) => {
-    this.checkDespawningFromPlayerLeavingRoom(entity);
-  };
-
   private checkDespawningFromPlayerLeavingRoom(entity: Entity) {
     const ptrHash = GetPtrHash(entity);
     const pickupIndex = v.room.pickupIndexes.get(ptrHash);
@@ -186,8 +186,7 @@ export class PickupIndexCreation extends Feature {
    */
   // eslint-disable-next-line complete/no-mutable-return
   private getPickupDataMapForCurrentRoom():
-    | Map<PickupIndex, PickupDescription>
-    | undefined {
+    Map<PickupIndex, PickupDescription> | undefined {
     if (onAscent()) {
       return undefined;
     }