isaacscript-common 26.0.0 → 26.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "26.0.0",
+  "version": "26.1.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/src/index",
   "types": "dist/index.rollup.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^11.1.6"
+    "isaac-typescript-definitions": "^12.0.0"
   }
 }

package/src/classes/callbacks/PostCursedTeleport.ts

@@ -1,7 +1,6 @@
 import {
   CollectibleType,
   DamageFlag,
-  ModCallback,
   PlayerVariant,
   RoomType,
   TrinketType,
@@ -39,50 +38,16 @@ export class PostCursedTeleport extends CustomCallback<ModCallbackCustom.POST_CU
   constructor() {
     super();
 
-    this.callbacksUsed = [
-      // 32
-      [
-        ModCallback.POST_PLAYER_RENDER,
-        // Co-op babies cannot perform Cursed Eye teleports.
-        this.postPlayerRenderPlayer,
-        [PlayerVariant.PLAYER],
-      ],
-    ];
-
     this.customCallbacksUsed = [
       [ModCallbackCustom.ENTITY_TAKE_DMG_PLAYER, this.entityTakeDmgPlayer],
+      [
+        ModCallbackCustom.POST_PLAYER_RENDER_REORDERED,
+        this.postPlayerRenderReorderedPlayer,
+        [PlayerVariant.PLAYER], // Co-op babies cannot perform Cursed Eye teleports.
+      ],
     ];
   }
 
-  // ModCallback.POST_PLAYER_RENDER (32)
-  // PlayerVariant.PLAYER (0)
-  private postPlayerRenderPlayer = (
-    player: EntityPlayer,
-    _renderOffset: Vector,
-  ): void => {
-    // Retrieve information about this player.
-    const trackingArray = mapGetPlayer(v.run.playersDamageFrameMap, player);
-    if (trackingArray === undefined) {
-      return;
-    }
-    const [lastDamageFrame, callbackActivatedOnThisFrame] = trackingArray;
-
-    if (!playerIsTeleportingFromCursedTeleport(player, lastDamageFrame)) {
-      return;
-    }
-
-    // Do nothing if the callback already fired on this frame.
-    if (callbackActivatedOnThisFrame) {
-      return;
-    }
-
-    const gameFrameCount = game.GetFrameCount();
-    const newTrackingArray = [gameFrameCount, true];
-    mapSetPlayer(v.run.playersDamageFrameMap, player, newTrackingArray);
-
-    this.fire(player);
-  };
-
   // ModCallbackCustom.ENTITY_TAKE_DMG_PLAYER
   private entityTakeDmgPlayer = (
     player: EntityPlayer,
@@ -146,35 +111,64 @@ export class PostCursedTeleport extends CustomCallback<ModCallbackCustom.POST_CU
       (v.level.numSacrifices === 6 || v.level.numSacrifices >= 12)
     );
   }
-}
 
-function playerIsTeleportingFromCursedTeleport(
-  player: EntityPlayer,
-  lastDamageFrame: int,
-) {
-  // Check to see if this is the frame that we last took damage.
-  const gameFrameCount = game.GetFrameCount();
-  if (gameFrameCount !== lastDamageFrame) {
-    return false;
-  }
+  // ModCallbackCustom.POST_PLAYER_RENDER_REORDERED
+  // PlayerVariant.PLAYER (0)
+  private postPlayerRenderReorderedPlayer = (
+    player: EntityPlayer,
+    _renderOffset: Vector,
+  ): void => {
+    // Retrieve information about this player.
+    const trackingArray = mapGetPlayer(v.run.playersDamageFrameMap, player);
+    if (trackingArray === undefined) {
+      return;
+    }
+    const [lastDamageFrame, callbackActivatedOnThisFrame] = trackingArray;
+
+    if (!this.playerIsTeleportingFromCursedTeleport(player, lastDamageFrame)) {
+      return;
+    }
+
+    // Do nothing if the callback already fired on this frame.
+    if (callbackActivatedOnThisFrame) {
+      return;
+    }
+
+    const gameFrameCount = game.GetFrameCount();
+    const newTrackingArray = [gameFrameCount, true];
+    mapSetPlayer(v.run.playersDamageFrameMap, player, newTrackingArray);
+
+    this.fire(player);
+  };
 
-  // Check to see if this is the 1st frame that we are teleporting.
-  const sprite = player.GetSprite();
-  if (
-    !sprite.IsPlaying("TeleportUp") ||
-    sprite.GetFrame() !== 1 // The 0th frame never fires
+  private playerIsTeleportingFromCursedTeleport(
+    player: EntityPlayer,
+    lastDamageFrame: int,
   ) {
-    return false;
-  }
+    // Check to see if this is the frame that we last took damage.
+    const gameFrameCount = game.GetFrameCount();
+    if (gameFrameCount !== lastDamageFrame) {
+      return false;
+    }
 
-  if (player.HasCollectible(CollectibleType.CURSED_EYE)) {
-    return true;
-  }
+    // Check to see if this is the 1st frame that we are teleporting.
+    const sprite = player.GetSprite();
+    if (
+      !sprite.IsPlaying("TeleportUp") ||
+      sprite.GetFrame() !== 1 // The 0th frame never fires
+    ) {
+      return false;
+    }
 
-  const numHitsRemaining = getPlayerNumHitsRemaining(player);
-  if (player.HasTrinket(TrinketType.CURSED_SKULL) && numHitsRemaining === 1) {
-    return true;
-  }
+    if (player.HasCollectible(CollectibleType.CURSED_EYE)) {
+      return true;
+    }
 
-  return false;
+    const numHitsRemaining = getPlayerNumHitsRemaining(player);
+    if (player.HasTrinket(TrinketType.CURSED_SKULL) && numHitsRemaining === 1) {
+      return true;
+    }
+
+    return false;
+  }
 }

package/src/classes/callbacks/PostNewRoomEarly.ts

@@ -23,6 +23,7 @@ export class PostNewRoomEarly extends CustomCallback<ModCallbackCustom.POST_NEW_
 
     this.callbacksUsed = [
       // 19
+      // eslint-disable-next-line deprecation/deprecation
       [ModCallback.POST_NEW_ROOM, this.postNewRoom],
 
       // 24

package/src/classes/callbacks/PreNewLevel.ts

@@ -1,4 +1,3 @@
-import { ModCallback } from "isaac-typescript-definitions";
 import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
 import { getLastFrameOfAnimation } from "../../functions/sprites";
 import { getEffectiveStage } from "../../functions/stage";
@@ -22,14 +21,16 @@ export class PreNewLevel extends CustomCallback<ModCallbackCustom.PRE_NEW_LEVEL>
   constructor() {
     super();
 
-    this.callbacksUsed = [
-      // 32
-      [ModCallback.POST_PLAYER_RENDER, this.postPlayerRender],
+    this.customCallbacksUsed = [
+      [
+        ModCallbackCustom.POST_PLAYER_RENDER_REORDERED,
+        this.postPlayerRenderReordered,
+      ],
     ];
   }
 
-  // ModCallback.POST_PLAYER_RENDER (32)
-  private postPlayerRender = (player: EntityPlayer) => {
+  // ModCallbackCustom.POST_PLAYER_RENDER_REORDERED
+  private postPlayerRenderReordered = (player: EntityPlayer) => {
     const effectiveStage = getEffectiveStage();
     if (effectiveStage === v.run.firedOnStage) {
       return;

package/src/classes/features/callbackLogic/GameReorderedCallbacks.ts

@@ -57,12 +57,15 @@ export class GameReorderedCallbacks extends Feature {
       ],
 
       // 15
+      // eslint-disable-next-line deprecation/deprecation
       [ModCallback.POST_GAME_STARTED, this.postGameStarted],
 
       // 18
+      // eslint-disable-next-line deprecation/deprecation
       [ModCallback.POST_NEW_LEVEL, this.postNewLevel],
 
       // 19
+      // eslint-disable-next-line deprecation/deprecation
       [ModCallback.POST_NEW_ROOM, this.postNewRoom],
     ];
 

package/src/classes/features/callbackLogic/PlayerReorderedCallbacks.ts

@@ -4,6 +4,7 @@
 // - POST_PLAYER_UPDATE_REORDERED
 
 import { ModCallback } from "isaac-typescript-definitions";
+import { VectorZero } from "../../../core/constants";
 import { ModCallbackCustom } from "../../../enums/ModCallbackCustom";
 import { emptyArray } from "../../../functions/array";
 import {
@@ -16,13 +17,18 @@ import { PostPlayerRenderReordered } from "../../callbacks/PostPlayerRenderReord
 import { PostPlayerUpdateReordered } from "../../callbacks/PostPlayerUpdateReordered";
 import { Feature } from "../../private/Feature";
 
+interface QueueElement {
+  playerIndex: PlayerIndex;
+  renderOffset: Vector;
+}
+
 const v = {
   run: {
     postGameStartedFiredOnThisRun: false,
 
-    postPEffectUpdateQueue: [] as PlayerIndex[],
-    postPlayerUpdateQueue: [] as PlayerIndex[],
-    postPlayerRenderQueue: [] as PlayerIndex[],
+    postPEffectUpdateQueue: [] as QueueElement[],
+    postPlayerUpdateQueue: [] as QueueElement[],
+    postPlayerRenderQueue: [] as QueueElement[],
   },
 };
 
@@ -42,12 +48,15 @@ export class PlayerReorderedCallbacks extends Feature {
 
     this.callbacksUsed = [
       // 4
+      // eslint-disable-next-line deprecation/deprecation
       [ModCallback.POST_PEFFECT_UPDATE, this.postPEffectUpdate],
 
       // 31
+      // eslint-disable-next-line deprecation/deprecation
       [ModCallback.POST_PLAYER_UPDATE, this.postPlayerUpdate],
 
       // 32
+      // eslint-disable-next-line deprecation/deprecation
       [ModCallback.POST_PLAYER_RENDER, this.postPlayerRender],
     ];
 
@@ -70,7 +79,10 @@ export class PlayerReorderedCallbacks extends Feature {
     } else {
       // Defer callback execution until the `POST_GAME_STARTED` callback fires.
       const playerIndex = getPlayerIndex(player);
-      v.run.postPEffectUpdateQueue.push(playerIndex);
+      v.run.postPEffectUpdateQueue.push({
+        playerIndex,
+        renderOffset: VectorZero,
+      });
     }
   };
 
@@ -81,21 +93,24 @@ export class PlayerReorderedCallbacks extends Feature {
     } else {
       // Defer callback execution until the `POST_GAME_STARTED` callback fires.
       const playerIndex = getPlayerIndex(player);
-      v.run.postPlayerUpdateQueue.push(playerIndex);
+      v.run.postPlayerUpdateQueue.push({
+        playerIndex,
+        renderOffset: VectorZero,
+      });
     }
   };
 
   // ModCallback.POST_PLAYER_RENDER (32)
   private postPlayerRender = (
     player: EntityPlayer,
-    _renderOffset: Vector,
+    renderOffset: Vector,
   ): void => {
     if (v.run.postGameStartedFiredOnThisRun) {
-      this.postPlayerRenderReordered.fire(player);
+      this.postPlayerRenderReordered.fire(player, renderOffset);
     } else {
       // Defer callback execution until the `POST_GAME_STARTED` callback fires.
       const playerIndex = getPlayerIndex(player);
-      v.run.postPlayerRenderQueue.push(playerIndex);
+      v.run.postPlayerRenderQueue.push({ playerIndex, renderOffset });
     }
   };
 
@@ -110,15 +125,16 @@ export class PlayerReorderedCallbacks extends Feature {
 }
 
 function dequeue(
-  playerIndexes: PlayerIndex[],
-  fireFunc: (player: EntityPlayer) => void,
+  queue: QueueElement[],
+  fireFunc: (player: EntityPlayer, renderOffset: Vector) => void,
 ) {
-  for (const playerIndex of playerIndexes) {
+  for (const element of queue) {
+    const { playerIndex, renderOffset } = element;
     const player = getPlayerFromIndex(playerIndex);
     if (player !== undefined) {
-      fireFunc(player);
+      fireFunc(player, renderOffset);
     }
   }
 
-  emptyArray(playerIndexes);
+  emptyArray(queue);
 }

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

@@ -1,9 +1,9 @@
-import { ModCallback } from "isaac-typescript-definitions";
 import { game } from "../../../core/cachedClasses";
 import { Exported } from "../../../decorators";
+import { ModCallbackCustom } from "../../../enums/ModCallbackCustom";
 import { Feature } from "../../private/Feature";
 
-const FADE_IN_SPEED = 1;
+const INSTANT_FADE_IN_SPEED = 1;
 
 export class FadeInRemover extends Feature {
   private enabled = false;
@@ -12,16 +12,18 @@ export class FadeInRemover extends Feature {
   constructor() {
     super();
 
-    this.callbacksUsed = [
-      // 15
-      [ModCallback.POST_GAME_STARTED, this.postGameStarted],
+    this.customCallbacksUsed = [
+      [
+        ModCallbackCustom.POST_GAME_STARTED_REORDERED,
+        this.postGameStartedReordered,
+      ],
     ];
   }
 
-  // ModCallback.POST_GAME_STARTED (15)
-  private postGameStarted = (_isContinued: boolean) => {
+  // ModCallbackCustom.POST_GAME_STARTED_REORDERED
+  private postGameStartedReordered = () => {
     if (this.enabled) {
-      game.Fadein(FADE_IN_SPEED);
+      game.Fadein(INSTANT_FADE_IN_SPEED);
     }
   };
 

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

@@ -103,6 +103,8 @@ export class SaveDataManager extends Feature {
       [ModCallback.PRE_GAME_EXIT, this.preGameExit],
 
       // 18
+      // We want to avoid a needless dependency on the `GameReorderedCallbacks` feature.
+      // eslint-disable-next-line deprecation/deprecation
       [ModCallback.POST_NEW_LEVEL, this.postNewLevel],
     ];
 

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

@@ -1,4 +1,4 @@
-import { ModCallback } from "isaac-typescript-definitions";
+import { ModCallbackCustom } from "../../../../enums/ModCallbackCustom";
 import { Feature } from "../../../private/Feature";
 import { defaultEntityDisplayCallback, renderTextOnEntity } from "./utils";
 
@@ -9,14 +9,16 @@ export class DebugDisplayPlayer extends Feature {
   constructor() {
     super();
 
-    this.callbacksUsed = [
-      // 32
-      [ModCallback.POST_PLAYER_RENDER, this.postPlayerRender],
+    this.customCallbacksUsed = [
+      [
+        ModCallbackCustom.POST_PLAYER_RENDER_REORDERED,
+        this.postPlayerRenderReordered,
+      ],
     ];
   }
 
-  // ModCallback.POST_PLAYER_RENDER (32)
-  private postPlayerRender = (player: EntityPlayer) => {
+  // ModCallbackCustom.POST_PLAYER_RENDER_REORDERED
+  private postPlayerRenderReordered = (player: EntityPlayer) => {
     const text = this.textCallback(player);
     renderTextOnEntity(player, text);
   };

package/src/enums/ModCallbackCustom.ts

@@ -428,8 +428,7 @@ export enum ModCallbackCustom {
    *
    * `POST_GAME_STARTED_REORDERED` --> `POST_NEW_LEVEL_REORDERED` --> `POST_NEW_ROOM_REORDERED`
    *
-   * - You must provide a third argument to specify if you want the callback to fire if the game is
-   *   continued:
+   * - You must provide a third argument:
    *   - Pass true if you want the callback to only fire if the run is continued.
    *   - Pass false if you want the callback to only fire when the run is not continued.
    *   - Pass undefined if you want the callback to fire in both situations.
@@ -449,8 +448,7 @@ export enum ModCallbackCustom {
    * new run has started (or continued), but you can be sure that all new-run-related initialization
    * has been completed.
    *
-   * - You must provide a third argument to specify if you want the callback to fire if the game is
-   *   continued:
+   * - You must provide a third argument:
    *   - Pass true if you want the callback to only fire if the run is continued.
    *   - Pass false if you want the callback to only fire when the run is not continued.
    *   - Pass undefined if you want the callback to fire in both situations.
@@ -1466,7 +1464,7 @@ export enum ModCallbackCustom {
    *   matches the `PlayerType` provided.
    *
    * ```ts
-   * function postPlayerRenderReordered(player: EntityPlayer): void {}
+   * function postPlayerRenderReordered(player: EntityPlayer, renderOffset: Vector): void {}
    * ```
    */
   POST_PLAYER_RENDER_REORDERED,

package/src/functions/utils.ts

@@ -1,5 +1,6 @@
 import { RenderMode } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
+import { getAllPlayers } from "./playerIndex";
 import { isFunction } from "./types";
 
 /**
@@ -79,6 +80,19 @@ export function inRange(num: int, start: int, end: int): boolean {
   return num >= start && num <= end;
 }
 
+/**
+ * Helper function to detect if there is two or more players currently playing.
+ *
+ * Specifically, this function looks for unique `ControllerIndex` values across all players.
+ */
+export function isMultiplayer(): boolean {
+  const players = getAllPlayers();
+  const controllerIndexes = players.map((player) => player.ControllerIndex);
+  const controllerIndexesSet = new Set(controllerIndexes);
+
+  return controllerIndexesSet.size > 1;
+}
+
 /**
  * Helper function to see if the current render callback is rendering a water reflection.
  *

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -589,7 +589,7 @@ export interface AddCallbackParametersCustom {
   ];
 
   [ModCallbackCustom.POST_PLAYER_RENDER_REORDERED]: [
-    callback: (player: EntityPlayer) => void,
+    callback: (player: EntityPlayer, renderOffset: Vector) => void,
     playerVariant?: PlayerVariant,
     character?: PlayerType,
   ];

package/src/shouldFire.ts

@@ -313,6 +313,7 @@ export function shouldFirePit(
 export function shouldFirePlayer(
   fireArgs:
     | [player: EntityPlayer]
+    | [player: EntityPlayer, renderOffset: Vector]
     | [player: EntityPlayer, numSacrifices: int]
     | [player: EntityPlayer, collectible: EntityPickupCollectible]
     | [player: EntityPlayer, oldCharacter: PlayerType, newCharacter: PlayerType]