isaacscript-common 6.6.1-dev.2 → 6.6.1

package/functions/roomShape.js

@@ -1,99 +0,0 @@
-import { RoomShape } from "isaac-typescript-definitions";
-import { ROOM_SHAPE_BOUNDS } from "../objects/roomShapeBounds";
-import { ROOM_SHAPE_CORNERS } from "../objects/roomShapeCorners";
-import { ROOM_SHAPE_LAYOUT_SIZES } from "../objects/roomShapeLayoutSizes";
-import { ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION } from "../objects/roomShapeToBottomRightPosition";
-import { ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA } from "../objects/roomShapeToDoorSlotsToGridIndexDelta";
-import { ROOM_SHAPE_TO_GRID_WIDTH } from "../objects/roomShapeToGridWidth";
-import { ROOM_SHAPE_TO_TOP_LEFT_POSITION } from "../objects/roomShapeToTopLeftPosition";
-import { ROOM_SHAPE_VOLUMES } from "../objects/roomShapeVolumes";
-import { L_ROOM_SHAPES_SET } from "../sets/LRoomShapesSet";
-import { NARROW_ROOM_SHAPES_SET } from "../sets/narrowRoomShapesSet";
-/**
- * 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 function getGridIndexDelta(roomShape, doorSlot) {
-    const doorSlotToGridIndexMap = ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape];
-    return doorSlotToGridIndexMap.get(doorSlot);
-}
-/**
- * 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 function getRoomShapeBottomRightPosition(roomShape) {
-    return ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION[roomShape];
-}
-/**
- * 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 function getRoomShapeBounds(roomShape) {
-    return ROOM_SHAPE_BOUNDS[roomShape];
-}
-/**
- * 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 function getRoomShapeCharges(roomShape) {
-    return isRoomShapeDoubleCharge(roomShape) ? 2 : 1;
-}
-/** Helper function to get the corners that exist in the given room shape. */
-export function getRoomShapeCorners(roomShape) {
-    return ROOM_SHAPE_CORNERS[roomShape];
-}
-/**
- * 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 function getRoomShapeLayoutSize(roomShape) {
-    return ROOM_SHAPE_LAYOUT_SIZES[roomShape];
-}
-/**
- * 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 function getRoomShapeTopLeftPosition(roomShape) {
-    return ROOM_SHAPE_TO_TOP_LEFT_POSITION[roomShape];
-}
-/**
- * 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 function getRoomShapeVolume(roomShape) {
-    return ROOM_SHAPE_VOLUMES[roomShape];
-}
-export function getRoomShapeWidth(roomShape) {
-    return ROOM_SHAPE_TO_GRID_WIDTH[roomShape];
-}
-export function isLRoom(roomShape) {
-    return L_ROOM_SHAPES_SET.has(roomShape);
-}
-export function isNarrowRoom(roomShape) {
-    return NARROW_ROOM_SHAPES_SET.has(roomShape);
-}
-/**
- * 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 function isRoomShapeDoubleCharge(roomShape) {
-    // 2x2 rooms and L rooms should grant 2 charges.
-    return roomShape >= RoomShape.SHAPE_2x2;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm9vbVNoYXBlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vcGFja2FnZXMvaXNhYWNzY3JpcHQtY29tbW9uL3NyYy9mdW5jdGlvbnMvcm9vbVNoYXBlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBWSxTQUFTLEVBQUUsTUFBTSw4QkFBOEIsQ0FBQztBQUVuRSxPQUFPLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSw0QkFBNEIsQ0FBQztBQUMvRCxPQUFPLEVBQUUsa0JBQWtCLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNqRSxPQUFPLEVBQUUsdUJBQXVCLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUMxRSxPQUFPLEVBQUUsbUNBQW1DLEVBQUUsTUFBTSwyQ0FBMkMsQ0FBQztBQUNoRyxPQUFPLEVBQUUsNENBQTRDLEVBQUUsTUFBTSxpREFBaUQsQ0FBQztBQUMvRyxPQUFPLEVBQUUsd0JBQXdCLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUMzRSxPQUFPLEVBQUUsK0JBQStCLEVBQUUsTUFBTSx1Q0FBdUMsQ0FBQztBQUN4RixPQUFPLEVBQUUsa0JBQWtCLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNqRSxPQUFPLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUMzRCxPQUFPLEVBQUUsc0JBQXNCLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUVyRTs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxpQkFBaUIsQ0FDL0IsU0FBb0IsRUFDcEIsUUFBa0I7SUFFbEIsTUFBTSxzQkFBc0IsR0FDMUIsNENBQTRDLENBQUMsU0FBUyxDQUFDLENBQUM7SUFDMUQsT0FBTyxzQkFBc0IsQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLENBQUM7QUFDOUMsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLCtCQUErQixDQUM3QyxTQUFvQjtJQUVwQixPQUFPLG1DQUFtQyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQ3hELENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxrQkFBa0IsQ0FDaEMsU0FBb0I7SUFFcEIsT0FBTyxpQkFBaUIsQ0FBQyxTQUFTLENBQUMsQ0FBQztBQUN0QyxDQUFDO0FBRUQ7Ozs7O0dBS0c7QUFDSCxNQUFNLFVBQVUsbUJBQW1CLENBQUMsU0FBb0I7SUFDdEQsT0FBTyx1QkFBdUIsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDcEQsQ0FBQztBQUVELDZFQUE2RTtBQUM3RSxNQUFNLFVBQVUsbUJBQW1CLENBQUMsU0FBb0I7SUFDdEQsT0FBTyxrQkFBa0IsQ0FBQyxTQUFTLENBQUMsQ0FBQztBQUN2QyxDQUFDO0FBRUQ7Ozs7O0dBS0c7QUFDSCxNQUFNLFVBQVUsc0JBQXNCLENBQ3BDLFNBQW9CO0lBRXBCLE9BQU8sdUJBQXVCLENBQUMsU0FBUyxDQUFDLENBQUM7QUFDNUMsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLDJCQUEyQixDQUN6QyxTQUFvQjtJQUVwQixPQUFPLCtCQUErQixDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQ3BELENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxrQkFBa0IsQ0FBQyxTQUFvQjtJQUNyRCxPQUFPLGtCQUFrQixDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQ3ZDLENBQUM7QUFFRCxNQUFNLFVBQVUsaUJBQWlCLENBQUMsU0FBb0I7SUFDcEQsT0FBTyx3QkFBd0IsQ0FBQyxTQUFTLENBQUMsQ0FBQztBQUM3QyxDQUFDO0FBRUQsTUFBTSxVQUFVLE9BQU8sQ0FBQyxTQUFvQjtJQUMxQyxPQUFPLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsQ0FBQztBQUMxQyxDQUFDO0FBRUQsTUFBTSxVQUFVLFlBQVksQ0FBQyxTQUFvQjtJQUMvQyxPQUFPLHNCQUFzQixDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsQ0FBQztBQUMvQyxDQUFDO0FBRUQ7Ozs7O0dBS0c7QUFDSCxNQUFNLFVBQVUsdUJBQXVCLENBQUMsU0FBb0I7SUFDMUQsZ0RBQWdEO0lBQ2hELE9BQU8sU0FBUyxJQUFJLFNBQVMsQ0FBQyxTQUFTLENBQUM7QUFDMUMsQ0FBQyJ9

package/functions/roomShape.lua

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

package/functions/rooms.d.ts

@@ -1,202 +0,0 @@
-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;