isaacscript-common 6.6.1-dev.2 → 6.6.1

package/dist/functions/roomData.lua

@@ -0,0 +1,160 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlotFlag = ____isaac_2Dtypescript_2Ddefinitions.DoorSlotFlag
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____doors = require("functions.doors")
+local doorSlotFlagToDoorSlot = ____doors.doorSlotFlagToDoorSlot
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+--- Helper function to get the room data for the provided room.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.getRoomData(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.Data
+end
+--- Helper function to get the descriptor for a room.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.getRoomDescriptor(self, roomGridIndex)
+    local level = game:GetLevel()
+    if roomGridIndex == nil then
+        roomGridIndex = ____exports.getRoomGridIndex(nil)
+    end
+    return level:GetRoomByIdx(roomGridIndex)
+end
+--- Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
+-- `RoomDescriptor` object that you are retrieving.
+function ____exports.getRoomDescriptorReadOnly(self)
+    local level = game:GetLevel()
+    return level:GetCurrentRoomDesc()
+end
+--- Helper function to get the grid index of the current room.
+-- 
+-- - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
+--   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
+--   overlaps with, or the top-right 1x1 section of a `RoomType.SHAPE_LTL` room.)
+-- - If the current room is outside of the grid, it will return the index from the
+--   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases).
+-- 
+-- Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
+-- will return the specific 1x1 quadrant that the player entered the room at. For most situations,
+-- using the safe grid index is more reliable than this.
+-- 
+-- Data structures that store data per room should use the room's `ListIndex` instead of
+-- `SafeGridIndex`, since the former is unique across different dimensions.
+function ____exports.getRoomGridIndex(self)
+    local level = game:GetLevel()
+    local currentRoomIndex = level:GetCurrentRoomIndex()
+    if currentRoomIndex < 0 then
+        return currentRoomIndex
+    end
+    local roomDescriptor = ____exports.getRoomDescriptorReadOnly(nil)
+    return roomDescriptor.SafeGridIndex
+end
+--- Helper function to get the set of allowed door slots for the room at the supplied grid index.
+-- This corresponds to the doors that are enabled in the STB/XML file for the room.
+function ____exports.getRoomAllowedDoors(self, roomGridIndex)
+    local allowedDoors = __TS__New(Set)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    if roomData == nil then
+        return allowedDoors
+    end
+    local doorSlotFlags = getEnumValues(nil, DoorSlotFlag)
+    for ____, doorSlotFlag in ipairs(doorSlotFlags) do
+        if hasFlag(nil, roomData.Doors, doorSlotFlag) then
+            local doorSlot = doorSlotFlagToDoorSlot(nil, doorSlotFlag)
+            allowedDoors:add(doorSlot)
+        end
+    end
+    return allowedDoors
+end
+--- Helper function to get the list grid index of the provided room, which is equal to the index in
+-- the `RoomList.Get` method. In other words, this is equal to the order that the room was created
+-- by the floor generation algorithm.
+-- 
+-- Use this as an index for data structures that store data per room, since it is unique across
+-- different dimensions.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.getRoomListIndex(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.ListIndex
+end
+--- Helper function to get the name of the room as it appears in the STB/XML data.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room name. Returns "Unknown" if the type was not found.
+function ____exports.getRoomName(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and "Unknown" or roomData.Name
+end
+--- Helper function to get the name of the room as it appears in the STB/XML data.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room name. Returns "Unknown" if the type was not found.
+function ____exports.getRoomShape(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local ____temp_0
+    if roomData == nil then
+        ____temp_0 = nil
+    else
+        ____temp_0 = roomData.Shape
+    end
+    return ____temp_0
+end
+--- Helper function to get the stage ID for a room from the XML/STB data. The room stage ID will
+-- correspond to the first number in the filename of the XML/STB file. For example, a Depths room
+-- would have a stage ID of 7.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room stage ID. Returns -1 if the stage ID was not found.
+function ____exports.getRoomStageID(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and -1 or roomData.StageID
+end
+--- Helper function to get the sub-type for a room from the XML/STB data. The room sub-type will
+-- correspond to different things depending on what XML/STB file it draws from. For example, in the
+-- "00.special rooms.stb" file, an Angel Room with a sub-type of 0 will correspond to a normal Angel
+-- Room and a sub-type of 1 will correspond to an Angel Room shop for The Stairway.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room sub-type. Returns -1 if the sub-type was not found.
+function ____exports.getRoomSubType(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and -1 or roomData.Subtype
+end
+--- Helper function for getting the type of the room with the given grid index.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room data type. Returns -1 if the type was not found.
+function ____exports.getRoomType(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and -1 or roomData.Type
+end
+--- Helper function to get the variant for a room from the XML/STB data. You can think of a room
+-- variant as its identifier. For example, to go to Basement room #123, you would use a console
+-- command of `goto d.123` while on the Basement.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns The room variant. Returns -1 if the variant was not found.
+function ____exports.getRoomVariant(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and -1 or roomData.Variant
+end
+--- Note that the room visited count will be inaccurate during the period before the PostNewRoom
+-- callback has fired (i.e. when entities are initializing and performing their first update). This
+-- is because the variable is only incremented immediately before the PostNewRoom callback fires.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.getRoomVisitedCount(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.VisitedCount
+end
+return ____exports

package/dist/functions/roomGrid.d.ts

@@ -0,0 +1,41 @@
+import { RoomShape } from "isaac-typescript-definitions";
+/**
+ * Helper function to convert grid coordinates to a world position `Vector`.
+ *
+ * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+ */
+export declare function gridCoordinatesToWorldPosition(x: int, y: int): Vector;
+/**
+ * Helper function to convert a grid index to a grid position.
+ *
+ * For example, in a 1x1 room, grid index 0 is equal to "Vector(-1, -1) and grid index 16 is equal
+ * to "Vector(0, 0)".
+ */
+export declare function gridIndexToGridPosition(gridIndex: int, roomShape: RoomShape): Vector;
+/**
+ * Helper function to convert a grid position `Vector` to a world position `Vector`.
+ *
+ * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+ */
+export declare function gridPositionToWorldPosition(gridPosition: Vector): Vector;
+/**
+ * Test if a grid position is actually in the given `RoomShape`.
+ *
+ * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+ */
+export declare function isValidGridPosition(gridPosition: Vector, roomShape: RoomShape): boolean;
+/**
+ * Helper function to convert a world position `Vector` to a grid position `Vector`.
+ *
+ * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+ */
+export declare function worldPositionToGridPosition(worldPos: Vector): Vector;
+/**
+ * Helper function to convert a world position `Vector` to a grid position `Vector`.
+ *
+ * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+ *
+ * This is similar to the `worldPositionToGridPosition` function, but the values are not rounded.
+ */
+export declare function worldPositionToGridPositionFast(worldPos: Vector): Vector;
+//# sourceMappingURL=roomGrid.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"roomGrid.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/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"}

package/dist/functions/roomGrid.lua

@@ -0,0 +1,80 @@
+local ____exports = {}
+local isValidGridPositionNormal, isValidGridPositionLRoom
+local ____LRoomShapeToRectangles = require("objects.LRoomShapeToRectangles")
+local L_ROOM_SHAPE_TO_RECTANGLES = ____LRoomShapeToRectangles.L_ROOM_SHAPE_TO_RECTANGLES
+local ____math = require("functions.math")
+local inRectangle = ____math.inRectangle
+local ____roomShape = require("functions.roomShape")
+local getRoomShapeBottomRightPosition = ____roomShape.getRoomShapeBottomRightPosition
+local getRoomShapeTopLeftPosition = ____roomShape.getRoomShapeTopLeftPosition
+local getRoomShapeWidth = ____roomShape.getRoomShapeWidth
+local isLRoom = ____roomShape.isLRoom
+--- Helper function to convert a grid position `Vector` to a world position `Vector`.
+-- 
+-- For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+function ____exports.gridPositionToWorldPosition(self, gridPosition)
+    local x = (gridPosition.X + 2) * 40
+    local y = (gridPosition.Y + 4) * 40
+    return Vector(x, y)
+end
+function isValidGridPositionNormal(self, gridPosition, roomShape)
+    local topLeft = getRoomShapeTopLeftPosition(nil, roomShape)
+    local bottomRight = getRoomShapeBottomRightPosition(nil, roomShape)
+    return inRectangle(nil, gridPosition, topLeft, bottomRight)
+end
+function isValidGridPositionLRoom(self, gridPosition, roomShape)
+    local rectangles = L_ROOM_SHAPE_TO_RECTANGLES[roomShape]
+    if rectangles == nil then
+        return false
+    end
+    local verticalTopLeft, verticalBottomRight, horizontalTopLeft, horizontalBottomRight = table.unpack(rectangles)
+    return inRectangle(nil, gridPosition, verticalTopLeft, verticalBottomRight) or inRectangle(nil, gridPosition, horizontalTopLeft, horizontalBottomRight)
+end
+--- Helper function to convert grid coordinates to a world position `Vector`.
+-- 
+-- For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+function ____exports.gridCoordinatesToWorldPosition(self, x, y)
+    local gridPosition = Vector(x, y)
+    return ____exports.gridPositionToWorldPosition(nil, gridPosition)
+end
+--- Helper function to convert a grid index to a grid position.
+-- 
+-- For example, in a 1x1 room, grid index 0 is equal to "Vector(-1, -1) and grid index 16 is equal
+-- to "Vector(0, 0)".
+function ____exports.gridIndexToGridPosition(self, gridIndex, roomShape)
+    local gridWidth = getRoomShapeWidth(nil, roomShape)
+    local x = gridIndex % gridWidth - 1
+    local y = math.floor(gridIndex / gridWidth) - 1
+    return Vector(x, y)
+end
+--- Test if a grid position is actually in the given `RoomShape`.
+-- 
+-- In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+function ____exports.isValidGridPosition(self, gridPosition, roomShape)
+    local ____isLRoom_result_0
+    if isLRoom(nil, roomShape) then
+        ____isLRoom_result_0 = isValidGridPositionLRoom(nil, gridPosition, roomShape)
+    else
+        ____isLRoom_result_0 = isValidGridPositionNormal(nil, gridPosition, roomShape)
+    end
+    return ____isLRoom_result_0
+end
+--- Helper function to convert a world position `Vector` to a grid position `Vector`.
+-- 
+-- In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+function ____exports.worldPositionToGridPosition(self, worldPos)
+    local x = math.floor(worldPos.X / 40 - 2 + 0.5)
+    local y = math.floor(worldPos.Y / 40 - 4 + 0.5)
+    return Vector(x, y)
+end
+--- Helper function to convert a world position `Vector` to a grid position `Vector`.
+-- 
+-- In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+-- 
+-- This is similar to the `worldPositionToGridPosition` function, but the values are not rounded.
+function ____exports.worldPositionToGridPositionFast(self, worldPos)
+    local x = worldPos.X / 40 - 2
+    local y = worldPos.Y / 40 - 4
+    return Vector(x, y)
+end
+return ____exports

package/dist/functions/roomShape.d.ts

@@ -0,0 +1,64 @@
+import { DoorSlot, RoomShape } from "isaac-typescript-definitions";
+import { Corner } from "../interfaces/Corner";
+/**
+ * Helper function to get the grid index delta that a door out of the given room shape would lead
+ * to. For example, if you went through the bottom door in a room of `RoomShape.SHAPE_1x2`, you
+ * would end up in a room with a grid index that is +26 units from the `SafeGridIndex` of where you
+ * started.
+ */
+export declare function getGridIndexDelta(roomShape: RoomShape, doorSlot: DoorSlot): int | undefined;
+/**
+ * Helper function to see if a given room shape will grant a single charge or a double charge to the
+ * player's active item(s).
+ *
+ * For example, `RoomShape.SHAPE_2x2` will return 2.
+ */
+export declare function getRoomShapeBottomRightPosition(roomShape: RoomShape): Readonly<Vector>;
+/**
+ * Helper function to get the grid position of the bottom-right tile of a given room shape.
+ *
+ * "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
+ * wall would be at "Vector(-1, -1)".)
+ */
+export declare function getRoomShapeBounds(roomShape: RoomShape): readonly [width: int, height: int];
+/**
+ * Helper function to get the number of charges that a given room shape will grant to a player upon
+ * clearing it.
+ *
+ * For example, `RoomShape.SHAPE_2x2` will return 2.
+ */
+export declare function getRoomShapeCharges(roomShape: RoomShape): int;
+/** Helper function to get the corners that exist in the given room shape. */
+export declare function getRoomShapeCorners(roomShape: RoomShape): readonly Corner[];
+/**
+ * Helper function to get the dimensions of a room shape's layout. This is NOT the size of the
+ * room's actual contents! For that, use the `getRoomShapeBounds` function.
+ *
+ * For example, a horizontal narrow room has a layout size of equal to that of a 1x1 room.
+ */
+export declare function getRoomShapeLayoutSize(roomShape: RoomShape): readonly [width: int, height: int];
+/**
+ * Helper function to get the grid position of the top-left tile of a given room shape.
+ *
+ * "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
+ * wall would be at "Vector(-1, -1)".)
+ */
+export declare function getRoomShapeTopLeftPosition(roomShape: RoomShape): Readonly<Vector>;
+/**
+ * Helper function to get the volume of a room shape, which is the amount of tiles that are inside
+ * the room.
+ *
+ * (This cannot be directly calculated from the bounds since L rooms are a special case.)
+ */
+export declare function getRoomShapeVolume(roomShape: RoomShape): int;
+export declare function getRoomShapeWidth(roomShape: RoomShape): int;
+export declare function isLRoom(roomShape: RoomShape): boolean;
+export declare function isNarrowRoom(roomShape: RoomShape): boolean;
+/**
+ * Helper function to see if a given room shape will grant a single charge or a double charge to the
+ * player's active item(s).
+ *
+ * For example, `RoomShape.SHAPE_2x2` will return true.
+ */
+export declare function isRoomShapeDoubleCharge(roomShape: RoomShape): boolean;
+//# sourceMappingURL=roomShape.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"roomShape.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/roomShape.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAY9C;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,GACjB,GAAG,GAAG,SAAS,CAIjB;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,SAAS,GACnB,QAAQ,CAAC,MAAM,CAAC,CAElB;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,SAAS,GACnB,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,GAAG,CAE7D;AAED,6EAA6E;AAC7E,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,MAAM,EAAE,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,SAAS,GACnB,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,SAAS,GACnB,QAAQ,CAAC,MAAM,CAAC,CAElB;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,GAAG,CAE5D;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,GAAG,CAE3D;AAED,wBAAgB,OAAO,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAErD;AAED,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAE1D;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAGrE"}

package/dist/functions/roomShape.lua

@@ -0,0 +1,96 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+local ____roomShapeBounds = require("objects.roomShapeBounds")
+local ROOM_SHAPE_BOUNDS = ____roomShapeBounds.ROOM_SHAPE_BOUNDS
+local ____roomShapeCorners = require("objects.roomShapeCorners")
+local ROOM_SHAPE_CORNERS = ____roomShapeCorners.ROOM_SHAPE_CORNERS
+local ____roomShapeLayoutSizes = require("objects.roomShapeLayoutSizes")
+local ROOM_SHAPE_LAYOUT_SIZES = ____roomShapeLayoutSizes.ROOM_SHAPE_LAYOUT_SIZES
+local ____roomShapeToBottomRightPosition = require("objects.roomShapeToBottomRightPosition")
+local ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = ____roomShapeToBottomRightPosition.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION
+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 ____roomShapeToGridWidth = require("objects.roomShapeToGridWidth")
+local ROOM_SHAPE_TO_GRID_WIDTH = ____roomShapeToGridWidth.ROOM_SHAPE_TO_GRID_WIDTH
+local ____roomShapeToTopLeftPosition = require("objects.roomShapeToTopLeftPosition")
+local ROOM_SHAPE_TO_TOP_LEFT_POSITION = ____roomShapeToTopLeftPosition.ROOM_SHAPE_TO_TOP_LEFT_POSITION
+local ____roomShapeVolumes = require("objects.roomShapeVolumes")
+local ROOM_SHAPE_VOLUMES = ____roomShapeVolumes.ROOM_SHAPE_VOLUMES
+local ____LRoomShapesSet = require("sets.LRoomShapesSet")
+local L_ROOM_SHAPES_SET = ____LRoomShapesSet.L_ROOM_SHAPES_SET
+local ____narrowRoomShapesSet = require("sets.narrowRoomShapesSet")
+local NARROW_ROOM_SHAPES_SET = ____narrowRoomShapesSet.NARROW_ROOM_SHAPES_SET
+--- Helper function to see if a given room shape will grant a single charge or a double charge to the
+-- player's active item(s).
+-- 
+-- For example, `RoomShape.SHAPE_2x2` will return true.
+function ____exports.isRoomShapeDoubleCharge(self, roomShape)
+    return roomShape >= RoomShape.SHAPE_2x2
+end
+--- Helper function to get the grid index delta that a door out of the given room shape would lead
+-- to. For example, if you went through the bottom door in a room of `RoomShape.SHAPE_1x2`, you
+-- would end up in a room with a grid index that is +26 units from the `SafeGridIndex` of where you
+-- started.
+function ____exports.getGridIndexDelta(self, roomShape, doorSlot)
+    local doorSlotToGridIndexMap = ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
+    return doorSlotToGridIndexMap:get(doorSlot)
+end
+--- Helper function to see if a given room shape will grant a single charge or a double charge to the
+-- player's active item(s).
+-- 
+-- For example, `RoomShape.SHAPE_2x2` will return 2.
+function ____exports.getRoomShapeBottomRightPosition(self, roomShape)
+    return ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION[roomShape]
+end
+--- Helper function to get the grid position of the bottom-right tile of a given room shape.
+-- 
+-- "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
+-- wall would be at "Vector(-1, -1)".)
+function ____exports.getRoomShapeBounds(self, roomShape)
+    return ROOM_SHAPE_BOUNDS[roomShape]
+end
+--- Helper function to get the number of charges that a given room shape will grant to a player upon
+-- clearing it.
+-- 
+-- For example, `RoomShape.SHAPE_2x2` will return 2.
+function ____exports.getRoomShapeCharges(self, roomShape)
+    return ____exports.isRoomShapeDoubleCharge(nil, roomShape) and 2 or 1
+end
+--- Helper function to get the corners that exist in the given room shape.
+function ____exports.getRoomShapeCorners(self, roomShape)
+    return ROOM_SHAPE_CORNERS[roomShape]
+end
+--- Helper function to get the dimensions of a room shape's layout. This is NOT the size of the
+-- room's actual contents! For that, use the `getRoomShapeBounds` function.
+-- 
+-- For example, a horizontal narrow room has a layout size of equal to that of a 1x1 room.
+function ____exports.getRoomShapeLayoutSize(self, roomShape)
+    return ROOM_SHAPE_LAYOUT_SIZES[roomShape]
+end
+--- Helper function to get the grid position of the top-left tile of a given room shape.
+-- 
+-- "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
+-- wall would be at "Vector(-1, -1)".)
+function ____exports.getRoomShapeTopLeftPosition(self, roomShape)
+    return ROOM_SHAPE_TO_TOP_LEFT_POSITION[roomShape]
+end
+--- Helper function to get the volume of a room shape, which is the amount of tiles that are inside
+-- the room.
+-- 
+-- (This cannot be directly calculated from the bounds since L rooms are a special case.)
+function ____exports.getRoomShapeVolume(self, roomShape)
+    return ROOM_SHAPE_VOLUMES[roomShape]
+end
+function ____exports.getRoomShapeWidth(self, roomShape)
+    return ROOM_SHAPE_TO_GRID_WIDTH[roomShape]
+end
+function ____exports.isLRoom(self, roomShape)
+    return L_ROOM_SHAPES_SET:has(roomShape)
+end
+function ____exports.isNarrowRoom(self, roomShape)
+    return NARROW_ROOM_SHAPES_SET:has(roomShape)
+end
+return ____exports

package/dist/functions/rooms.d.ts

@@ -0,0 +1,203 @@
+import { BossID, Dimension, Direction, DoorSlot, ItemPoolType, MinibossID, RoomShape, 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.
+ *
+ * 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.
+ */
+export declare function getRoomGridIndexesForType(...roomTypes: RoomType[]): int[];
+/**
+ * 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.
+ *
+ * For example, `RoomType.TREASURE` will return "Treasure Room".
+ */
+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.
+ *
+ * @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.
+ */
+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.
+ *
+ * @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.
+ */
+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.
+ *
+ * @returns A map of room ListIndex to RoomDescriptor.
+ */
+export declare function getRoomsOfDimension(dimension: Dimension): RoomDescriptor[];
+/**
+ * Helper function to determine if the current room shape is equal to `RoomShape.1x2` or
+ * `RoomShape.2x1`.
+ */
+export declare function in2x1Room(): boolean;
+export declare function inAngelShop(): boolean;
+export declare function inBeastRoom(): boolean;
+/**
+ * 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.
+ */
+export declare function inBossRoomOf(bossID: BossID): boolean;
+/**
+ * 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.
+ */
+export declare function inCrawlSpace(): boolean;
+/**
+ * We cannot use the standard code in the `inDimension` function for this purpose since it is bugged
+ * with the Death Certificate area.
+ */
+export declare function inDeathCertificateArea(): boolean;
+/**
+ * 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.
+ */
+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. */
+export declare function inLRoom(): boolean;
+export declare function inMegaSatanRoom(): boolean;
+/**
+ * Helper function to determine if the current room is part of the Repentance "escape sequence" in
+ * the Mines/Ashpit.
+ */
+export declare function inMineShaft(): boolean;
+/**
+ * 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.
+ */
+export declare function inMinibossRoomOf(minibossID: MinibossID): boolean;
+/**
+ * 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.
+ */
+export declare function inSecretShop(): boolean;
+/**
+ * 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).
+ */
+export declare function inStartingRoom(): boolean;
+/**
+ * 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.
+ */
+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 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.
+ */
+export declare function roomUpdateSafe(): void;
+/**
+ * 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.
+ */
+export declare function setRoomCleared(): void;
+/**
+ * Helper function to emulate what happens when you bomb an Angel Statue or push a Reward Plate that
+ * spawns an NPC.
+ */
+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.
+ *
+ * @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`.
+ */
+export declare function teleport(roomGridIndex: int, direction?: Direction, roomTransitionAnim?: RoomTransitionAnim): void;
+//# sourceMappingURL=rooms.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/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"}