isaacscript-common 7.4.2 → 7.5.1

package/src/features/customStage/versusScreen.ts

@@ -9,7 +9,7 @@ import {
 import { game, sfxManager } from "../../core/cachedClasses";
 import { arrayRemove } from "../../functions/array";
 import { getBosses } from "../../functions/bosses";
-import { getEntityID } from "../../functions/entities";
+import { getRoomSubType } from "../../functions/roomData";
 import { erange } from "../../functions/utils";
 import { CustomStage } from "../../interfaces/private/CustomStage";
 import { BOSS_NAME_PNG_FILE_NAMES } from "../../objects/bossNamePNGFileNames";
@@ -26,7 +26,7 @@ import {
   DEFAULT_BASE_STAGE_TYPE,
   INVALID_STAGE_VALUE,
 } from "./exports";
-import v, { customBossPNGPaths } from "./v";
+import v from "./v";
 
 const DEFAULT_CHARACTER = PlayerType.ISAAC;
 const DEFAULT_STAGE_ID = StageID.BASEMENT;
@@ -137,22 +137,25 @@ export function playVersusScreenAnimation(customStage: CustomStage): void {
   pause();
   hud.SetVisible(false);
 
-  const [playerNamePNGPath, playerPortraitPNGPath] = getPlayerPNGPaths();
-  versusScreenSprite.ReplaceSpritesheet(
-    PLAYER_NAME_ANM2_LAYER,
-    playerNamePNGPath,
-  );
-  versusScreenSprite.ReplaceSpritesheet(
-    PLAYER_PORTRAIT_ANM2_LAYER,
-    playerPortraitPNGPath,
-  );
+  // Player
+  {
+    const { namePNGPath, portraitPNGPath } = getPlayerPNGPaths();
+    versusScreenSprite.ReplaceSpritesheet(PLAYER_NAME_ANM2_LAYER, namePNGPath);
+    versusScreenSprite.ReplaceSpritesheet(
+      PLAYER_PORTRAIT_ANM2_LAYER,
+      portraitPNGPath,
+    );
+  }
 
-  const [bossNamePNGPath, bossPortraitPNGPath] = getBossPNGPaths();
-  versusScreenSprite.ReplaceSpritesheet(BOSS_NAME_ANM2_LAYER, bossNamePNGPath);
-  versusScreenSprite.ReplaceSpritesheet(
-    BOSS_PORTRAIT_ANM2_LAYER,
-    bossPortraitPNGPath,
-  );
+  // Boss
+  {
+    const { namePNGPath, portraitPNGPath } = getBossPNGPaths(customStage);
+    versusScreenSprite.ReplaceSpritesheet(BOSS_NAME_ANM2_LAYER, namePNGPath);
+    versusScreenSprite.ReplaceSpritesheet(
+      BOSS_PORTRAIT_ANM2_LAYER,
+      portraitPNGPath,
+    );
+  }
 
   versusScreenSprite.LoadGraphics();
 
@@ -186,67 +189,81 @@ function willVanillaVersusScreenPlay() {
 }
 
 /** Use the character of the 0th player. */
-function getPlayerPNGPaths(): [
-  playerNamePNGPath: string,
-  playerPortraitPNGPath: string,
-] {
+function getPlayerPNGPaths(): {
+  namePNGPath: string;
+  portraitPNGPath: string;
+} {
   const player = Isaac.GetPlayer();
   const character = player.GetPlayerType();
 
-  let playerNamePNGFileName = PLAYER_NAME_PNG_FILE_NAMES[character];
-  if (playerNamePNGFileName === undefined) {
-    playerNamePNGFileName = PLAYER_NAME_PNG_FILE_NAMES[DEFAULT_CHARACTER];
+  let namePNGFileName = PLAYER_NAME_PNG_FILE_NAMES[character];
+  if (namePNGFileName === undefined) {
+    namePNGFileName = PLAYER_NAME_PNG_FILE_NAMES[DEFAULT_CHARACTER];
   }
 
-  const playerNamePNGPath = `${PNG_PATH_PREFIX}/${playerNamePNGFileName}`;
+  const namePNGPath = `${PNG_PATH_PREFIX}/${namePNGFileName}`;
 
-  let playerPortraitFileName = PLAYER_PORTRAIT_PNG_FILE_NAMES[character];
-  if (playerNamePNGFileName === undefined) {
-    playerPortraitFileName = PLAYER_PORTRAIT_PNG_FILE_NAMES[DEFAULT_CHARACTER];
+  let portraitFileName = PLAYER_PORTRAIT_PNG_FILE_NAMES[character];
+  if (namePNGFileName === undefined) {
+    portraitFileName = PLAYER_PORTRAIT_PNG_FILE_NAMES[DEFAULT_CHARACTER];
   }
 
-  const playerPortraitPNGPath = `${PLAYER_PORTRAIT_PNG_PATH_PREFIX}/${playerPortraitFileName}`;
+  const portraitPNGPath = `${PLAYER_PORTRAIT_PNG_PATH_PREFIX}/${portraitFileName}`;
 
-  return [playerNamePNGPath, playerPortraitPNGPath];
+  return { namePNGPath, portraitPNGPath };
 }
 
 /** Use the boss of the first boss found. */
-function getBossPNGPaths(): [
-  bossNamePNGPath: string,
-  bossPortraitPNGPath: string,
-] {
-  const bosses = getBosses();
-  const firstBoss = bosses[0];
-
+function getBossPNGPaths(customStage: CustomStage): {
+  namePNGPath: string;
+  portraitPNGPath: string;
+} {
   // Prefer the PNG paths specified by the end-user, if any.
-  if (firstBoss !== undefined) {
-    const entityID = getEntityID(firstBoss);
-    const pngPaths = customBossPNGPaths.get(entityID);
-    if (pngPaths !== undefined) {
-      return pngPaths;
-    }
+  const paths = getBossPNGPathsCustom(customStage);
+  if (paths !== undefined) {
+    return paths;
   }
 
   // If this is not a vanilla boss, default to showing question marks.
+  const bosses = getBosses();
+  const firstBoss = bosses[0];
   const bossID = firstBoss === undefined ? 0 : firstBoss.GetBossID();
   if (bossID === 0) {
     const questionMarkSprite = `${PNG_PATH_PREFIX}/${
       BOSS_NAME_PNG_FILE_NAMES[BossID.BLUE_BABY]
     }`;
-    const bossNamePNGPath = questionMarkSprite;
-    const bossPortraitPNGPath = questionMarkSprite;
-    return [bossNamePNGPath, bossPortraitPNGPath];
+    const namePNGPath = questionMarkSprite;
+    const portraitPNGPath = questionMarkSprite;
+    return { namePNGPath, portraitPNGPath };
   }
 
   // If this is a vanilla boss, it will have a boss ID, and we can use the corresponding vanilla
   // files.
-  const bossNamePNGFileName = BOSS_NAME_PNG_FILE_NAMES[bossID];
-  const bossNamePNGPath = `${PNG_PATH_PREFIX}/${bossNamePNGFileName}`;
+  const namePNGFileName = BOSS_NAME_PNG_FILE_NAMES[bossID];
+  const namePNGPath = `${PNG_PATH_PREFIX}/${namePNGFileName}`;
 
-  const bossPortraitPNGFileName = BOSS_PORTRAIT_PNG_FILE_NAMES[bossID];
-  const bossPortraitPNGPath = `${PNG_PATH_PREFIX}/${bossPortraitPNGFileName}`;
+  const portraitPNGFileName = BOSS_PORTRAIT_PNG_FILE_NAMES[bossID];
+  const portraitPNGPath = `${PNG_PATH_PREFIX}/${portraitPNGFileName}`;
 
-  return [bossNamePNGPath, bossPortraitPNGPath];
+  return { namePNGPath, portraitPNGPath };
+}
+
+function getBossPNGPathsCustom(
+  customStage: CustomStage,
+): { namePNGPath: string; portraitPNGPath: string } | undefined {
+  if (customStage.bossPool === undefined) {
+    return undefined;
+  }
+
+  const roomSubType = getRoomSubType();
+  const matchingBossEntry = customStage.bossPool.find(
+    (bossEntry) => bossEntry.subType === roomSubType,
+  );
+  if (matchingBossEntry === undefined) {
+    return undefined;
+  }
+
+  return matchingBossEntry.versusScreen;
 }
 
 function finishVersusScreenAnimation() {
@@ -267,10 +284,8 @@ export function versusScreenPostRender(): void {
     return;
   }
 
-  const isPaused = game.IsPaused();
-  if (isPaused) {
-    return;
-  }
+  // We do not want to early return when the game is paused because we need to start displaying the
+  // black screen as soon as the slide animation starts.
 
   if (versusScreenSprite.IsFinished(VERSUS_SCREEN_ANIMATION_NAME)) {
     finishVersusScreenAnimation();

package/src/functions/dev.ts

@@ -0,0 +1,31 @@
+import { ModUpgraded } from "../classes/ModUpgraded";
+import { enableExtraConsoleCommands } from "../features/extraConsoleCommands/exports";
+import { removeFadeIn } from "../features/fadeInRemover";
+import { enableFastReset } from "../features/fastReset";
+import { saveDataManagerSetGlobal } from "../features/saveDataManager/exports";
+import { setLogFunctionsGlobal } from "./log";
+
+/**
+ * Helper function to enable some IsaacScript features that are useful when developing a mod. They
+ * shouldn't be enabled when your mod goes to production (i.e. it is uploaded to the Steam
+ * Workshop).
+ *
+ * The list of development features that are enabled are as follows:
+ *
+ * - `saveDataManagerSetGlobal` - Sets your local variables registered with the save data manager as
+ *   global variables so you can access them from the in-game console.
+ * - `setLogFunctionsGlobal` - Sets the various log functions global so that you can access them
+ *   from the in-game console.
+ * - `enableExtraConsoleCommands` - Enables many extra in-game console commands that make warping
+ *   around easier (like e.g. `angel` to warp to the Angel Room).
+ * - `enableFastReset` - Makes it so that the r key resets the game instantaneously.
+ * - `removeFadeIn` - Removes the slow fade in that occurs at the beginning of the run, so that you
+ *   can immediately start playing or testing.
+ */
+export function enableDevFeatures(mod: ModUpgraded): void {
+  saveDataManagerSetGlobal();
+  setLogFunctionsGlobal();
+  enableExtraConsoleCommands(mod);
+  enableFastReset();
+  removeFadeIn();
+}

package/src/functions/doors.ts

@@ -21,6 +21,7 @@ import { ROOM_SHAPE_TO_DOOR_SLOTS } from "../objects/roomShapeToDoorSlots";
 import { arrayToBitFlags } from "./bitwise";
 import { directionToVector } from "./direction";
 import { getEnumValues } from "./enums";
+import { hasFlag } from "./flag";
 import { isTSTLSet } from "./tstlClass";
 import { asNumber } from "./types";
 
@@ -53,6 +54,21 @@ export function doorSlotFlagToDoorSlot(doorSlotFlag: DoorSlotFlag): DoorSlot {
   return doorSlot === undefined ? DEFAULT_DOOR_SLOT : doorSlot;
 }
 
+export function doorSlotFlagsToDoorSlots(
+  doorSlotFlags: BitFlags<DoorSlotFlag>,
+): DoorSlot[] {
+  const doorSlots: DoorSlot[] = [];
+
+  for (const doorSlotFlag of getEnumValues(DoorSlotFlag)) {
+    if (hasFlag(doorSlotFlags, doorSlotFlag)) {
+      const doorSlot = doorSlotFlagToDoorSlot(doorSlotFlag);
+      doorSlots.push(doorSlot);
+    }
+  }
+
+  return doorSlots;
+}
+
 export function doorSlotToDirection(doorSlot: DoorSlot): Direction {
   return DOOR_SLOT_TO_DIRECTION[doorSlot];
 }
@@ -61,6 +77,27 @@ export function doorSlotToDoorSlotFlag(doorSlot: DoorSlot): DoorSlotFlag {
   return DOOR_SLOT_TO_DOOR_SLOT_FLAG[doorSlot];
 }
 
+/**
+ * Helper function to convert an array of door slots or a set of door slots to the resulting bit
+ * flag number.
+ */
+export function doorSlotsToDoorSlotFlags(
+  doorSlots:
+    | DoorSlot[]
+    | readonly DoorSlot[]
+    | Set<DoorSlot>
+    | ReadonlySet<DoorSlot>,
+): BitFlags<DoorSlotFlag> {
+  const doorSlotArray = isTSTLSet(doorSlots)
+    ? [...doorSlots.values()]
+    : (doorSlots as DoorSlot[]);
+  const doorSlotFlagArray = doorSlotArray.map((doorSlot) =>
+    doorSlotToDoorSlotFlag(doorSlot),
+  );
+
+  return arrayToBitFlags(doorSlotFlagArray);
+}
+
 export function getAngelRoomDoor(): GridEntityDoor | undefined {
   const angelRoomDoors = getDoors(RoomType.ANGEL);
   return angelRoomDoors.length === 0 ? undefined : angelRoomDoors[0];
@@ -113,27 +150,6 @@ export function getDoorSlotEnterPositionOffset(
   return oppositeVector.mul(ROOM_ENTRY_OFFSET_FROM_DOOR);
 }
 
-/**
- * Helper function to convert an array of door slots or a set of door slots to the resulting bit
- * flag number.
- */
-export function getDoorSlotFlags(
-  doorSlots:
-    | DoorSlot[]
-    | readonly DoorSlot[]
-    | Set<DoorSlot>
-    | ReadonlySet<DoorSlot>,
-): BitFlags<DoorSlotFlag> {
-  const doorSlotArray = isTSTLSet(doorSlots)
-    ? [...doorSlots.values()]
-    : (doorSlots as DoorSlot[]);
-  const doorSlotFlagArray = doorSlotArray.map((doorSlot) =>
-    doorSlotToDoorSlotFlag(doorSlot),
-  );
-
-  return arrayToBitFlags(doorSlotFlagArray);
-}
-
 /** Helper function to get the possible door slots that can exist for a given room shape. */
 export function getDoorSlotsForRoomShape(
   roomShape: RoomShape,

package/src/functions/enums.ts

@@ -18,7 +18,7 @@ import { irange } from "./utils";
  * Also see the `getEnumKeys` and `getEnumValues` helper functions.
  *
  * For a more in depth explanation, see:
- * https://isaacscript.github.io/gotchas#iterating-over-enums
+ * https://isaacscript.github.io/main/gotchas#iterating-over-enums
  */
 export function getEnumEntries<T>(
   transpiledEnum: T,
@@ -57,7 +57,7 @@ export function getEnumEntries<T>(
  * Also see the `getEnumEntries` and `getEnumValues` helper functions.
  *
  * For a more in depth explanation, see:
- * https://isaacscript.github.io/gotchas#iterating-over-enums
+ * https://isaacscript.github.io/main/gotchas#iterating-over-enums
  */
 export function getEnumKeys<T>(transpiledEnum: T): string[] {
   const enumEntries = getEnumEntries(transpiledEnum);
@@ -84,7 +84,7 @@ export function getEnumLength<T>(transpiledEnum: T): int {
  * Also see the `getEnumEntries` and `getEnumKeys` helper functions.
  *
  * For a more in depth explanation, see:
- * https://isaacscript.github.io/gotchas#iterating-over-enums
+ * https://isaacscript.github.io/main/gotchas#iterating-over-enums
  */
 export function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]> {
   const enumEntries = getEnumEntries(transpiledEnum);

package/src/functions/gridEntities.ts

@@ -1,5 +1,6 @@
 import {
   CrawlSpaceVariant,
+  EffectVariant,
   GridCollisionClass,
   GridEntityType,
   GridEntityXMLType,
@@ -16,12 +17,14 @@ import {
   ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP,
 } from "../maps/roomShapeToTopLeftWallGridIndexMap";
 import { AnyGridEntity } from "../types/AnyGridEntity";
+import { removeEntities } from "./entities";
+import { getEffects } from "./entitiesSpecific";
 import { isCircleIntersectingRectangle } from "./math";
 import { roomUpdateSafe } from "./rooms";
 import { clearSprite } from "./sprites";
 import { asNumber, isNumber } from "./types";
 import { erange } from "./utils";
-import { isVector } from "./vector";
+import { isVector, vectorEquals } from "./vector";
 
 const BREAKABLE_GRID_ENTITY_TYPES_BY_EXPLOSIONS: ReadonlySet<GridEntityType> =
   new Set([
@@ -498,6 +501,9 @@ export function removeGridEntities<T extends AnyGridEntity>(
  * Helper function to remove a grid entity by providing the grid entity object or the grid index
  * inside of the room.
  *
+ * If removing a Devil Statue or an Angel Statue, this will also remove the associated effect
+ * (`EffectVariant.DEVIL` (6) or `EffectVariant.ANGEL` (9), respectively.)
+ *
  * @param gridEntityOrGridIndex The grid entity or grid index to remove.
  * @param updateRoom Whether or not to update the room after the grid entity is removed. This is
  *                   generally a good idea because if the room is not updated, you will be unable to
@@ -511,6 +517,18 @@ export function removeGridEntity(
 ): void {
   const room = game.GetRoom();
 
+  const gridEntity = isNumber(gridEntityOrGridIndex)
+    ? room.GetGridEntity(gridEntityOrGridIndex)
+    : gridEntityOrGridIndex;
+  if (gridEntity === undefined) {
+    // There is no grid entity to remove.
+    return;
+  }
+
+  const gridEntityType = gridEntity.GetType();
+  const variant = gridEntity.GetVariant();
+  const position = gridEntity.Position;
+
   const gridIndex = isNumber(gridEntityOrGridIndex)
     ? gridEntityOrGridIndex
     : gridEntityOrGridIndex.GetGridIndex();
@@ -519,6 +537,20 @@ export function removeGridEntity(
   if (updateRoom) {
     roomUpdateSafe();
   }
+
+  // In the special case of removing a Devil Statue or Angel Statue, we also need to delete the
+  // corresponding effect.
+  if (gridEntityType === GridEntityType.STATUE) {
+    const effectVariant =
+      variant === asNumber(StatueVariant.DEVIL)
+        ? EffectVariant.DEVIL
+        : EffectVariant.ANGEL;
+    const effects = getEffects(effectVariant);
+    const effectsOnTile = effects.filter((effect) =>
+      vectorEquals(effect.Position, position),
+    );
+    removeEntities(effectsOnTile);
+  }
 }
 
 /**

package/src/functions/playerStats.ts

@@ -21,5 +21,6 @@ export function getPlayerStat<T extends StatType>(
     [StatType.TEAR_COLOR]: player.TearColor, // 1 << 6
     [StatType.FLYING]: player.CanFly, // 1 << 7
     [StatType.LUCK]: player.Luck, // 1 << 10
+    [StatType.SIZE]: player.SpriteScale, // 1 << 11
   }[statType];
 }

package/src/functions/players.ts

@@ -21,7 +21,11 @@ import {
 import { getCollectibleMaxCharges } from "./collectibles";
 import { getCollectibleArray } from "./collectibleSet";
 import { getEnumValues } from "./enums";
-import { getPlayerIndexVanilla, getPlayers } from "./playerIndex";
+import {
+  getAllPlayers,
+  getPlayerIndexVanilla,
+  getPlayers,
+} from "./playerIndex";
 import { addTearsStat } from "./tears";
 import { isNumber } from "./types";
 import { repeat } from "./utils";
@@ -127,12 +131,12 @@ export function addTrinketCostume(
 export function anyPlayerHasCollectible(
   collectibleType: CollectibleType,
 ): boolean {
-  const players = getPlayers();
+  const players = getAllPlayers();
   return players.some((player) => player.HasCollectible(collectibleType));
 }
 
 export function anyPlayerHasTrinket(trinketType: TrinketType): boolean {
-  const players = getPlayers();
+  const players = getAllPlayers();
   return players.some((player) => player.HasTrinket(trinketType));
 }
 

package/src/functions/rooms.ts

@@ -4,6 +4,7 @@ import {
   BossID,
   Dimension,
   DoorSlot,
+  DownpourRoomSubType,
   DungeonSubType,
   GridRoom,
   HomeRoomSubType,
@@ -425,6 +426,23 @@ export function inMinibossRoomOf(minibossID: MinibossID): boolean {
   );
 }
 
+/**
+ * Helper function to check if the current room is a "mirror room" in Downpour or Dross. (These
+ * rooms are marked with a specific sub-type.)
+ */
+export function inMirrorRoom(): boolean {
+  const room = game.GetRoom();
+  const roomType = room.GetType();
+  const roomStageID = getRoomStageID();
+  const roomSubType = getRoomSubType();
+
+  return (
+    roomType === RoomType.DEFAULT &&
+    (roomStageID === StageID.DOWNPOUR || roomStageID === StageID.DROSS) &&
+    roomSubType === asNumber(DownpourRoomSubType.MIRROR)
+  );
+}
+
 /**
  * Helper function for checking if the room is a secret shop (from the Member Card collectible).
  *