isaacscript-common 6.6.1-dev.2 → 6.6.1-dev.4

package/dist/functions/rooms.lua

@@ -0,0 +1,492 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__Spread = ____lualib.__TS__Spread
+local Map = ____lualib.Map
+local __TS__StringIncludes = ____lualib.__TS__StringIncludes
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local AngelRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.AngelRoomSubType
+local Dimension = ____isaac_2Dtypescript_2Ddefinitions.Dimension
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+local DungeonSubType = ____isaac_2Dtypescript_2Ddefinitions.DungeonSubType
+local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
+local HomeRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.HomeRoomSubType
+local RoomDescriptorFlag = ____isaac_2Dtypescript_2Ddefinitions.RoomDescriptorFlag
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+local RoomTransitionAnim = ____isaac_2Dtypescript_2Ddefinitions.RoomTransitionAnim
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
+local StageID = ____isaac_2Dtypescript_2Ddefinitions.StageID
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local sfxManager = ____cachedClasses.sfxManager
+local ____constants = require("constants")
+local LEVEL_GRID_ROW_WIDTH = ____constants.LEVEL_GRID_ROW_WIDTH
+local MAX_LEVEL_GRID_INDEX = ____constants.MAX_LEVEL_GRID_INDEX
+local NUM_DIMENSIONS = ____constants.NUM_DIMENSIONS
+local ____roomShapeToDoorSlotsToGridIndexDelta = require("objects.roomShapeToDoorSlotsToGridIndexDelta")
+local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToDoorSlotsToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
+local ____roomTypeNames = require("objects.roomTypeNames")
+local ROOM_TYPE_NAMES = ____roomTypeNames.ROOM_TYPE_NAMES
+local ____mineShaftRoomSubTypesSet = require("sets.mineShaftRoomSubTypesSet")
+local MINE_SHAFT_ROOM_SUB_TYPE_SET = ____mineShaftRoomSubTypesSet.MINE_SHAFT_ROOM_SUB_TYPE_SET
+local ____doors = require("functions.doors")
+local closeAllDoors = ____doors.closeAllDoors
+local getDoors = ____doors.getDoors
+local isHiddenSecretRoomDoor = ____doors.isHiddenSecretRoomDoor
+local openDoorFast = ____doors.openDoorFast
+local ____entity = require("functions.entity")
+local getEntities = ____entity.getEntities
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____positionVelocity = require("functions.positionVelocity")
+local getEntityPositions = ____positionVelocity.getEntityPositions
+local getEntityVelocities = ____positionVelocity.getEntityVelocities
+local setEntityPositions = ____positionVelocity.setEntityPositions
+local setEntityVelocities = ____positionVelocity.setEntityVelocities
+local ____roomData = require("functions.roomData")
+local getRoomAllowedDoors = ____roomData.getRoomAllowedDoors
+local getRoomData = ____roomData.getRoomData
+local getRoomDescriptor = ____roomData.getRoomDescriptor
+local getRoomDescriptorReadOnly = ____roomData.getRoomDescriptorReadOnly
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+local getRoomName = ____roomData.getRoomName
+local getRoomShape = ____roomData.getRoomShape
+local getRoomStageID = ____roomData.getRoomStageID
+local getRoomSubType = ____roomData.getRoomSubType
+local ____roomShape = require("functions.roomShape")
+local getGridIndexDelta = ____roomShape.getGridIndexDelta
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
+local irange = ____utils.irange
+function ____exports.getRoomShapeNeighborGridIndexDeltas(self, roomShape)
+    return {__TS__Spread(ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]:values())}
+end
+--- Helper function to get the room descriptor for every room on the level, including off-grid rooms.
+-- Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be
+-- non-existent and are not added to the list.
+-- 
+-- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
+-- extra-dimensional rooms are automatically generated and can be
+-- seen when you iterate over the `RoomList`. Default is false.
+function ____exports.getRooms(self, includeExtraDimensionalRooms)
+    if includeExtraDimensionalRooms == nil then
+        includeExtraDimensionalRooms = false
+    end
+    local level = game:GetLevel()
+    local roomList = level:GetRooms()
+    local roomsMap = __TS__New(Map)
+    if includeExtraDimensionalRooms then
+        do
+            local i = 0
+            while i < roomList.Size do
+                local roomDescriptor = roomList:Get(i)
+                if roomDescriptor ~= nil and roomDescriptor.Data ~= nil then
+                    roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
+                end
+                i = i + 1
+            end
+        end
+    else
+        for ____, roomGridIndex in ipairs(irange(nil, MAX_LEVEL_GRID_INDEX)) do
+            local roomDescriptor = level:GetRoomByIdx(roomGridIndex)
+            if roomDescriptor.Data ~= nil then
+                roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
+            end
+        end
+    end
+    return {__TS__Spread(roomsMap:values())}
+end
+--- Helper function to check if a room exists at the given room grid index.
+function ____exports.roomExists(self, roomGridIndex)
+    local roomData = getRoomData(nil, roomGridIndex)
+    return roomData ~= nil
+end
+--- Helper function for quickly switching to a new room without playing a particular animation. Use
+-- this helper function over invoking the `Game.ChangeRoom` method directly to ensure that you do
+-- not forget to set the `LeaveDoor` property and to prevent crashing on invalid room grid indexes.
+function ____exports.changeRoom(self, roomGridIndex)
+    local level = game:GetLevel()
+    local roomData = getRoomData(nil, roomGridIndex)
+    if roomData == nil then
+        error(("Failed to change the room to grid index " .. tostring(roomGridIndex)) .. " because that room does not exist.")
+    end
+    level.LeaveDoor = DoorSlot.NO_DOOR_SLOT
+    game:ChangeRoom(roomGridIndex)
+end
+--- Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
+function ____exports.getAllDimensions(self)
+    return erange(nil, NUM_DIMENSIONS)
+end
+--- Helper function to get the grid index for every room on the entire floor.
+function ____exports.getAllRoomGridIndexes(self)
+    local rooms = ____exports.getRooms(nil)
+    return __TS__ArrayMap(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
+    )
+end
+--- 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.
+function ____exports.getDimension(self)
+    local level = game:GetLevel()
+    local roomGridIndex = getRoomGridIndex(nil)
+    local roomDescription = level:GetRoomByIdx(roomGridIndex, Dimension.CURRENT)
+    local currentRoomHash = GetPtrHash(roomDescription)
+    for ____, dimension in ipairs(____exports.getAllDimensions(nil)) do
+        local dimensionRoomDescription = level:GetRoomByIdx(roomGridIndex, dimension)
+        local dimensionRoomHash = GetPtrHash(dimensionRoomDescription)
+        if dimensionRoomHash == currentRoomHash then
+            return dimension
+        end
+    end
+    error("Failed to get the current dimension.")
+end
+--- Helper function to get the number of rooms that are currently on the floor layout. This does not
+-- include off-grid rooms, like the Devil Room.
+function ____exports.getNumRooms(self)
+    local rooms = ____exports.getRooms(nil)
+    return #rooms
+end
+--- Helper function to get an array of all of the safe grid indexes for rooms that match the
+-- specified room type.
+-- 
+-- This function only searches through rooms in the current dimension.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to get the combined grid
+-- indexes for N room types.
+function ____exports.getRoomGridIndexesForType(self, ...)
+    local roomTypesSet = __TS__New(Set, {...})
+    local rooms = ____exports.getRooms(nil)
+    local matchingRooms = __TS__ArrayFilter(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypesSet:has(roomDescriptor.Data.Type) end
+    )
+    return __TS__ArrayMap(
+        matchingRooms,
+        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
+    )
+end
+--- Helper function to get the item pool type for the current room. For example, this returns
+-- `ItemPoolType.ItemPoolType.POOL_ANGEL` if you are in an Angel Room.
+function ____exports.getRoomItemPoolType(self)
+    local itemPool = game:GetItemPool()
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local roomSeed = room:GetSpawnSeed()
+    return itemPool:GetPoolForRoom(roomType, roomSeed)
+end
+--- Helper function to get the grid indexes of all the rooms connected to the given room index.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.getRoomNeighbors(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    if roomDescriptor.SafeGridIndex < 0 or roomDescriptor.SafeGridIndex > MAX_LEVEL_GRID_INDEX then
+        return {}
+    end
+    local roomData = roomDescriptor.Data
+    if roomData == nil then
+        return {}
+    end
+    local roomShape = roomData.Shape
+    local gridIndexDeltas = ____exports.getRoomShapeNeighborGridIndexDeltas(nil, roomShape)
+    local gridIndexes = __TS__ArrayMap(
+        gridIndexDeltas,
+        function(____, gridIndexDelta) return roomDescriptor.SafeGridIndex + gridIndexDelta end
+    )
+    return __TS__ArrayFilter(
+        gridIndexes,
+        function(____, gridIndex) return ____exports.roomExists(nil, gridIndex) end
+    )
+end
+--- Helper function to get the proper name of a room type.
+-- 
+-- For example, `RoomType.TREASURE` will return "Treasure Room".
+function ____exports.getRoomTypeName(self, roomType)
+    return ROOM_TYPE_NAMES[roomType]
+end
+--- Helper function to get the room descriptor for every room on the level except for rooms that are
+-- not on the grid. Uses the `Level.GetRooms` method to accomplish this. Rooms without data are
+-- assumed to be non-existent and are not added to the list.
+-- 
+-- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
+-- extra-dimensional rooms are automatically be generated and can be
+-- seen when you iterate over the `RoomList`. Default is false.
+function ____exports.getRoomsInGrid(self, includeExtraDimensionalRooms)
+    if includeExtraDimensionalRooms == nil then
+        includeExtraDimensionalRooms = false
+    end
+    local rooms = ____exports.getRooms(nil, includeExtraDimensionalRooms)
+    return __TS__ArrayFilter(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex >= 0 end
+    )
+end
+--- Helper function to get the room descriptor for every room on the level in a specific dimension.
+-- Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be
+-- non-existent and are not added to the list.
+-- 
+-- @returns A map of room ListIndex to RoomDescriptor.
+function ____exports.getRoomsOfDimension(self, dimension)
+    local level = game:GetLevel()
+    local roomsMap = __TS__New(Map)
+    for ____, roomGridIndex in ipairs(irange(nil, MAX_LEVEL_GRID_INDEX)) do
+        local roomDescriptor = level:GetRoomByIdx(roomGridIndex, dimension)
+        if roomDescriptor.Data ~= nil then
+            roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
+        end
+    end
+    return {__TS__Spread(roomsMap:values())}
+end
+--- Helper function to determine if the current room shape is equal to `RoomShape.1x2` or
+-- `RoomShape.2x1`.
+function ____exports.in2x1Room(self)
+    local room = game:GetRoom()
+    local roomShape = room:GetRoomShape()
+    return roomShape == RoomShape.SHAPE_1x2 or roomShape == RoomShape.SHAPE_2x1
+end
+function ____exports.inAngelShop(self)
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local roomSubType = getRoomSubType(nil)
+    return roomType == RoomType.ANGEL and roomSubType == AngelRoomSubType.SHOP
+end
+function ____exports.inBeastRoom(self)
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local roomSubType = getRoomSubType(nil)
+    return roomType == RoomType.DUNGEON and roomSubType == DungeonSubType.BEAST_ROOM
+end
+--- Helper function to check if the current room is a boss room for a particular boss. This will only
+-- work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
+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 == bossID
+end
+--- Helper function for determining whether the current room is a crawl space. Use this function over
+-- comparing to `RoomType.DUNGEON` or `GridRoom.DUNGEON_IDX` since there is a special case of the
+-- player being in a boss fight that take place in a dungeon.
+function ____exports.inCrawlSpace(self)
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local roomSubType = getRoomSubType(nil)
+    return roomType == RoomType.DUNGEON and roomSubType == DungeonSubType.NORMAL
+end
+--- We cannot use the standard code in the `inDimension` function for this purpose since it is bugged
+-- with the Death Certificate area.
+function ____exports.inDeathCertificateArea(self)
+    local roomStageID = getRoomStageID(nil)
+    local roomSubType = getRoomSubType(nil)
+    return roomStageID == StageID.HOME and (roomSubType == HomeRoomSubType.DEATH_CERTIFICATE_ENTRANCE or roomSubType == HomeRoomSubType.DEATH_CERTIFICATE_ITEMS)
+end
+--- Helper function to detect if the current room is a Treasure Room created when entering with a
+-- Devil's Crown trinket. Under the hood, this checks for the `RoomDescriptorFlag.DEVIL_TREASURE`
+-- flag.
+function ____exports.inDevilsCrownTreasureRoom(self)
+    local roomDescriptor = getRoomDescriptorReadOnly(nil)
+    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.DEVIL_TREASURE)
+end
+function ____exports.inDimension(self, dimension)
+    return dimension == ____exports.getDimension(nil)
+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")
+end
+function ____exports.inGenesisRoom(self)
+    local roomGridIndex = getRoomGridIndex(nil)
+    return roomGridIndex == GridRoom.GENESIS
+end
+--- Helper function to determine if the current room shape is one of the four L room shapes.
+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
+end
+function ____exports.inMegaSatanRoom(self)
+    local roomGridIndex = getRoomGridIndex(nil)
+    return roomGridIndex == GridRoom.MEGA_SATAN
+end
+--- Helper function to determine if the current room is part of the Repentance "escape sequence" in
+-- the Mines/Ashpit.
+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)
+end
+--- Helper function to check if the current room is a miniboss room for a particular miniboss. This
+-- will only work for mini-bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
+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 == minibossID
+end
+--- Helper function for checking if the room is a secret shop (from the Member Card collectible).
+-- 
+-- Secret shops are simply copies of normal shops, but with the backdrop of a secret room. In other
+-- words, they will have the same room type, room variant, and room sub-type of a normal shop. Thus,
+-- the only way to detect them is by using the grid index.
+function ____exports.inSecretShop(self)
+    local roomGridIndex = getRoomGridIndex(nil)
+    return roomGridIndex == GridRoom.SECRET_SHOP
+end
+--- Helper function to determine whether or not the current room is the starting room of a floor. It
+-- only returns true for the starting room of the primary dimension (meaning that being in the
+-- starting room of the mirror world does not count).
+function ____exports.inStartingRoom(self)
+    local level = game:GetLevel()
+    local startingRoomGridIndex = level:GetStartingRoomIndex()
+    local roomGridIndex = getRoomGridIndex(nil)
+    return roomGridIndex == startingRoomGridIndex and ____exports.inDimension(nil, Dimension.MAIN)
+end
+--- Helper function to loop through every room on the floor and see if it has been cleared.
+-- 
+-- This function will only check rooms in the current dimension.
+-- 
+-- @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
+-- the array will be ignored. If not specified, then all rooms will be
+-- checked. Undefined by default.
+function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
+    local ____temp_0
+    if onlyCheckRoomTypes == nil then
+        ____temp_0 = nil
+    else
+        ____temp_0 = __TS__New(Set, onlyCheckRoomTypes)
+    end
+    local roomTypeWhitelist = ____temp_0
+    local rooms = ____exports.getRooms(nil)
+    local matchingRooms = roomTypeWhitelist == nil and rooms or __TS__ArrayFilter(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypeWhitelist:has(roomDescriptor.Data.Type) end
+    )
+    return __TS__ArrayEvery(
+        matchingRooms,
+        function(____, roomDescriptor) return roomDescriptor.Clear end
+    )
+end
+function ____exports.isDoorSlotValidAtGridIndex(self, doorSlot, roomGridIndex)
+    local allowedDoors = getRoomAllowedDoors(nil, roomGridIndex)
+    return allowedDoors:has(doorSlot)
+end
+function ____exports.isDoorSlotValidAtGridIndexForRedRoom(self, doorSlot, roomGridIndex)
+    local doorSlotValidAtGridIndex = ____exports.isDoorSlotValidAtGridIndex(nil, doorSlot, roomGridIndex)
+    if not doorSlotValidAtGridIndex then
+        return false
+    end
+    local roomShape = getRoomShape(nil, roomGridIndex)
+    if roomShape == nil then
+        return false
+    end
+    local delta = getGridIndexDelta(nil, roomShape, doorSlot)
+    if delta == nil then
+        return false
+    end
+    local redRoomGridIndex = roomGridIndex + delta
+    return not ____exports.roomExists(nil, redRoomGridIndex) and redRoomGridIndex >= 0 and redRoomGridIndex <= MAX_LEVEL_GRID_INDEX
+end
+--- Helper function to detect if the provided room was created by the Red Key item. Under the hood,
+-- this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.isRedKeyRoom(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
+end
+--- Helper function to determine if the provided room is part of the floor layout. For example, Devil
+-- Rooms and the Mega Satan room are not considered to be inside the map.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.isRoomInsideMap(self, roomGridIndex)
+    if roomGridIndex == nil then
+        roomGridIndex = getRoomGridIndex(nil)
+    end
+    return roomGridIndex >= 0
+end
+--- Helper function to get the coordinates of a given grid index. The floor is represented by a 13x13
+-- grid. For example, since the starting room is in the center, the starting room grid index of 84
+-- be equal to coordinates of (?, ?).
+function ____exports.roomGridIndexToXY(self, roomGridIndex)
+    local x = roomGridIndex % LEVEL_GRID_ROW_WIDTH
+    local y = math.floor(roomGridIndex / LEVEL_GRID_ROW_WIDTH)
+    return {x, y}
+end
+--- If the `Room.Update` method is called in a PostNewRoom callback, then some entities will slide
+-- around (such as the player). Since those entity velocities are already at zero, setting them to
+-- zero will have no effect. Thus, a generic solution is to record all of the entity
+-- positions/velocities before updating the room, and then restore those positions/velocities.
+function ____exports.roomUpdateSafe(self)
+    local room = game:GetRoom()
+    local entities = getEntities(nil)
+    local entityPositions = getEntityPositions(nil, entities)
+    local entityVelocities = getEntityVelocities(nil, entities)
+    room:Update()
+    setEntityPositions(nil, entityPositions, entities)
+    setEntityVelocities(nil, entityVelocities, entities)
+end
+--- Helper function to convert an uncleared room to a cleared room in the PostNewRoom callback. This
+-- is useful because if enemies are removed in this callback, a room drop will be awarded and the
+-- doors will start closed and then open.
+function ____exports.setRoomCleared(self)
+    local room = game:GetRoom()
+    local roomClear = room:IsClear()
+    if roomClear then
+        return
+    end
+    room:SetClear(true)
+    for ____, door in ipairs(getDoors(nil)) do
+        do
+            if isHiddenSecretRoomDoor(nil, door) then
+                goto __continue69
+            end
+            openDoorFast(nil, door)
+            door.ExtraVisible = false
+        end
+        ::__continue69::
+    end
+    sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
+    game:ShakeScreen(0)
+end
+--- Helper function to emulate what happens when you bomb an Angel Statue or push a Reward Plate that
+-- spawns an NPC.
+function ____exports.setRoomUncleared(self)
+    local room = game:GetRoom()
+    room:SetClear(false)
+    closeAllDoors(nil)
+end
+--- Helper function to change the current room. It can be used for both teleportation and "normal"
+-- room transitions, depending on what is passed for the `direction` and `roomTransitionAnim`
+-- arguments. Use this function instead of invoking the `Game.StartRoomTransition` method directly
+-- so that you do not forget to set `Level.LeaveDoor` property and to prevent crashing on invalid
+-- room grid indexes.
+-- 
+-- @param roomGridIndex The room grid index of the destination room.
+-- @param direction Optional. Default is `Direction.NO_DIRECTION`.
+-- @param roomTransitionAnim Optional. Default is `RoomTransitionAnim.TELEPORT`.
+function ____exports.teleport(self, roomGridIndex, direction, roomTransitionAnim)
+    if direction == nil then
+        direction = Direction.NO_DIRECTION
+    end
+    if roomTransitionAnim == nil then
+        roomTransitionAnim = RoomTransitionAnim.TELEPORT
+    end
+    local level = game:GetLevel()
+    local roomData = getRoomData(nil, roomGridIndex)
+    if roomData == nil then
+        error(("Failed to change the room to grid index " .. tostring(roomGridIndex)) .. " because that room does not exist.")
+    end
+    level.LeaveDoor = DoorSlot.NO_DOOR_SLOT
+    game:StartRoomTransition(roomGridIndex, direction, roomTransitionAnim)
+end
+return ____exports

package/dist/functions/rooms.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/rooms.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,6CAiBO;AAhBL;AAEA;AACA;AACA;AACA;AACA;AACA;AAGA;AACA;AACA;AACA;AACA;AACA;AAEF,0BAAiC;AAAxB;AAAM;AACf,sBAIO;AAHL;AACA;AACA;AAEF,iDAA6D;AAApD;AACT,0BAAgC;AAAvB;AACT,qCAA6C;AAApC;AACT,kBAKO;AAJL;AACA;AACA;AACA;AAEF,mBAA4B;AAAnB;AACT,iBAAwB;AAAf;AACT,6BAKO;AAJL;AACA;AACA;AACA;AAEF,qBAUO;AATL;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEF,sBAAkC;AAAzB;AACT,kBAA+B;AAAtB;AAAQ;AAsIjB,+DACE;AAEA,WAAO,CAAC,aAAG,6CAA6C,WAAW;AAHrE;;;;;;;;AAwBA,oCACE;OAAA;QAAA,+BAA+B;;AAEzB,kBAAQ,KAAK;AACb,qBAAW,MAAM;AAEjB,qBAAW,UAAI;OACjB;;AACO,sBAAI;kBAAG,IAAI;AACZ,uCAAiB,SAAS,IAAI;mBAChC,0BAAgC;oBAClC,SAAS,IAAI,0BAA0B;;AAHR;;;;AAOnC,kBAAW,wBAAiB,YAAO;AAC3B,mCAAiB,MAAM,aAAa;eACtC;gBACF,SAAS,IAAI,0BAA0B;;;;AAK7C,WAAO,CAAC,aAAG,SAAS;AAvBtB;;AAmVA,sCAA2B;AACnB,qBAAW,iBAAY;AAC7B,WAAO;AAFT;;;;AA1eA,sCAA2B;AACnB,kBAAQ,KAAK;AAEb,qBAAW,iBAAY;OACzB;QACF,OACE,uDAA2C,mBAAa;;AAM5D,sBAAkB;IAElB,KAAK,WAAW;AAdlB;;AAoBA;AACE,WAAO,YAAO;AADhB;;AAKA;AACQ,kBAAQ;AACd,WAAO;QAAA;QAAU,eAAC,gBAAmB,mCAApB;;AAFnB;;;AASA;AACQ,kBAAQ,KAAK;AACb,0BAAgB;AAChB,4BAAkB,MAAM,aAAa,eAAe;AACpD,4BAAkB,WAAW;AAEnC,cAAW,oBAAa;AAChB,yCAA2B,MAAM,aACrC,eACA;AAEI,kCAAoB,WAAW;WAEjC,qBAAsB;AACxB,mBAAO;;;IAIX,MAAM;AAlBR;;;AAyBA;AACQ,kBAAQ;AACd,WAAO;AAFT;;;;;;;;AAcA;AACQ,yBAAe,UAAI,KAAc,CAAC;AAElC,kBAAQ;AACR,0BAAgB;QAAA;QACpB,eAAC,gBACC,sCACA,aAAa,IAAI,yBAFnB;;AAKF,WAAO;QAAA;QAAkB,eAAC,gBAAmB,mCAApB;;AAV3B;;;AAiBA;AACQ,qBAAW,KAAK;AAChB,iBAAO,KAAK;AACZ,qBAAW,KAAK;AAChB,qBAAW,KAAK;AAEtB,WAAO,SAAS,eAAe,UAAU;AAN3C;;;;AAcA,4CAAiC;AACzB,2BAAiB,uBAAkB;OAGvC,+BAA+B,KAC/B,+BAA+B;AAE/B,eAAO;;AAGH,qBAAW;OACb;AACF,eAAO;;AAGH,sBAAY;AACZ,4BAAkB,qDAAoC;AACtD,wBAAc;QAAA;QAClB,eAAC,gBAAmB,sCAA+B,cAAnD;;AAEF,WAAO;QAAA;QAAmB,eAAC,WAAc,mCAAW,UAA1B;;AApB5B;;;;AAkCA,2CAAgC;AAC9B,WAAO,gBAAgB;AADzB;;;;;;;;AAgDA,0CACE;OAAA;QAAA,+BAA+B;;AAEzB,kBAAQ,0BAAS;AACvB,WAAO;QAAA;QAAa,eAAC,gBAAmB,uCAAgC,CAApD;;AAJtB;;;;;;AAcA,+CAAoC;AAC5B,kBAAQ,KAAK;AAEb,qBAAW,UAAI;AACrB,cAAW,wBAAiB,YAAO;AAC3B,+BAAiB,MAAM,aAAa,eAAe;WACrD;YACF,SAAS,IAAI,0BAA0B;;;AAI3C,WAAO,CAAC,aAAG,SAAS;AAXtB;;;AAkBA;AACQ,iBAAO,KAAK;AACZ,sBAAY,KAAK;AAEvB,WAAO,aAAc,uBAAuB,aAAc;AAJ5D;AAOA;AACQ,iBAAO,KAAK;AACZ,qBAAW,KAAK;AAChB,wBAAc;AAGpB,WAAO,YAAa,mBAAkB,eAAgB;AANxD;AASA;AACQ,iBAAO,KAAK;AACZ,qBAAW,KAAK;AAChB,wBAAc;AAEpB,WAEE,YAAa,qBAAoB,eAAgB;AAPrD;;;AAeA,wCAA6B;AACrB,iBAAO,KAAK;AACZ,qBAAW,KAAK;AAChB,wBAAc;AACd,wBAAc;AAEpB,WACE,YAAa,kBACb,eAAgB,0BAChB,eAAgB;AATpB;;;;AAkBA;AACQ,iBAAO,KAAK;AACZ,qBAAW,KAAK;AAChB,wBAAc;AAGpB,WAAO,YAAa,qBAAoB,eAAgB;AAN1D;;;AAaA;AACQ,wBAAc;AACd,wBAAc;AAEpB,WACE,eAAgB,iBAEf,gBAAgB,8CAEf,eAAgB;AATtB;;;;AAkBA;AACQ,2BAAiB;AACvB,WAAO,aAAQ,sBAAsB;AAFvC;AAKA,uCAA4B;AAC1B,WAAO,aAAc;AADvB;AAIA;AACQ,iBAAO,KAAK;AACZ,qBAAW,KAAK;AAChB,qBAAW;AAEjB,WAAO,YAAa,kBAAiB,+BAAkB;AALzD;AAQA;AACQ,0BAAgB;AAGtB,WAAO,iBAAkB;AAJ3B;;AAQA;AACQ,iBAAO,KAAK;AACZ,sBAAY,KAAK;AAEvB,WACE,aAAc,iBACd,aAAc,iBACd,aAAc,iBACd,aAAc;AARlB;AAYA;AACQ,0BAAgB;AAGtB,WAAO,iBAAkB;AAJ3B;;;AAWA;AACQ,wBAAc;AACd,wBAAc;AAEpB,WACE,CAAC,eAAgB,iBAAiB,eAAgB,oBAElD,6BAA6B,IAAI;AAPrC;;;AAeA,4CAAiC;AACzB,iBAAO,KAAK;AACZ,qBAAW,KAAK;AAChB,wBAAc;AACd,wBAAc;AAEpB,WACE,YAAa,uBACb,eAAgB,0BAChB,eAAgB;AATpB;;;;;;AAoBA;AACQ,0BAAgB;AAGtB,WAAO,iBAAkB;AAJ3B;;;;AAYA;AACQ,kBAAQ,KAAK;AACb,kCAAwB,MAAM;AAC9B,0BAAgB;AAEtB,WAAO,iBAAkB,0BAAyB,6BAAY;AALhE;;;;;;;;AAiBA,2CAAgC;AAE5B;OAAA;AAAmC;;AAAO,+BAAI,KAAI;;AAD9C;AAEA,kBAAQ;AACR,0BACJ,qBAAsB,QAClB,SACA;QAAA;QACE,eAAC,gBACC,sCACA,kBAAkB,IAAI,yBAFxB;;AAKR,WAAO;QAAA;QAAoB,eAAC,gBAAmB,2BAApB;;AAb7B;AAgBA,sDACE,UACA;AAEM,yBAAe,yBAAoB;AACzC,WAAO,aAAa,IAAI;AAL1B;AAQA,gEACE,UACA;AAEM,qCAA2B,4CAC/B,UACA;WAEG;AACH,eAAO;;AAGH,sBAAY,kBAAa;OAC3B;AACF,eAAO;;AAGH,kBAAQ,uBAAkB,WAAW;OACvC;AACF,eAAO;;AAGH,6BAAmB,gBAAgB;AACzC,WACE,IAAC,4BAAW,sBACZ,oBAAoB,MACpB,oBAAoB;AA1BxB;;;;;AAoCA,wCAA6B;AACrB,2BAAiB,uBAAkB;AACzC,WAAO,aAAQ,sBAAsB;AAFvC;;;;;AAWA,2CAAgC;OAC1B;AACF,wBAAgB;;AAGlB,WAAO,iBAAiB;AAL1B;;;;AAmBA,6CAAkC;AAC1B,cAAI,gBAAgB;AACpB,cAAI,WAAW,gBAAgB;AAErC,WAAO,CAAC,GAAG;AAJb;;;;;AAaA;AACQ,iBAAO,KAAK;AACZ,qBAAW;AAEX,4BAAkB,wBAAmB;AACrC,6BAAmB,yBAAoB;IAE7C,KAAK;IAEL,wBAAmB,iBAAiB;IACpC,yBAAoB,kBAAkB;AAVxC;;;;AAkBA;AACQ,iBAAO,KAAK;AACZ,sBAAY,KAAK;OAGnB;AACF;;IAGF,KAAK,SAAS;AAEd,cAAW,eAAQ;;eACb,4BAAuB;AACzB;;YAKF,kBAAa;AAIb,gCAAoB;;;;IAGtB,WAAW,KAAK;IAIhB,KAAK,YAAY;AA7BnB;;;AAoCA;AACQ,iBAAO,KAAK;IAElB,KAAK,SAAS;IACd;AAJF;;;;;;;;;;AAkBA,oCACE,eACA,WACA;OADA;QAAA,YAAY;;OACZ;QAAA,qBAAqB;;AAEf,kBAAQ,KAAK;AAEb,qBAAW,iBAAY;OACzB;QACF,OACE,uDAA2C,mBAAa;;AAM5D,sBAAkB;IAElB,KAAK,oBAAoB,eAAe,WAAW;AAlBrD","file":"rooms.lua","sourceRoot":"../src/"}

package/dist/functions/run.js

@@ -0,0 +1,53 @@
+import { Challenge, PlayerType } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { FIRST_CHARACTER } from "../constantsFirstLast";
+import { log } from "./log";
+/**
+ * Whether or not the player is playing on a set seed (i.e. that they entered in a specific seed by
+ * pressing tab on the character selection screen). When the player resets the game on a set seed,
+ * the game will not switch to a different seed.
+ */
+export function onSetSeed() {
+    const seeds = game.GetSeeds();
+    const customRun = seeds.IsCustomRun();
+    const challenge = Isaac.GetChallenge();
+    return challenge === Challenge.NULL && customRun;
+}
+/**
+ * Helper function to restart the run using the console command of "restart". If the player is
+ * playing a seeded run, then it will restart the game to the beginning of the seed. Otherwise, it
+ * will put the player on a run with an entirely new seed.
+ *
+ * You can optionally specify a `PlayerType` to restart the game as that character.
+ */
+export function restart(character) {
+    if (character === undefined) {
+        const command = "restart";
+        log(`Restarting the run with a console command of: ${command}`);
+        Isaac.ExecuteCommand(command);
+        return;
+    }
+    if (character < FIRST_CHARACTER) {
+        error(`Restarting as a character of ${character} would crash the game.`);
+    }
+    const command = `restart ${character}`;
+    log(`Restarting the run as PlayerType.${PlayerType[character]} (${character}) with a console command of: ${command}`);
+    Isaac.ExecuteCommand(command);
+}
+/**
+ * Helper function to change the run status to that of an unseeded run with a new random seed.
+ *
+ * This is useful to revert the behavior where playing on a set and restarting the game will not
+ * take you to a new seed.
+ */
+export function setUnseeded() {
+    const seeds = game.GetSeeds();
+    // Invoking the `Seeds.Reset` method will cause the start seed to be set to 0. Subsequently, the
+    // `Seeds.GetStartSeed` method will return 0, and can cause crashes (due to RNG objects not being
+    // able to handle a seed of 0). It also causes the log to be spammed with: "[ASSERT] - Error: Game
+    // Start Seed was not set." Thus, we must immediately re-initialize the game start seed by using
+    // the `Seeds.Restart` method.
+    seeds.Reset();
+    seeds.Restart(Challenge.NULL);
+}
+//# sourceMappingURL=run.js.map

package/dist/functions/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"../src/","sources":["functions/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAE5B;;;;GAIG;AACH,MAAM,UAAU,SAAS;IACvB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IACtC,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IAEvC,OAAO,SAAS,KAAK,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC;AACnD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,SAAsB;IAC5C,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,MAAM,OAAO,GAAG,SAAS,CAAC;QAC1B,GAAG,CAAC,iDAAiD,OAAO,EAAE,CAAC,CAAC;QAChE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO;KACR;IAED,IAAI,SAAS,GAAG,eAAe,EAAE;QAC/B,KAAK,CAAC,gCAAgC,SAAS,wBAAwB,CAAC,CAAC;KAC1E;IAED,MAAM,OAAO,GAAG,WAAW,SAAS,EAAE,CAAC;IACvC,GAAG,CACD,oCAAoC,UAAU,CAAC,SAAS,CAAC,KAAK,SAAS,gCAAgC,OAAO,EAAE,CACjH,CAAC;IACF,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW;IACzB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAE9B,gGAAgG;IAChG,iGAAiG;IACjG,kGAAkG;IAClG,gGAAgG;IAChG,8BAA8B;IAC9B,KAAK,CAAC,KAAK,EAAE,CAAC;IACd,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC"}

package/dist/functions/run.lua

@@ -0,0 +1,48 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____constantsFirstLast = require("constantsFirstLast")
+local FIRST_CHARACTER = ____constantsFirstLast.FIRST_CHARACTER
+local ____log = require("functions.log")
+local log = ____log.log
+--- Whether or not the player is playing on a set seed (i.e. that they entered in a specific seed by
+-- pressing tab on the character selection screen). When the player resets the game on a set seed,
+-- the game will not switch to a different seed.
+function ____exports.onSetSeed(self)
+    local seeds = game:GetSeeds()
+    local customRun = seeds:IsCustomRun()
+    local challenge = Isaac.GetChallenge()
+    return challenge == Challenge.NULL and customRun
+end
+--- Helper function to restart the run using the console command of "restart". If the player is
+-- playing a seeded run, then it will restart the game to the beginning of the seed. Otherwise, it
+-- will put the player on a run with an entirely new seed.
+-- 
+-- You can optionally specify a `PlayerType` to restart the game as that character.
+function ____exports.restart(self, character)
+    if character == nil then
+        local command = "restart"
+        log("Restarting the run with a console command of: " .. command)
+        Isaac.ExecuteCommand(command)
+        return
+    end
+    if character < FIRST_CHARACTER then
+        error(("Restarting as a character of " .. tostring(character)) .. " would crash the game.")
+    end
+    local command = "restart " .. tostring(character)
+    log((((("Restarting the run as PlayerType." .. tostring(PlayerType[character])) .. " (") .. tostring(character)) .. ") with a console command of: ") .. command)
+    Isaac.ExecuteCommand(command)
+end
+--- Helper function to change the run status to that of an unseeded run with a new random seed.
+-- 
+-- This is useful to revert the behavior where playing on a set and restarting the game will not
+-- take you to a new seed.
+function ____exports.setUnseeded(self)
+    local seeds = game:GetSeeds()
+    seeds:Reset()
+    seeds:Restart(Challenge.NULL)
+end
+return ____exports

package/dist/functions/run.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/run.ts"],"names":[],"mappings":";AAAA,6CAAsC;AAA7B;AAAW;AACpB,0BAAqB;AAAZ;AACT,+BAAgC;AAAvB;AACT,gBAAoB;AAAX;;;;AAOT;AACQ,kBAAQ,KAAK;AACb,sBAAY,MAAM;AAClB,sBAAY;AAElB,WAAO,aAAc,mBAAkB;AALzC;;;;;;AAeA,mCAAwB;OAClB;AACI,wBAAU;QAChB,IAAI,oDAAiD;QACrD,qBAAqB;AACrB;;OAGE,YAAY;QACd,OAAM,4CAAgC,eAAS;;AAG3C,oBAAU,uBAAW;IAC3B,QACE,gDAAoC,WAAW,gBAAU,kBAAK,eAAS,oCAAgC;IAEzG,qBAAqB;AAhBvB;;;;;AAyBA;AACQ,kBAAQ,KAAK;IAOnB,MAAM;IACN,MAAM,QAAQ;AAThB","file":"run.lua","sourceRoot":"../src/"}