isaacscript-common 6.20.2 → 6.22.1

package/src/features/customStage/customStageGridEntities.ts

@@ -1,18 +1,26 @@
 import {
   CollectibleType,
   EntityType,
+  GridEntityType,
+  LevelStage,
   TrinketType,
 } from "isaac-typescript-definitions";
 import { DecorationVariant } from "../../enums/DecorationVariant";
 import { removeEntities } from "../../functions/entities";
 import { getNPCs } from "../../functions/entitiesSpecific";
+import { removeGridEntity } from "../../functions/gridEntities";
 import {
   getCoins,
   getCollectibles,
   getTrinkets,
 } from "../../functions/pickupsSpecific";
+import { calculateStageType } from "../../functions/stage";
 import { vectorEquals } from "../../functions/vector";
-import { CustomStage } from "../../interfaces/CustomStage";
+import { CustomStage } from "../../interfaces/private/CustomStage";
+import { TrapdoorDestination } from "../../types/TrapdoorDestination";
+import { spawnCustomTrapdoor } from "../customTrapdoor/exports";
+import { DEFAULT_BASE_STAGE } from "./exports";
+import v from "./v";
 
 /** For `GridEntityType.DECORATION` (1) */
 export function setCustomDecorationGraphics(
@@ -25,6 +33,11 @@ export function setCustomDecorationGraphics(
     return;
   }
 
+  const gridEntityType = gridEntity.GetType();
+  if (gridEntityType !== GridEntityType.DECORATION) {
+    return;
+  }
+
   // Ignore custom grid entities. (They are represented as decorations with a non-zero variant.)
   const variant = gridEntity.GetVariant();
   if (variant !== (DecorationVariant.VANILLA_DECORATION as int)) {
@@ -51,6 +64,11 @@ export function setCustomRockGraphics(
     return;
   }
 
+  const gridEntityRock = gridEntity.ToRock();
+  if (gridEntityRock === undefined) {
+    return;
+  }
+
   const sprite = gridEntity.GetSprite();
   const fileName = sprite.GetFilename();
   if (fileName === "gfx/grid/grid_rock.anm2") {
@@ -73,6 +91,11 @@ export function setCustomPitGraphics(
     return;
   }
 
+  const gridEntityPit = gridEntity.ToPit();
+  if (gridEntityPit === undefined) {
+    return;
+  }
+
   const sprite = gridEntity.GetSprite();
   const fileName = sprite.GetFilename();
   if (fileName === "gfx/grid/grid_pit.anm2") {
@@ -86,6 +109,17 @@ export function setCustomDoorGraphics(
   customStage: CustomStage,
   gridEntity: GridEntity,
 ): void {
+  // If the end-user did not specify custom pit graphics, default to Basement graphics. (We don't
+  // have to adjust anything for this case.)
+  if (customStage.doorPNGPaths === undefined) {
+    return;
+  }
+
+  const gridEntityDoor = gridEntity.ToDoor();
+  if (gridEntityDoor === undefined) {
+    return;
+  }
+
   const sprite = gridEntity.GetSprite();
   const fileName = sprite.GetFilename();
   const doorPNGPath = getNewDoorPNGPath(customStage, fileName);
@@ -148,6 +182,33 @@ function getNewDoorPNGPath(
   return undefined;
 }
 
+export function convertVanillaTrapdoors(
+  customStage: CustomStage,
+  gridEntity: GridEntity,
+): void {
+  const gridEntityType = gridEntity.GetType();
+  if (gridEntityType !== GridEntityType.TRAPDOOR) {
+    return;
+  }
+
+  removeGridEntity(gridEntity, true);
+
+  // - If we are on the first floor of a custom stage, then the destination will be the second floor
+  //   of the custom stage. (e.g. Caves 1 to Caves 2)
+  // - If we are on the second floor of a custom stage, then the destination will be the vanilla
+  //   floor equivalent to 2 floors after the floor used as a basis for the custom stage.
+  const baseStage =
+    customStage.baseStage === undefined
+      ? DEFAULT_BASE_STAGE
+      : customStage.baseStage;
+  const vanillaNextStage = (baseStage + 2) as LevelStage;
+  const vanillaNextStageType = calculateStageType(vanillaNextStage);
+  const destination: TrapdoorDestination = v.run.firstFloor
+    ? [customStage.name, 2]
+    : [vanillaNextStage, vanillaNextStageType];
+  spawnCustomTrapdoor(gridEntity.Position, destination);
+}
+
 /**
  * The rewards are based on the ones from the wiki:
  * https://bindingofisaacrebirth.fandom.com/wiki/Rocks#Urns

package/src/features/customStage/exports.ts

@@ -1,3 +1,12 @@
+// eslint-disable-next-line isaacscript/complete-sentences-jsdoc
+/**
+ * These are helper functions relating to creating custom stages with the built-in standard library.
+ * For more information about custom stages, see the [main
+ * documentation page](https://isaacscript.github.io/main/custom-stages).
+ *
+ * @module
+ */
+
 import {
   EntityType,
   LevelStage,
@@ -5,26 +14,28 @@ import {
   RoomType,
   StageType,
 } from "isaac-typescript-definitions";
-import { game } from "../../cachedClasses";
-import { reorderedCallbacksSetStage } from "../../callbacks/reorderedCallbacks";
+import { reorderedCallbacksSetStageInternal } from "../../callbacks/reorderedCallbacks";
+import { game } from "../../core/cachedClasses";
 import { getEntityIDFromConstituents } from "../../functions/entities";
-import { log, logError } from "../../functions/log";
+import { logError } from "../../functions/log";
 import { newRNG } from "../../functions/rng";
 import {
   getRoomDataForTypeVariant,
   getRoomsInGrid,
 } from "../../functions/rooms";
 import { setStage } from "../../functions/stage";
+import { CustomStage } from "../../interfaces/private/CustomStage";
 import { getRandomCustomStageRoom } from "./customStageUtils";
-import { topStreakTextStart } from "./streakText";
 import v, {
   customBossPNGPaths,
   customStageCachedRoomData,
   customStagesMap,
 } from "./v";
 
-const DEFAULT_BASE_STAGE = LevelStage.BASEMENT_2;
-const DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL;
+export const DEFAULT_BASE_STAGE = LevelStage.BASEMENT_2;
+export const DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL;
+
+export const INVALID_STAGE_VALUE = -1 as LevelStage;
 
 /**
  * Helper function to warp to a custom stage/level.
@@ -33,13 +44,15 @@ const DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL;
  * more details: https://isaacscript.github.io/main/custom-stages/
  *
  * @param name The name of the custom stage, corresponding to what is in the "tsconfig.json" file.
- * @param _firstFloor Whether to go to the first floor or the second floor. For example, if you have
- *                    a custom stage emulating Caves, then the first floor would be Caves 1, and the
- *                    second floor would be Caves 2.
+ * @param firstFloor Optional. Whether to go to the first floor or the second floor. For example, if
+ *                   you have a custom stage emulating Caves, then the first floor would be Caves 1,
+ *                   and the second floor would be Caves 2. Default is true.
+ * @param verbose Optional. Whether to log additional information about the rooms that are chosen.
+ *                Default is false.
  */
 export function setCustomStage(
   name: string,
-  _firstFloor = true,
+  firstFloor = true,
   verbose = false,
 ): void {
   const customStage = customStagesMap.get(name);
@@ -50,24 +63,64 @@ export function setCustomStage(
   }
 
   const level = game.GetLevel();
-  const startingRoomGridIndex = level.GetStartingRoomIndex();
+  const stage = level.GetStage();
   const seeds = game.GetSeeds();
   const startSeed = seeds.GetStartSeed();
   const rng = newRNG(startSeed);
 
   v.run.currentCustomStage = customStage;
+  v.run.firstFloor = firstFloor;
+
+  // Before changing the stage, we have to revert the bugged stage, if necessary. This prevents the
+  // bug where the backdrop will not spawn.
+  if (stage === INVALID_STAGE_VALUE) {
+    level.SetStage(LevelStage.BASEMENT_1, StageType.ORIGINAL);
+  }
 
-  const baseStage =
+  let baseStage: int =
     customStage.baseStage === undefined
       ? DEFAULT_BASE_STAGE
-      : (customStage.baseStage as LevelStage);
+      : customStage.baseStage;
+  if (!firstFloor) {
+    baseStage++;
+  }
+
   const baseStageType =
     customStage.baseStageType === undefined
       ? DEFAULT_BASE_STAGE_TYPE
       : (customStage.baseStageType as StageType);
-  setStage(baseStage, baseStageType);
 
-  // Now, we need to pick a custom room for each vanilla room.
+  const reseed = (stage as int) >= baseStage;
+
+  setStage(baseStage as LevelStage, baseStageType, reseed);
+
+  setStageRoomsData(customStage, rng, verbose);
+
+  // Set the stage to an invalid value, which will prevent the walls and floors from loading.
+  // Furthermore, we must use `StageType.WRATH_OF_THE_LAMB` instead of `StageType.ORIGINAL` or else
+  // the walls will not render properly. DeadInfinity suspects that this might be because it is
+  // trying to use the Dark Room's backdrop (instead of The Chest).
+  const targetStage = INVALID_STAGE_VALUE;
+  const targetStageType = StageType.WRATH_OF_THE_LAMB;
+  level.SetStage(targetStage, targetStageType);
+  reorderedCallbacksSetStageInternal(targetStage, targetStageType);
+
+  // We must reload the current room in order for the `Level.SetStage` method to take effect.
+  // Furthermore, we need to cancel the queued warp to the `GridRoom.DEBUG` room. We can accomplish
+  // both of these things by initiating a room transition to an arbitrary room. However, we rely on
+  // the parent function to do this, since for normal purposes, we need to initiate a room
+  // transition for the pixelation effect.
+}
+
+/** Pick a custom room for each vanilla room. */
+function setStageRoomsData(
+  customStage: CustomStage,
+  rng: RNG,
+  verbose: boolean,
+) {
+  const level = game.GetLevel();
+  const startingRoomGridIndex = level.GetStartingRoomIndex();
+
   for (const room of getRoomsInGrid()) {
     // The starting floor of each room should stay empty.
     if (room.SafeGridIndex === startingRoomGridIndex) {
@@ -85,7 +138,7 @@ export function setCustomStage(
       // special rooms.)
       if (roomType === RoomType.DEFAULT) {
         logError(
-          `Failed to find any custom rooms for RoomType.${RoomType[roomType]} (${roomType}) for custom stage: ${name}`,
+          `Failed to find any custom rooms for RoomType.${RoomType[roomType]} (${roomType}) for custom stage: ${customStage.name}`,
         );
       }
       continue;
@@ -95,7 +148,7 @@ export function setCustomStage(
     const roomDoorSlotFlagMap = roomShapeMap.get(roomShape);
     if (roomDoorSlotFlagMap === undefined) {
       logError(
-        `Failed to find any custom rooms for RoomType.${RoomType[roomType]} (${roomType}) + RoomShape.${RoomShape[roomShape]} (${roomShape}) for custom stage: ${name}`,
+        `Failed to find any custom rooms for RoomType.${RoomType[roomType]} (${roomType}) + RoomShape.${RoomShape[roomShape]} (${roomShape}) for custom stage: ${customStage.name}`,
       );
       continue;
     }
@@ -104,7 +157,7 @@ export function setCustomStage(
     const roomsMetadata = roomDoorSlotFlagMap.get(doorSlotFlags);
     if (roomsMetadata === undefined) {
       logError(
-        `Failed to find any custom rooms for RoomType.${RoomType[roomType]} (${roomType}) + RoomShape.${RoomShape[roomShape]} (${roomShape}) + DoorSlotFlags ${doorSlotFlags} for custom stage: ${name}`,
+        `Failed to find any custom rooms for RoomType.${RoomType[roomType]} (${roomType}) + RoomShape.${RoomShape[roomShape]} (${roomShape}) + DoorSlotFlags ${doorSlotFlags} for custom stage: ${customStage.name}`,
       );
       continue;
     }
@@ -121,7 +174,7 @@ export function setCustomStage(
       );
       if (newRoomData === undefined) {
         logError(
-          `Failed to get the room data for room variant ${randomRoom.variant} for custom stage: ${name}`,
+          `Failed to get the room data for room variant ${randomRoom.variant} for custom stage: ${customStage.name}`,
         );
         continue;
       }
@@ -131,31 +184,6 @@ export function setCustomStage(
 
     room.Data = newRoomData;
   }
-
-  // Set the stage to an invalid value, which will prevent the walls and floors from loading. We
-  // must use `StageType.WRATH_OF_THE_LAMB` instead of `StageType.ORIGINAL` or else the walls will
-  // not render properly. DeadInfinity suspects that this might be because it is trying to use the
-  // Dark Room's backdrop (instead of The Chest).
-  const stage = -1 as LevelStage;
-  const stageType = StageType.WRATH_OF_THE_LAMB;
-  level.SetStage(stage, stageType);
-  reorderedCallbacksSetStage(stage, stageType);
-
-  // We must reload the current room in order for the `Level.SetStage` method to take effect.
-  // Furthermore, we need to cancel the queued warp to the `GridRoom.DEBUG` room. We can accomplish
-  // both of these things by initiating a room transition to an arbitrary room. However, we rely on
-  // the parent function to do this, since for normal purposes, we need to initiate a room
-  // transition for the pixelation effect.
-}
-
-export function setCustomStageDebug(): void {
-  const customStage = v.run.currentCustomStage;
-  if (customStage === null) {
-    log("No custom stage is currently loaded.");
-    return;
-  }
-
-  topStreakTextStart();
 }
 
 /**
@@ -193,3 +221,11 @@ export function registerCustomBoss(
   const entityID = getEntityIDFromConstituents(entityType, variant, subType);
   customBossPNGPaths.set(entityID, [namePNGPath, portraitPNGPath]);
 }
+
+/**
+ * Helper function to disable the custom stage. This is typically called before taking the player to
+ * a vanilla floor.
+ */
+export function disableCustomStage(): void {
+  v.run.currentCustomStage = null;
+}

package/src/features/customStage/init.ts

@@ -10,14 +10,15 @@ import { ModUpgraded } from "../../classes/ModUpgraded";
 import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
 import { isArray } from "../../functions/array";
 import { hasFlag, removeFlag } from "../../functions/flag";
-import { CustomStage, RoomTypeMap } from "../../interfaces/CustomStage";
 import {
   CustomStageLua,
   CustomStageRoomMetadata,
 } from "../../interfaces/CustomStageLua";
+import { CustomStage, RoomTypeMap } from "../../interfaces/private/CustomStage";
 import { saveDataManager } from "../saveDataManager/exports";
 import { setBackdrop } from "./backdrop";
 import {
+  convertVanillaTrapdoors,
   removeUrnRewards,
   setCustomDecorationGraphics,
   setCustomDoorGraphics,
@@ -26,12 +27,7 @@ import {
 } from "./customStageGridEntities";
 import * as metadataJSON from "./metadata.json"; // This will correspond to "metadata.lua" at run-time.
 import { setShadows } from "./shadows";
-import {
-  streakTextGetShaderParams,
-  streakTextInit,
-  streakTextPostGameStarted,
-  streakTextPostRender,
-} from "./streakText";
+import { streakTextGetShaderParams, streakTextPostRender } from "./streakText";
 import v, { customStagesMap } from "./v";
 import {
   playVersusScreenAnimation,
@@ -47,12 +43,10 @@ export function customStageInit(mod: ModUpgraded): void {
   }
 
   saveDataManager("customStage", v);
-  streakTextInit();
   versusScreenInit();
 
   mod.AddCallback(ModCallback.POST_RENDER, postRender); // 2
   mod.AddCallback(ModCallback.POST_CURSE_EVAL, postCurseEval); // 12
-  mod.AddCallback(ModCallback.POST_GAME_STARTED, postGameStarted); // 15
   mod.AddCallback(ModCallback.GET_SHADER_PARAMS, getShaderParams); // 21
   mod.AddCallbackCustom(
     ModCallbackCustom.POST_GRID_ENTITY_BROKEN,
@@ -61,7 +55,7 @@ export function customStageInit(mod: ModUpgraded): void {
   );
   mod.AddCallbackCustom(
     ModCallbackCustom.POST_GRID_ENTITY_INIT,
-    postGridEntityBrokenInit,
+    postGridEntityInit,
   );
   mod.AddCallbackCustom(
     ModCallbackCustom.POST_NEW_ROOM_REORDERED,
@@ -150,19 +144,13 @@ function postCurseEval(
   }
 
   // Prevent XL floors on custom stages, since the streak text will not work properly.
-  if (hasFlag(curses, LevelCurse.MAZE)) {
-    return removeFlag(curses, LevelCurse.MAZE);
+  if (hasFlag(curses, LevelCurse.LABYRINTH)) {
+    return removeFlag(curses, LevelCurse.LABYRINTH);
   }
 
   return undefined;
 }
 
-// ModCallback.POST_GAME_STARTED (15)
-function postGameStarted() {
-  // We don't early return here because we need to unconditionally reset the sprites.
-  streakTextPostGameStarted();
-}
-
 // ModCallback.GET_SHADER_PARAMS (22)
 function getShaderParams(
   shaderName: string,
@@ -188,7 +176,7 @@ function postGridEntityBrokenRockAlt(gridEntity: GridEntity) {
 }
 
 // ModCallbackCustom.POST_GRID_ENTITY_INIT
-function postGridEntityBrokenInit(gridEntity: GridEntity) {
+function postGridEntityInit(gridEntity: GridEntity) {
   const customStage = v.run.currentCustomStage;
   if (customStage === null) {
     return;
@@ -198,6 +186,7 @@ function postGridEntityBrokenInit(gridEntity: GridEntity) {
   setCustomRockGraphics(customStage, gridEntity);
   setCustomPitGraphics(customStage, gridEntity);
   setCustomDoorGraphics(customStage, gridEntity);
+  convertVanillaTrapdoors(customStage, gridEntity);
 }
 
 // ModCallbackCustom.POST_NEW_ROOM_REORDERED

package/src/features/customStage/shadows.ts

@@ -1,8 +1,8 @@
 import { EffectVariant, RoomShape } from "isaac-typescript-definitions";
-import { game } from "../../cachedClasses";
+import { game } from "../../core/cachedClasses";
 import { getRandomArrayElement } from "../../functions/array";
 import { spawnEffectWithSeed } from "../../functions/entitiesSpecific";
-import { CustomStage } from "../../interfaces/CustomStage";
+import { CustomStage } from "../../interfaces/private/CustomStage";
 import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./customStageConstants";
 import v from "./v";
 
@@ -17,6 +17,7 @@ type ShadowAnimation = "1x1" | "1x2" | "2x1" | "2x2";
  * time passes, like most other effects.
  */
 const SHADOW_EFFECT_VARIANT = EffectVariant.LADDER;
+const SHADOW_EFFECT_SUBTYPE = 102;
 
 /** The animation comes from StageAPI. */
 const ROOM_SHAPE_TO_SHADOW_ANIMATION: {
@@ -57,7 +58,7 @@ export function setShadows(customStage: CustomStage): void {
   // rendering throughout this animation.)
   const shadowEffect = spawnEffectWithSeed(
     SHADOW_EFFECT_VARIANT,
-    0,
+    SHADOW_EFFECT_SUBTYPE,
     centerPos,
     1 as Seed,
   );