isaacscript-common 9.18.4 → 9.19.2

package/dist/src/functions/roomData.lua

@@ -0,0 +1,167 @@
+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("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____doors = require("src.functions.doors")
+local doorSlotFlagToDoorSlot = ____doors.doorSlotFlagToDoorSlot
+local ____enums = require("src.functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____flag = require("src.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 `POST_NEW_ROOM`
+-- 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 `POST_NEW_ROOM` 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
+--- 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, roomData)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    roomDescriptor.Data = roomData
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"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/src/functions/roomGrid.lua

@@ -0,0 +1,80 @@
+local ____exports = {}
+local isValidGridPositionNormal, isValidGridPositionLRoom
+local ____LRoomShapeToRectangles = require("src.objects.LRoomShapeToRectangles")
+local L_ROOM_SHAPE_TO_RECTANGLES = ____LRoomShapeToRectangles.L_ROOM_SHAPE_TO_RECTANGLES
+local ____math = require("src.functions.math")
+local inRectangle = ____math.inRectangle
+local ____roomShape = require("src.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/src/functions/roomShape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomShape.d.ts","sourceRoot":"","sources":["../../../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/src/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("src.objects.roomShapeBounds")
+local ROOM_SHAPE_BOUNDS = ____roomShapeBounds.ROOM_SHAPE_BOUNDS
+local ____roomShapeCorners = require("src.objects.roomShapeCorners")
+local ROOM_SHAPE_CORNERS = ____roomShapeCorners.ROOM_SHAPE_CORNERS
+local ____roomShapeLayoutSizes = require("src.objects.roomShapeLayoutSizes")
+local ROOM_SHAPE_LAYOUT_SIZES = ____roomShapeLayoutSizes.ROOM_SHAPE_LAYOUT_SIZES
+local ____roomShapeToBottomRightPosition = require("src.objects.roomShapeToBottomRightPosition")
+local ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = ____roomShapeToBottomRightPosition.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION
+local ____roomShapeToDoorSlotsToGridIndexDelta = require("src.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("src.objects.roomShapeToGridWidth")
+local ROOM_SHAPE_TO_GRID_WIDTH = ____roomShapeToGridWidth.ROOM_SHAPE_TO_GRID_WIDTH
+local ____roomShapeToTopLeftPosition = require("src.objects.roomShapeToTopLeftPosition")
+local ROOM_SHAPE_TO_TOP_LEFT_POSITION = ____roomShapeToTopLeftPosition.ROOM_SHAPE_TO_TOP_LEFT_POSITION
+local ____roomShapeVolumes = require("src.objects.roomShapeVolumes")
+local ROOM_SHAPE_VOLUMES = ____roomShapeVolumes.ROOM_SHAPE_VOLUMES
+local ____LRoomShapesSet = require("src.sets.LRoomShapesSet")
+local L_ROOM_SHAPES_SET = ____LRoomShapesSet.L_ROOM_SHAPES_SET
+local ____narrowRoomShapesSet = require("src.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/src/functions/roomTransition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomTransition.d.ts","sourceRoot":"","sources":["../../../src/functions/roomTransition.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAGT,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AAMtC;;;;;GAKG;AACH,wBAAgB,UAAU,IAAI,IAAI,CAQjC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,QAAQ,CACtB,aAAa,EAAE,GAAG,EAClB,SAAS,YAAyB,EAClC,kBAAkB,qBAA8B,EAChD,KAAK,UAAQ,GACZ,IAAI,CA6BN"}

package/dist/src/functions/roomTransition.lua

@@ -0,0 +1,75 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+local LevelCurse = ____isaac_2Dtypescript_2Ddefinitions.LevelCurse
+local RoomTransitionAnim = ____isaac_2Dtypescript_2Ddefinitions.RoomTransitionAnim
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____runNextRoom = require("src.features.runNextRoom")
+local runNextRoom = ____runNextRoom.runNextRoom
+local ____curses = require("src.functions.curses")
+local hasCurse = ____curses.hasCurse
+local ____roomData = require("src.functions.roomData")
+local getRoomData = ____roomData.getRoomData
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+--- 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 the `Level.LeaveDoor` field
+-- - 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.
+function ____exports.teleport(self, roomGridIndex, direction, roomTransitionAnim, force)
+    if direction == nil then
+        direction = Direction.NO_DIRECTION
+    end
+    if roomTransitionAnim == nil then
+        roomTransitionAnim = RoomTransitionAnim.TELEPORT
+    end
+    if force == nil then
+        force = false
+    end
+    local level = game:GetLevel()
+    local shouldTempDisableCurse = force and hasCurse(nil, LevelCurse.MAZE)
+    if shouldTempDisableCurse then
+        level:RemoveCurses(LevelCurse.MAZE)
+    end
+    local roomData = getRoomData(nil, roomGridIndex)
+    if roomData == nil then
+        error(("Failed to change the room to grid index " .. tostring(roomGridIndex)) .. " because that room does not exist.")
+    end
+    level.LeaveDoor = DoorSlot.NO_DOOR_SLOT
+    game:StartRoomTransition(roomGridIndex, direction, roomTransitionAnim)
+    if shouldTempDisableCurse then
+        runNextRoom(
+            nil,
+            function()
+                local futureLevel = game:GetLevel()
+                futureLevel:AddCurse(LevelCurse.MAZE, false)
+            end
+        )
+    end
+end
+--- Helper function to reload the current room using `Game.StartRoomTransition`.
+-- 
+-- This is useful for canceling the "goto" console command or to make the `Level.SetStage` method
+-- take effect.
+function ____exports.reloadRoom(self)
+    local roomGridIndex = getRoomGridIndex(nil)
+    ____exports.teleport(
+        nil,
+        roomGridIndex,
+        Direction.NO_DIRECTION,
+        RoomTransitionAnim.FADE,
+        true
+    )
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../../src/functions/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACZ,MAAM,EACN,SAAS,EAMT,YAAY,EACZ,UAAU,EAGV,QAAQ,EAGT,MAAM,8BAA8B,CAAC;AAkCtC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAenD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,GAAG,CAGjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,IAAI,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAiBlE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,oBAAoB,UAAO,GAC1B,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,CAUlC;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CACtB,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAOlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAqBlB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,EAAE,CAe1E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,cAAc,EAAE,CAWtD;AAED;;;GAGG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAKnC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;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,CAStC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAShD;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,OAAO,CAGnD;AAED,wBAAgB,eAAe,IAAI,OAAO,CAMzC;AAED,wBAAgB,aAAa,IAAI,OAAO,CAIvC;AAED,+FAA+F;AAC/F,wBAAgB,OAAO,IAAI,OAAO,CAUjC;AAED,gGAAgG;AAChG,wBAAgB,eAAe,IAAI,OAAO,CAIzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAWhE;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAWtC;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAItC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAItC;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,+DAA+D;AAC/D,wBAAgB,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAG5D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,IAAI,CA8BrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC"}