isaacscript-common 6.11.2 → 6.12.0

package/src/functions/playerCenter.ts

@@ -6,7 +6,7 @@ import {
 } from "../constants";
 import { getPlayerFamiliars } from "./familiars";
 import { getCircleDiscretizedPoints } from "./math";
-import { getPlayers } from "./playerIndex";
+import { getAllPlayers } from "./playerIndex";
 
 const CIRCLE_RADIUS_BETWEEN_PLAYERS = 50;
 
@@ -25,7 +25,7 @@ export function movePlayersToCenter(): void {
     ? NEW_FLOOR_STARTING_POSITION_GREED_MODE
     : NEW_FLOOR_STARTING_POSITION_NORMAL_MODE;
 
-  const players = getPlayers();
+  const players = getAllPlayers();
   const firstPlayer = players[0];
   if (firstPlayer === undefined) {
     return;

package/src/functions/playerIndex.ts

@@ -72,9 +72,6 @@ export function getPlayerFromIndex(
  * Instead, we use the `EntityPlayer.GetCollectibleRNG` method with an arbitrary value of Sad Onion
  * (1). This works even if the player does not have any Sad Onions.
  *
- * Since the RNG value is the same for both Tainted Lazarus and Dead Tainted Lazarus, we revert to
- * using the RNG of The Inner Eye (2) for Dead Tainted Lazarus.
- *
  * Note that by default, this returns the same index for both The Forgotten and The Soul. (Even
  * though they are technically different characters, they share the same inventory and InitSeed.) If
  * this is not desired, pass true for the `differentiateForgottenAndSoul` argument, and the RNG of
@@ -94,13 +91,13 @@ export function getPlayerIndex(
   // We can safely ignore the player's character because regardless of whether the main player ends
   // up being The Forgotten or The Soul, the collectible RNG values will be the same. The
   // `EntityPlayer.IsSubPlayer` method can return true for Dead Tainted Lazarus during the
-  // PostPlayerInit callback, but since we fall back to the player in the case of
+  // `POST_PLAYER_INIT` callback, but since we fall back to the player in the case of
   // "getSubPlayerParent" returning undefined, we do not need to explicitly check for this case.
   let playerToUse = player;
   const isSubPlayer = player.IsSubPlayer();
   if (isSubPlayer) {
     // The "getSubPlayerParent" function will return undefined in the situation where we are on Dead
-    // Tainted Lazarus in the PostPlayerInit callback.
+    // Tainted Lazarus in the `POST_PLAYER_INIT` callback.
     const playerParent = getSubPlayerParent(player as EntitySubPlayer);
     if (playerParent !== undefined) {
       playerToUse = playerParent;
@@ -123,23 +120,13 @@ function getPlayerIndexCollectibleType(
 ) {
   const character = player.GetPlayerType();
 
-  switch (character) {
-    // 17
-    case PlayerType.THE_SOUL: {
-      return differentiateForgottenAndSoul
-        ? CollectibleType.SPOON_BENDER
-        : DEFAULT_COLLECTIBLE_TYPE;
-    }
-
-    // 38
-    case PlayerType.LAZARUS_2_B: {
-      return CollectibleType.INNER_EYE;
-    }
-
-    default: {
-      return DEFAULT_COLLECTIBLE_TYPE;
-    }
+  if (character === PlayerType.THE_SOUL) {
+    return differentiateForgottenAndSoul
+      ? CollectibleType.INNER_EYE
+      : DEFAULT_COLLECTIBLE_TYPE;
   }
+
+  return DEFAULT_COLLECTIBLE_TYPE;
 }
 
 /**

package/src/functions/roomData.ts

@@ -187,9 +187,10 @@ export function getRoomVariant(roomGridIndex?: int): int {
 }
 
 /**
- * Note that the room visited count will be inaccurate during the period before the PostNewRoom
+ * Note that the room visited count will be inaccurate during the period before the `POST_NEW_ROOM`
  * callback has fired (i.e. when entities are initializing and performing their first update). This
- * is because the variable is only incremented immediately before the PostNewRoom callback fires.
+ * is because the variable is only incremented immediately before the `POST_NEW_ROOM` callback
+ * fires.
  *
  * @param roomGridIndex Optional. Default is the current room index.
  */

package/src/functions/rooms.ts

@@ -566,9 +566,9 @@ export function roomGridIndexToXY(roomGridIndex: int): [x: int, y: int] {
 }
 
 /**
- * If the `Room.Update` method is called in a PostNewRoom callback, then some entities will slide
- * around (such as the player). Since those entity velocities are already at zero, setting them to
- * zero will have no effect. Thus, a generic solution is to record all of the entity
+ * If the `Room.Update` method is called in a `POST_NEW_ROOM` callback, then some entities will
+ * slide around (such as the player). Since those entity velocities are already at zero, setting
+ * them to zero will have no effect. Thus, a generic solution is to record all of the entity
  * positions/velocities before updating the room, and then restore those positions/velocities.
  */
 export function roomUpdateSafe(): void {
@@ -585,9 +585,9 @@ export function roomUpdateSafe(): void {
 }
 
 /**
- * Helper function to convert an uncleared room to a cleared room in the PostNewRoom callback. This
- * is useful because if enemies are removed in this callback, a room drop will be awarded and the
- * doors will start closed and then open.
+ * Helper function to convert an uncleared room to a cleared room in the `POST_NEW_ROOM` callback.
+ * This is useful because if enemies are removed in this callback, a room drop will be awarded and
+ * the doors will start closed and then open.
  */
 export function setRoomCleared(): void {
   const room = game.GetRoom();

package/src/functions/stage.ts

@@ -1,4 +1,9 @@
-import { LevelStage, RoomType, StageType } from "isaac-typescript-definitions";
+import {
+  GameStateFlag,
+  LevelStage,
+  RoomType,
+  StageType,
+} from "isaac-typescript-definitions";
 import { game } from "../cachedClasses";
 import { ROOM_TYPE_GOTO_PREFIXES } from "../objects/roomTypeGotoPrefixes";
 import { STAGE_TYPE_SUFFIXES } from "../objects/stageTypeSuffixes";
@@ -116,6 +121,10 @@ export function isRepentanceStage(stageType: StageType): boolean {
   );
 }
 
+export function onAscent(): boolean {
+  return game.GetStateFlag(GameStateFlag.BACKWARDS_PATH);
+}
+
 export function onCathedral(): boolean {
   const level = game.GetLevel();
   const stage = level.GetStage();

package/src/index.ts

@@ -47,10 +47,12 @@ export * from "./features/extraConsoleCommands/exports";
 export { removeFadeIn, restoreFadeIn } from "./features/fadeInRemover";
 export { disableFastReset, enableFastReset } from "./features/fastReset";
 export { forgottenSwitch } from "./features/forgottenSwitch";
+export { pause, unpause } from "./features/pause";
 export {
   removePersistentEntity,
   spawnPersistentEntity,
 } from "./features/persistentEntities";
+export * from "./features/pickupIndex";
 export { getPlayerInventory } from "./features/playerInventory";
 export {
   anyPlayerUsingPony,
@@ -62,6 +64,7 @@ export {
   getRoomClearGameFrame,
   getRoomClearRoomFrame,
 } from "./features/roomClearFrame";
+export * from "./features/roomHistory";
 export {
   runInNGameFrames,
   runInNRenderFrames,

package/src/initCustomCallbacks.ts

@@ -20,6 +20,8 @@ import { postFlipCallbacksInit } from "./callbacks/postFlip";
 import { postGreedModeWaveInit } from "./callbacks/postGreedModeWave";
 import { postGridEntityCallbacksInit } from "./callbacks/postGridEntity";
 import { postGridEntityCollisionInit } from "./callbacks/postGridEntityCollision";
+import { postGridEntityCustomRenderInit } from "./callbacks/postGridEntityCustomRender";
+import { postGridEntityCustomUpdateInit } from "./callbacks/postGridEntityCustomUpdate";
 import { postGridEntityRenderInit } from "./callbacks/postGridEntityRender";
 import { postHolyMantleRemovedInit } from "./callbacks/postHolyMantleRemoved";
 import { postItemDischargeInit } from "./callbacks/postItemDischarged";
@@ -89,6 +91,8 @@ export function initCustomCallbacks(mod: ModUpgraded): void {
   postGreedModeWaveInit(mod);
   postGridEntityCallbacksInit(mod);
   postGridEntityCollisionInit(mod);
+  postGridEntityCustomRenderInit(mod);
+  postGridEntityCustomUpdateInit(mod);
   postGridEntityRenderInit(mod);
   postHolyMantleRemovedInit(mod);
   postItemDischargeInit(mod);

package/src/initFeatures.ts

@@ -13,11 +13,13 @@ import { fastResetInit } from "./features/fastReset";
 import { forgottenSwitchInit } from "./features/forgottenSwitch";
 import { pauseInit } from "./features/pause";
 import { persistentEntitiesInit } from "./features/persistentEntities";
+import { pickupIndexInit } from "./features/pickupIndex";
 import { playerInventoryInit } from "./features/playerInventory";
 import { ponyDetectionInit } from "./features/ponyDetection";
 import { preventCollectibleRotationInit } from "./features/preventCollectibleRotation";
 import { registerHotkeyInit } from "./features/registerHotkey";
 import { roomClearFrameInit } from "./features/roomClearFrame";
+import { roomHistoryInit } from "./features/roomHistory";
 import { runInNFramesInit } from "./features/runInNFrames";
 import { runNextRoomInit } from "./features/runNextRoom";
 import { sirenHelpersInit } from "./features/sirenHelpers";
@@ -48,11 +50,13 @@ function initFeaturesMinor(mod: ModUpgraded) {
   collectibleItemPoolTypeInit(mod);
   pauseInit(mod);
   persistentEntitiesInit(mod);
+  pickupIndexInit(mod);
   playerInventoryInit(mod);
   ponyDetectionInit(mod);
   preventCollectibleRotationInit(mod);
   registerHotkeyInit(mod);
   roomClearFrameInit(mod);
+  roomHistoryInit(mod);
   runNextRoomInit(mod);
   sirenHelpersInit(mod);
   stageHistoryInit(mod);

package/src/interfaces/AddCallbackParameterCustom.ts

@@ -23,6 +23,8 @@ import { PostGameStartedReorderedRegisterParameters } from "../callbacks/subscri
 import { PostGreedModeWaveRegisterParameters } from "../callbacks/subscriptions/postGreedModeWave";
 import { PostGridEntityBrokenRegisterParameters } from "../callbacks/subscriptions/postGridEntityBroken";
 import { PostGridEntityCollisionRegisterParameters } from "../callbacks/subscriptions/postGridEntityCollision";
+import { PostGridEntityCustomRenderRegisterParameters } from "../callbacks/subscriptions/postGridEntityCustomRender";
+import { PostGridEntityCustomUpdateRegisterParameters } from "../callbacks/subscriptions/postGridEntityCustomUpdate";
 import { PostGridEntityInitRegisterParameters } from "../callbacks/subscriptions/postGridEntityInit";
 import { PostGridEntityRemoveRegisterParameters } from "../callbacks/subscriptions/postGridEntityRemove";
 import { PostGridEntityRenderRegisterParameters } from "../callbacks/subscriptions/postGridEntityRender";
@@ -109,6 +111,8 @@ export interface AddCallbackParameterCustom {
   [ModCallbackCustom.POST_GREED_MODE_WAVE]: PostGreedModeWaveRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_BROKEN]: PostGridEntityBrokenRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_COLLISION]: PostGridEntityCollisionRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_RENDER]: PostGridEntityCustomRenderRegisterParameters;
+  [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_UPDATE]: PostGridEntityCustomUpdateRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_INIT]: PostGridEntityInitRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_REMOVE]: PostGridEntityRemoveRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_RENDER]: PostGridEntityRenderRegisterParameters;

package/src/interfaces/RoomDescription.ts

@@ -0,0 +1,19 @@
+import {
+  LevelStage,
+  RoomType,
+  StageID,
+  StageType,
+} from "isaac-typescript-definitions";
+
+/** Used by the room history feature. */
+export interface RoomDescription {
+  stage: LevelStage;
+  stageType: StageType;
+  stageID: StageID;
+  roomType: RoomType;
+  roomVariant: int;
+  roomSubType: int;
+  roomName: string;
+  roomGridIndex: int;
+  roomListIndex: int;
+}

package/src/objects/callbackRegisterFunctions.ts

@@ -23,6 +23,8 @@ import { postGameStartedReorderedRegister } from "../callbacks/subscriptions/pos
 import { postGreedModeWaveRegister } from "../callbacks/subscriptions/postGreedModeWave";
 import { postGridEntityBrokenRegister } from "../callbacks/subscriptions/postGridEntityBroken";
 import { postGridEntityCollisionRegister } from "../callbacks/subscriptions/postGridEntityCollision";
+import { postGridEntityCustomRenderRegister } from "../callbacks/subscriptions/postGridEntityCustomRender";
+import { postGridEntityCustomUpdateRegister } from "../callbacks/subscriptions/postGridEntityCustomUpdate";
 import { postGridEntityInitRegister } from "../callbacks/subscriptions/postGridEntityInit";
 import { postGridEntityRemoveRegister } from "../callbacks/subscriptions/postGridEntityRemove";
 import { postGridEntityRenderRegister } from "../callbacks/subscriptions/postGridEntityRender";
@@ -118,6 +120,10 @@ export const CALLBACK_REGISTER_FUNCTIONS: {
   [ModCallbackCustom.POST_GRID_ENTITY_BROKEN]: postGridEntityBrokenRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_COLLISION]:
     postGridEntityCollisionRegister,
+  [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_RENDER]:
+    postGridEntityCustomRenderRegister,
+  [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_UPDATE]:
+    postGridEntityCustomUpdateRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_INIT]: postGridEntityInitRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_REMOVE]: postGridEntityRemoveRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_RENDER]: postGridEntityRenderRegister,

package/src/types/CollectibleIndex.ts

@@ -1,5 +1,5 @@
 /**
- * CollectibleIndex is a specific type of string; see the documentation for the
+ * `CollectibleIndex` is a specific type of string; see the documentation for the
  * `getCollectibleIndex` function. Mods can signify that data structures handle collectibles by
  * using this type.
  *

package/src/types/PickupIndex.ts

@@ -0,0 +1,15 @@
+/**
+ * `PickupIndex` is a specific type of string; see the documentation for the `getPickupIndex`
+ * function. Mods can signify that data structures handle collectibles by using this type.
+ *
+ * For example:
+ *
+ * ```ts
+ * const pickupNameMap = new Map<PickupIndex, string>();
+ * ```
+ *
+ * This type is branded for extra type safety.
+ */
+export type PickupIndex = int & {
+  readonly __pickupIndexBrand: symbol;
+};

package/src/types/PlayerIndex.ts

@@ -1,5 +1,5 @@
 /**
- * PlayerIndex is a specific type of number that represents a unique identifier for a player. Mods
+ * `PlayerIndex` is a specific type of number that represents a unique identifier for a player. Mods
  * can signify that data structures handle `EntityPlayer` by using this type. For more information,
  * see the documentation for the `getPlayerIndex` function.
  *

package/src/upgradeMod.ts

@@ -39,7 +39,8 @@ export function upgradeMod(modVanilla: Mod): ModUpgraded {
     patchErrorFunction();
     loadShaderCrashFix(modVanilla);
 
-    // We initialize the PostNewRoomEarly callback first since it is used by the save data manager.
+    // We initialize the `POST_NEW_ROOM_EARLY` callback first since it is used by the save data
+    // manager.
     postNewRoomEarlyCallbackInit(mod);
 
     // We initialized the save data manager second since it is used by the other custom callbacks