isaacscript-common 7.6.0 → 7.7.0

package/dist/functions/levelGrid.lua

@@ -1,10 +1,10 @@
 local ____lualib = require("lualib_bundle")
-local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
-local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
+local Set = ____lualib.Set
 local ____exports = {}
 local ADJACENT_ROOM_GRID_INDEX_DELTAS
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
@@ -45,7 +45,20 @@ local ____roomShape = require("functions.roomShape")
 local getGridIndexDelta = ____roomShape.getGridIndexDelta
 local ____types = require("functions.types")
 local asNumber = ____types.asNumber
---- Helper function to get the room grid indexes that are adjacent to a given room grid index.
+--- Helper function to get only the adjacent room grid indexes that do not exist (i.e. do not have
+-- room data).
+-- 
+-- This is just a filtering of the results of the `getAdjacentExistingRoomGridIndexes` function. See
+-- that function for more information.
+function ____exports.getAdjacentNonExistingRoomGridIndexes(self, roomGridIndex)
+    local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
+    return __TS__ArrayFilter(
+        adjacentRoomGridIndexes,
+        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) == nil end
+    )
+end
+--- Helper function to get all of the room grid indexes that are adjacent to a given room grid index
+-- (even if those room grid indexes do not have any rooms in them).
 -- 
 -- Adjacent room grid indexes that are outside of the grid will not be included in the returned
 -- array.
@@ -85,25 +98,22 @@ function ____exports.getNewRoomCandidatesBesideRoom(self, roomGridIndex)
     if roomData == nil then
         return {}
     end
-    local doorSlotToRoomGridIndexes = ____exports.getRoomShapeNeighborGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
+    local doorSlotToRoomGridIndexes = ____exports.getRoomShapeAdjacentNonExistingGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
     local roomCandidates = {}
     for ____, ____value in __TS__Iterator(doorSlotToRoomGridIndexes:entries()) do
         local doorSlot = ____value[1]
-        local neighborRoomGridIndex = ____value[2]
+        local adjacentRoomGridIndex = ____value[2]
         do
             local doorSlotFlag = doorSlotToDoorSlotFlag(nil, doorSlot)
             if not hasFlag(nil, roomData.Doors, doorSlotFlag) then
-                goto __continue13
-            end
-            if ____exports.roomExists(nil, neighborRoomGridIndex) then
-                goto __continue13
+                goto __continue17
             end
-            if not ____exports.isDeadEnd(nil, neighborRoomGridIndex) then
-                goto __continue13
+            if not ____exports.isDeadEnd(nil, adjacentRoomGridIndex) then
+                goto __continue17
             end
-            roomCandidates[#roomCandidates + 1] = {doorSlot, neighborRoomGridIndex}
+            roomCandidates[#roomCandidates + 1] = {doorSlot, adjacentRoomGridIndex}
         end
-        ::__continue13::
+        ::__continue17::
     end
     return roomCandidates
 end
@@ -128,13 +138,30 @@ function ____exports.getNewRoomCandidatesForLevel(self)
     end
     return newRoomCandidates
 end
+--- Helper function to get only the adjacent room grid indexes for a room shape that exist (i.e. have
+-- room data).
+-- 
+-- This is just a filtering of the results of the `getRoomShapeAdjacentGridIndexes` function. See
+-- that function for more information.
+function ____exports.getRoomShapeAdjacentExistingGridIndexes(self, safeRoomGridIndex, roomShape)
+    local roomShapeAdjacentGridIndexes = ____exports.getRoomShapeAdjacentGridIndexes(nil, safeRoomGridIndex, roomShape)
+    for ____, ____value in __TS__Iterator(roomShapeAdjacentGridIndexes:entries()) do
+        local doorSlot = ____value[1]
+        local roomGridIndex = ____value[2]
+        local roomData = getRoomData(nil, roomGridIndex)
+        if roomData == nil then
+            roomShapeAdjacentGridIndexes:delete(doorSlot)
+        end
+    end
+    return roomShapeAdjacentGridIndexes
+end
 --- Helper function to get the room grid index delta that each hypothetical door in a given room
 -- shape would go to.
 -- 
--- This is used by the `getRoomShapeNeighborGridIndexes` function.
+-- This is used by the `getRoomShapeAdjacentGridIndexes` function.
 -- 
 -- @returns A map of `DoorSlot` to the corresponding room grid index delta.
-function ____exports.getRoomShapeNeighborGridIndexDeltas(self, roomShape)
+function ____exports.getRoomShapeAdjacentGridIndexDeltas(self, roomShape)
     return ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
 end
 --- Helper function to get the room grid index that each hypothetical door in a given room shape
@@ -144,18 +171,35 @@ end
 -- for the respective room).
 -- @param roomShape The shape of the room.
 -- @returns A map of `DoorSlot` to the corresponding room grid index.
-function ____exports.getRoomShapeNeighborGridIndexes(self, safeRoomGridIndex, roomShape)
-    local roomShapeNeighborGridIndexDeltas = ____exports.getRoomShapeNeighborGridIndexDeltas(nil, roomShape)
-    local neighborGridIndexes = __TS__New(Map)
-    for ____, ____value in __TS__Iterator(roomShapeNeighborGridIndexDeltas:entries()) do
+function ____exports.getRoomShapeAdjacentGridIndexes(self, safeRoomGridIndex, roomShape)
+    local roomShapeAdjacentGridIndexDeltas = ____exports.getRoomShapeAdjacentGridIndexDeltas(nil, roomShape)
+    local adjacentGridIndexes = __TS__New(Map)
+    for ____, ____value in __TS__Iterator(roomShapeAdjacentGridIndexDeltas:entries()) do
         local doorSlot = ____value[1]
         local delta = ____value[2]
         local roomGridIndex = safeRoomGridIndex + delta
         if ____exports.isRoomInsideGrid(nil, roomGridIndex) then
-            neighborGridIndexes:set(doorSlot, roomGridIndex)
+            adjacentGridIndexes:set(doorSlot, roomGridIndex)
         end
     end
-    return neighborGridIndexes
+    return adjacentGridIndexes
+end
+--- Helper function to get only the adjacent room grid indexes for a room shape that do not exist
+-- (i.e. do not have room data).
+-- 
+-- This is just a filtering of the results of the `getRoomShapeAdjacentGridIndexes` function. See
+-- that function for more information.
+function ____exports.getRoomShapeAdjacentNonExistingGridIndexes(self, safeRoomGridIndex, roomShape)
+    local roomShapeAdjacentGridIndexes = ____exports.getRoomShapeAdjacentGridIndexes(nil, safeRoomGridIndex, roomShape)
+    for ____, ____value in __TS__Iterator(roomShapeAdjacentGridIndexes:entries()) do
+        local doorSlot = ____value[1]
+        local roomGridIndex = ____value[2]
+        local roomData = getRoomData(nil, roomGridIndex)
+        if roomData ~= nil then
+            roomShapeAdjacentGridIndexes:delete(doorSlot)
+        end
+    end
+    return roomShapeAdjacentGridIndexes
 end
 --- Helper function to check if the given room grid index is a dead end. Specifically, this is
 -- defined as having only one adjacent room that exists.
@@ -168,16 +212,8 @@ end
 -- 
 -- @param roomGridIndex Optional. Default is the current room index.
 function ____exports.isDeadEnd(self, roomGridIndex)
-    local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
-    local adjacentRoomData = __TS__ArrayMap(
-        adjacentRoomGridIndexes,
-        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) end
-    )
-    local existingRoomData = __TS__ArrayFilter(
-        adjacentRoomData,
-        function(____, data) return data ~= nil end
-    )
-    return #existingRoomData == 1
+    local adjacentNonExistingRoomGridIndexes = ____exports.getAdjacentNonExistingRoomGridIndexes(nil, roomGridIndex)
+    return #adjacentNonExistingRoomGridIndexes == 1
 end
 --- Helper function to determine if a given room grid index is inside of the normal 13x13 level grid.
 -- 
@@ -201,6 +237,17 @@ local UP = -LEVEL_GRID_ROW_WIDTH
 local RIGHT = 1
 local DOWN = LEVEL_GRID_ROW_WIDTH
 ADJACENT_ROOM_GRID_INDEX_DELTAS = {LEFT, UP, RIGHT, DOWN}
+--- Helper function to get only the adjacent room grid indexes that exist (i.e. have room data).
+-- 
+-- This is just a filtering of the results of the `getAdjacentExistingRoomGridIndexes` function. See
+-- that function for more information.
+function ____exports.getAdjacentExistingRoomGridIndexes(self, roomGridIndex)
+    local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
+    return __TS__ArrayFilter(
+        adjacentRoomGridIndexes,
+        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) ~= nil end
+    )
+end
 --- Helper function to get the room safe grid index for every room on the entire floor.
 function ____exports.getAllRoomGridIndexes(self)
     local rooms = getRooms(nil)
@@ -227,6 +274,25 @@ function ____exports.getNewRoomCandidate(self, seedOrRNG)
     end
     return getRandomArrayElement(nil, newRoomCandidatesForLevel, seedOrRNG)
 end
+--- Helper function to get the grid indexes of all the rooms connected to the given room index,
+-- taking the shape of the room into account. (This will only include rooms with valid data.)
+-- 
+-- Returns an empty map if the provided room grid index is out of bounds or has no associated room
+-- data.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns A map of `DoorSlot` to the corresponding room grid index.
+function ____exports.getRoomAdjacentGridIndexes(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    if not ____exports.isRoomInsideGrid(nil, roomDescriptor.SafeGridIndex) then
+        return __TS__New(Map)
+    end
+    local roomData = roomDescriptor.Data
+    if roomData == nil then
+        return __TS__New(Map)
+    end
+    return ____exports.getRoomShapeAdjacentExistingGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
+end
 --- Helper function to get an array of all of the safe grid indexes for rooms that match the
 -- specified room type.
 -- 
@@ -246,34 +312,6 @@ function ____exports.getRoomGridIndexesForType(self, ...)
         function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
     )
 end
---- Helper function to get the grid indexes of all the rooms connected to the given room index,
--- taking the shape of the room into account. (This will only include rooms with valid data.)
--- 
--- Returns an empty map if the provided room grid index is out of bounds or has no associated room
--- data.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
--- @returns A map of `DoorSlot` to the corresponding room grid index.
-function ____exports.getRoomNeighbors(self, roomGridIndex)
-    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
-    if not ____exports.isRoomInsideGrid(nil, roomDescriptor.SafeGridIndex) then
-        return __TS__New(Map)
-    end
-    local roomData = roomDescriptor.Data
-    if roomData == nil then
-        return __TS__New(Map)
-    end
-    local doorSlotToRoomGridIndexes = ____exports.getRoomShapeNeighborGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
-    local roomNeighbors = __TS__New(Map)
-    for ____, ____value in __TS__Iterator(doorSlotToRoomGridIndexes:entries()) do
-        local doorSlot = ____value[1]
-        local neighborRoomGridIndex = ____value[2]
-        if ____exports.roomExists(nil, neighborRoomGridIndex) then
-            roomNeighbors:set(doorSlot, neighborRoomGridIndex)
-        end
-    end
-    return roomNeighbors
-end
 function ____exports.isDoorSlotValidAtGridIndex(self, doorSlot, roomGridIndex)
     local allowedDoors = getRoomAllowedDoors(nil, roomGridIndex)
     return allowedDoors:has(doorSlot)

package/dist/interfaces/CustomStageTSConfig.d.ts

@@ -26,7 +26,7 @@ export interface CustomStageTSConfig {
      * https://isaacscript.github.io/main/custom-stages
      *
      * @minimum 101
-     * @maximum 109
+     * @maximum 999
      */
     roomVariantPrefix: number;
     /**

package/dist/interfaces/GridEntityCustomData.d.ts

@@ -13,8 +13,8 @@ export interface GridEntityCustomData {
     gridEntityTypeCustom: GridEntityType;
     roomListIndex: int;
     gridIndex: int;
-    anm2Path: string;
+    gridCollisionClass?: GridCollisionClass;
+    anm2Path?: string;
     defaultAnimation?: string;
-    gridCollisionClass: GridCollisionClass;
 }
 //# sourceMappingURL=GridEntityCustomData.d.ts.map

package/dist/interfaces/GridEntityCustomData.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GridEntityCustomData.d.ts","sourceRoot":"","sources":["../../src/interfaces/GridEntityCustomData.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,cAAc,EACf,MAAM,8BAA8B,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,oBAAoB,EAAE,cAAc,CAAC;IAErC,aAAa,EAAE,GAAG,CAAC;IACnB,SAAS,EAAE,GAAG,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,kBAAkB,CAAC;CACxC"}
+{"version":3,"file":"GridEntityCustomData.d.ts","sourceRoot":"","sources":["../../src/interfaces/GridEntityCustomData.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,cAAc,EACf,MAAM,8BAA8B,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,oBAAoB,EAAE,cAAc,CAAC;IAErC,aAAa,EAAE,GAAG,CAAC;IACnB,SAAS,EAAE,GAAG,CAAC;IACf,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B"}

package/dist/objects/roomTypeNames.d.ts

@@ -1,5 +1,4 @@
 import { RoomType } from "isaac-typescript-definitions";
-export declare const DEFAULT_ROOM_TYPE_NAME = "Unknown";
 export declare const ROOM_TYPE_NAMES: {
     readonly [key in RoomType]: string;
 };

package/dist/objects/roomTypeNames.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roomTypeNames.d.ts","sourceRoot":"","sources":["../../src/objects/roomTypeNames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExD,eAAO,MAAM,sBAAsB,YAAY,CAAC;AAEhD,eAAO,MAAM,eAAe,EAAE;IAAE,QAAQ,EAAE,GAAG,IAAI,QAAQ,GAAG,MAAM;CA8BxD,CAAC"}
+{"version":3,"file":"roomTypeNames.d.ts","sourceRoot":"","sources":["../../src/objects/roomTypeNames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExD,eAAO,MAAM,eAAe,EAAE;IAAE,QAAQ,EAAE,GAAG,IAAI,QAAQ,GAAG,MAAM;CA8BxD,CAAC"}

package/dist/objects/roomTypeNames.lua

@@ -1,7 +1,6 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
-____exports.DEFAULT_ROOM_TYPE_NAME = "Unknown"
 ____exports.ROOM_TYPE_NAMES = {
     [RoomType.DEFAULT] = "default room",
     [RoomType.SHOP] = "shop",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "7.6.0",
+  "version": "7.7.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/features/customGridEntity.ts

@@ -184,13 +184,15 @@ function postNewRoomReordered() {
       continue;
     }
 
-    const sprite = decoration.GetSprite();
-    sprite.Load(data.anm2Path, true);
-    const animationToPlay =
-      data.defaultAnimation === undefined
-        ? sprite.GetDefaultAnimation()
-        : data.defaultAnimation;
-    sprite.Play(animationToPlay, true);
+    if (data.anm2Path !== undefined) {
+      const sprite = decoration.GetSprite();
+      sprite.Load(data.anm2Path, true);
+      const animationToPlay =
+        data.defaultAnimation === undefined
+          ? sprite.GetDefaultAnimation()
+          : data.defaultAnimation;
+      sprite.Play(animationToPlay, true);
+    }
   }
 }
 
@@ -220,8 +222,11 @@ function postNewRoomReordered() {
  * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
  *                            entity at. If a position is specified, the closest grid index will be
  *                            used.
- * @param gridCollisionClass The collision class that you want the custom grid entity to have.
- * @param anm2Path The path to the ANM2 file to use for the sprite.
+ * @param gridCollisionClass Optional. The collision class that you want the custom grid entity to
+ *                           have. If not specified, the grid collision class from the base grid
+ *                           entity will be used.
+ * @param anm2Path Optional. The path to the ANM2 file to use for the sprite. If not specified, the
+ *                 normal sprite from the base grid entity will be used.
  * @param defaultAnimation Optional. The name of the animation to play after the sprite is
  *                         initialized and after the player re-enters a room with this grid entity
  *                         in it. If not specified, the default animation in the anm2 will be used.
@@ -233,8 +238,8 @@ function postNewRoomReordered() {
 export function spawnCustomGridEntity(
   gridEntityTypeCustom: GridEntityType,
   gridIndexOrPosition: int | Vector,
-  gridCollisionClass: GridCollisionClass,
-  anm2Path: string,
+  gridCollisionClass?: GridCollisionClass,
+  anm2Path?: string,
   defaultAnimation?: string,
   baseGridEntityType = GridEntityType.DECORATION,
   baseGridEntityVariant = 0,
@@ -255,15 +260,20 @@ export function spawnCustomGridEntity(
   if (customGridEntity === undefined) {
     error("Failed to spawn a custom grid entity.");
   }
-  customGridEntity.CollisionClass = gridCollisionClass;
-
-  const sprite = customGridEntity.GetSprite();
-  sprite.Load(anm2Path, true);
-  const animationToPlay =
-    defaultAnimation === undefined
-      ? sprite.GetDefaultAnimation()
-      : defaultAnimation;
-  sprite.Play(animationToPlay, true);
+
+  if (gridCollisionClass !== undefined) {
+    customGridEntity.CollisionClass = gridCollisionClass;
+  }
+
+  if (anm2Path !== undefined) {
+    const sprite = customGridEntity.GetSprite();
+    sprite.Load(anm2Path, true);
+    const animationToPlay =
+      defaultAnimation === undefined
+        ? sprite.GetDefaultAnimation()
+        : defaultAnimation;
+    sprite.Play(animationToPlay, true);
+  }
 
   const customGridEntityData: GridEntityCustomData = {
     gridEntityTypeCustom,

package/src/features/customStage/customStageConstants.ts

@@ -1,3 +1,5 @@
+export const CUSTOM_STAGE_FEATURE_NAME = "customStage";
+
 export const ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = "gfx/isaacscript-custom-stage";
 
 /** Corresponds to "ui_streak.anm2". */

package/src/features/customStage/init.ts

@@ -17,6 +17,7 @@ import {
 import { CustomStage, RoomTypeMap } from "../../interfaces/private/CustomStage";
 import { saveDataManager } from "../saveDataManager/exports";
 import { setCustomStageBackdrop } from "./backdrop";
+import { CUSTOM_STAGE_FEATURE_NAME } from "./customStageConstants";
 import {
   convertVanillaTrapdoors,
   removeUrnRewards,
@@ -42,7 +43,7 @@ export function customStageInit(mod: ModUpgraded): void {
     return;
   }
 
-  saveDataManager("customStage", v);
+  saveDataManager(CUSTOM_STAGE_FEATURE_NAME, v);
   versusScreenInit();
 
   mod.AddCallback(ModCallback.POST_RENDER, postRender); // 2

package/src/features/customStage/versusScreen.ts

@@ -18,9 +18,13 @@ import { PLAYER_NAME_PNG_FILE_NAMES } from "../../objects/playerNamePNGFileNames
 import { PLAYER_PORTRAIT_PNG_FILE_NAMES } from "../../objects/playerPortraitPNGFileNames";
 import { VERSUS_SCREEN_BACKGROUND_COLORS } from "../../objects/versusScreenBackgroundColors";
 import { VERSUS_SCREEN_DIRT_SPOT_COLORS } from "../../objects/versusScreenDirtSpotColors";
+import { disableAllSound, enableAllSound } from "../disableAllSound";
 import { pause, unpause } from "../pause";
 import { runNextGameFrame } from "../runInNFrames";
-import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./customStageConstants";
+import {
+  CUSTOM_STAGE_FEATURE_NAME,
+  ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH,
+} from "./customStageConstants";
 import {
   DEFAULT_BASE_STAGE,
   DEFAULT_BASE_STAGE_TYPE,
@@ -136,6 +140,7 @@ export function playVersusScreenAnimation(customStage: CustomStage): void {
 
   pause();
   hud.SetVisible(false);
+  disableAllSound(CUSTOM_STAGE_FEATURE_NAME);
 
   // Player
   {
@@ -273,6 +278,7 @@ function finishVersusScreenAnimation() {
 
   unpause();
   hud.SetVisible(true);
+  enableAllSound(CUSTOM_STAGE_FEATURE_NAME);
 
   // The sound effect only plays once the versus cutscene is over.
   sfxManager.Play(SoundEffect.CASTLE_PORTCULLIS);

package/src/features/customTrapdoor/spawn.ts

@@ -45,10 +45,9 @@ export function spawnCustomTrapdoorToDestination(
   };
   roomTrapdoorMap.set(gridIndex, customTrapdoorDescription);
 
-  if (!open) {
-    const sprite = gridEntity.GetSprite();
-    sprite.Play(TrapdoorAnimation.CLOSED, true);
-  }
+  const sprite = gridEntity.GetSprite();
+  const animation = open ? TrapdoorAnimation.OPENED : TrapdoorAnimation.CLOSED;
+  sprite.Play(animation, true);
 
   return gridEntity;
 }

package/src/features/extraConsoleCommands/commandsSubroutines.ts

@@ -9,7 +9,10 @@ import { game } from "../../core/cachedClasses";
 import { HealthType } from "../../enums/HealthType";
 import { directionToVector } from "../../functions/direction";
 import { spawnGridEntityWithVariant } from "../../functions/gridEntities";
-import { getRoomGridIndexesForType } from "../../functions/levelGrid";
+import {
+  getRoomAdjacentGridIndexes,
+  getRoomGridIndexesForType,
+} from "../../functions/levelGrid";
 import {
   logAllEntities,
   logAllGridEntities,
@@ -18,10 +21,7 @@ import { addPlayerHealthType } from "../../functions/playerHealth";
 import { getRoomData, getRoomDescriptor } from "../../functions/roomData";
 import { changeRoom } from "../../functions/rooms";
 import { printConsole } from "../../functions/utils";
-import {
-  DEFAULT_ROOM_TYPE_NAME,
-  ROOM_TYPE_NAMES,
-} from "../../objects/roomTypeNames";
+import { ROOM_TYPE_NAMES } from "../../objects/roomTypeNames";
 
 const DEFAULT_MOVE_UNITS = 0.5;
 
@@ -127,10 +127,6 @@ export function spawnTrapdoorOrCrawlSpace(trapdoor: boolean): void {
 
 export function warpToRoomType(roomType: RoomType): void {
   const roomTypeName = ROOM_TYPE_NAMES[roomType];
-  if (roomTypeName === DEFAULT_ROOM_TYPE_NAME) {
-    printConsole(`Invalid room type: ${roomType}`);
-  }
-
   const gridIndexes = getRoomGridIndexesForType(roomType);
   const firstGridIndex = gridIndexes[0];
   if (firstGridIndex === undefined) {
@@ -141,3 +137,28 @@ export function warpToRoomType(roomType: RoomType): void {
   changeRoom(firstGridIndex);
   printConsole(`Warped to room type: ${roomTypeName} (${roomType})`);
 }
+
+export function warpNextToRoomType(roomType: RoomType): void {
+  const roomTypeName = ROOM_TYPE_NAMES[roomType];
+  const gridIndexes = getRoomGridIndexesForType(roomType);
+  const firstGridIndex = gridIndexes[0];
+  if (firstGridIndex === undefined) {
+    printConsole(`There are no ${roomTypeName}s on this floor.`);
+    return;
+  }
+
+  const adjacentRoomGridIndexes = getRoomAdjacentGridIndexes(firstGridIndex);
+
+  for (const [_doorSlot, roomGridIndex] of adjacentRoomGridIndexes.entries()) {
+    const roomData = getRoomData(roomGridIndex);
+    if (roomData !== undefined && roomData.Type === RoomType.DEFAULT) {
+      changeRoom(firstGridIndex);
+      printConsole(`Warped next to room type: ${roomTypeName} (${roomType})`);
+      return;
+    }
+  }
+
+  printConsole(
+    `Failed to find the room next to room type: ${roomTypeName} (${roomType})`,
+  );
+}

package/src/features/extraConsoleCommands/init.ts

@@ -46,6 +46,7 @@ function initMap() {
   );
   extraConsoleCommandsFunctionMap.set("bombs", commands.bombs);
   extraConsoleCommandsFunctionMap.set("boneHearts", commands.boneHearts);
+  extraConsoleCommandsFunctionMap.set("bossNextRoom", commands.bossNextRoom);
   extraConsoleCommandsFunctionMap.set("bossRoom", commands.bossRoom);
   extraConsoleCommandsFunctionMap.set("bossRush", commands.bossRush);
   extraConsoleCommandsFunctionMap.set("brokenHearts", commands.brokenHearts);

package/src/features/extraConsoleCommands/listCommands.ts

@@ -102,6 +102,7 @@ import {
   listGridEntities,
   movePlayer,
   spawnTrapdoorOrCrawlSpace,
+  warpNextToRoomType,
   warpToRoomType,
 } from "./commandsSubroutines";
 import v from "./v";
@@ -284,6 +285,11 @@ export function boneHearts(params: string): void {
   addHeart(params, HealthType.BONE);
 }
 
+/** Warps to the room next to the first Boss Room on the floor. */
+export function bossNextRoom(): void {
+  warpNextToRoomType(RoomType.BOSS);
+}
+
 /** Warps to the first Boss Room on the floor. */
 export function bossRoom(): void {
   warpToRoomType(RoomType.BOSS);