isaacscript-common 6.20.2 → 6.22.1

package/src/features/customStage/streakText.ts

@@ -1,21 +1,18 @@
 import { ButtonAction, ControllerIndex } from "isaac-typescript-definitions";
-import { fonts, game } from "../../cachedClasses";
-import { KColorDefault, VectorOne } from "../../constants";
+import { fonts, game } from "../../core/cachedClasses";
+import { KColorDefault, VectorOne } from "../../core/constants";
 import { getEnumValues } from "../../functions/enums";
 import {
   getScreenBottomCenterPos,
   getScreenTopCenterPos,
 } from "../../functions/ui";
-import { CustomStage } from "../../interfaces/CustomStage";
+import { CustomStage } from "../../interfaces/private/CustomStage";
+import {
+  UIStreakAnimation,
+  UI_STREAK_ANIMATION_END_FRAMES,
+} from "./customStageConstants";
 import v from "./v";
 
-enum UIStreakAnimation {
-  TEXT = "Text",
-  TEXT_IN = "TextIn",
-  TEXT_OUT = "TextOut",
-  TEXT_STAY = "TextStay",
-}
-
 /** This must match the name of the shader in "shaders.xml". */
 const EMPTY_SHADER_NAME = "IsaacScript-RenderAboveHUD";
 
@@ -29,7 +26,7 @@ const TEXT_STAY_FRAME = 8;
 const TEXT_OUT_FRAME = 60;
 
 /** This matches the offset that the vanilla game uses; determined via trial and error. */
-const STREAK_SPRITE_TOP_OFFSET = Vector(0, 48.25);
+const STREAK_SPRITE_TOP_OFFSET = Vector(0, 47);
 
 /** This matches the offset that the vanilla game uses; determined via trial and error. */
 const STREAK_SPRITE_BOTTOM_OFFSET = Vector(0, -48.25);
@@ -47,9 +44,6 @@ const STREAK_TEXT_BOTTOM_Y_OFFSET = -9;
  */
 const NUM_RENDER_FRAMES_MAP_HELD_BEFORE_STREAK_TEXT = 11;
 
-/** Corresponds to the vanilla value; determined through trial and error. */
-const TEXT_PLAYBACK_SPEED = 0.5;
-
 /** Taken from StageAPI. */
 const TEXT_IN_ADJUSTMENTS = [-800, -639, -450, -250, -70, 10, 6, 3];
 
@@ -82,33 +76,6 @@ const TEXT_OUT_SCALES = [
   Vector(3, 0.2),
 ];
 
-/**
- * We do not actually need to render this sprite at all. It's only purpose is to be an invisible
- * reference for when and where we need to render the stage's name. Thus, we specify "false" for
- * "loadGraphics", but still manage playing its animations in the code below.
- */
-const topStreakSprite = Sprite();
-
-/**
- * We do not actually need to render this sprite at all. It's only purpose is to be an invisible
- * reference for when and where we need to render the stage's name. Thus, we specify "false" for
- * "loadGraphics", but still manage playing its animations in the code below.
- */
-const bottomStreakSprite = Sprite();
-
-/**
- * We must load the sprites in an init function to prevent issues with mods that replace the vanilla
- * files. (For some reason, loading the sprites will cause the overwrite to no longer apply on the
- * second and subsequent runs.)
- */
-export function streakTextInit(): void {
-  topStreakSprite.Load("resources/gfx/ui/ui_streak.anm2", false);
-  topStreakSprite.PlaybackSpeed = TEXT_PLAYBACK_SPEED;
-
-  bottomStreakSprite.Load("resources/gfx/ui/ui_streak.anm2", false);
-  bottomStreakSprite.PlaybackSpeed = TEXT_PLAYBACK_SPEED;
-}
-
 // ModCallback.POST_RENDER (2)
 export function streakTextPostRender(): void {
   // The top streak only plays when the player arrives on the floor (or continues a game from the
@@ -124,7 +91,7 @@ export function streakTextPostRender(): void {
 function checkEndTopStreakText() {
   if (
     v.run.topStreakTextStartedRenderFrame === null ||
-    !topStreakSprite.IsPlaying(UIStreakAnimation.TEXT_STAY)
+    v.run.topStreakText.animation !== UIStreakAnimation.TEXT_STAY
   ) {
     return;
   }
@@ -133,7 +100,10 @@ function checkEndTopStreakText() {
   const elapsedFrames =
     renderFrameCount - v.run.topStreakTextStartedRenderFrame;
   if (elapsedFrames >= 115) {
-    playTextOut(topStreakSprite);
+    v.run.topStreakText.animation = UIStreakAnimation.TEXT;
+    // We adjust by the frame backwards by an arbitrary amount to roughly align with the speed of
+    // the vanilla animation.
+    v.run.topStreakText.frame = TEXT_OUT_FRAME - 2;
   }
 }
 
@@ -165,7 +135,7 @@ function trackMapInputPressed() {
  * slides in from the left.
  */
 function checkStartBottomStreakText() {
-  if (bottomStreakSprite.IsPlaying()) {
+  if (v.run.bottomStreakText.animation !== UIStreakAnimation.NONE) {
     return;
   }
 
@@ -180,7 +150,8 @@ function checkStartBottomStreakText() {
   const gameFrameCount = game.GetFrameCount();
   const elapsedFrames = gameFrameCount - earliestFrame;
   if (elapsedFrames >= NUM_RENDER_FRAMES_MAP_HELD_BEFORE_STREAK_TEXT) {
-    bottomStreakSprite.Play(UIStreakAnimation.TEXT, true);
+    v.run.bottomStreakText.animation = UIStreakAnimation.TEXT;
+    v.run.bottomStreakText.frame = 0;
   }
 }
 
@@ -189,7 +160,7 @@ function checkStartBottomStreakText() {
  * right.
  */
 function checkEndBottomStreakText() {
-  if (!bottomStreakSprite.IsPlaying(UIStreakAnimation.TEXT_STAY)) {
+  if (v.run.bottomStreakText.animation !== UIStreakAnimation.TEXT_STAY) {
     return;
   }
 
@@ -197,16 +168,13 @@ function checkEndBottomStreakText() {
     ...v.run.controllerIndexPushingMapRenderFrame.values(),
   ];
   if (pushedMapFrames.length === 0) {
-    playTextOut(bottomStreakSprite);
+    v.run.bottomStreakText.animation = UIStreakAnimation.TEXT;
+    // We adjust by the frame backwards by an arbitrary amount to roughly align with the speed of
+    // the vanilla animation.
+    v.run.bottomStreakText.frame = TEXT_OUT_FRAME - 2;
   }
 }
 
-// ModCallback.POST_GAME_STARTED (15)
-export function streakTextPostGameStarted(): void {
-  topStreakSprite.Stop();
-  bottomStreakSprite.Stop();
-}
-
 // ModCallback.GET_SHADER_PARAMS (22)
 export function streakTextGetShaderParams(
   customStage: CustomStage,
@@ -218,27 +186,44 @@ export function streakTextGetShaderParams(
 
   const topCenterPos = getScreenTopCenterPos();
   const topStreakPosition = topCenterPos.add(STREAK_SPRITE_TOP_OFFSET);
-  renderSprite(customStage, topStreakSprite, topStreakPosition);
+  renderStreakText(customStage, v.run.topStreakText, topStreakPosition);
 
   const bottomCenterPos = getScreenBottomCenterPos();
   const bottomStreakPosition = bottomCenterPos.add(STREAK_SPRITE_BOTTOM_OFFSET);
-  renderSprite(customStage, bottomStreakSprite, bottomStreakPosition);
+  renderStreakText(customStage, v.run.bottomStreakText, bottomStreakPosition);
 }
 
-function renderSprite(
+function renderStreakText(
   customStage: CustomStage,
-  sprite: Sprite,
+  streakText: { animation: UIStreakAnimation; frame: int; pauseFrame: boolean },
   position: Vector,
 ) {
-  sprite.Update();
-  if (!sprite.IsPlaying()) {
+  if (streakText.animation === UIStreakAnimation.NONE) {
+    return;
+  }
+
+  if (streakText.animation !== UIStreakAnimation.TEXT_STAY) {
+    const { pauseFrame } = streakText;
+    streakText.pauseFrame = !streakText.pauseFrame;
+
+    if (!pauseFrame) {
+      streakText.frame++;
+    }
+  }
+
+  const endFrame = UI_STREAK_ANIMATION_END_FRAMES[streakText.animation];
+  if (streakText.frame > endFrame) {
+    streakText.animation = UIStreakAnimation.NONE;
+    streakText.frame = 0;
     return;
   }
 
-  const animation = sprite.GetAnimation() as UIStreakAnimation;
-  const frame = sprite.GetFrame();
-  if (animation === UIStreakAnimation.TEXT && frame === TEXT_STAY_FRAME) {
-    sprite.Play(UIStreakAnimation.TEXT_STAY, true);
+  if (
+    streakText.animation === UIStreakAnimation.TEXT &&
+    streakText.frame === TEXT_STAY_FRAME
+  ) {
+    streakText.animation = UIStreakAnimation.TEXT_STAY;
+    streakText.frame = 0;
   }
 
   const isPaused = game.IsPaused();
@@ -248,39 +233,22 @@ function renderSprite(
 
   const font = fonts.upheaval;
   const { name } = customStage;
-  const length = font.GetStringWidthUTF8(name);
+  const numberSuffix = v.run.firstFloor ? "I" : "II";
+  const nameWithNumberSuffix = `${name} ${numberSuffix}`;
+  const length = font.GetStringWidthUTF8(nameWithNumberSuffix);
   const centeredX = position.X - length / 2;
 
   let adjustment = 0;
   let scale = VectorOne;
-  switch (animation) {
-    case UIStreakAnimation.TEXT: {
-      if (frame < TEXT_STAY_FRAME) {
-        adjustment = TEXT_IN_ADJUSTMENTS[frame] ?? 0;
-        scale = TEXT_IN_SCALES[frame] ?? VectorOne;
-      } else {
-        const adjustedFrame = frame - TEXT_OUT_FRAME;
-        adjustment = TEXT_OUT_ADJUSTMENTS[adjustedFrame] ?? 0;
-        scale = TEXT_OUT_SCALES[adjustedFrame] ?? VectorOne;
-      }
 
-      break;
-    }
-
-    case UIStreakAnimation.TEXT_IN: {
-      adjustment = TEXT_IN_ADJUSTMENTS[frame] ?? 0;
-      scale = TEXT_IN_SCALES[frame] ?? VectorOne;
-      break;
-    }
-
-    case UIStreakAnimation.TEXT_OUT: {
-      adjustment = TEXT_OUT_ADJUSTMENTS[frame] ?? 0;
-      scale = TEXT_OUT_SCALES[frame] ?? VectorOne;
-      break;
-    }
-
-    default: {
-      break;
+  if (streakText.animation === UIStreakAnimation.TEXT) {
+    if (streakText.frame < TEXT_STAY_FRAME) {
+      adjustment = TEXT_IN_ADJUSTMENTS[streakText.frame] ?? 0;
+      scale = TEXT_IN_SCALES[streakText.frame] ?? VectorOne;
+    } else {
+      const adjustedFrame = streakText.frame - TEXT_OUT_FRAME;
+      adjustment = TEXT_OUT_ADJUSTMENTS[adjustedFrame] ?? 0;
+      scale = TEXT_OUT_SCALES[adjustedFrame] ?? VectorOne;
     }
   }
 
@@ -288,7 +256,7 @@ function renderSprite(
   const adjustedY = position.Y + STREAK_TEXT_BOTTOM_Y_OFFSET;
 
   font.DrawStringScaled(
-    name,
+    nameWithNumberSuffix,
     adjustedX,
     adjustedY,
     scale.X,
@@ -297,12 +265,6 @@ function renderSprite(
   );
 }
 
-function playTextOut(sprite: Sprite) {
-  sprite.Play(UIStreakAnimation.TEXT, true);
-  // We adjust by 2 to roughly align with the speed of the vanilla animation.
-  sprite.SetFrame(TEXT_OUT_FRAME - 2);
-}
-
 export function topStreakTextStart(): void {
   const level = game.GetLevel();
   const renderFrameCount = Isaac.GetFrameCount();
@@ -311,6 +273,7 @@ export function topStreakTextStart(): void {
   level.ShowName(false);
 
   // Initiate the animation for the custom text.
+  v.run.topStreakText.animation = UIStreakAnimation.TEXT;
+  v.run.topStreakText.frame = 0;
   v.run.topStreakTextStartedRenderFrame = renderFrameCount;
-  topStreakSprite.Play(UIStreakAnimation.TEXT, true);
 }

package/src/features/customStage/v.ts

@@ -1,15 +1,32 @@
 import { ControllerIndex } from "isaac-typescript-definitions";
-import { CustomStage } from "../../interfaces/CustomStage";
+import { CustomStage } from "../../interfaces/private/CustomStage";
+import { UIStreakAnimation } from "./customStageConstants";
 
 const v = {
   run: {
     currentCustomStage: null as CustomStage | null,
+
+    /** Whether we are on e.g. Caves 1 or Caves 2. */
+    firstFloor: true,
+
     showingBossVersusScreen: false,
 
     /** Values are the render frame that the controller first pressed the map button. */
     controllerIndexPushingMapRenderFrame: new Map<ControllerIndex, int>(),
 
     topStreakTextStartedRenderFrame: null as int | null,
+
+    topStreakText: {
+      animation: UIStreakAnimation.NONE,
+      frame: 0,
+      pauseFrame: false,
+    },
+
+    bottomStreakText: {
+      animation: UIStreakAnimation.NONE,
+      frame: 0,
+      pauseFrame: false,
+    },
   },
 
   room: {

package/src/features/customStage/versusScreen.ts

@@ -4,13 +4,14 @@ import {
   RoomType,
   SoundEffect,
   StageID,
+  StageType,
 } from "isaac-typescript-definitions";
-import { game, sfxManager } from "../../cachedClasses";
+import { game, sfxManager } from "../../core/cachedClasses";
 import { arrayRemove } from "../../functions/array";
 import { getBosses } from "../../functions/bosses";
 import { getEntityID } from "../../functions/entities";
 import { erange } from "../../functions/utils";
-import { CustomStage } from "../../interfaces/CustomStage";
+import { CustomStage } from "../../interfaces/private/CustomStage";
 import { BOSS_NAME_PNG_FILE_NAMES } from "../../objects/bossNamePNGFileNames";
 import { BOSS_PORTRAIT_PNG_FILE_NAMES } from "../../objects/bossPortraitPNGFileNames";
 import { PLAYER_NAME_PNG_FILE_NAMES } from "../../objects/playerNamePNGFileNames";
@@ -18,7 +19,13 @@ import { PLAYER_PORTRAIT_PNG_FILE_NAMES } from "../../objects/playerPortraitPNGF
 import { VERSUS_SCREEN_BACKGROUND_COLORS } from "../../objects/versusScreenBackgroundColors";
 import { VERSUS_SCREEN_DIRT_SPOT_COLORS } from "../../objects/versusScreenDirtSpotColors";
 import { pause, unpause } from "../pause";
+import { runNextGameFrame } from "../runInNFrames";
 import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./customStageConstants";
+import {
+  DEFAULT_BASE_STAGE,
+  DEFAULT_BASE_STAGE_TYPE,
+  INVALID_STAGE_VALUE,
+} from "./exports";
 import v, { customBossPNGPaths } from "./v";
 
 const DEFAULT_CHARACTER = PlayerType.ISAAC;
@@ -102,12 +109,29 @@ export function versusScreenInit(): void {
 export function playVersusScreenAnimation(customStage: CustomStage): void {
   const room = game.GetRoom();
   const roomType = room.GetType();
+  const roomCleared = room.IsClear();
   const hud = game.GetHUD();
 
   if (roomType !== RoomType.BOSS) {
     return;
   }
 
+  if (roomCleared) {
+    return;
+  }
+
+  if (willVanillaVersusScreenPlay()) {
+    // Since we are on an invalid stage, the versus screen will have a completely black background.
+    // Revert to using the background from the default stage.
+    const level = game.GetLevel();
+    level.SetStage(DEFAULT_BASE_STAGE, DEFAULT_BASE_STAGE_TYPE);
+    runNextGameFrame(() => {
+      const futureLevel = game.GetLevel();
+      futureLevel.SetStage(INVALID_STAGE_VALUE, StageType.ORIGINAL);
+    });
+    return;
+  }
+
   v.run.showingBossVersusScreen = true;
 
   pause();
@@ -156,6 +180,11 @@ export function playVersusScreenAnimation(customStage: CustomStage): void {
   }
 }
 
+function willVanillaVersusScreenPlay() {
+  const bosses = getBosses();
+  return bosses.some((boss) => boss.GetBossID() !== 0);
+}
+
 /** Use the character of the 0th player. */
 function getPlayerPNGPaths(): [
   playerNamePNGPath: string,

package/src/features/customTrapdoor/blackSprite.ts

@@ -1,4 +1,4 @@
-import { VectorZero } from "../../constants";
+import { VectorZero } from "../../core/constants";
 import { StageTravelState } from "../../enums/private/StageTravelState";
 import v from "./v";
 
@@ -9,7 +9,11 @@ import v from "./v";
 const blackSprite = Sprite();
 
 export function drawBlackSprite(): void {
-  if (v.run.state !== StageTravelState.PAUSING_ON_BLACK) {
+  if (
+    v.run.state !== StageTravelState.WAITING_FOR_FIRST_PIXELATION_TO_END &&
+    v.run.state !==
+      StageTravelState.WAITING_FOR_SECOND_PIXELATION_TO_GET_HALF_WAY
+  ) {
     return;
   }
 

package/src/features/customTrapdoor/customTrapdoorConstants.ts

@@ -3,6 +3,10 @@ import { GridEntityType } from "isaac-typescript-definitions";
 export const CUSTOM_TRAPDOOR_FEATURE_NAME = "customTrapdoor";
 
 export const GridEntityTypeCustom = {
+  /**
+   * We arbitrarily choose 1000 as to not conflict with end-user mods. (The expectation is that
+   * end-user mods will begin their enums with values of 1 and increment upwards.)
+   */
   TRAPDOOR_CUSTOM: 1000 as GridEntityType,
 } as const;
 

package/src/features/customTrapdoor/exports.ts

@@ -3,13 +3,14 @@ import {
   LevelStage,
   StageType,
 } from "isaac-typescript-definitions";
-import { game } from "../../cachedClasses";
+import { game } from "../../core/cachedClasses";
 import { TrapdoorAnimation } from "../../enums/private/TrapdoorAnimation";
 import { errorIfFeaturesNotInitialized } from "../../featuresInitialized";
 import { getNextStage, getNextStageType } from "../../functions/nextStage";
 import { getRoomListIndex } from "../../functions/roomData";
 import { isVector } from "../../functions/vector";
 import { CustomTrapdoorDescription } from "../../interfaces/private/CustomTrapdoorDescription";
+import { TrapdoorDestination } from "../../types/TrapdoorDestination";
 import { spawnCustomGridEntity } from "../customGridEntity";
 import {
   CUSTOM_TRAPDOOR_FEATURE_NAME,
@@ -25,7 +26,6 @@ import v from "./v";
  * - custom destination (or custom logic for after the player enters)
  * - custom graphics
  * - custom logic for opening/closing
- * - TODO: player jumping animation?
  *
  * You can use this function to take the player to your custom stage.
  *
@@ -34,10 +34,12 @@ import v from "./v";
  *
  * @param gridIndexOrPosition The location in the room to spawn the trapdoor.
  * @param destination Optional. Used to specify where the player will go after jumping into the
- *                    trapdoor. Can either be a tuple containing the stage and stage type, or a
- *                    string containing the name of a custom stage. If not specified at all, then
- *                    the "normal" destination corresponding to the current stage and room will be
- *                    used (e.g. the next floor).
+ *                    trapdoor. Can either be a vanilla stage tuple, a custom stage tuple, or
+ *                    undefined. For example, a destination of `[LevelStage.CAVES_1,
+ *                    StageType.ORIGINAL]` corresponds to Caves 1, and a destination of
+ *                    `["Slaughterhouse", 1]` corresponds to a custom stage of Slaughterhouse 1. If
+ *                    the destination is undefined, then the "normal" destination corresponding to
+ *                    the current stage and room will be used (e.g. the next floor, in most cases).
  * @param anm2Path Optional. The path to the anm2 file to use. By default, the vanilla trapdoor anm2
  *                 of "gfx/grid/door_11_trapdoor.anm2" will be used. The specified anm2 file must
  *                 have animations called "Opened", "Closed", and "Open Animation".
@@ -46,7 +48,7 @@ import v from "./v";
  */
 export function spawnCustomTrapdoor(
   gridIndexOrPosition: int | Vector,
-  destination?: [stage: LevelStage, stageType: StageType] | string,
+  destination?: TrapdoorDestination,
   anm2Path = "gfx/grid/door_11_trapdoor.anm2",
   spawnOpen?: boolean,
 ): GridEntity {

package/src/features/customTrapdoor/init.ts

@@ -1,19 +1,22 @@
 import {
   Direction,
+  EntityCollisionClass,
+  EntityGridCollisionClass,
   ModCallback,
   RoomTransitionAnim,
+  StageType,
 } from "isaac-typescript-definitions";
-import { game } from "../../cachedClasses";
 import { ModUpgraded } from "../../classes/ModUpgraded";
+import { game } from "../../core/cachedClasses";
 import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
 import { StageTravelState } from "../../enums/private/StageTravelState";
 import { movePlayersToCenter } from "../../functions/playerCenter";
 import { getAllPlayers } from "../../functions/playerIndex";
 import { getRoomGridIndex, getRoomListIndex } from "../../functions/roomData";
-import { teleport } from "../../functions/rooms";
+import { teleport } from "../../functions/roomTransition";
 import { setStage } from "../../functions/stage";
 import { isString } from "../../functions/types";
-import { setCustomStage } from "../customStage/exports";
+import { disableCustomStage, setCustomStage } from "../customStage/exports";
 import { topStreakTextStart } from "../customStage/streakText";
 import { enableAllInputs } from "../disableInputs";
 import { runNextGameFrame } from "../runInNFrames";
@@ -45,7 +48,7 @@ export function customTrapdoorInit(mod: ModUpgraded): void {
 function postRender() {
   checkAllPlayersJumpComplete();
   checkPixelationToBlackComplete();
-  checkPausingOnBlackComplete();
+  checkSecondPixelationHalfWay();
   checkAllPlayersLayingDownComplete();
   drawBlackSprite();
 }
@@ -74,6 +77,8 @@ function checkAllPlayersJumpComplete() {
     Direction.NO_DIRECTION,
     RoomTransitionAnim.PIXELATION,
   );
+
+  // Next, we wait a certain amount of render frames for the pixelation to fade the screen to black.
 }
 
 function checkPixelationToBlackComplete() {
@@ -86,7 +91,6 @@ function checkPixelationToBlackComplete() {
 
   const hud = game.GetHUD();
   const renderFrameCount = Isaac.GetFrameCount();
-  const roomGridIndex = getRoomGridIndex();
 
   const renderFrameScreenBlack =
     v.run.stateRenderFrame + PIXELATION_TO_BLACK_FRAMES;
@@ -94,25 +98,44 @@ function checkPixelationToBlackComplete() {
     return;
   }
 
-  v.run.state = StageTravelState.PAUSING_ON_BLACK;
-  v.run.stateRenderFrame = renderFrameCount;
+  v.run.state = StageTravelState.WAITING_FOR_FIRST_PIXELATION_TO_END;
 
+  // Now, we display a black sprite on top of the pixelation effect, to prevent showing the rest of
+  // the animation.
   hud.SetVisible(false);
-  goToCustomDestination();
 
-  // Start another pixelation effect. This time, we will keep the screen black with the sprite, and
-  // then remove the black sprite once the pixelation effect is halfway complete.
-  teleport(
-    roomGridIndex,
-    Direction.NO_DIRECTION,
-    RoomTransitionAnim.PIXELATION,
-    true,
-  );
+  // If the pixelation effect is not fully allowed to complete, the game's internal buffer will not
+  // be flushed. The consequence of this is that after 11 custom stage transitions, the "log.txt"
+  // starts to become become spammed with: [ASSERT] - PushRenderTarget: stack overflow!
+
+  // In order to work around this, we fully let the animation complete by only continuing the stage
+  // transition on the next game frame.
+  runNextGameFrame(() => {
+    const level = game.GetLevel();
+    const startingRoomIndex = level.GetStartingRoomIndex();
+    const futureRenderFrameCount = Isaac.GetFrameCount();
+
+    v.run.state =
+      StageTravelState.WAITING_FOR_SECOND_PIXELATION_TO_GET_HALF_WAY;
+    v.run.stateRenderFrame = futureRenderFrameCount;
+
+    goToCustomDestination();
+
+    // Start another pixelation effect. This time, we will keep the screen black with the sprite,
+    // and then remove the black sprite once the pixelation effect is halfway complete.
+    teleport(
+      startingRoomIndex,
+      Direction.NO_DIRECTION,
+      RoomTransitionAnim.PIXELATION,
+      true,
+    );
+  });
 }
 
-function checkPausingOnBlackComplete() {
+function checkSecondPixelationHalfWay() {
   if (
-    v.run.state !== StageTravelState.PAUSING_ON_BLACK ||
+    v.run.state !==
+      StageTravelState.WAITING_FOR_SECOND_PIXELATION_TO_GET_HALF_WAY ||
     v.run.stateRenderFrame === null
   ) {
     return;
@@ -132,14 +155,18 @@ function checkPausingOnBlackComplete() {
   hud.SetVisible(true);
 
   runNextRoom(() => {
+    v.run.state = StageTravelState.PLAYERS_LAYING_DOWN;
+
     // After the room transition, the players will be placed next to a door, but they should be in
     // the center of the room to emulate what happens on a vanilla stage.
     movePlayersToCenter();
 
-    v.run.state = StageTravelState.PLAYERS_LAYING_DOWN;
-
     for (const player of getAllPlayers()) {
       player.AnimateAppear();
+
+      // We need to restore the original collision classes.
+      player.EntityCollisionClass = EntityCollisionClass.ALL;
+      player.GridCollisionClass = EntityGridCollisionClass.GROUND;
     }
   });
 
@@ -171,11 +198,16 @@ function goToCustomDestination() {
     return;
   }
 
-  if (isString(v.run.destination)) {
-    setCustomStage("Slaughterhouse");
+  const [arg1, arg2] = v.run.destination;
+
+  if (isString(arg1)) {
+    // A string represents a custom stage.
+    const firstFloor = arg2 === 1;
+    setCustomStage("Slaughterhouse", firstFloor);
   } else {
-    const [stage, stageType] = v.run.destination;
-    setStage(stage, stageType);
+    // A number represents a vanilla `LevelStage`.
+    disableCustomStage();
+    setStage(arg1, arg2 as StageType);
   }
 }
 

package/src/features/customTrapdoor/openClose.ts

@@ -1,5 +1,5 @@
 import { RoomType } from "isaac-typescript-definitions";
-import { game } from "../../cachedClasses";
+import { game } from "../../core/cachedClasses";
 import { TrapdoorAnimation } from "../../enums/private/TrapdoorAnimation";
 import { anyPlayerCloserThan } from "../../functions/positionVelocity";
 import { CustomTrapdoorDescription } from "../../interfaces/private/CustomTrapdoorDescription";

package/src/features/customTrapdoor/touched.ts

@@ -5,7 +5,7 @@ import {
   EntityPartition,
   PlayerType,
 } from "isaac-typescript-definitions";
-import { VectorZero } from "../../constants";
+import { VectorZero } from "../../core/constants";
 import { StageTravelState } from "../../enums/private/StageTravelState";
 import { easeOutSine } from "../../functions/easing";
 import {
@@ -81,6 +81,9 @@ function playerTouchedCustomTrapdoor(
   v.run.state = StageTravelState.PLAYERS_JUMPING_DOWN;
   v.run.destination = trapdoorDescription.destination;
 
+  // We don't want to allow pausing, since that will allow render frames to pass without advancing
+  // the stage traveling logic. (We track how many render frames have passed to know when to move to
+  // the next step.)
   const whitelist = new Set([ButtonAction.CONSOLE]);
   disableAllInputsExceptFor(CUSTOM_TRAPDOOR_FEATURE_NAME, whitelist);
   setPlayerAttributes(player, gridEntity.Position);
@@ -115,7 +118,7 @@ function setPlayerAttributes(trapdoorPlayer: EntityPlayer, position: Vector) {
     player.EntityCollisionClass = EntityCollisionClass.NONE;
     player.GridCollisionClass = EntityGridCollisionClass.NONE;
 
-    player.SubType = -1;
+    player.StopExtraAnimation();
   }
 }