isaacscript-common 6.1.1 → 6.3.0

package/features/runNextRoom.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Supply a function to run on the next `POST_NEW_ROOM` callback.
+ *
+ * Note that this function will not handle saving and quitting. If a player saving and quitting
+ * before the deferred function fires would cause a bug in your mod, then you should handle deferred
+ * functions manually using serializable data.
+ */
+export declare function runNextRoom(func: () => void): void;

package/features/runNextRoom.lua

@@ -0,0 +1,40 @@
+local ____exports = {}
+local postNewRoomReordered, v
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____featuresInitialized = require("featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____array = require("functions.array")
+local emptyArray = ____array.emptyArray
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postNewRoomReordered(self)
+    for ____, func in ipairs(v.run.queuedFunctions) do
+        func(nil)
+    end
+    emptyArray(nil, v.run.queuedFunctions)
+end
+local FEATURE_NAME = "runNextRoom"
+v = {run = {queuedFunctions = {}}}
+---
+-- @internal
+function ____exports.runNextRoomInit(self, mod)
+    saveDataManager(
+        nil,
+        FEATURE_NAME,
+        v,
+        function() return false end
+    )
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
+end
+--- Supply a function to run on the next `POST_NEW_ROOM` callback.
+-- 
+-- Note that this function will not handle saving and quitting. If a player saving and quitting
+-- before the deferred function fires would cause a bug in your mod, then you should handle deferred
+-- functions manually using serializable data.
+function ____exports.runNextRoom(self, func)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local ____v_run_queuedFunctions_0 = v.run.queuedFunctions
+    ____v_run_queuedFunctions_0[#____v_run_queuedFunctions_0 + 1] = func
+end
+return ____exports

package/functions/chargeBar.lua

@@ -1,7 +1,5 @@
 local ____exports = {}
 local getChargeBarClamp
-local ____constants = require("constants")
-local VectorZero = ____constants.VectorZero
 function getChargeBarClamp(self, charges, maxCharges)
     local meterMultiplier = 24 / maxCharges
     local meterClip = 26 - charges * meterMultiplier
@@ -37,11 +35,11 @@ end
 --- Helper function to render a charge bar on the screen. First, call the `newChargeBarSprites`
 -- function to initialize the sprites, and then call this function on every render frame.
 function ____exports.renderChargeBar(self, sprites, position, normalCharges, batteryCharges)
-    sprites.back:Render(position, VectorZero, VectorZero)
+    sprites.back:Render(position)
     local normalChargesClamp = getChargeBarClamp(nil, normalCharges, sprites.maxCharges)
-    sprites.meter:Render(position, normalChargesClamp, VectorZero)
+    sprites.meter:Render(position, normalChargesClamp)
     local batteryChargesClamp = getChargeBarClamp(nil, batteryCharges, sprites.maxCharges)
-    sprites.meterBattery:Render(position, batteryChargesClamp, VectorZero)
-    sprites.lines:Render(position, VectorZero, VectorZero)
+    sprites.meterBattery:Render(position, batteryChargesClamp)
+    sprites.lines:Render(position)
 end
 return ____exports

package/functions/direction.d.ts

@@ -8,5 +8,5 @@ import { Direction } from "isaac-typescript-definitions";
  */
 export declare function angleToDirection(angleDegrees: int): Direction;
 export declare function directionToDegrees(direction: Direction): int;
-export declare function directionToVector(direction: Direction): Vector;
+export declare function directionToVector(direction: Direction): Readonly<Vector>;
 export declare function getDirectionName(direction: Direction): string | undefined;

package/functions/doors.d.ts

@@ -22,7 +22,7 @@ export declare function getDevilRoomOrAngelRoomDoor(): GridEntityDoor | undefine
  * they would immediately collide with the loading zone. Instead, they are offset by a certain
  * amount of units.
  */
-export declare function getDoorEnterPosition(door: GridEntityDoor): Vector;
+export declare function getDoorEnterPosition(door: GridEntityDoor): Readonly<Vector>;
 /**
  * Helper function to get the offset from a door position that a player will enter a room at.
  *
@@ -30,7 +30,7 @@ export declare function getDoorEnterPosition(door: GridEntityDoor): Vector;
  * they would immediately collide with the loading zone. Instead, they are offset by a certain
  * amount of units.
  */
-export declare function getDoorSlotEnterPositionOffset(doorSlot: DoorSlot): Vector;
+export declare function getDoorSlotEnterPositionOffset(doorSlot: DoorSlot): Readonly<Vector>;
 /**
  * Helper function to convert an array of door slots or a set of door slots to the resulting bit
  * flag number.
@@ -53,6 +53,10 @@ export declare function getDoors(...roomTypes: RoomType[]): GridEntityDoor[];
 export declare function getDoorsToRoomIndex(...roomGridIndex: int[]): GridEntityDoor[];
 export declare function getOppositeDoorSlot(doorSlot: DoorSlot): DoorSlot | undefined;
 export declare function getRepentanceDoor(): GridEntityDoor | undefined;
+/**
+ * Helper function to get the corresponding door slot for a given room shape and grid coordinates.
+ */
+export declare function getRoomShapeDoorSlot(roomShape: RoomShape, x: int, y: int): DoorSlot | undefined;
 /**
  * Helper function to get the room grid coordinates for a specific room shape and door slot
  * combination.

package/functions/doors.lua

@@ -5,6 +5,7 @@ local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayFind = ____lualib.__TS__ArrayFind
+local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
 local ROOM_ENTRY_OFFSET_FROM_DOOR
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
@@ -193,6 +194,19 @@ function ____exports.getRepentanceDoor(self)
         function(____, door) return ____exports.isRepentanceDoor(nil, door) end
     )
 end
+--- Helper function to get the corresponding door slot for a given room shape and grid coordinates.
+function ____exports.getRoomShapeDoorSlot(self, roomShape, x, y)
+    local coordinatesMap = ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES[roomShape]
+    for ____, ____value in __TS__Iterator(coordinatesMap:entries()) do
+        local doorSlot = ____value[1]
+        local doorX = ____value[2][1]
+        local doorY = ____value[2][2]
+        if x == doorX and y == doorY then
+            return doorSlot
+        end
+    end
+    return nil
+end
 --- Helper function to get the room grid coordinates for a specific room shape and door slot
 -- combination.
 function ____exports.getRoomShapeDoorSlotCoordinates(self, roomShape, doorSlot)

package/functions/familiars.d.ts

@@ -57,4 +57,6 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: Col
  *                        spawn new familiars with a sub-type of 0.
  */
 export declare function checkFamiliarFromCollectibles(player: EntityPlayer, collectibleType: CollectibleType, familiarVariant: FamiliarVariant, familiarSubType?: int): void;
+/** Helper function to get only the familiars that belong to a specific player. */
+export declare function getPlayerFamiliars(player: EntityPlayer): EntityFamiliar[];
 export declare function isFamiliarThatShootsPlayerTears(familiar: EntityFamiliar): boolean;

package/functions/familiars.lua

@@ -1,8 +1,12 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
 local ____familiarsThatShootPlayerTearsSet = require("sets.familiarsThatShootPlayerTearsSet")
 local FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET = ____familiarsThatShootPlayerTearsSet.FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET
+local ____entitySpecific = require("functions.entitySpecific")
+local getFamiliars = ____entitySpecific.getFamiliars
 --- Helper function to add and remove familiars based on a target amount that you specify.
 -- 
 -- This is a convenience wrapper around the `EntityPlayer.CheckFamiliar` method. Use this helper
@@ -79,6 +83,18 @@ function ____exports.checkFamiliarFromCollectibles(self, player, collectibleType
         familiarSubType
     )
 end
+--- Helper function to get only the familiars that belong to a specific player.
+function ____exports.getPlayerFamiliars(self, player)
+    local playerPtrHash = GetPtrHash(player)
+    local familiars = getFamiliars(nil)
+    return __TS__ArrayFilter(
+        familiars,
+        function(____, familiar)
+            local familiarPlayerPtrHash = GetPtrHash(familiar.Player)
+            return familiarPlayerPtrHash == playerPtrHash
+        end
+    )
+end
 function ____exports.isFamiliarThatShootsPlayerTears(self, familiar)
     return FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET:has(familiar.Variant)
 end

package/functions/jsonRoom.d.ts

@@ -1,8 +1,24 @@
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
+import { DoorSlotFlag } from "isaac-typescript-definitions";
 import { JSONRoom } from "../interfaces/JSONRoomsFile";
+/**
+ * Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
+ * given JSON room.
+ */
+export declare function getJSONRoomDoorSlotFlags(jsonRoom: JSONRoom): BitFlags<DoorSlotFlag>;
+/**
+ * Helper function to find a specific room from an array of JSON rooms.
+ *
+ * @param jsonRooms The array of rooms to search through.
+ * @param variant The room variant to select. (The room variant can be thought of as the ID of the
+ *                room.)
+ */
 export declare function getJSONRoomOfVariant(jsonRooms: JSONRoom[] | readonly JSONRoom[], variant: int): JSONRoom | undefined;
+/**
+ * Helper function to find all of the JSON rooms that match the sub-type provided.
+ *
+ * @param jsonRooms The array of rooms to search through.
+ * @param subType The sub-type to match.
+ */
 export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[] | readonly JSONRoom[], subType: int): JSONRoom[];
 /**
  * Helper function to get a random JSON room from an array of JSON rooms.
@@ -10,5 +26,11 @@ export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[] | readonly J
  * Note that this function does not simply choose a random element in the provided array; it will
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers
+ *
+ * @param jsonRooms The array of rooms to random choose between.
+ * @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()`.
+ * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+ *                what the function is doing. Default is false.
  */
 export declare function getRandomJSONRoom(jsonRooms: JSONRoom[] | readonly JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): JSONRoom;

package/functions/jsonRoom.lua

@@ -3,8 +3,15 @@ local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local ____exports = {}
 local getTotalWeightOfJSONRooms, getJSONRoomWithChosenWeight
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlotFlagZero = ____isaac_2Dtypescript_2Ddefinitions.DoorSlotFlagZero
 local ____array = require("functions.array")
 local sumArray = ____array.sumArray
+local ____doors = require("functions.doors")
+local doorSlotToDoorSlotFlag = ____doors.doorSlotToDoorSlotFlag
+local getRoomShapeDoorSlot = ____doors.getRoomShapeDoorSlot
+local ____flag = require("functions.flag")
+local addFlag = ____flag.addFlag
 local ____log = require("functions.log")
 local log = ____log.log
 local ____random = require("functions.random")
@@ -37,8 +44,53 @@ function getJSONRoomWithChosenWeight(self, jsonRooms, chosenWeight)
         end
         chosenWeight = chosenWeight - roomWeight
     end
-    return error("Failed to get a JSON room with chosen weight: " .. tostring(chosenWeight))
+    error("Failed to get a JSON room with chosen weight: " .. tostring(chosenWeight))
 end
+--- Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
+-- given JSON room.
+function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
+    local roomShapeString = jsonRoom["$"].shape
+    local roomShapeNumber = tonumber(roomShapeString)
+    if roomShapeNumber == nil then
+        error("Failed to parse the \"shape\" property of a JSON room: " .. roomShapeString)
+    end
+    local roomShape = roomShapeNumber
+    local doorSlotFlags = DoorSlotFlagZero
+    for ____, door in ipairs(jsonRoom.door) do
+        do
+            local existsString = door["$"].exists
+            if existsString ~= "True" and existsString ~= "False" then
+                error("Failed to parse the \"exists\" property of a JSON room door: " .. existsString)
+            end
+            if existsString == "False" then
+                goto __continue4
+            end
+            local xString = door["$"].x
+            local x = tonumber(xString)
+            if x == nil then
+                error("Failed to parse the \"x\" property of a JSON room door: " .. xString)
+            end
+            local yString = door["$"].y
+            local y = tonumber(yString)
+            if y == nil then
+                error("Failed to parse the \"y\" property of a JSON room door: " .. yString)
+            end
+            local doorSlot = getRoomShapeDoorSlot(nil, roomShape, x, y)
+            if doorSlot == nil then
+                error(((("Failed to retrieve the door slot for a JSON room door at coordinates: [" .. tostring(x)) .. ", ") .. tostring(y)) .. "]")
+            end
+            local doorSlotFlag = doorSlotToDoorSlotFlag(nil, doorSlot)
+            doorSlotFlags = addFlag(nil, doorSlotFlags, doorSlotFlag)
+        end
+        ::__continue4::
+    end
+    return doorSlotFlags
+end
+--- Helper function to find a specific room from an array of JSON rooms.
+-- 
+-- @param jsonRooms The array of rooms to search through.
+-- @param variant The room variant to select. (The room variant can be thought of as the ID of the
+-- room.)
 function ____exports.getJSONRoomOfVariant(self, jsonRooms, variant)
     local jsonRoomsOfVariant = __TS__ArrayFilter(
         jsonRooms,
@@ -54,8 +106,12 @@ function ____exports.getJSONRoomOfVariant(self, jsonRooms, variant)
     if #jsonRoomsOfVariant == 1 then
         return jsonRoomsOfVariant[1]
     end
-    return error(((("Found " .. tostring(#jsonRoomsOfVariant)) .. " JSON rooms with a variant of ") .. tostring(variant)) .. ", when there should only be 1.")
+    error(((("Found " .. tostring(#jsonRoomsOfVariant)) .. " JSON rooms with a variant of ") .. tostring(variant)) .. ", when there should only be 1.")
 end
+--- Helper function to find all of the JSON rooms that match the sub-type provided.
+-- 
+-- @param jsonRooms The array of rooms to search through.
+-- @param subType The sub-type to match.
 function ____exports.getJSONRoomsOfSubType(self, jsonRooms, subType)
     return __TS__ArrayFilter(
         jsonRooms,
@@ -71,6 +127,12 @@ end
 -- Note that this function does not simply choose a random element in the provided array; it will
 -- properly account for each room weight using the algorithm from:
 -- https://stackoverflow.com/questions/1761626/weighted-random-numbers
+-- 
+-- @param jsonRooms The array of rooms to random choose between.
+-- @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()`.
+-- @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+-- what the function is doing. Default is false.
 function ____exports.getRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)

package/functions/playerCenter.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Helper function to move all of the players to where they would normally go when arriving at a new
+ * floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
+ * door.)
+ *
+ * If there is more than one player, they will be distributed around the center in a circle.
+ *
+ * This function emulates what happens in the vanilla game when you travel to a new floor.
+ */
+export declare function movePlayersToCenter(): void;

package/functions/playerCenter.lua

@@ -0,0 +1,64 @@
+local ____exports = {}
+local movePlayerAndTheirFamiliars
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("constants")
+local NEW_FLOOR_STARTING_POSITION_GREED_MODE = ____constants.NEW_FLOOR_STARTING_POSITION_GREED_MODE
+local NEW_FLOOR_STARTING_POSITION_NORMAL_MODE = ____constants.NEW_FLOOR_STARTING_POSITION_NORMAL_MODE
+local ____familiars = require("functions.familiars")
+local getPlayerFamiliars = ____familiars.getPlayerFamiliars
+local ____math = require("functions.math")
+local getCircleDiscretizedPoints = ____math.getCircleDiscretizedPoints
+local ____playerIndex = require("functions.playerIndex")
+local getPlayers = ____playerIndex.getPlayers
+function movePlayerAndTheirFamiliars(self, player, position)
+    player.Position = position
+    local familiars = getPlayerFamiliars(nil, player)
+    for ____, familiar in ipairs(familiars) do
+        familiar.Position = position
+    end
+end
+local CIRCLE_RADIUS_BETWEEN_PLAYERS = 50
+--- Helper function to move all of the players to where they would normally go when arriving at a new
+-- floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
+-- door.)
+-- 
+-- If there is more than one player, they will be distributed around the center in a circle.
+-- 
+-- This function emulates what happens in the vanilla game when you travel to a new floor.
+function ____exports.movePlayersToCenter(self)
+    local isGreedMode = game:IsGreedMode()
+    local startingPosition = isGreedMode and NEW_FLOOR_STARTING_POSITION_GREED_MODE or NEW_FLOOR_STARTING_POSITION_NORMAL_MODE
+    local players = getPlayers(nil)
+    local firstPlayer = players[1]
+    if firstPlayer == nil then
+        return
+    end
+    if #players == 1 then
+        movePlayerAndTheirFamiliars(nil, firstPlayer, startingPosition)
+        return
+    end
+    local circlePoints = getCircleDiscretizedPoints(
+        nil,
+        startingPosition,
+        CIRCLE_RADIUS_BETWEEN_PLAYERS,
+        #players,
+        1,
+        1,
+        Direction.LEFT
+    )
+    do
+        local i = 0
+        while i < #players do
+            local player = players[i + 1]
+            local circlePosition = circlePoints[i + 1]
+            if player ~= nil and circlePosition ~= nil then
+                player.Position = circlePosition
+            end
+            i = i + 1
+        end
+    end
+end
+return ____exports

package/functions/playerIndex.d.ts

@@ -44,6 +44,9 @@ export declare function getPlayerIndex(player: EntityPlayer, differentiateForgot
 /**
  * Helper function to return the index of this player with respect to the output of the
  * `Isaac.GetPlayer` method.
+ *
+ * Note that if you storing information about a player in a data structure, you never want to use
+ * this index; use the `getPlayerIndex` function instead.
  */
 export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int | undefined;
 /**

package/functions/playerIndex.lua

@@ -155,6 +155,9 @@ function ____exports.getPlayerFromIndex(self, playerIndex)
 end
 --- Helper function to return the index of this player with respect to the output of the
 -- `Isaac.GetPlayer` method.
+-- 
+-- Note that if you storing information about a player in a data structure, you never want to use
+-- this index; use the `getPlayerIndex` function instead.
 function ____exports.getPlayerIndexVanilla(self, playerToFind)
     local numPlayers = game:GetNumPlayers()
     local playerToFindHash = GetPtrHash(playerToFind)

package/functions/roomShape.d.ts

@@ -1,4 +1,5 @@
 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
@@ -12,7 +13,7 @@ export declare function getGridIndexDelta(roomShape: RoomShape, doorSlot: DoorSl
  *
  * For example, `RoomShape.SHAPE_2x2` will return 2.
  */
-export declare function getRoomShapeBottomRightPosition(roomShape: RoomShape): Vector;
+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.
  *
@@ -21,10 +22,14 @@ export declare function getRoomShapeBottomRightPosition(roomShape: RoomShape): V
  */
 export declare function getRoomShapeBounds(roomShape: RoomShape): readonly [width: int, height: int];
 /**
- * Helper function to get the bounds of a room shape, which are a box representing its contents.
- * This does not include the tiles that the walls are on. L rooms use the same bounds as a 2x2 room.
+ * 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.
@@ -38,7 +43,7 @@ export declare function getRoomShapeLayoutSize(roomShape: RoomShape): readonly [
  * "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): Vector;
+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.
@@ -48,6 +53,7 @@ export declare function getRoomShapeTopLeftPosition(roomShape: RoomShape): Vecto
 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).

package/functions/roomShape.lua

@@ -5,6 +5,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 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")
@@ -19,6 +21,8 @@ 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).
 -- 
@@ -48,11 +52,17 @@ end
 function ____exports.getRoomShapeBounds(self, roomShape)
     return ROOM_SHAPE_BOUNDS[roomShape]
 end
---- Helper function to get the bounds of a room shape, which are a box representing its contents.
--- This does not include the tiles that the walls are on. L rooms use the same bounds as a 2x2 room.
+--- 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.
 -- 
@@ -80,4 +90,7 @@ 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/functions/rooms.d.ts

@@ -55,7 +55,7 @@ export declare function getRoomTypeName(roomType: RoomType): string;
  * 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
+ *                                 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[];

package/functions/rooms.lua

@@ -72,7 +72,7 @@ end
 -- 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
+-- extra-dimensional rooms are automatically generated and can be
 -- seen when you iterate over the `RoomList`. Default is false.
 function ____exports.getRooms(self, includeExtraDimensionalRooms)
     if includeExtraDimensionalRooms == nil then
@@ -145,7 +145,7 @@ function ____exports.getDimension(self)
             return dimension
         end
     end
-    return error("Failed to get the current dimension.")
+    error("Failed to get the current dimension.")
 end
 --- Helper function to get the number of rooms that are currently on the floor layout. This does not
 -- include off-grid rooms, like the Devil Room.

package/functions/sprite.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Helper function to clear a specific layer from a sprite.
+ * Helper function to clear all layers or specific layers from a sprite.
  *
  * This function is variadic, so pass as many layer IDs as you want to clear. If no specific layers
  * are passed, it will clear every layer.

package/functions/sprite.lua

@@ -12,7 +12,7 @@ function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
     local kColor2 = sprite2:GetTexel(position, VectorZero, 1, layerID)
     return kColorEquals(nil, kColor1, kColor2)
 end
---- Helper function to clear a specific layer from a sprite.
+--- Helper function to clear all layers or specific layers from a sprite.
 -- 
 -- This function is variadic, so pass as many layer IDs as you want to clear. If no specific layers
 -- are passed, it will clear every layer.

package/functions/stage.d.ts

@@ -16,10 +16,10 @@ export declare function calculateStageTypeRepentance(stage: LevelStage): StageTy
  */
 export declare function getEffectiveStage(): int;
 /**
- * Helper function to get the prefix to use with the "goto" console command that would correspond to
- * the provided room type.
+ * Helper function to get the corresponding "goto" console command that would correspond to the
+ * provided room type and room variant.
  */
-export declare function getGotoCommandPrefix(roomType: RoomType): string;
+export declare function getGotoCommand(roomType: RoomType, roomVariant: int): string;
 /** Alias for the `Level.GetStage` method. */
 export declare function getStage(): LevelStage;
 /** Alias for the `Level.GetStageType` method. */

package/functions/stage.lua

@@ -64,10 +64,11 @@ function ____exports.getEffectiveStage(self)
     end
     return stage
 end
---- Helper function to get the prefix to use with the "goto" console command that would correspond to
--- the provided room type.
-function ____exports.getGotoCommandPrefix(self, roomType)
-    return ROOM_TYPE_GOTO_PREFIXES[roomType]
+--- Helper function to get the corresponding "goto" console command that would correspond to the
+-- provided room type and room variant.
+function ____exports.getGotoCommand(self, roomType, roomVariant)
+    local prefix = ROOM_TYPE_GOTO_PREFIXES[roomType]
+    return (("goto " .. prefix) .. ".") .. tostring(roomVariant)
 end
 --- Alias for the `Level.GetStage` method.
 function ____exports.getStage(self)

package/functions/trinkets.lua

@@ -76,7 +76,7 @@ function ____exports.getOpenTrinketSlot(self, player)
         end
         return trinketType2 == TrinketType.NULL and 1 or nil
     end
-    return error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
+    error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
 end
 --- Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
 -- trinket type was not valid.

package/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./cachedClasses";
 export { initCustomDoor, spawnCustomDoor, } from "./callbacks/postCustomDoorEnter";
-export { forceNewLevelCallback, forceNewRoomCallback, } from "./callbacks/reorderedCallbacks";
+export { forceNewLevelCallback, forceNewRoomCallback, reorderedCallbacksSetStage, } from "./callbacks/reorderedCallbacks";
 export * from "./classes/DefaultMap";
 export * from "./classes/ModUpgraded";
 export * from "./constants";
@@ -86,6 +86,7 @@ export * from "./functions/pickups";
 export * from "./functions/pickupVariants";
 export * from "./functions/pills";
 export * from "./functions/player";
+export * from "./functions/playerCenter";
 export * from "./functions/playerDataStructures";
 export * from "./functions/playerHealth";
 export * from "./functions/playerIndex";

package/index.lua

@@ -18,8 +18,10 @@ do
     local ____reorderedCallbacks = require("callbacks.reorderedCallbacks")
     local forceNewLevelCallback = ____reorderedCallbacks.forceNewLevelCallback
     local forceNewRoomCallback = ____reorderedCallbacks.forceNewRoomCallback
+    local reorderedCallbacksSetStage = ____reorderedCallbacks.reorderedCallbacksSetStage
     ____exports.forceNewLevelCallback = forceNewLevelCallback
     ____exports.forceNewRoomCallback = forceNewRoomCallback
+    ____exports.reorderedCallbacksSetStage = reorderedCallbacksSetStage
 end
 do
     local ____export = require("classes.DefaultMap")
@@ -685,6 +687,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.playerCenter")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.playerDataStructures")
     for ____exportKey, ____exportValue in pairs(____export) do