isaacscript-common 6.19.0 → 6.20.2

package/src/features/customStage/exports.ts

@@ -1,6 +1,5 @@
 import {
   EntityType,
-  GridRoom,
   LevelStage,
   RoomShape,
   RoomType,
@@ -11,9 +10,11 @@ import { reorderedCallbacksSetStage } from "../../callbacks/reorderedCallbacks";
 import { getEntityIDFromConstituents } from "../../functions/entities";
 import { log, logError } from "../../functions/log";
 import { newRNG } from "../../functions/rng";
-import { getRoomData } from "../../functions/roomData";
-import { getRooms } from "../../functions/rooms";
-import { getGotoCommand, setStage } from "../../functions/stage";
+import {
+  getRoomDataForTypeVariant,
+  getRoomsInGrid,
+} from "../../functions/rooms";
+import { setStage } from "../../functions/stage";
 import { getRandomCustomStageRoom } from "./customStageUtils";
 import { topStreakTextStart } from "./streakText";
 import v, {
@@ -30,12 +31,21 @@ const DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL;
  *
  * Custom stages/levels must first be defined in the "tsconfig.json" file. See the documentation for
  * 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.
  */
-export function setCustomStage(name: string, verbose = false): void {
+export function setCustomStage(
+  name: string,
+  _firstFloor = true,
+  verbose = false,
+): void {
   const customStage = customStagesMap.get(name);
   if (customStage === undefined) {
     error(
-      `Failed to set the custom stage of "${name}" because it was not found in the custom stages map. (Try restarting IsaacScript / recompiling the mod, and try again. If that does not work, you probably forgot to define it in your "tsconfig.json" file.) See the website for more details on how to set up custom stages.`,
+      `Failed to set the custom stage of "${name}" because it was not found in the custom stages map. (Try restarting IsaacScript / recompiling the mod / restarting the game, and try again. If that does not work, you probably forgot to define it in your "tsconfig.json" file.) See the website for more details on how to set up custom stages.`,
     );
   }
 
@@ -58,7 +68,7 @@ export function setCustomStage(name: string, verbose = false): void {
   setStage(baseStage, baseStageType);
 
   // Now, we need to pick a custom room for each vanilla room.
-  for (const room of getRooms()) {
+  for (const room of getRoomsInGrid()) {
     // The starting floor of each room should stay empty.
     if (room.SafeGridIndex === startingRoomGridIndex) {
       continue;
@@ -103,18 +113,19 @@ export function setCustomStage(name: string, verbose = false): void {
 
     let newRoomData = customStageCachedRoomData.get(randomRoom.variant);
     if (newRoomData === undefined) {
-      // We need the room data for this room. We can leverage the "goto" console command to load it
-      // into the "debug" slot. This is convenient because we do not actually have to travel to the
-      // room.
-      const command = getGotoCommand(roomType, randomRoom.variant);
-      Isaac.ExecuteCommand(command);
-      newRoomData = getRoomData(GridRoom.DEBUG);
+      // We do not already have the room data for this room cached.
+      newRoomData = getRoomDataForTypeVariant(
+        roomType,
+        randomRoom.variant,
+        false,
+      );
       if (newRoomData === undefined) {
         logError(
           `Failed to get the room data for room variant ${randomRoom.variant} for custom stage: ${name}`,
         );
         continue;
       }
+
       customStageCachedRoomData.set(randomRoom.variant, newRoomData);
     }
 
@@ -134,7 +145,7 @@ export function setCustomStage(name: string, verbose = false): void {
   // 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 pixelation purposes.
+  // transition for the pixelation effect.
 }
 
 export function setCustomStageDebug(): void {

package/src/features/customTrapdoor/blackSprite.ts

@@ -16,6 +16,7 @@ export function drawBlackSprite(): void {
   if (!blackSprite.IsLoaded()) {
     blackSprite.Load("gfx/ui/boss/versusscreen.anm2", true);
     blackSprite.SetFrame("Scene", 0);
+    blackSprite.Scale = Vector(100, 100);
   }
 
   blackSprite.RenderLayer(0, VectorZero);

package/src/features/customTrapdoor/init.ts

@@ -10,6 +10,7 @@ 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 { setStage } from "../../functions/stage";
 import { isString } from "../../functions/types";
 import { setCustomStage } from "../customStage/exports";
@@ -65,8 +66,10 @@ function checkAllPlayersJumpComplete() {
   v.run.stateRenderFrame = renderFrameCount;
 
   // In order to display the pixelation effect that should happen when we go to a new floor, we need
-  // to start a room transition. We arbitrarily pick the current room for this purpose.
-  game.StartRoomTransition(
+  // to start a room transition. We arbitrarily pick the current room for this purpose. (We do not
+  // have to worry about Curse of the Maze here, because even if we are taken to a different room,
+  // it will not matter, since we will be traveling to a new floor after the screen fades to black.)
+  teleport(
     roomGridIndex,
     Direction.NO_DIRECTION,
     RoomTransitionAnim.PIXELATION,
@@ -99,10 +102,11 @@ function checkPixelationToBlackComplete() {
 
   // 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.
-  game.StartRoomTransition(
+  teleport(
     roomGridIndex,
     Direction.NO_DIRECTION,
     RoomTransitionAnim.PIXELATION,
+    true,
   );
 }
 

package/src/features/extraConsoleCommands/commandsSubroutines.ts

@@ -9,10 +9,11 @@ import { game } from "../../cachedClasses";
 import { HealthType } from "../../enums/HealthType";
 import { directionToVector } from "../../functions/direction";
 import { spawnGridEntityWithVariant } from "../../functions/gridEntities";
+import { getRoomGridIndexesForType } from "../../functions/levelGrid";
 import { logAllEntities, logAllGridEntities } from "../../functions/log";
 import { addPlayerHealthType } from "../../functions/playerHealth";
 import { getRoomData, getRoomDescriptor } from "../../functions/roomData";
-import { changeRoom, getRoomGridIndexesForType } from "../../functions/rooms";
+import { changeRoom } from "../../functions/rooms";
 import { printConsole } from "../../functions/utils";
 import {
   DEFAULT_ROOM_TYPE_NAME,

package/src/features/extraConsoleCommands/listCommands.ts

@@ -63,6 +63,7 @@ import { getNPCs } from "../../functions/entitiesSpecific";
 import { getEnumValues } from "../../functions/enums";
 import { addFlag } from "../../functions/flag";
 import { spawnGridEntity } from "../../functions/gridEntities";
+import { getRoomGridIndexesForType } from "../../functions/levelGrid";
 import {
   logPlayerEffects,
   logRoom,
@@ -85,7 +86,7 @@ import {
   useActiveItemTemp,
 } from "../../functions/players";
 import { gridCoordinatesToWorldPosition } from "../../functions/roomGrid";
-import { changeRoom, getRoomGridIndexesForType } from "../../functions/rooms";
+import { changeRoom } from "../../functions/rooms";
 import { onSetSeed, restart, setUnseeded } from "../../functions/run";
 import { getGoldenTrinketType } from "../../functions/trinkets";
 import { irange, printConsole, printEnabled } from "../../functions/utils";

package/src/functions/curses.ts

@@ -0,0 +1,9 @@
+import { LevelCurse } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { hasFlag } from "./flag";
+
+export function hasCurse(curse: LevelCurse): boolean {
+  const level = game.GetLevel();
+  const curses = level.GetCurses();
+  return hasFlag(curses, curse);
+}

package/src/functions/dimensions.ts

@@ -0,0 +1,41 @@
+import { Dimension } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { NUM_DIMENSIONS } from "../constants";
+import { getRoomGridIndex } from "./roomData";
+import { erange } from "./utils";
+
+/**
+ * Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
+ */
+export function getAllDimensions(): Dimension[] {
+  return erange(NUM_DIMENSIONS) as Dimension[];
+}
+
+/**
+ * Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,
+ * but it can change if e.g. the player is in the mirror world of Downpour/Dross.
+ */
+export function getDimension(): Dimension {
+  const level = game.GetLevel();
+  const roomGridIndex = getRoomGridIndex();
+  const roomDescription = level.GetRoomByIdx(roomGridIndex, Dimension.CURRENT);
+  const currentRoomHash = GetPtrHash(roomDescription);
+
+  for (const dimension of getAllDimensions()) {
+    const dimensionRoomDescription = level.GetRoomByIdx(
+      roomGridIndex,
+      dimension,
+    );
+    const dimensionRoomHash = GetPtrHash(dimensionRoomDescription);
+
+    if (dimensionRoomHash === currentRoomHash) {
+      return dimension;
+    }
+  }
+
+  error("Failed to get the current dimension.");
+}
+
+export function inDimension(dimension: Dimension): boolean {
+  return dimension === getDimension();
+}

package/src/functions/level.ts

@@ -1,21 +1,18 @@
 import { DoorSlot } from "isaac-typescript-definitions";
 import { game } from "../cachedClasses";
 import { getEnumValues } from "./enums";
-import {
-  getNumRooms,
-  getRooms,
-  isDoorSlotValidAtGridIndexForRedRoom,
-} from "./rooms";
+import { isDoorSlotValidAtGridIndexForRedRoom } from "./levelGrid";
+import { getNumRooms, getRoomsInGrid } from "./rooms";
 
 export function fillLevelWithRedRooms(): void {
   const level = game.GetLevel();
 
-  let numRooms: int;
+  let numRoomsInGrid: int;
   do {
-    const rooms = getRooms();
-    numRooms = rooms.length;
+    const roomsInGrid = getRoomsInGrid();
+    numRoomsInGrid = roomsInGrid.length;
 
-    for (const roomDescriptor of rooms) {
+    for (const roomDescriptor of roomsInGrid) {
       for (const doorSlot of getEnumValues(DoorSlot)) {
         if (
           isDoorSlotValidAtGridIndexForRedRoom(
@@ -27,5 +24,5 @@ export function fillLevelWithRedRooms(): void {
         }
       }
     }
-  } while (numRooms !== getNumRooms());
+  } while (numRoomsInGrid !== getNumRooms());
 }