isaacscript-common 6.17.1 → 6.20.0

package/dist/functions/levelGrid.lua

@@ -0,0 +1,326 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local Map = ____lualib.Map
+local __TS__Iterator = ____lualib.__TS__Iterator
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ADJACENT_ROOM_GRID_INDEX_DELTAS
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DownpourRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.DownpourRoomSubType
+local MinesRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.MinesRoomSubType
+local RoomDescriptorFlag = ____isaac_2Dtypescript_2Ddefinitions.RoomDescriptorFlag
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+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 ____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 ____array = require("functions.array")
+local getRandomArrayElement = ____array.getRandomArrayElement
+local ____doors = require("functions.doors")
+local doorSlotToDoorSlotFlag = ____doors.doorSlotToDoorSlotFlag
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local ____roomData = require("functions.roomData")
+local getRoomAllowedDoors = ____roomData.getRoomAllowedDoors
+local getRoomData = ____roomData.getRoomData
+local getRoomDescriptor = ____roomData.getRoomDescriptor
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+local getRoomShape = ____roomData.getRoomShape
+local ____rooms = require("functions.rooms")
+local getRooms = ____rooms.getRooms
+local getRoomsInGrid = ____rooms.getRoomsInGrid
+local ____roomShape = require("functions.roomShape")
+local getGridIndexDelta = ____roomShape.getGridIndexDelta
+--- Helper function to get the room grid indexes that are adjacent to a given room grid index.
+-- 
+-- Adjacent room grid indexes that are outside of the grid will not be included in the returned
+-- array.
+-- 
+-- If a room grid index is provided that is outside of the grid, then an empty array will be
+-- returned.
+-- 
+-- Note that this function does not take the shape of the room into account; it only looks at a
+-- single room grid index.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.getAdjacentRoomGridIndexes(self, roomGridIndex)
+    local roomGridIndexToUse = roomGridIndex == nil and getRoomGridIndex(nil) or roomGridIndex
+    if not ____exports.isRoomGridIndexInBounds(nil, roomGridIndexToUse) then
+        return {}
+    end
+    local adjacentRoomGridIndexes = __TS__ArrayMap(
+        ADJACENT_ROOM_GRID_INDEX_DELTAS,
+        function(____, delta) return roomGridIndexToUse + delta end
+    )
+    return __TS__ArrayFilter(
+        adjacentRoomGridIndexes,
+        function(____, adjacentRoomGridIndex) return ____exports.isRoomGridIndexInBounds(nil, adjacentRoomGridIndex) end
+    )
+end
+--- 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.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns A array of tuples of `DoorSlot` and room grid index.
+function ____exports.getNewRoomCandidatesBesideRoom(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    if not ____exports.isRoomGridIndexInBounds(nil, roomDescriptor.SafeGridIndex) then
+        return {}
+    end
+    local roomData = roomDescriptor.Data
+    if roomData == nil then
+        return {}
+    end
+    local doorSlotToRoomGridIndexes = ____exports.getRoomShapeNeighborGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
+    local roomCandidates = {}
+    for ____, ____value in __TS__Iterator(doorSlotToRoomGridIndexes:entries()) do
+        local doorSlot = ____value[1]
+        local neighborRoomGridIndex = ____value[2]
+        do
+            local doorSlotFlag = doorSlotToDoorSlotFlag(nil, doorSlot)
+            if not hasFlag(nil, roomData.Doors, doorSlotFlag) then
+                goto __continue13
+            end
+            if ____exports.roomExists(nil, neighborRoomGridIndex) then
+                goto __continue13
+            end
+            if not ____exports.isDeadEnd(nil, neighborRoomGridIndex) then
+                goto __continue13
+            end
+            roomCandidates[#roomCandidates + 1] = {doorSlot, neighborRoomGridIndex}
+        end
+        ::__continue13::
+    end
+    return roomCandidates
+end
+--- Helper function to search through all of the rooms on the floor for a spot to insert a brand new
+-- room.
+-- 
+-- @returns A array of tuples of adjacent room grid index, `DoorSlot`, and new room grid index.
+function ____exports.getNewRoomCandidatesForFloor(self)
+    local rooms = getRoomsInGrid(nil)
+    local normalRooms = __TS__ArrayFilter(
+        rooms,
+        function(____, room) return room.Data ~= nil and room.Data.Type == RoomType.DEFAULT and room.Data.Subtype ~= DownpourRoomSubType.MIRROR and room.Data.Subtype ~= MinesRoomSubType.MINESHAFT_ENTRANCE end
+    )
+    local newRoomCandidates = {}
+    for ____, room in ipairs(normalRooms) do
+        local newRoomCandidatesBesideRoom = ____exports.getNewRoomCandidatesBesideRoom(nil, room.SafeGridIndex)
+        for ____, ____value in ipairs(newRoomCandidatesBesideRoom) do
+            local doorSlot = ____value[1]
+            local newRoomGridIndex = ____value[2]
+            newRoomCandidates[#newRoomCandidates + 1] = {room.SafeGridIndex, doorSlot, newRoomGridIndex}
+        end
+    end
+    return newRoomCandidates
+end
+--- Helper function to get the room grid index delta that each hypothetical door in a given room
+-- shape would go to.
+-- 
+-- This is used by the `getRoomShapeNeighborGridIndexes` function.
+-- 
+-- @returns A map of `DoorSlot` to the corresponding room grid index delta.
+function ____exports.getRoomShapeNeighborGridIndexDeltas(self, roomShape)
+    return ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
+end
+--- Helper function to get the room grid index that each hypothetical door in a given room shape
+-- would go to. (This will not include room grid indexes that are outside of the grid.)
+-- 
+-- @param safeRoomGridIndex This must be the room safe grid index (i.e. the top-left room grid index
+-- for the respective room).
+-- @param roomShape The shape of the room.
+-- @returns A map of `DoorSlot` to the corresponding room grid index.
+function ____exports.getRoomShapeNeighborGridIndexes(self, safeRoomGridIndex, roomShape)
+    local roomShapeNeighborGridIndexDeltas = ____exports.getRoomShapeNeighborGridIndexDeltas(nil, roomShape)
+    local neighborGridIndexes = __TS__New(Map)
+    for ____, ____value in __TS__Iterator(roomShapeNeighborGridIndexDeltas:entries()) do
+        local doorSlot = ____value[1]
+        local delta = ____value[2]
+        local roomGridIndex = safeRoomGridIndex + delta
+        if ____exports.isRoomGridIndexInBounds(nil, roomGridIndex) then
+            neighborGridIndexes:set(doorSlot, roomGridIndex)
+        end
+    end
+    return neighborGridIndexes
+end
+--- Helper function to check if the given room grid index is a dead end. Specifically, this is
+-- defined as having only one adjacent room that exists.
+-- 
+-- Note that this function does not take the shape of the room into account; it only looks at a
+-- single room grid index.
+-- 
+-- This function does not care if the given room grid index actually exists, so you can use it to
+-- check if a hypothetical room would be a dead end.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.isDeadEnd(self, roomGridIndex)
+    local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
+    local adjacentRoomData = __TS__ArrayMap(
+        adjacentRoomGridIndexes,
+        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) end
+    )
+    local existingRoomData = __TS__ArrayFilter(
+        adjacentRoomData,
+        function(____, data) return data ~= nil end
+    )
+    return #existingRoomData == 1
+end
+--- Helper function to determine if a given room grid index is inside of the normal 13x13 level grid.
+-- 
+-- For example, Devil Rooms and the Mega Satan room are not considered to be inside the grid.
+function ____exports.isRoomGridIndexInBounds(self, roomGridIndex)
+    return roomGridIndex >= 0 and roomGridIndex <= MAX_LEVEL_GRID_INDEX
+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
+local LEFT = -1
+local UP = -LEVEL_GRID_ROW_WIDTH
+local RIGHT = 1
+local DOWN = LEVEL_GRID_ROW_WIDTH
+ADJACENT_ROOM_GRID_INDEX_DELTAS = {LEFT, UP, RIGHT, DOWN}
+--- Helper function to get the room safe grid index for every room on the entire floor.
+function ____exports.getAllRoomGridIndexes(self)
+    local rooms = getRooms(nil)
+    return __TS__ArrayMap(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
+    )
+end
+--- Helper function to pick a random valid spot on the floor to insert a brand new room. Note that
+-- some floors will not have any valid spots. If this is the case, this function will return
+-- undefined.
+-- 
+-- @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()`.
+-- @returns Either a tuple of adjacent room grid index, `DoorSlot`, and new room grid index, or
+-- undefined.
+function ____exports.getNewRoomCandidate(self, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    local newRoomCandidatesForFloor = ____exports.getNewRoomCandidatesForFloor(nil)
+    if #newRoomCandidatesForFloor == 0 then
+        return nil
+    end
+    return getRandomArrayElement(nil, newRoomCandidatesForFloor, seedOrRNG)
+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 = 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 grid indexes of all the rooms connected to the given room index,
+-- taking the shape of the room into account. (This will only include rooms with valid data.)
+-- 
+-- Returns an empty map if the provided room grid index is out of bounds or has no associated room
+-- data.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns A map of `DoorSlot` to the corresponding room grid index.
+function ____exports.getRoomNeighbors(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    if not ____exports.isRoomGridIndexInBounds(nil, roomDescriptor.SafeGridIndex) then
+        return __TS__New(Map)
+    end
+    local roomData = roomDescriptor.Data
+    if roomData == nil then
+        return __TS__New(Map)
+    end
+    local doorSlotToRoomGridIndexes = ____exports.getRoomShapeNeighborGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
+    local roomNeighbors = __TS__New(Map)
+    for ____, ____value in __TS__Iterator(doorSlotToRoomGridIndexes:entries()) do
+        local doorSlot = ____value[1]
+        local neighborRoomGridIndex = ____value[2]
+        if ____exports.roomExists(nil, neighborRoomGridIndex) then
+            roomNeighbors:set(doorSlot, neighborRoomGridIndex)
+        end
+    end
+    return roomNeighbors
+end
+function ____exports.isDoorSlotValidAtGridIndex(self, doorSlot, roomGridIndex)
+    local allowedDoors = getRoomAllowedDoors(nil, roomGridIndex)
+    return allowedDoors:has(doorSlot)
+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 ____exports.isRoomGridIndexInBounds(nil, redRoomGridIndex)
+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 generate a new room on the floor at a valid dead end attached to a normal
+-- room.
+-- 
+-- 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.
+-- 
+-- @returns The room grid index of the new room or undefined if the floor had no valid dead ends to
+-- place a room.
+function ____exports.newRoom(self)
+    local newRoomCandidate = ____exports.getNewRoomCandidate(nil)
+    if newRoomCandidate == nil then
+        return nil
+    end
+    local adjacentRoomGridIndex, doorSlot, newRoomGridIndex = table.unpack(newRoomCandidate)
+    local level = game:GetLevel()
+    level:MakeRedRoomDoor(adjacentRoomGridIndex, doorSlot)
+    return newRoomGridIndex
+end
+--- Helper function to get the coordinates of a given grid index. The floor is represented by a 13x13
+-- grid.
+-- 
+-- - Since the starting room is in the center, the starting room grid index of 84 is equal to
+--   coordinates of (6, 6).
+-- - The top-left grid index of 0 is equal to coordinates of: (12, 0)
+-- - The top-right grid index of 12 is equal to coordinates of: (0, 0)
+-- - The bottom-left grid index of 156 is equal to coordinates of: (0, 12)
+-- - The bottom-right grid index of 168 is equal to coordinates of: (12, 12)
+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
+return ____exports

package/dist/functions/roomData.d.ts

@@ -107,4 +107,9 @@ export declare function getRoomVariant(roomGridIndex?: int): int;
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function getRoomVisitedCount(roomGridIndex?: int): int;
+/**
+ * Helper function to set the data for a given room. This will change the room type, contents, and
+ * so on.
+ */
+export declare function setRoomData(roomGridIndex: int, data: Readonly<RoomConfig>): void;
 //# sourceMappingURL=roomData.d.ts.map

package/dist/functions/roomData.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roomData.d.ts","sourceRoot":"","sources":["../../src/functions/roomData.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAER,SAAS,EACT,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAMtC;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,CAiBtE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAGvE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,cAAc,CAQrE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,sBAAsB,CAGlE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAatC;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,MAAM,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAGvE;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAG3D;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,QAAQ,CAGzD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAG5D"}
+{"version":3,"file":"roomData.d.ts","sourceRoot":"","sources":["../../src/functions/roomData.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAER,SAAS,EACT,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAMtC;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,CAiBtE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAGvE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,cAAc,CAQrE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,sBAAsB,CAGlE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAatC;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,MAAM,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAGvE;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAG3D;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,QAAQ,CAGzD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAG5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CACzB,aAAa,EAAE,GAAG,EAClB,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,GACzB,IAAI,CAGN"}

package/dist/functions/roomData.lua

@@ -158,4 +158,10 @@ function ____exports.getRoomVisitedCount(self, roomGridIndex)
     local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
     return roomDescriptor.VisitedCount
 end
+--- Helper function to set the data for a given room. This will change the room type, contents, and
+-- so on.
+function ____exports.setRoomData(self, roomGridIndex, data)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    roomDescriptor.Data = data
+end
 return ____exports

package/dist/functions/roomGrid.d.ts

@@ -1,3 +1,11 @@
+/**
+ * These functions have to do with the grid index inside of a room (i.e. the grid index that grid
+ * entities use).
+ *
+ * For functions having to do with the room grid index of the level, see the "Level Grid" functions.
+ *
+ * @module
+ */
 import { RoomShape } from "isaac-typescript-definitions";
 /**
  * Helper function to convert grid coordinates to a world position `Vector`.

package/dist/functions/roomGrid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roomGrid.d.ts","sourceRoot":"","sources":["../../src/functions/roomGrid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAUzD;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,GAAG,MAAM,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,GAAG,EACd,SAAS,EAAE,SAAS,GACnB,MAAM,CAMR;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAIxE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,SAAS,GACnB,OAAO,CAIT;AA0BD;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAIpE;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAIxE"}
+{"version":3,"file":"roomGrid.d.ts","sourceRoot":"","sources":["../../src/functions/roomGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAUzD;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,GAAG,MAAM,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,GAAG,EACd,SAAS,EAAE,SAAS,GACnB,MAAM,CAMR;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAIxE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,SAAS,GACnB,OAAO,CAIT;AA0BD;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAIpE;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAIxE"}

package/dist/functions/rooms.d.ts

@@ -1,48 +1,39 @@
-import { BossID, Dimension, Direction, DoorSlot, ItemPoolType, MinibossID, RoomShape, RoomTransitionAnim, RoomType } from "isaac-typescript-definitions";
+import { BossID, Dimension, Direction, ItemPoolType, MinibossID, RoomTransitionAnim, RoomType } from "isaac-typescript-definitions";
 /**
  * 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.
  */
 export declare function changeRoom(roomGridIndex: int): void;
-/**
- * Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
- */
-export declare function getAllDimensions(): Dimension[];
-/** Helper function to get the grid index for every room on the entire floor. */
-export declare function getAllRoomGridIndexes(): int[];
-/**
- * Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,
- * but it can change if e.g. the player is in the mirror world of Downpour/Dross.
- */
-export declare function getDimension(): Dimension;
 /**
  * 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.
  */
 export declare function getNumRooms(): int;
 /**
- * Helper function to get an array of all of the safe grid indexes for rooms that match the
- * specified room type.
+ * Helper function to get the room data for a specific room type and variant combination. This is
+ * accomplished by using the "goto" console command to load the specified room into the
+ * `GridRoom.DEBUG` slot.
  *
- * This function only searches through rooms in the current dimension.
+ * Note that the side effect of using the "goto" console command is that it will trigger a room
+ * transition after a short delay. By default, this function cancels the incoming room transition by
+ * using the `Game.StartRoomTransition` method to travel to the same room.
  *
- * This function is variadic, meaning that you can specify N arguments to get the combined grid
- * indexes for N room types.
+ * @param roomType The type of room to retrieve.
+ * @param roomVariant The room variant to retrieve. (The room variant is the "ID" of the room in
+ *                    Basement Renovator.)
+ * @param cancelRoomTransition Optional. Whether to cancel the room transition by using the
+ *                             `Game.StartRoomTransition` method to travel to the same room. Default
+ *                             is true. Set this to false if you are getting the data for many rooms
+ *                             at the same time, and then use the `teleport` helper function when
+ *                             you are finished.
  */
-export declare function getRoomGridIndexesForType(...roomTypes: RoomType[]): int[];
+export declare function getRoomDataForTypeVariant(roomType: RoomType, roomVariant: int, cancelRoomTransition?: boolean): Readonly<RoomConfig> | undefined;
 /**
  * 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.
  */
 export declare function getRoomItemPoolType(): ItemPoolType;
-/**
- * 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.
- */
-export declare function getRoomNeighbors(roomGridIndex?: int): int[];
-export declare function getRoomShapeNeighborGridIndexDeltas(roomShape: RoomShape): int[];
 /**
  * Helper function to get the proper name of a room type.
  *
@@ -50,9 +41,12 @@ export declare function getRoomShapeNeighborGridIndexDeltas(roomShape: RoomShape
  */
 export declare function getRoomTypeName(roomType: RoomType): string;
 /**
- * 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.
+ * Helper function to get the room descriptor for every room on the level. This includes off-grid
+ * rooms, such as the Devil Room. (Off-grid rooms will only be included if they the data exists,
+ * which only usually happens once they have been visited at least once.)
+ *
+ * Under the hood, this function 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
@@ -61,8 +55,10 @@ export declare function getRoomTypeName(roomType: RoomType): string;
 export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
 /**
  * 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.
+ * not on the grid.
+ *
+ * Under the hood, this function 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
@@ -71,8 +67,10 @@ export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDe
 export declare function getRoomsInGrid(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
 /**
  * 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.
+ * This will not include any off-grid rooms, such as the Devil Room.
+ *
+ * Under the hood, this function 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.
  */
@@ -106,7 +104,6 @@ export declare function inDeathCertificateArea(): boolean;
  * flag.
  */
 export declare function inDevilsCrownTreasureRoom(): boolean;
-export declare function inDimension(dimension: Dimension): boolean;
 export declare function inDoubleTrouble(): boolean;
 export declare function inGenesisRoom(): boolean;
 /** Helper function to determine if the current room shape is one of the four L room shapes. */
@@ -146,30 +143,6 @@ export declare function inStartingRoom(): boolean;
  *                           checked. Undefined by default.
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean;
-export declare function isDoorSlotValidAtGridIndex(doorSlot: DoorSlot, roomGridIndex: int): boolean;
-export declare function isDoorSlotValidAtGridIndexForRedRoom(doorSlot: DoorSlot, roomGridIndex: int): boolean;
-/**
- * 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.
- */
-export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
-/**
- * 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.
- */
-export declare function isRoomInsideMap(roomGridIndex?: int): boolean;
-/** Helper function to check if a room exists at the given room grid index. */
-export declare function roomExists(roomGridIndex: int): boolean;
-/**
- * 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 (?, ?).
- */
-export declare function roomGridIndexToXY(roomGridIndex: int): [x: int, y: int];
 /**
  * If the `Room.Update` method is called in a `POST_NEW_ROOM` callback, then some entities will
  * slide around (such as the player). Since those entity velocities are already at zero, setting
@@ -191,13 +164,18 @@ export declare function setRoomUncleared(): void;
 /**
  * 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.
+ * arguments.
+ *
+ * Use this function instead of invoking the `Game.StartRoomTransition` method directly so that:
+ * - you do not forget to set `Level.LeaveDoor` property
+ * - to prevent crashing on invalid room grid indexes
+ * - to automatically handle Curse of the Maze
  *
  * @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`.
+ * @param force Optional. Whether to temporarily disable Curse of the Maze. Default is false. If set
+ *              to false, then this function may not go to the provided room grid index.
  */
-export declare function teleport(roomGridIndex: int, direction?: Direction, roomTransitionAnim?: RoomTransitionAnim): void;
+export declare function teleport(roomGridIndex: int, direction?: Direction, roomTransitionAnim?: RoomTransitionAnim, force?: boolean): void;
 //# sourceMappingURL=rooms.d.ts.map

package/dist/functions/rooms.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../src/functions/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,MAAM,EACN,SAAS,EACT,SAAS,EACT,QAAQ,EAIR,YAAY,EACZ,UAAU,EAEV,SAAS,EACT,kBAAkB,EAClB,QAAQ,EAGT,MAAM,8BAA8B,CAAC;AAsCtC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAenD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,SAAS,EAAE,CAE9C;AAED,gFAAgF;AAChF,wBAAgB,qBAAqB,IAAI,GAAG,EAAE,CAG7C;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAmBxC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,GAAG,CAGjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,GAAG,EAAE,CAWzE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAqB3D;AAED,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,SAAS,GACnB,GAAG,EAAE,CAEP;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAsBlB;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAGlB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,EAAE,CAY1E;AAED;;;GAGG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAKnC;AAED,wBAAgB,WAAW,IAAI,OAAO,CAOrC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAWpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAOtC;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAWhD;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,OAAO,CAGnD;AAED,wBAAgB,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAEzD;AAED,wBAAgB,eAAe,IAAI,OAAO,CAMzC;AAED,wBAAgB,aAAa,IAAI,OAAO,CAKvC;AAED,+FAA+F;AAC/F,wBAAgB,OAAO,IAAI,OAAO,CAUjC;AAED,wBAAgB,eAAe,IAAI,OAAO,CAKzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAWhE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAMxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,GAAG,OAAO,CAcxE;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,CAyBT;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAM5D;AAED,8EAA8E;AAC9E,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,GAAG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAKtE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAWrC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,IAAI,CA8BrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CACtB,aAAa,EAAE,GAAG,EAClB,SAAS,YAAyB,EAClC,kBAAkB,qBAA8B,GAC/C,IAAI,CAeN"}
+{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../src/functions/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,MAAM,EACN,SAAS,EACT,SAAS,EAKT,YAAY,EAEZ,UAAU,EAGV,kBAAkB,EAClB,QAAQ,EAGT,MAAM,8BAA8B,CAAC;AAgCtC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAenD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,GAAG,CAGjC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,oBAAoB,UAAO,GAC1B,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,CAgBlC;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE1D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CACtB,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAwBlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC5B,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAGlB;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,EAAE,CAc1E;AAED;;;GAGG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAKnC;AAED,wBAAgB,WAAW,IAAI,OAAO,CAOrC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAWpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAOtC;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAWhD;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,OAAO,CAGnD;AAED,wBAAgB,eAAe,IAAI,OAAO,CAMzC;AAED,wBAAgB,aAAa,IAAI,OAAO,CAKvC;AAED,+FAA+F;AAC/F,wBAAgB,OAAO,IAAI,OAAO,CAUjC;AAED,wBAAgB,eAAe,IAAI,OAAO,CAKzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAWhE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAMxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,GAAG,OAAO,CAcxE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAWrC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,IAAI,CA8BrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,QAAQ,CACtB,aAAa,EAAE,GAAG,EAClB,SAAS,YAAyB,EAClC,kBAAkB,qBAA8B,EAChD,KAAK,UAAQ,GACZ,IAAI,CA0BN"}