isaacscript-common 30.12.11 → 31.0.0

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 30.12.11
+isaacscript-common 31.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -25336,7 +25336,7 @@ end
 function ____exports.getRoomShapeWidth(self, roomShape)
     return ROOM_SHAPE_TO_GRID_WIDTH[roomShape]
 end
-function ____exports.isLRoom(self, roomShape)
+function ____exports.isLRoomShape(self, roomShape)
     return L_ROOM_SHAPES_SET:has(roomShape)
 end
 function ____exports.isNarrowRoom(self, roomShape)
@@ -27306,9 +27306,9 @@ local Map = ____lualib.Map
 local __TS__Spread = ____lualib.__TS__Spread
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local __TS__StringIncludes = ____lualib.__TS__StringIncludes
 local __TS__ArrayIncludes = ____lualib.__TS__ArrayIncludes
-local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local AngelRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.AngelRoomSubType
@@ -27318,7 +27318,6 @@ local DownpourRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.DownpourRoomSub
 local DungeonSubType = ____isaac_2Dtypescript_2Ddefinitions.DungeonSubType
 local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
 local HomeRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.HomeRoomSubType
-local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
 local RoomDescriptorFlag = ____isaac_2Dtypescript_2Ddefinitions.RoomDescriptorFlag
 local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
@@ -27357,9 +27356,8 @@ local getRoomData = ____roomData.getRoomData
 local getRoomDescriptor = ____roomData.getRoomDescriptor
 local getRoomDescriptorReadOnly = ____roomData.getRoomDescriptorReadOnly
 local getRoomGridIndex = ____roomData.getRoomGridIndex
-local getRoomName = ____roomData.getRoomName
-local getRoomStageID = ____roomData.getRoomStageID
-local getRoomSubType = ____roomData.getRoomSubType
+local ____roomShape = require("src.functions.roomShape")
+local isLRoomShape = ____roomShape.isLRoomShape
 local ____roomTransition = require("src.functions.roomTransition")
 local reloadRoom = ____roomTransition.reloadRoom
 local ____stage = require("src.functions.stage")
@@ -27413,6 +27411,61 @@ function ____exports.getRoomsOutsideGrid(self)
         function(____, readOnlyRoomDescriptor) return getRoomDescriptor(nil, readOnlyRoomDescriptor.SafeGridIndex) end
     )
 end
+function ____exports.is2x1Room(self, roomData)
+    return roomData.Shape == RoomShape.SHAPE_1x2 or roomData.Shape == RoomShape.SHAPE_2x1
+end
+function ____exports.isAngelShop(self, roomData)
+    return roomData.Type == RoomType.ANGEL and roomData.Subtype == asNumber(nil, AngelRoomSubType.SHOP)
+end
+function ____exports.isBeastRoom(self, roomData)
+    return roomData.Type == RoomType.DUNGEON and roomData.Subtype == asNumber(nil, DungeonSubType.BEAST_ROOM)
+end
+function ____exports.isBossRoomOf(self, roomData, bossID)
+    return roomData.Type == RoomType.BOSS and roomData.StageID == StageID.SPECIAL_ROOMS and roomData.Subtype == asNumber(nil, bossID)
+end
+function ____exports.isCrawlSpace(self, roomData)
+    return roomData.Type == RoomType.DUNGEON and roomData.Subtype == asNumber(nil, DungeonSubType.NORMAL)
+end
+function ____exports.isDeathCertificateArea(self, roomData)
+    return roomData.StageID == StageID.HOME and (roomData.Subtype == asNumber(nil, HomeRoomSubType.DEATH_CERTIFICATE_ENTRANCE) or roomData.Subtype == asNumber(nil, HomeRoomSubType.DEATH_CERTIFICATE_ITEMS))
+end
+function ____exports.isDevilsCrownTreasureRoom(self, roomDescriptor)
+    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.DEVIL_TREASURE)
+end
+function ____exports.isDoubleTrouble(self, roomData)
+    return roomData.Type == RoomType.BOSS and __TS__StringIncludes(roomData.Name, "Double Trouble")
+end
+function ____exports.isGenesisRoom(self, roomDescriptor)
+    return roomDescriptor.GridIndex == asNumber(nil, GridRoom.GENESIS)
+end
+function ____exports.isHomeCloset(self, roomData)
+    return roomData.StageID == StageID.HOME and (roomData.Subtype == asNumber(nil, HomeRoomSubType.CLOSET_LEFT) or roomData.Subtype == asNumber(nil, HomeRoomSubType.CLOSET_RIGHT))
+end
+function ____exports.isLRoom(self, roomData)
+    return isLRoomShape(nil, roomData.Shape)
+end
+function ____exports.isMegaSatanRoom(self, roomDescriptor)
+    return roomDescriptor.GridIndex == asNumber(nil, GridRoom.MEGA_SATAN)
+end
+function ____exports.isMineShaft(self, roomData)
+    return (roomData.StageID == StageID.MINES or roomData.StageID == StageID.ASHPIT) and MINE_SHAFT_ROOM_SUB_TYPE_SET:has(roomData.Subtype)
+end
+function ____exports.isMinibossRoomOf(self, roomData, minibossID)
+    return roomData.Type == RoomType.MINI_BOSS and roomData.StageID == StageID.SPECIAL_ROOMS and roomData.Subtype == asNumber(nil, minibossID)
+end
+function ____exports.isMirrorRoom(self, roomData)
+    return roomData.Type == RoomType.DEFAULT and (roomData.StageID == StageID.DOWNPOUR or roomData.StageID == StageID.DROSS) and roomData.Subtype == asNumber(nil, DownpourRoomSubType.MIRROR)
+end
+function ____exports.isRoomType(self, roomData, ...)
+    local roomTypes = {...}
+    return __TS__ArrayIncludes(roomTypes, roomData.Type)
+end
+function ____exports.isSecretExit(self, roomDescriptor)
+    return roomDescriptor.GridIndex == asNumber(nil, GridRoom.SECRET_EXIT)
+end
+function ____exports.isSecretShop(self, roomDescriptor)
+    return roomDescriptor.GridIndex == asNumber(nil, GridRoom.SECRET_SHOP)
+end
 local SECRET_ROOM_TYPES = __TS__New(ReadonlySet, {RoomType.SECRET, RoomType.SUPER_SECRET, RoomType.ULTRA_SECRET})
 function ____exports.changeRoom(self, roomGridIndex)
     local level = game:GetLevel()
@@ -27478,101 +27531,76 @@ function ____exports.getRoomsOfDimension(self, dimension)
     return {__TS__Spread(roomsMap:values())}
 end
 function ____exports.in2x1Room(self)
-    local room = game:GetRoom()
-    local roomShape = room:GetRoomShape()
-    return roomShape == RoomShape.SHAPE_1x2 or roomShape == RoomShape.SHAPE_2x1
+    local roomData = getRoomData(nil)
+    return ____exports.is2x1Room(nil, roomData)
 end
 function ____exports.inAngelShop(self)
-    local room = game:GetRoom()
-    local roomType = room:GetType()
-    local roomSubType = getRoomSubType(nil)
-    return roomType == RoomType.ANGEL and roomSubType == asNumber(nil, AngelRoomSubType.SHOP)
+    local roomData = getRoomData(nil)
+    return ____exports.isAngelShop(nil, roomData)
 end
 function ____exports.inBeastRoom(self)
-    local room = game:GetRoom()
-    local roomType = room:GetType()
-    local roomSubType = getRoomSubType(nil)
-    return roomType == RoomType.DUNGEON and roomSubType == asNumber(nil, DungeonSubType.BEAST_ROOM)
+    local roomData = getRoomData(nil)
+    return ____exports.isBeastRoom(nil, roomData)
 end
 function ____exports.inBossRoomOf(self, bossID)
-    local room = game:GetRoom()
-    local roomType = room:GetType()
-    local roomStageID = getRoomStageID(nil)
-    local roomSubType = getRoomSubType(nil)
-    return roomType == RoomType.BOSS and roomStageID == StageID.SPECIAL_ROOMS and roomSubType == asNumber(nil, bossID)
+    local roomData = getRoomData(nil)
+    return ____exports.isBossRoomOf(nil, roomData, bossID)
 end
 function ____exports.inCrawlSpace(self)
-    local room = game:GetRoom()
-    local roomType = room:GetType()
-    local roomSubType = getRoomSubType(nil)
-    return roomType == RoomType.DUNGEON and roomSubType == asNumber(nil, DungeonSubType.NORMAL)
+    local roomData = getRoomData(nil)
+    return ____exports.isCrawlSpace(nil, roomData)
 end
 function ____exports.inDeathCertificateArea(self)
-    local roomStageID = getRoomStageID(nil)
-    local roomSubType = getRoomSubType(nil)
-    return roomStageID == StageID.HOME and (roomSubType == asNumber(nil, HomeRoomSubType.DEATH_CERTIFICATE_ENTRANCE) or roomSubType == asNumber(nil, HomeRoomSubType.DEATH_CERTIFICATE_ITEMS))
+    local roomData = getRoomData(nil)
+    return ____exports.isDeathCertificateArea(nil, roomData)
 end
 function ____exports.inDevilsCrownTreasureRoom(self)
     local roomDescriptor = getRoomDescriptorReadOnly(nil)
-    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.DEVIL_TREASURE)
+    return ____exports.isDevilsCrownTreasureRoom(nil, roomDescriptor)
 end
 function ____exports.inDoubleTrouble(self)
-    local room = game:GetRoom()
-    local roomType = room:GetType()
-    local roomName = getRoomName(nil)
-    return roomType == RoomType.BOSS and __TS__StringIncludes(roomName, "Double Trouble")
+    local roomData = getRoomData(nil)
+    return ____exports.isDoubleTrouble(nil, roomData)
 end
 function ____exports.inGenesisRoom(self)
-    local roomGridIndex = getRoomGridIndex(nil)
-    return roomGridIndex == asNumber(nil, GridRoom.GENESIS)
+    local roomDescriptor = getRoomDescriptorReadOnly(nil)
+    return ____exports.isGenesisRoom(nil, roomDescriptor)
 end
 function ____exports.inHomeCloset(self)
-    local level = game:GetLevel()
-    local stage = level:GetStage()
-    local roomSubType = getRoomSubType(nil)
-    return stage == LevelStage.HOME and (roomSubType == asNumber(nil, HomeRoomSubType.CLOSET_LEFT) or roomSubType == asNumber(nil, HomeRoomSubType.CLOSET_RIGHT))
+    local roomData = getRoomData(nil)
+    return ____exports.isHomeCloset(nil, roomData)
 end
 function ____exports.inLRoom(self)
-    local room = game:GetRoom()
-    local roomShape = room:GetRoomShape()
-    return roomShape == RoomShape.LTL or roomShape == RoomShape.LTR or roomShape == RoomShape.LBL or roomShape == RoomShape.LBR
+    local roomData = getRoomData(nil)
+    return ____exports.isLRoom(nil, roomData)
 end
 function ____exports.inMegaSatanRoom(self)
-    local roomGridIndex = getRoomGridIndex(nil)
-    return roomGridIndex == asNumber(nil, GridRoom.MEGA_SATAN)
+    local roomDescriptor = getRoomDescriptorReadOnly(nil)
+    return ____exports.isMegaSatanRoom(nil, roomDescriptor)
 end
 function ____exports.inMineShaft(self)
-    local roomStageID = getRoomStageID(nil)
-    local roomSubType = getRoomSubType(nil)
-    return (roomStageID == StageID.MINES or roomStageID == StageID.ASHPIT) and MINE_SHAFT_ROOM_SUB_TYPE_SET:has(roomSubType)
+    local roomData = getRoomData(nil)
+    return ____exports.isMineShaft(nil, roomData)
 end
 function ____exports.inMinibossRoomOf(self, minibossID)
-    local room = game:GetRoom()
-    local roomType = room:GetType()
-    local roomStageID = getRoomStageID(nil)
-    local roomSubType = getRoomSubType(nil)
-    return roomType == RoomType.MINI_BOSS and roomStageID == StageID.SPECIAL_ROOMS and roomSubType == asNumber(nil, minibossID)
+    local roomData = getRoomData(nil)
+    return ____exports.isMinibossRoomOf(nil, roomData, minibossID)
 end
 function ____exports.inMirrorRoom(self)
-    local room = game:GetRoom()
-    local roomType = room:GetType()
-    local roomStageID = getRoomStageID(nil)
-    local roomSubType = getRoomSubType(nil)
-    return roomType == RoomType.DEFAULT and (roomStageID == StageID.DOWNPOUR or roomStageID == StageID.DROSS) and roomSubType == asNumber(nil, DownpourRoomSubType.MIRROR)
+    local roomData = getRoomData(nil)
+    return ____exports.isMirrorRoom(nil, roomData)
 end
 function ____exports.inRoomType(self, ...)
-    local roomTypes = {...}
-    local room = game:GetRoom()
-    local thisRoomType = room:GetType()
-    return __TS__ArrayIncludes(roomTypes, thisRoomType)
+    local roomData = getRoomData(nil)
+    return ____exports.isRoomType(nil, roomData, ...)
 end
 function ____exports.inSecretExit(self)
-    local roomGridIndex = getRoomGridIndex(nil)
-    return roomGridIndex == asNumber(nil, GridRoom.SECRET_EXIT)
+    local roomDescriptor = getRoomDescriptorReadOnly(nil)
+    return ____exports.isSecretExit(nil, roomDescriptor)
 end
 function ____exports.inSecretShop(self)
-    local roomGridIndex = getRoomGridIndex(nil)
-    return roomGridIndex == asNumber(nil, GridRoom.SECRET_SHOP)
+    local roomDescriptor = getRoomDescriptorReadOnly(nil)
+    return ____exports.isSecretShop(nil, roomDescriptor)
 end
 function ____exports.inStartingRoom(self)
     local level = game:GetLevel()
@@ -27641,12 +27669,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue59
+                goto __continue77
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue59::
+        ::__continue77::
     end
     sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)
@@ -29498,13 +29526,9 @@ function ____exports.logRoom()
     local roomListIndex = getRoomListIndex(nil)
     local roomData = getRoomData(nil)
     log("Logging room information:")
-    if roomData == nil then
-        log("- Room data is undefined.")
-    else
-        log("- Room stage ID: " .. tostring(roomData.StageID))
-        log((((("- Type/variant/sub-type: " .. tostring(roomData.Type)) .. ".") .. tostring(roomData.Variant)) .. ".") .. tostring(roomData.Subtype))
-        log("- Name: " .. roomData.Name)
-    end
+    log("- Room stage ID: " .. tostring(roomData.StageID))
+    log((((("- Type/variant/sub-type: " .. tostring(roomData.Type)) .. ".") .. tostring(roomData.Variant)) .. ".") .. tostring(roomData.Subtype))
+    log("- Name: " .. roomData.Name)
     local roomGridIndexName = GridRoom[roomGridIndex]
     if roomGridIndexName == nil then
         log("- Grid index: " .. tostring(roomGridIndex))
@@ -42194,7 +42218,7 @@ local spawnEffectWithSeed = ____entitiesSpecific.spawnEffectWithSeed
 local ____rng = require("src.functions.rng")
 local newRNG = ____rng.newRNG
 local ____roomShape = require("src.functions.roomShape")
-local isLRoom = ____roomShape.isLRoom
+local isLRoomShape = ____roomShape.isLRoomShape
 local isNarrowRoom = ____roomShape.isNarrowRoom
 local ____string = require("src.functions.string")
 local removeCharactersBefore = ____string.removeCharactersBefore
@@ -42231,7 +42255,7 @@ function spawnWallEntity(self, customStage, rng, isExtraWall)
     if numWallLayers == nil then
         error("Failed to get the layers when creating the backdrop for custom stage: " .. customStage.name)
     end
-    if isLRoom(nil, roomShape) then
+    if isLRoomShape(nil, roomShape) then
         local cornerPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.CORNER, rng)
         sprite:ReplaceSpritesheet(0, cornerPNGPath)
     end
@@ -42278,7 +42302,7 @@ function spawnFloorEntity(self, customStage, rng)
             local wallPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.WALL, rng)
             sprite:ReplaceSpritesheet(layerID, wallPNGPath)
         end
-    elseif isLRoom(nil, roomShape) then
+    elseif isLRoomShape(nil, roomShape) then
         for ____, layerID in ipairs(L_FLOOR_ANM2_LAYERS) do
             local LFloorPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.L_FLOOR, rng)
             sprite:ReplaceSpritesheet(layerID, LFloorPNGPath)
@@ -45924,13 +45948,13 @@ local ____gridIndex = require("src.functions.gridIndex")
 local getGridIndexesBetween = ____gridIndex.getGridIndexesBetween
 local ____roomShape = require("src.functions.roomShape")
 local getRoomShapeCorners = ____roomShape.getRoomShapeCorners
-local isLRoom = ____roomShape.isLRoom
+local isLRoomShape = ____roomShape.isLRoomShape
 local ____rooms = require("src.functions.rooms")
 local inBossRoomOf = ____rooms.inBossRoomOf
 local inHomeCloset = ____rooms.inHomeCloset
 function getVanillaWallGridIndexSetForRoomShape(self, roomShape)
     local corners = getRoomShapeCorners(nil, roomShape)
-    local lRoom = isLRoom(nil, roomShape)
+    local lRoom = isLRoomShape(nil, roomShape)
     if lRoom and #corners ~= 6 then
         error(((("Failed to get the correct amount of corners for: RoomShape." .. RoomShape[roomShape]) .. " (") .. tostring(roomShape)) .. ")")
     end
@@ -46456,7 +46480,7 @@ local ____roomShape = require("src.functions.roomShape")
 local getRoomShapeBottomRightPosition = ____roomShape.getRoomShapeBottomRightPosition
 local getRoomShapeTopLeftPosition = ____roomShape.getRoomShapeTopLeftPosition
 local getRoomShapeWidth = ____roomShape.getRoomShapeWidth
-local isLRoom = ____roomShape.isLRoom
+local isLRoomShape = ____roomShape.isLRoomShape
 function ____exports.gridPositionToWorldPosition(self, gridPosition)
     local x = (gridPosition.X + 2) * 40
     local y = (gridPosition.Y + 4) * 40
@@ -46489,13 +46513,13 @@ function ____exports.gridIndexToGridPosition(self, gridIndex, roomShape)
     return Vector(x, y)
 end
 function ____exports.isValidGridPosition(self, gridPosition, roomShape)
-    local ____isLRoom_result_0
-    if isLRoom(nil, roomShape) then
-        ____isLRoom_result_0 = isValidGridPositionLRoom(nil, gridPosition, roomShape)
+    local ____isLRoomShape_result_0
+    if isLRoomShape(nil, roomShape) then
+        ____isLRoomShape_result_0 = isValidGridPositionLRoom(nil, gridPosition, roomShape)
     else
-        ____isLRoom_result_0 = isValidGridPositionNormal(nil, gridPosition, roomShape)
+        ____isLRoomShape_result_0 = isValidGridPositionNormal(nil, gridPosition, roomShape)
     end
-    return ____isLRoom_result_0
+    return ____isLRoomShape_result_0
 end
 function ____exports.worldPositionToGridPosition(self, worldPos)
     local x = math.floor(worldPos.X / 40 - 2 + 0.5)
@@ -47652,9 +47676,7 @@ local ____exports = {}
 local ADJACENT_ROOM_GRID_INDEX_DELTAS
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local DisplayFlag = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlag
-local DownpourRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.DownpourRoomSubType
 local LevelStateFlag = ____isaac_2Dtypescript_2Ddefinitions.LevelStateFlag
-local MinesRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.MinesRoomSubType
 local RoomDescriptorFlag = ____isaac_2Dtypescript_2Ddefinitions.RoomDescriptorFlag
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 local ____cachedClasses = require("src.core.cachedClasses")
@@ -47690,9 +47712,9 @@ local getGridIndexDelta = ____roomShape.getGridIndexDelta
 local ____rooms = require("src.functions.rooms")
 local getRooms = ____rooms.getRooms
 local getRoomsInsideGrid = ____rooms.getRoomsInsideGrid
+local isMineShaft = ____rooms.isMineShaft
+local isMirrorRoom = ____rooms.isMirrorRoom
 local isSecretRoomType = ____rooms.isSecretRoomType
-local ____types = require("src.functions.types")
-local asNumber = ____types.asNumber
 function ____exports.getAdjacentExistingRoomGridIndexes(self, roomGridIndex)
     local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
     return __TS__ArrayFilter(
@@ -47714,7 +47736,10 @@ function ____exports.getAdjacentRoomGridIndexes(self, roomGridIndex)
         function(____, adjacentRoomGridIndex) return ____exports.isRoomInsideGrid(nil, adjacentRoomGridIndex) end
     )
 end
-function ____exports.getNewRoomCandidatesBesideRoom(self, roomGridIndex)
+function ____exports.getNewRoomCandidatesBesideRoom(self, roomGridIndex, ensureDeadEnd)
+    if ensureDeadEnd == nil then
+        ensureDeadEnd = true
+    end
     local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
     if not ____exports.isRoomInsideGrid(nil, roomDescriptor.SafeGridIndex) then
         return {}
@@ -47733,7 +47758,7 @@ function ____exports.getNewRoomCandidatesBesideRoom(self, roomGridIndex)
             if not hasFlag(nil, roomData.Doors, doorSlotFlag) then
                 goto __continue17
             end
-            if not ____exports.isDeadEnd(nil, adjacentRoomGridIndex) then
+            if ensureDeadEnd and not ____exports.isDeadEnd(nil, adjacentRoomGridIndex) then
                 goto __continue17
             end
             roomCandidates[#roomCandidates + 1] = {doorSlot = doorSlot, roomGridIndex = adjacentRoomGridIndex}
@@ -47742,15 +47767,19 @@ function ____exports.getNewRoomCandidatesBesideRoom(self, roomGridIndex)
     end
     return roomCandidates
 end
-function ____exports.getNewRoomCandidatesForLevel(self)
+function ____exports.getNewRoomCandidatesForLevel(self, ensureDeadEnd)
+    if ensureDeadEnd == nil then
+        ensureDeadEnd = true
+    end
     local rooms = getRoomsInsideGrid(nil)
     local normalRooms = __TS__ArrayFilter(
         rooms,
-        function(____, room) return room.Data ~= nil and room.Data.Type == RoomType.DEFAULT and room.Data.Subtype ~= asNumber(nil, DownpourRoomSubType.MIRROR) and room.Data.Subtype ~= asNumber(nil, MinesRoomSubType.MINESHAFT_ENTRANCE) end
+        function(____, room) return room.Data ~= nil and room.Data.Type == RoomType.DEFAULT and not isMirrorRoom(nil, room.Data) and not isMineShaft(nil, room.Data) end
     )
+    local roomsToLookThrough = ensureDeadEnd and normalRooms or rooms
     local newRoomCandidates = {}
-    for ____, room in ipairs(normalRooms) do
-        local newRoomCandidatesBesideRoom = ____exports.getNewRoomCandidatesBesideRoom(nil, room.SafeGridIndex)
+    for ____, room in ipairs(roomsToLookThrough) do
+        local newRoomCandidatesBesideRoom = ____exports.getNewRoomCandidatesBesideRoom(nil, room.SafeGridIndex, ensureDeadEnd)
         for ____, ____value in ipairs(newRoomCandidatesBesideRoom) do
             local doorSlot = ____value.doorSlot
             local roomGridIndex = ____value.roomGridIndex
@@ -47838,11 +47867,14 @@ function ____exports.getAllRoomGridIndexes(self)
         function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
     )
 end
-function ____exports.getNewRoomCandidate(self, seedOrRNG)
+function ____exports.getNewRoomCandidate(self, seedOrRNG, ensureDeadEnd)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
-    local newRoomCandidatesForLevel = ____exports.getNewRoomCandidatesForLevel(nil)
+    if ensureDeadEnd == nil then
+        ensureDeadEnd = true
+    end
+    local newRoomCandidatesForLevel = ____exports.getNewRoomCandidatesForLevel(nil, ensureDeadEnd)
     if #newRoomCandidatesForLevel == 0 then
         return nil
     end
@@ -47899,13 +47931,16 @@ function ____exports.isRedKeyRoom(self, roomGridIndex)
     local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
     return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
 end
-function ____exports.newRoom(self, seedOrRNG)
+function ____exports.newRoom(self, seedOrRNG, ensureDeadEnd, customRoomData)
+    if ensureDeadEnd == nil then
+        ensureDeadEnd = true
+    end
     local level = game:GetLevel()
     if seedOrRNG == nil then
         seedOrRNG = level:GetDungeonPlacementSeed()
     end
     local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
-    local newRoomCandidate = ____exports.getNewRoomCandidate(nil, rng)
+    local newRoomCandidate = ____exports.getNewRoomCandidate(nil, rng, ensureDeadEnd)
     if newRoomCandidate == nil then
         return nil
     end
@@ -47915,6 +47950,9 @@ function ____exports.newRoom(self, seedOrRNG)
     level:MakeRedRoomDoor(adjacentRoomGridIndex, doorSlot)
     local roomDescriptor = getRoomDescriptor(nil, newRoomGridIndex)
     roomDescriptor.Flags = removeFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
+    if customRoomData ~= nil then
+        roomDescriptor.Data = customRoomData
+    end
     local roomData = roomDescriptor.Data
     if roomData ~= nil then
         local hasFullMap = level:GetStateFlag(LevelStateFlag.FULL_MAP_EFFECT)

package/dist/src/classes/features/other/customStages/backdrop.lua

@@ -20,7 +20,7 @@ local spawnEffectWithSeed = ____entitiesSpecific.spawnEffectWithSeed
 local ____rng = require("src.functions.rng")
 local newRNG = ____rng.newRNG
 local ____roomShape = require("src.functions.roomShape")
-local isLRoom = ____roomShape.isLRoom
+local isLRoomShape = ____roomShape.isLRoomShape
 local isNarrowRoom = ____roomShape.isNarrowRoom
 local ____string = require("src.functions.string")
 local removeCharactersBefore = ____string.removeCharactersBefore
@@ -57,7 +57,7 @@ function spawnWallEntity(self, customStage, rng, isExtraWall)
     if numWallLayers == nil then
         error("Failed to get the layers when creating the backdrop for custom stage: " .. customStage.name)
     end
-    if isLRoom(nil, roomShape) then
+    if isLRoomShape(nil, roomShape) then
         local cornerPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.CORNER, rng)
         sprite:ReplaceSpritesheet(0, cornerPNGPath)
     end
@@ -104,7 +104,7 @@ function spawnFloorEntity(self, customStage, rng)
             local wallPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.WALL, rng)
             sprite:ReplaceSpritesheet(layerID, wallPNGPath)
         end
-    elseif isLRoom(nil, roomShape) then
+    elseif isLRoomShape(nil, roomShape) then
         for ____, layerID in ipairs(L_FLOOR_ANM2_LAYERS) do
             local LFloorPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.L_FLOOR, rng)
             sprite:ReplaceSpritesheet(layerID, LFloorPNGPath)

package/dist/src/functions/levelGrid.d.ts

@@ -48,34 +48,41 @@ export declare function getAllRoomGridIndexes(): readonly int[];
  *
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param ensureDeadEnd Optional. Whether to pick a valid dead end attached to a normal room. If
+ *                      false, the function will randomly pick from any valid location that would
+ *                      have a red door.
  * @returns Either a tuple of adjacent room grid index, `DoorSlot`, and new room grid index, or
  *          undefined.
  */
-export declare function getNewRoomCandidate(seedOrRNG?: Seed | RNG): {
+export declare function getNewRoomCandidate(seedOrRNG?: Seed | RNG, ensureDeadEnd?: boolean): {
     readonly adjacentRoomGridIndex: int;
     readonly doorSlot: DoorSlot;
     readonly newRoomGridIndex: int;
 } | undefined;
 /**
  * Helper function to iterate through the possible doors for a room and see if any of them would be
- * a valid spot to insert a brand new room on the floor. (Any potential new rooms cannot be
- * connected to any other existing rooms on the floor.)
+ * a valid spot to insert a brand new room on the floor.
  *
  * @param roomGridIndex Optional. Default is the current room index.
+ * @param ensureDeadEnd Optional. Whether to only include doors that lead to a valid dead end
+ *                      attached to a normal room. If false, the function will include all doors
+ *                      that would have a red door.
  * @returns A array of tuples of `DoorSlot` and room grid index.
  */
-export declare function getNewRoomCandidatesBesideRoom(roomGridIndex?: int): ReadonlyArray<{
+export declare function getNewRoomCandidatesBesideRoom(roomGridIndex?: int, ensureDeadEnd?: boolean): ReadonlyArray<{
     readonly doorSlot: DoorSlot;
     readonly roomGridIndex: int;
 }>;
 /**
- * Helper function to search through all of the rooms on the floor for a spot to insert a brand new
- * room.
+ * Helper function to get all of the spots on the floor to insert a brand new room.
  *
+ * @param ensureDeadEnd Optional. Whether to only include spots that are a valid dead end attached
+ *                      to a normal room. If false, the function will include all valid spots that
+ *                      have a red door.
  * @returns A array of tuples containing the adjacent room grid index, the `DoorSlot`, and the new
  *          room grid index.
  */
-export declare function getNewRoomCandidatesForLevel(): ReadonlyArray<{
+export declare function getNewRoomCandidatesForLevel(ensureDeadEnd?: boolean): ReadonlyArray<{
     readonly adjacentRoomGridIndex: int;
     readonly doorSlot: DoorSlot;
     readonly newRoomGridIndex: int;
@@ -177,23 +184,25 @@ export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
  */
 export declare function isRoomInsideGrid(roomGridIndex?: int): boolean;
 /**
- * Helper function to generate a new room on the floor at a valid dead end attached to a normal
- * room.
+ * Helper function to generate a new room on the floor.
  *
  * Under the hood, this function uses the `Level.MakeRedRoomDoor` method to create the room.
  *
- * The newly created room will have data corresponding to the game's randomly generated red room. If
- * you want to modify this, use the `setRoomData` helper function.
- *
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `Level.GetDungeonPlacementSeed`.
  *                  Note that the RNG is only used to select the random location to put the room on
  *                  the floor; it does not influence the randomly chosen room contents. (That is
  *                  performed by the game and can not be manipulated prior to its generation.)
+ * @param ensureDeadEnd Optional. Whether to place the room at a valid dead end attached to a normal
+ *                      room. If false, it will randomly appear at any valid location that would
+ *                      have a red door.
+ * @param customRoomData Optional. By default, the newly created room will have data corresponding
+ *                       to the game's randomly generated red room. If you provide this function
+ *                       with room data, it will be used to override the vanilla data.
  * @returns The room grid index of the new room or undefined if the floor had no valid dead ends to
  *          place a room.
  */
-export declare function newRoom(seedOrRNG?: Seed | RNG): int | undefined;
+export declare function newRoom(seedOrRNG?: Seed | RNG, ensureDeadEnd?: boolean, customRoomData?: RoomConfig): int | undefined;
 /**
  * Helper function to check if a room exists at the given room grid index. (A room will exist if it
  * has non-undefined data in the room descriptor.)

package/dist/src/functions/levelGrid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"levelGrid.d.ts","sourceRoot":"","sources":["../../../src/functions/levelGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAML,QAAQ,EACT,MAAM,8BAA8B,CAAC;AA+BtC;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAChD,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAKhB;AAED;;;;;;GAMG;AACH,wBAAgB,qCAAqC,CACnD,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAKhB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAchB;AAED,0FAA0F;AAC1F,wBAAgB,qBAAqB,IAAI,SAAS,GAAG,EAAE,CAGtD;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,GAAE,IAAI,GAAG,GAAqB,GACvE;IACE,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC;CAChC,GACD,SAAS,CAOZ;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,CAAC,EAAE,GAAG,GAClB,aAAa,CAAC;IAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,CAAA;CAAE,CAAC,CAiD7E;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,IAAI,aAAa,CAAC;IAC5D,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC;CAChC,CAAC,CAmCD;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAgB5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,cAAc,EAAE,CASlB;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,SAAS,GAAG,EAAE,CAGhB;AAED;;;;;;GAMG;AACH,wBAAgB,uCAAuC,CACrD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAE5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAC7C,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;GAMG;AACH,wBAAgB,0CAA0C,CACxD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAKtD;AAED,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAGT;AAED,wBAAgB,oCAAoC,CAClD,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAqBT;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAGzD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAM7D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,SAAS,CAmD/D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,CAK1E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAE7D"}
+{"version":3,"file":"levelGrid.d.ts","sourceRoot":"","sources":["../../../src/functions/levelGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAIL,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAoCtC;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAChD,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAKhB;AAED;;;;;;GAMG;AACH,wBAAgB,qCAAqC,CACnD,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAKhB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,SAAS,GAAG,EAAE,CAchB;AAED,0FAA0F;AAC1F,wBAAgB,qBAAqB,IAAI,SAAS,GAAG,EAAE,CAGtD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,aAAa,UAAO,GAElB;IACE,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC;CAChC,GACD,SAAS,CAOZ;AAED;;;;;;;;;GASG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,CAAC,EAAE,GAAG,EACnB,aAAa,UAAO,GACnB,aAAa,CAAC;IAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,CAAA;CAAE,CAAC,CAiD7E;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAC1C,aAAa,UAAO,GACnB,aAAa,CAAC;IACf,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC;CAChC,CAAC,CAoCD;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAgB5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,cAAc,EAAE,CASlB;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,SAAS,EAAE,QAAQ,EAAE,GACvB,SAAS,GAAG,EAAE,CAGhB;AAED;;;;;;GAMG;AACH,wBAAgB,uCAAuC,CACrD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAE5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAC7C,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;GAMG;AACH,wBAAgB,0CAA0C,CACxD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAa5B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAKtD;AAED,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAGT;AAED,wBAAgB,oCAAoC,CAClD,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAqBT;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAGzD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAM7D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,OAAO,CACrB,SAAS,CAAC,EAAE,IAAI,GAAG,GAAG,EACtB,aAAa,UAAO,EACpB,cAAc,CAAC,EAAE,UAAU,GAC1B,GAAG,GAAG,SAAS,CAuDjB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,CAK1E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAE7D"}