isaacscript-common 13.3.4 → 14.1.0

package/src/callbacks/postAmbush.ts

@@ -2,11 +2,10 @@
 // - `POST_AMBUSH_STARTED`
 // - `POST_AMBUSH_FINISHED`
 
-import { ModCallback, RoomType } from "isaac-typescript-definitions";
+import { ModCallback } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
-import { AmbushType } from "../enums/AmbushType";
 import { saveDataManager } from "../features/saveDataManager/exports";
-import { getRoomType } from "../functions/roomData";
+import { getAmbushType } from "../functions/ambush";
 import {
   postAmbushFinishedFire,
   postAmbushFinishedHasSubscriptions,
@@ -41,14 +40,17 @@ function postUpdate() {
     return;
   }
 
+  const ambushType = getAmbushType();
+  if (ambushType === undefined) {
+    return;
+  }
+
   const room = game.GetRoom();
 
   if (!v.room.ambushActive) {
     const ambushActive = room.IsAmbushActive();
     if (ambushActive) {
       v.room.ambushActive = true;
-
-      const ambushType = getAmbushType();
       postAmbushStartedFire(ambushType);
     }
   }
@@ -57,16 +59,7 @@ function postUpdate() {
     const ambushDone = room.IsAmbushDone();
     if (ambushDone) {
       v.room.ambushDone = true;
-
-      const ambushType = getAmbushType();
       postAmbushFinishedFire(ambushType);
     }
   }
 }
-
-function getAmbushType(): AmbushType {
-  const roomType = getRoomType();
-  return roomType === RoomType.BOSS_RUSH
-    ? AmbushType.BOSS_RUSH
-    : AmbushType.CHALLENGE_ROOM;
-}

package/src/callbacks/postBombExploded.ts

@@ -3,7 +3,7 @@ import { BOMB_EXPLODE_FRAME } from "../core/constants";
 import {
   postBombExplodedFire,
   postBombExplodedHasSubscriptions,
-} from "./subscriptions/postBoneExploded";
+} from "./subscriptions/postBombExploded";
 
 export function postBombExplodedInit(mod: Mod): void {
   mod.AddCallback(ModCallback.POST_BOMB_UPDATE, postBombUpdate); // 58

package/src/callbacks/postBoneSwing.ts

@@ -33,7 +33,8 @@ function postKnifeRender(knife: EntityKnife) {
     return;
   }
 
-  // The PostKnifeRender callback cannot be registered with knife variants for some reason.
+  // The tertiary argument of the `POST_KNIFE_RENDER` callback takes sub-types instead of knife
+  // variants.
   if (knife.Variant !== KnifeVariant.BONE_CLUB) {
     return;
   }

package/src/callbacks/postCollectibleEmpty.ts

@@ -29,6 +29,8 @@ function hasSubscriptions() {
   return postCollectibleEmptyHasSubscriptions();
 }
 
+// ModCallback.POST_PICKUP_UPDATE (35)
+// PickupVariant.COLLECTIBLE (100)
 function postPickupUpdateCollectible(pickup: EntityPickup) {
   const collectible = pickup as EntityPickupCollectible;
   const ptrHash = GetPtrHash(collectible);

package/src/callbacks/postCollectibleInitFirst.ts

@@ -27,6 +27,8 @@ function hasSubscriptions() {
   return postCollectibleInitFirstHasSubscriptions();
 }
 
+// ModCallback.POST_PICKUP_INIT (34)
+// PickupVariant.COLLECTIBLE (100)
 function postPickupInitCollectible(pickup: EntityPickup) {
   const collectible = pickup as EntityPickupCollectible;
   const collectibleIndex = getCollectibleIndex(collectible);

package/src/callbacks/postDoorRender.ts

@@ -19,7 +19,7 @@ function postRender() {
     return;
   }
 
-  for (const doors of getDoors()) {
-    postDoorRenderFire(doors);
+  for (const door of getDoors()) {
+    postDoorRenderFire(door);
   }
 }

package/src/callbacks/postEffectStateChanged.ts

@@ -8,7 +8,7 @@ import {
 
 const v = {
   run: {
-    effectStateMap: new DefaultMap<PtrHash, int, [int]>((state) => state),
+    stateMap: new DefaultMap<PtrHash, int, [int]>((state) => state),
   },
 };
 
@@ -29,12 +29,9 @@ function postEffectUpdate(effect: EntityEffect) {
   }
 
   const ptrHash = GetPtrHash(effect);
-  const previousState = v.run.effectStateMap.getAndSetDefault(
-    ptrHash,
-    effect.State,
-  );
+  const previousState = v.run.stateMap.getAndSetDefault(ptrHash, effect.State);
   const currentState = effect.State;
-  v.run.effectStateMap.set(ptrHash, currentState);
+  v.run.stateMap.set(ptrHash, currentState);
 
   if (previousState !== currentState) {
     postEffectStateChangedFire(effect, previousState, currentState);

package/src/callbacks/postFamiliarStateChanged.ts

@@ -8,7 +8,7 @@ import {
 
 const v = {
   run: {
-    familiarStateMap: new DefaultMap<PtrHash, int, [int]>((state) => state),
+    stateMap: new DefaultMap<PtrHash, int, [int]>((state) => state),
   },
 };
 
@@ -29,12 +29,12 @@ function postFamiliarUpdate(familiar: EntityFamiliar) {
   }
 
   const ptrHash = GetPtrHash(familiar);
-  const previousState = v.run.familiarStateMap.getAndSetDefault(
+  const previousState = v.run.stateMap.getAndSetDefault(
     ptrHash,
     familiar.State,
   );
   const currentState = familiar.State;
-  v.run.familiarStateMap.set(ptrHash, currentState);
+  v.run.stateMap.set(ptrHash, currentState);
 
   if (previousState !== currentState) {
     postFamiliarStateChangedFire(familiar, previousState, currentState);

package/src/callbacks/postFlip.ts

@@ -71,7 +71,7 @@ function useItemFlip(
   return undefined;
 }
 
-function getNewLazarus(oldLazarus: EntityPlayer) {
+function getNewLazarus(oldLazarus: EntityPlayer): EntityPlayer | undefined {
   const oldCharacter = oldLazarus.GetPlayerType();
 
   let newCharacter: PlayerType;
@@ -80,7 +80,7 @@ function getNewLazarus(oldLazarus: EntityPlayer) {
   } else if (oldCharacter === PlayerType.LAZARUS_2_B) {
     newCharacter = PlayerType.LAZARUS_B;
   } else {
-    error("Failed to determine the character in the postFlip callback.");
+    return undefined;
   }
 
   const playersOfType = getPlayersOfType(newCharacter);

package/src/callbacks/postGridEntity.ts

@@ -62,7 +62,7 @@ import {
 
 type GridEntityTuple = [
   gridEntityType: GridEntityType,
-  gridEntityVariant: int,
+  variant: int,
   state: int,
 ];
 
@@ -204,13 +204,9 @@ function checkNewGridEntity(gridIndex: int, gridEntity: GridEntity) {
 
 function updateTupleInMap(gridEntity: GridEntity) {
   const gridEntityType = gridEntity.GetType();
-  const gridEntityVariant = gridEntity.GetVariant();
+  const variant = gridEntity.GetVariant();
   const gridIndex = gridEntity.GetGridIndex();
-  const newTuple: GridEntityTuple = [
-    gridEntityType,
-    gridEntityVariant,
-    gridEntity.State,
-  ];
+  const newTuple: GridEntityTuple = [gridEntityType, variant, gridEntity.State];
   v.room.initializedGridEntities.set(gridIndex, newTuple);
 }
 

package/src/callbacks/postNPCStateChanged.ts

@@ -8,7 +8,7 @@ import {
 
 const v = {
   run: {
-    npcStateMap: new DefaultMap<PtrHash, NpcState, [NpcState]>(
+    stateMap: new DefaultMap<PtrHash, NpcState, [NpcState]>(
       (state) => state, // eslint-disable-line isaacscript/strict-enums
     ),
   },
@@ -31,9 +31,9 @@ function postNPCUpdate(npc: EntityNPC) {
   }
 
   const ptrHash = GetPtrHash(npc);
-  const previousState = v.run.npcStateMap.getAndSetDefault(ptrHash, npc.State);
+  const previousState = v.run.stateMap.getAndSetDefault(ptrHash, npc.State);
   const currentState = npc.State;
-  v.run.npcStateMap.set(ptrHash, currentState);
+  v.run.stateMap.set(ptrHash, currentState);
 
   if (previousState !== currentState) {
     postNPCStateChangedFire(npc, previousState, currentState);

package/src/callbacks/postNewRoomEarly.ts

@@ -73,7 +73,7 @@ function checkRoomChanged() {
   }
 
   // For some reason, the above check will rarely fail. We duplicate the check with another wall
-  // segment to go from 99% to 100% reliability.
+  // segment to increase the reliability.
   if (topLeftWall2 === undefined) {
     topLeftWall2 = spawnGridEntity(
       GridEntityType.WALL,

package/src/callbacks/postPickupStateChanged.ts

@@ -8,7 +8,7 @@ import {
 
 const v = {
   run: {
-    pickupStateMap: new DefaultMap<PtrHash, int, [int]>((state) => state),
+    stateMap: new DefaultMap<PtrHash, int, [int]>((state) => state),
   },
 };
 
@@ -29,12 +29,9 @@ function postPickupUpdate(pickup: EntityPickup) {
   }
 
   const ptrHash = GetPtrHash(pickup);
-  const previousState = v.run.pickupStateMap.getAndSetDefault(
-    ptrHash,
-    pickup.State,
-  );
+  const previousState = v.run.stateMap.getAndSetDefault(ptrHash, pickup.State);
   const currentState = pickup.State;
-  v.run.pickupStateMap.set(ptrHash, currentState);
+  v.run.stateMap.set(ptrHash, currentState);
 
   if (previousState !== currentState) {
     postPickupStateChangedFire(pickup, previousState, currentState);

package/src/callbacks/postPlayerCollectible.ts

@@ -20,7 +20,10 @@ import {
   defaultMapGetPlayer,
   mapSetPlayer,
 } from "../functions/playerDataStructures";
-import { getPlayerCollectibleMap } from "../functions/players";
+import {
+  getPlayerCollectibleMap,
+  getPlayerFromPtr,
+} from "../functions/players";
 import { repeat } from "../functions/utils";
 import { PlayerIndex } from "../types/PlayerIndex";
 import {
@@ -228,19 +231,12 @@ function entityTakeDmgPlayer(
   }
 
   // The items will only be rerolled after the damage is successfully applied.
-  const ptr = EntityPtr(player);
+  const entityPtr = EntityPtr(player);
   runNextGameFrame(() => {
-    const futureEntity = ptr.Ref;
-    if (futureEntity === undefined) {
-      return;
+    const futurePlayer = getPlayerFromPtr(entityPtr);
+    if (futurePlayer !== undefined) {
+      updateCollectibleMapAndFire(player, undefined);
     }
-
-    const futurePlayer = futureEntity.ToPlayer();
-    if (futurePlayer === undefined) {
-      return;
-    }
-
-    updateCollectibleMapAndFire(player, undefined);
   });
 
   return undefined;

package/src/callbacks/postRoomClearChanged.ts

@@ -1,7 +1,6 @@
 import { ModCallback } from "isaac-typescript-definitions";
 import { ModUpgraded } from "../classes/ModUpgraded";
 import { game } from "../core/cachedClasses";
-import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { saveDataManager } from "../features/saveDataManager/exports";
 import {
   postRoomClearChangedFire,
@@ -18,10 +17,7 @@ export function postRoomClearChangedInit(mod: ModUpgraded): void {
   saveDataManager("postRoomClearChanged", v, hasSubscriptions);
 
   mod.AddCallback(ModCallback.POST_UPDATE, postUpdate); // 1
-  mod.AddCallbackCustom(
-    ModCallbackCustom.POST_NEW_ROOM_REORDERED,
-    postNewRoomReordered,
-  );
+  mod.AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom); // 19
 }
 
 function hasSubscriptions() {
@@ -43,8 +39,8 @@ function postUpdate() {
   }
 }
 
-// ModCallbackCustom.POST_NEW_ROOM_REORDERED
-function postNewRoomReordered() {
+// ModCallback.POST_NEW_ROOM (19)
+function postNewRoom() {
   if (!hasSubscriptions()) {
     return;
   }

package/src/callbacks/reorderedCallbacks.ts

@@ -48,9 +48,9 @@ export function reorderedCallbacksInit(mod: Mod): void {
     useItemGlowingHourGlass,
     CollectibleType.GLOWING_HOUR_GLASS,
   ); // 3
-  mod.AddCallback(ModCallback.POST_GAME_STARTED, postGameStartedVanilla); // 15
-  mod.AddCallback(ModCallback.POST_NEW_LEVEL, postNewLevelVanilla); // 18
-  mod.AddCallback(ModCallback.POST_NEW_ROOM, postNewRoomVanilla); // 19
+  mod.AddCallback(ModCallback.POST_GAME_STARTED, postGameStarted); // 15
+  mod.AddCallback(ModCallback.POST_NEW_LEVEL, postNewLevel); // 18
+  mod.AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom); // 19
 }
 
 function hasSubscriptions() {
@@ -73,7 +73,7 @@ function useItemGlowingHourGlass(): boolean | undefined {
 }
 
 // ModCallback.POST_GAME_STARTED (15)
-function postGameStartedVanilla(isContinued: boolean) {
+function postGameStarted(isContinued: boolean) {
   if (!hasSubscriptions()) {
     return;
   }
@@ -87,7 +87,7 @@ function postGameStartedVanilla(isContinued: boolean) {
 }
 
 // ModCallback.POST_NEW_LEVEL (18)
-function postNewLevelVanilla() {
+function postNewLevel() {
   if (!hasSubscriptions()) {
     return;
   }
@@ -106,7 +106,7 @@ function postNewLevelVanilla() {
 }
 
 // ModCallback.POST_NEW_ROOM (19)
-function postNewRoomVanilla() {
+function postNewRoom() {
   if (!hasSubscriptions()) {
     return;
   }

package/src/callbacks/subscriptions/postCollectibleEmpty.ts

@@ -2,7 +2,7 @@ import { CollectibleType } from "isaac-typescript-definitions";
 
 export type PostCollectibleEmptyRegisterParameters = [
   callback: (
-    collectible: EntityPickup,
+    collectible: EntityPickupCollectible,
     oldCollectibleType: CollectibleType,
   ) => void,
   collectibleType?: CollectibleType,

package/src/callbacks/subscriptions/postCollectibleInitFirst.ts

@@ -1,7 +1,7 @@
 import { CollectibleType } from "isaac-typescript-definitions";
 
 export type PostCollectibleInitFirstRegisterParameters = [
-  callback: (collectible: EntityPickup) => void,
+  callback: (collectible: EntityPickupCollectible) => void,
   collectibleType?: CollectibleType,
 ];
 

package/src/callbacks/subscriptions/postCursedTeleport.ts

@@ -1,5 +1,9 @@
+import { PlayerType, PlayerVariant } from "isaac-typescript-definitions";
+
 export type PostCursedTeleportRegisterParameters = [
   callback: (player: EntityPlayer) => void,
+  playerVariant?: PlayerVariant,
+  character?: PlayerType,
 ];
 
 const subscriptions: PostCursedTeleportRegisterParameters[] = [];
@@ -15,7 +19,26 @@ export function postCursedTeleportRegister(
 }
 
 export function postCursedTeleportFire(player: EntityPlayer): void {
-  for (const [callback] of subscriptions) {
+  const character = player.GetPlayerType();
+
+  for (const [
+    callback,
+    callbackPlayerVariant,
+    callbackCharacter,
+  ] of subscriptions) {
+    // Handle the optional 2nd callback argument.
+    if (
+      callbackPlayerVariant !== undefined &&
+      callbackPlayerVariant !== player.Variant
+    ) {
+      continue;
+    }
+
+    // Handle the optional 3rd callback argument.
+    if (callbackCharacter !== undefined && callbackCharacter !== character) {
+      continue;
+    }
+
     callback(player);
   }
 }

package/src/callbacks/subscriptions/postGridEntityBroken.ts

@@ -3,7 +3,7 @@ import { GridEntityType } from "isaac-typescript-definitions";
 export type PostGridEntityBrokenRegisterParameters = [
   callback: (gridEntity: GridEntity) => void,
   gridEntityType?: GridEntityType,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostGridEntityBrokenRegisterParameters[] = [];
@@ -20,12 +20,12 @@ export function postGridEntityBrokenRegister(
 
 export function postGridEntityBrokenFire(gridEntity: GridEntity): void {
   const gridEntityType = gridEntity.GetType();
-  const gridEntityVariant = gridEntity.GetVariant();
+  const variant = gridEntity.GetVariant();
 
   for (const [
     callback,
     callbackGridEntityType,
-    callbackGridEntityVariant,
+    callbackVariant,
   ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
@@ -36,10 +36,7 @@ export function postGridEntityBrokenFire(gridEntity: GridEntity): void {
     }
 
     // Handle the optional 3rd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks/subscriptions/postGridEntityCollision.ts

@@ -34,7 +34,7 @@ export function postGridEntityCollisionFire(
     callbackEntityType,
     callbackEntityVariant,
   ] of subscriptions) {
-    // Handle the optional 2nd callback argument.
+    // Handle the optional 3rd callback argument.
     if (
       callbackGridEntityType !== undefined &&
       callbackGridEntityType !== gridEntityType
@@ -42,7 +42,7 @@ export function postGridEntityCollisionFire(
       continue;
     }
 
-    // Handle the optional 3rd callback argument.
+    // Handle the optional 4th callback argument.
     if (
       callbackGridEntityVariant !== undefined &&
       callbackGridEntityVariant !== gridEntityVariant
@@ -50,7 +50,7 @@ export function postGridEntityCollisionFire(
       continue;
     }
 
-    // Handle the optional 4th callback argument.
+    // Handle the optional 5th callback argument.
     if (
       callbackEntityType !== undefined &&
       callbackEntityType !== entity.Type
@@ -58,7 +58,7 @@ export function postGridEntityCollisionFire(
       continue;
     }
 
-    // Handle the optional 5th callback argument.
+    // Handle the optional 6th callback argument.
     if (
       callbackEntityVariant !== undefined &&
       callbackEntityVariant !== entity.Variant

package/src/callbacks/subscriptions/postGridEntityInit.ts

@@ -3,7 +3,7 @@ import { GridEntityType } from "isaac-typescript-definitions";
 export type PostGridEntityInitRegisterParameters = [
   callback: (gridEntity: GridEntity) => void,
   gridEntityType?: GridEntityType,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostGridEntityInitRegisterParameters[] = [];
@@ -20,12 +20,12 @@ export function postGridEntityInitRegister(
 
 export function postGridEntityInitFire(gridEntity: GridEntity): void {
   const gridEntityType = gridEntity.GetType();
-  const gridEntityVariant = gridEntity.GetVariant();
+  const variant = gridEntity.GetVariant();
 
   for (const [
     callback,
     callbackGridEntityType,
-    callbackGridEntityVariant,
+    callbackVariant,
   ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
@@ -36,10 +36,7 @@ export function postGridEntityInitFire(gridEntity: GridEntity): void {
     }
 
     // Handle the optional 3rd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks/subscriptions/postGridEntityRemove.ts

@@ -1,9 +1,13 @@
 import { GridEntityType } from "isaac-typescript-definitions";
 
 export type PostGridEntityRemoveRegisterParameters = [
-  callback: (gridIndex: int, gridEntityType: GridEntityType) => void,
+  callback: (
+    gridIndex: int,
+    gridEntityType: GridEntityType,
+    variant: int,
+  ) => void,
   gridEntityType?: GridEntityType,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostGridEntityRemoveRegisterParameters[] = [];
@@ -21,12 +25,12 @@ export function postGridEntityRemoveRegister(
 export function postGridEntityRemoveFire(
   gridIndex: int,
   gridEntityType: GridEntityType,
-  gridEntityVariant: int,
+  variant: int,
 ): void {
   for (const [
     callback,
     callbackGridEntityType,
-    callbackGridEntityVariant,
+    callbackVariant,
   ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
@@ -37,13 +41,10 @@ export function postGridEntityRemoveFire(
     }
 
     // Handle the optional 3rd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 
-    callback(gridIndex, gridEntityType);
+    callback(gridIndex, gridEntityType, variant);
   }
 }

package/src/callbacks/subscriptions/postGridEntityRender.ts

@@ -3,7 +3,7 @@ import { GridEntityType } from "isaac-typescript-definitions";
 export type PostGridEntityRenderRegisterParameters = [
   callback: (gridEntity: GridEntity) => void,
   gridEntityType?: GridEntityType,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostGridEntityRenderRegisterParameters[] = [];
@@ -20,12 +20,12 @@ export function postGridEntityRenderRegister(
 
 export function postGridEntityRenderFire(gridEntity: GridEntity): void {
   const gridEntityType = gridEntity.GetType();
-  const gridEntityVariant = gridEntity.GetVariant();
+  const variant = gridEntity.GetVariant();
 
   for (const [
     callback,
     callbackGridEntityType,
-    callbackGridEntityVariant,
+    callbackVariant,
   ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
@@ -36,10 +36,7 @@ export function postGridEntityRenderFire(gridEntity: GridEntity): void {
     }
 
     // Handle the optional 3rd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }
 

package/src/callbacks/subscriptions/postGridEntityStateChanged.ts

@@ -3,7 +3,7 @@ import { GridEntityType } from "isaac-typescript-definitions";
 export type PostGridEntityStateChangedRegisterParameters = [
   callback: (gridEntity: GridEntity, oldState: int, newState: int) => void,
   gridEntityType?: GridEntityType,
-  gridEntityVariant?: int,
+  variant?: int,
 ];
 
 const subscriptions: PostGridEntityStateChangedRegisterParameters[] = [];
@@ -24,12 +24,12 @@ export function postGridEntityStateChangedFire(
   newState: int,
 ): void {
   const gridEntityType = gridEntity.GetType();
-  const gridEntityVariant = gridEntity.GetVariant();
+  const variant = gridEntity.GetVariant();
 
   for (const [
     callback,
     callbackGridEntityType,
-    callbackGridEntityVariant,
+    callbackVariant,
   ] of subscriptions) {
     // Handle the optional 2nd callback argument.
     if (
@@ -40,10 +40,7 @@ export function postGridEntityStateChangedFire(
     }
 
     // Handle the optional 3rd callback argument.
-    if (
-      callbackGridEntityVariant !== undefined &&
-      callbackGridEntityVariant !== gridEntityVariant
-    ) {
+    if (callbackVariant !== undefined && callbackVariant !== variant) {
       continue;
     }