isaacscript-common 6.6.1-dev.1 → 6.6.1-dev.5

package/functions/rooms.lua

@@ -1,494 +0,0 @@
-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
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZnVuY3Rpb25zL3Jvb21zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSw2Q0FpQk87QUFoQkw7QUFFQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFHQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFFRiwwQkFBaUM7QUFBeEI7QUFBTTtBQUNmLHNCQUlPO0FBSEw7QUFDQTtBQUNBO0FBRUYsaURBQTZEO0FBQXBEO0FBQ1QsMEJBQWdDO0FBQXZCO0FBQ1QscUNBQTZDO0FBQXBDO0FBQ1Qsa0JBS087QUFKTDtBQUNBO0FBQ0E7QUFDQTtBQUVGLG1CQUE0QjtBQUFuQjtBQUNULGlCQUF3QjtBQUFmO0FBQ1QsNkJBS087QUFKTDtBQUNBO0FBQ0E7QUFDQTtBQUVGLHFCQVVPO0FBVEw7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBRUYsc0JBQWtDO0FBQXpCO0FBQ1Qsa0JBQStCO0FBQXRCO0FBQVE7QUFzSWpCLCtEQUNFO0FBRUEsV0FBTyxDQUFDLGFBQUcsNkNBQTZDLFdBQVc7QUFIckU7Ozs7Ozs7O0FBd0JBLG9DQUNFO09BQUE7UUFBQSwrQkFBK0I7O0FBRXpCLGtCQUFRLEtBQUs7QUFDYixxQkFBVyxNQUFNO0FBRWpCLHFCQUFXLFVBQUk7T0FDakI7O0FBQ08sc0JBQUk7a0JBQUcsSUFBSTtBQUNaLHVDQUFpQixTQUFTLElBQUk7bUJBQ2hDLDBCQUFnQztvQkFDbEMsU0FBUyxJQUFJLDBCQUEwQjs7QUFIUjs7OztBQU9uQyxrQkFBVyx3QkFBaUIsWUFBTztBQUMzQixtQ0FBaUIsTUFBTSxhQUFhO2VBQ3RDO2dCQUNGLFNBQVMsSUFBSSwwQkFBMEI7Ozs7QUFLN0MsV0FBTyxDQUFDLGFBQUcsU0FBUztBQXZCdEI7O0FBbVZBLHNDQUEyQjtBQUNuQixxQkFBVyxpQkFBWTtBQUM3QixXQUFPO0FBRlQ7Ozs7QUExZUEsc0NBQTJCO0FBQ25CLGtCQUFRLEtBQUs7QUFFYixxQkFBVyxpQkFBWTtPQUN6QjtRQUNGLE9BQ0UsdURBQTJDLG1CQUFhOztBQU01RCxzQkFBa0I7SUFFbEIsS0FBSyxXQUFXO0FBZGxCOztBQW9CQTtBQUNFLFdBQU8sWUFBTztBQURoQjs7QUFLQTtBQUNRLGtCQUFRO0FBQ2QsV0FBTztRQUFBO1FBQVUsZUFBQyxnQkFBbUIsbUNBQXBCOztBQUZuQjs7O0FBU0E7QUFDUSxrQkFBUSxLQUFLO0FBQ2IsMEJBQWdCO0FBQ2hCLDRCQUFrQixNQUFNLGFBQWEsZUFBZTtBQUNwRCw0QkFBa0IsV0FBVztBQUVuQyxjQUFXLG9CQUFhO0FBQ2hCLHlDQUEyQixNQUFNLGFBQ3JDLGVBQ0E7QUFFSSxrQ0FBb0IsV0FBVztXQUVqQyxxQkFBc0I7QUFDeEIsbUJBQU87OztJQUlYLE1BQU07QUFsQlI7OztBQXlCQTtBQUNRLGtCQUFRO0FBQ2QsV0FBTztBQUZUOzs7Ozs7OztBQWNBO0FBQ1EseUJBQWUsVUFBSSxLQUFjLENBQUM7QUFFbEMsa0JBQVE7QUFDUiwwQkFBZ0I7UUFBQTtRQUNwQixlQUFDLGdCQUNDLHNDQUNBLGFBQWEsSUFBSSx5QkFGbkI7O0FBS0YsV0FBTztRQUFBO1FBQWtCLGVBQUMsZ0JBQW1CLG1DQUFwQjs7QUFWM0I7OztBQWlCQTtBQUNRLHFCQUFXLEtBQUs7QUFDaEIsaUJBQU8sS0FBSztBQUNaLHFCQUFXLEtBQUs7QUFDaEIscUJBQVcsS0FBSztBQUV0QixXQUFPLFNBQVMsZUFBZSxVQUFVO0FBTjNDOzs7O0FBY0EsNENBQWlDO0FBQ3pCLDJCQUFpQix1QkFBa0I7T0FHdkMsK0JBQStCLEtBQy9CLCtCQUErQjtBQUUvQixlQUFPOztBQUdILHFCQUFXO09BQ2I7QUFDRixlQUFPOztBQUdILHNCQUFZO0FBQ1osNEJBQWtCLHFEQUFvQztBQUN0RCx3QkFBYztRQUFBO1FBQ2xCLGVBQUMsZ0JBQW1CLHNDQUErQixjQUFuRDs7QUFFRixXQUFPO1FBQUE7UUFBbUIsZUFBQyxXQUFjLG1DQUFXLFVBQTFCOztBQXBCNUI7Ozs7QUFrQ0EsMkNBQWdDO0FBQzlCLFdBQU8sZ0JBQWdCO0FBRHpCOzs7Ozs7OztBQWdEQSwwQ0FDRTtPQUFBO1FBQUEsK0JBQStCOztBQUV6QixrQkFBUSwwQkFBUztBQUN2QixXQUFPO1FBQUE7UUFBYSxlQUFDLGdCQUFtQix1Q0FBZ0MsQ0FBcEQ7O0FBSnRCOzs7Ozs7QUFjQSwrQ0FBb0M7QUFDNUIsa0JBQVEsS0FBSztBQUViLHFCQUFXLFVBQUk7QUFDckIsY0FBVyx3QkFBaUIsWUFBTztBQUMzQiwrQkFBaUIsTUFBTSxhQUFhLGVBQWU7V0FDckQ7WUFDRixTQUFTLElBQUksMEJBQTBCOzs7QUFJM0MsV0FBTyxDQUFDLGFBQUcsU0FBUztBQVh0Qjs7O0FBa0JBO0FBQ1EsaUJBQU8sS0FBSztBQUNaLHNCQUFZLEtBQUs7QUFFdkIsV0FBTyxhQUFjLHVCQUF1QixhQUFjO0FBSjVEO0FBT0E7QUFDUSxpQkFBTyxLQUFLO0FBQ1oscUJBQVcsS0FBSztBQUNoQix3QkFBYztBQUdwQixXQUFPLFlBQWEsbUJBQWtCLGVBQWdCO0FBTnhEO0FBU0E7QUFDUSxpQkFBTyxLQUFLO0FBQ1oscUJBQVcsS0FBSztBQUNoQix3QkFBYztBQUVwQixXQUVFLFlBQWEscUJBQW9CLGVBQWdCO0FBUHJEOzs7QUFlQSx3Q0FBNkI7QUFDckIsaUJBQU8sS0FBSztBQUNaLHFCQUFXLEtBQUs7QUFDaEIsd0JBQWM7QUFDZCx3QkFBYztBQUVwQixXQUNFLFlBQWEsa0JBQ2IsZUFBZ0IsMEJBQ2hCLGVBQWdCO0FBVHBCOzs7O0FBa0JBO0FBQ1EsaUJBQU8sS0FBSztBQUNaLHFCQUFXLEtBQUs7QUFDaEIsd0JBQWM7QUFHcEIsV0FBTyxZQUFhLHFCQUFvQixlQUFnQjtBQU4xRDs7O0FBYUE7QUFDUSx3QkFBYztBQUNkLHdCQUFjO0FBRXBCLFdBQ0UsZUFBZ0IsaUJBRWYsZ0JBQWdCLDhDQUVmLGVBQWdCO0FBVHRCOzs7O0FBa0JBO0FBQ1EsMkJBQWlCO0FBQ3ZCLFdBQU8sYUFBUSxzQkFBc0I7QUFGdkM7QUFLQSx1Q0FBNEI7QUFDMUIsV0FBTyxhQUFjO0FBRHZCO0FBSUE7QUFDUSxpQkFBTyxLQUFLO0FBQ1oscUJBQVcsS0FBSztBQUNoQixxQkFBVztBQUVqQixXQUFPLFlBQWEsa0JBQWlCLCtCQUFrQjtBQUx6RDtBQVFBO0FBQ1EsMEJBQWdCO0FBR3RCLFdBQU8saUJBQWtCO0FBSjNCOztBQVFBO0FBQ1EsaUJBQU8sS0FBSztBQUNaLHNCQUFZLEtBQUs7QUFFdkIsV0FDRSxhQUFjLGlCQUNkLGFBQWMsaUJBQ2QsYUFBYyxpQkFDZCxhQUFjO0FBUmxCO0FBWUE7QUFDUSwwQkFBZ0I7QUFHdEIsV0FBTyxpQkFBa0I7QUFKM0I7OztBQVdBO0FBQ1Esd0JBQWM7QUFDZCx3QkFBYztBQUVwQixXQUNFLENBQUMsZUFBZ0IsaUJBQWlCLGVBQWdCLG9CQUVsRCw2QkFBNkIsSUFBSTtBQVByQzs7O0FBZUEsNENBQWlDO0FBQ3pCLGlCQUFPLEtBQUs7QUFDWixxQkFBVyxLQUFLO0FBQ2hCLHdCQUFjO0FBQ2Qsd0JBQWM7QUFFcEIsV0FDRSxZQUFhLHVCQUNiLGVBQWdCLDBCQUNoQixlQUFnQjtBQVRwQjs7Ozs7O0FBb0JBO0FBQ1EsMEJBQWdCO0FBR3RCLFdBQU8saUJBQWtCO0FBSjNCOzs7O0FBWUE7QUFDUSxrQkFBUSxLQUFLO0FBQ2Isa0NBQXdCLE1BQU07QUFDOUIsMEJBQWdCO0FBRXRCLFdBQU8saUJBQWtCLDBCQUF5Qiw2QkFBWTtBQUxoRTs7Ozs7Ozs7QUFpQkEsMkNBQWdDO0FBRTVCO09BQUE7QUFBbUM7O0FBQU8sK0JBQUksS0FBSTs7QUFEOUM7QUFFQSxrQkFBUTtBQUNSLDBCQUNKLHFCQUFzQixRQUNsQixTQUNBO1FBQUE7UUFDRSxlQUFDLGdCQUNDLHNDQUNBLGtCQUFrQixJQUFJLHlCQUZ4Qjs7QUFLUixXQUFPO1FBQUE7UUFBb0IsZUFBQyxnQkFBbUIsMkJBQXBCOztBQWI3QjtBQWdCQSxzREFDRSxVQUNBO0FBRU0seUJBQWUseUJBQW9CO0FBQ3pDLFdBQU8sYUFBYSxJQUFJO0FBTDFCO0FBUUEsZ0VBQ0UsVUFDQTtBQUVNLHFDQUEyQiw0Q0FDL0IsVUFDQTtXQUVHO0FBQ0gsZUFBTzs7QUFHSCxzQkFBWSxrQkFBYTtPQUMzQjtBQUNGLGVBQU87O0FBR0gsa0JBQVEsdUJBQWtCLFdBQVc7T0FDdkM7QUFDRixlQUFPOztBQUdILDZCQUFtQixnQkFBZ0I7QUFDekMsV0FDRSxJQUFDLDRCQUFXLHNCQUNaLG9CQUFvQixNQUNwQixvQkFBb0I7QUExQnhCOzs7OztBQW9DQSx3Q0FBNkI7QUFDckIsMkJBQWlCLHVCQUFrQjtBQUN6QyxXQUFPLGFBQVEsc0JBQXNCO0FBRnZDOzs7OztBQVdBLDJDQUFnQztPQUMxQjtBQUNGLHdCQUFnQjs7QUFHbEIsV0FBTyxpQkFBaUI7QUFMMUI7Ozs7QUFtQkEsNkNBQWtDO0FBQzFCLGNBQUksZ0JBQWdCO0FBQ3BCLGNBQUksV0FBVyxnQkFBZ0I7QUFFckMsV0FBTyxDQUFDLEdBQUc7QUFKYjs7Ozs7QUFhQTtBQUNRLGlCQUFPLEtBQUs7QUFDWixxQkFBVztBQUVYLDRCQUFrQix3QkFBbUI7QUFDckMsNkJBQW1CLHlCQUFvQjtJQUU3QyxLQUFLO0lBRUwsd0JBQW1CLGlCQUFpQjtJQUNwQyx5QkFBb0Isa0JBQWtCO0FBVnhDOzs7O0FBa0JBO0FBQ1EsaUJBQU8sS0FBSztBQUNaLHNCQUFZLEtBQUs7T0FHbkI7QUFDRjs7SUFHRixLQUFLLFNBQVM7QUFFZCxjQUFXLGVBQVE7O2VBQ2IsNEJBQXVCO0FBQ3pCOztZQUtGLGtCQUFhO0FBSWIsZ0NBQW9COzs7O0lBR3RCLFdBQVcsS0FBSztJQUloQixLQUFLLFlBQVk7QUE3Qm5COzs7QUFvQ0E7QUFDUSxpQkFBTyxLQUFLO0lBRWxCLEtBQUssU0FBUztJQUNkO0FBSkY7Ozs7Ozs7Ozs7QUFrQkEsb0NBQ0UsZUFDQSxXQUNBO09BREE7UUFBQSxZQUFZOztPQUNaO1FBQUEscUJBQXFCOztBQUVmLGtCQUFRLEtBQUs7QUFFYixxQkFBVyxpQkFBWTtPQUN6QjtRQUNGLE9BQ0UsdURBQTJDLG1CQUFhOztBQU01RCxzQkFBa0I7SUFFbEIsS0FBSyxvQkFBb0IsZUFBZSxXQUFXO0FBbEJyRCIsImZpbGUiOiJyb29tcy5sdWEiLCJzb3VyY2VSb290IjoiIn0=

package/functions/run.d.ts

@@ -1,22 +0,0 @@
-import { PlayerType } from "isaac-typescript-definitions";
-/**
- * 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 declare function onSetSeed(): boolean;
-/**
- * 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 declare function restart(character?: PlayerType): void;
-/**
- * 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 declare function setUnseeded(): void;

package/functions/run.lua

@@ -1,50 +0,0 @@
-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
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZnVuY3Rpb25zL3J1bi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsNkNBQXNDO0FBQTdCO0FBQVc7QUFDcEIsMEJBQXFCO0FBQVo7QUFDVCwrQkFBZ0M7QUFBdkI7QUFDVCxnQkFBb0I7QUFBWDs7OztBQU9UO0FBQ1Esa0JBQVEsS0FBSztBQUNiLHNCQUFZLE1BQU07QUFDbEIsc0JBQVk7QUFFbEIsV0FBTyxhQUFjLG1CQUFrQjtBQUx6Qzs7Ozs7O0FBZUEsbUNBQXdCO09BQ2xCO0FBQ0ksd0JBQVU7UUFDaEIsSUFBSSxvREFBaUQ7UUFDckQscUJBQXFCO0FBQ3JCOztPQUdFLFlBQVk7UUFDZCxPQUFNLDRDQUFnQyxlQUFTOztBQUczQyxvQkFBVSx1QkFBVztJQUMzQixRQUNFLGdEQUFvQyxXQUFXLGdCQUFVLGtCQUFLLGVBQVMsb0NBQWdDO0lBRXpHLHFCQUFxQjtBQWhCdkI7Ozs7O0FBeUJBO0FBQ1Esa0JBQVEsS0FBSztJQU9uQixNQUFNO0lBQ04sTUFBTSxRQUFRO0FBVGhCIiwiZmlsZSI6InJ1bi5sdWEiLCJzb3VyY2VSb290IjoiIn0=

package/functions/saveFile.d.ts

@@ -1,15 +0,0 @@
-import { CollectibleType, ItemPoolType } from "isaac-typescript-definitions";
-/**
- * Helper function to see if the given collectible is unlocked on the player's save file. This
- * requires providing the corresponding item pool that the collectible is located in.
- *
- * - If any player currently has the item, then it is assumed to be unlocked. (This is because Eden
- *   may have randomly started with the provided collectible, and it will be subsequently removed
- *   from all pools.)
- * - If the collectible is located in more than one item pool, then any item pool can be provided.
- * - If the collectible is not located in any item pools, then this function will always return
- *   false.
- * - If any player is Tainted Lost, they will be temporarily changed to Isaac and then temporarily
- *   changed back (because Tainted Lost is not able to retrieve some collectibles from item pools).
- */
-export declare function isCollectibleUnlocked(collectibleTypeToCheckFor: CollectibleType, itemPoolToCheckFor: ItemPoolType): boolean;