isaacscript-common 6.18.0 → 6.20.1

package/dist/functions/levelGrid.d.ts

@@ -0,0 +1,155 @@
+/**
+ * These functions have to do with the room grid index for the level (i.e. the position that the
+ * room is on the grid that represents the map for the level).
+ *
+ * For functions having to do with the grid index inside of the room, see the "Room Grid" functions.
+ *
+ * @module
+ */
+import { DoorSlot, RoomShape, RoomType } from "isaac-typescript-definitions";
+/**
+ * Helper function to get the room grid indexes that are adjacent to a given room grid index.
+ *
+ * Adjacent room grid indexes that are outside of the grid will not be included in the returned
+ * array.
+ *
+ * If a room grid index is provided that is outside of the grid, then an empty array will be
+ * returned.
+ *
+ * Note that this function does not take the shape of the room into account; it only looks at a
+ * single room grid index.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export declare function getAdjacentRoomGridIndexes(roomGridIndex?: int): int[];
+/** Helper function to get the room safe grid index for every room on the entire floor. */
+export declare function getAllRoomGridIndexes(): int[];
+/**
+ * Helper function to pick a random valid spot on the floor to insert a brand new room. Note that
+ * some floors will not have any valid spots. If this is the case, this function will return
+ * undefined.
+ *
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @returns Either a tuple of adjacent room grid index, `DoorSlot`, and new room grid index, or
+ *          undefined.
+ */
+export declare function getNewRoomCandidate(seedOrRNG?: Seed | RNG): [adjacentRoomGridIndex: int, doorSlot: DoorSlot, newRoomGridIndex: int] | undefined;
+/**
+ * Helper function to iterate through the possible doors for a room and see if any of them would be
+ * a valid spot to insert a brand new room on the floor.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns A array of tuples of `DoorSlot` and room grid index.
+ */
+export declare function getNewRoomCandidatesBesideRoom(roomGridIndex?: int): Array<[doorSlot: DoorSlot, roomGridIndex: int]>;
+/**
+ * Helper function to search through all of the rooms on the floor for a spot to insert a brand new
+ * room.
+ *
+ * @returns A array of tuples of adjacent room grid index, `DoorSlot`, and new room grid index.
+ */
+export declare function getNewRoomCandidatesForLevel(): Array<[
+    adjacentRoomGridIndex: int,
+    doorSlot: DoorSlot,
+    newRoomGridIndex: 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 grid indexes of all the rooms connected to the given room index,
+ * taking the shape of the room into account. (This will only include rooms with valid data.)
+ *
+ * Returns an empty map if the provided room grid index is out of bounds or has no associated room
+ * data.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns A map of `DoorSlot` to the corresponding room grid index.
+ */
+export declare function getRoomNeighbors(roomGridIndex?: int): Map<DoorSlot, int>;
+/**
+ * Helper function to get the room grid index delta that each hypothetical door in a given room
+ * shape would go to.
+ *
+ * This is used by the `getRoomShapeNeighborGridIndexes` function.
+ *
+ * @returns A map of `DoorSlot` to the corresponding room grid index delta.
+ */
+export declare function getRoomShapeNeighborGridIndexDeltas(roomShape: RoomShape): Map<DoorSlot, int>;
+/**
+ * Helper function to get the room grid index that each hypothetical door in a given room shape
+ * would go to. (This will not include room grid indexes that are outside of the grid.)
+ *
+ * @param safeRoomGridIndex This must be the room safe grid index (i.e. the top-left room grid index
+ *                          for the respective room).
+ * @param roomShape The shape of the room.
+ * @returns A map of `DoorSlot` to the corresponding room grid index.
+ */
+export declare function getRoomShapeNeighborGridIndexes(safeRoomGridIndex: int, roomShape: RoomShape): Map<DoorSlot, int>;
+/**
+ * Helper function to check if the given room grid index is a dead end. Specifically, this is
+ * defined as having only one adjacent room that exists.
+ *
+ * Note that this function does not take the shape of the room into account; it only looks at a
+ * single room grid index.
+ *
+ * This function does not care if the given room grid index actually exists, so you can use it to
+ * check if a hypothetical room would be a dead end.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export declare function isDeadEnd(roomGridIndex?: int): 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 a given room grid index is inside of the normal 13x13 level grid.
+ *
+ * For example, Devil Rooms and the Mega Satan room are not considered to be inside the grid.
+ */
+export declare function isRoomGridIndexInBounds(roomGridIndex: int): boolean;
+/**
+ * Helper function to generate a new room on the floor at a valid dead end attached to a normal
+ * room.
+ *
+ * Under the hood, this function uses the `Level.MakeRedRoomDoor` method to create the room.
+ *
+ * The newly created room will have data corresponding to the game's randomly generated red room. If
+ * you want to modify this, use the `setRoomData` helper function.
+ *
+ * @returns The room grid index of the new room or undefined if the floor had no valid dead ends to
+ *          place a room.
+ */
+export declare function newRoom(): int | undefined;
+/**
+ * Helper function to check if a room exists at the given room grid index. (A room will exist if it
+ * has non-undefined data in the room descriptor.)
+ */
+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.
+ *
+ * - Since the starting room is in the center, the starting room grid index of 84 is equal to
+ *   coordinates of (6, 6).
+ * - The top-left grid index of 0 is equal to coordinates of: (12, 0)
+ * - The top-right grid index of 12 is equal to coordinates of: (0, 0)
+ * - The bottom-left grid index of 156 is equal to coordinates of: (0, 12)
+ * - The bottom-right grid index of 168 is equal to coordinates of: (12, 12)
+ */
+export declare function roomGridIndexToXY(roomGridIndex: int): [x: int, y: int];
+//# sourceMappingURL=levelGrid.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"levelGrid.d.ts","sourceRoot":"","sources":["../../src/functions/levelGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAEL,QAAQ,EAKR,SAAS,EACT,QAAQ,EACT,MAAM,8BAA8B,CAAC;AA6BtC;;;;;;;;;;;;;GAaG;AACH,wBAAgB,0BAA0B,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAerE;AAED,0FAA0F;AAC1F,wBAAgB,qBAAqB,IAAI,GAAG,EAAE,CAG7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,GAErC,CAAC,qBAAqB,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,CAAC,GACvE,SAAS,CAOZ;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,CAAC,EAAE,GAAG,GAClB,KAAK,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC,CA+CjD;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,IAAI,KAAK,CACnD;IAAC,qBAAqB,EAAE,GAAG;IAAE,QAAQ,EAAE,QAAQ;IAAE,gBAAgB,EAAE,GAAG;CAAC,CACxE,CAsBA;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,GAAG,EAAE,CAWzE;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CA+BxE;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAEpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAC7C,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAapB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAUtD;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,CAuBT;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAGzD;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAEnE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,IAAI,GAAG,GAAG,SAAS,CA6CzC;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,GAAG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAKtE"}

package/dist/functions/levelGrid.lua

@@ -0,0 +1,349 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local Map = ____lualib.Map
+local __TS__Iterator = ____lualib.__TS__Iterator
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ADJACENT_ROOM_GRID_INDEX_DELTAS
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DisplayFlag = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlag
+local DownpourRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.DownpourRoomSubType
+local LevelStateFlag = ____isaac_2Dtypescript_2Ddefinitions.LevelStateFlag
+local MinesRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.MinesRoomSubType
+local RoomDescriptorFlag = ____isaac_2Dtypescript_2Ddefinitions.RoomDescriptorFlag
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("constants")
+local ALL_DISPLAY_FLAGS = ____constants.ALL_DISPLAY_FLAGS
+local LEVEL_GRID_ROW_WIDTH = ____constants.LEVEL_GRID_ROW_WIDTH
+local MAX_LEVEL_GRID_INDEX = ____constants.MAX_LEVEL_GRID_INDEX
+local ____roomShapeToDoorSlotsToGridIndexDelta = require("objects.roomShapeToDoorSlotsToGridIndexDelta")
+local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToDoorSlotsToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
+local ____array = require("functions.array")
+local getRandomArrayElement = ____array.getRandomArrayElement
+local ____doors = require("functions.doors")
+local doorSlotToDoorSlotFlag = ____doors.doorSlotToDoorSlotFlag
+local ____flag = require("functions.flag")
+local addFlag = ____flag.addFlag
+local hasFlag = ____flag.hasFlag
+local removeFlag = ____flag.removeFlag
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local ____roomData = require("functions.roomData")
+local getRoomAllowedDoors = ____roomData.getRoomAllowedDoors
+local getRoomData = ____roomData.getRoomData
+local getRoomDescriptor = ____roomData.getRoomDescriptor
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+local getRoomShape = ____roomData.getRoomShape
+local ____rooms = require("functions.rooms")
+local getRooms = ____rooms.getRooms
+local getRoomsInGrid = ____rooms.getRoomsInGrid
+local ____roomShape = require("functions.roomShape")
+local getGridIndexDelta = ____roomShape.getGridIndexDelta
+--- Helper function to get the room grid indexes that are adjacent to a given room grid index.
+-- 
+-- Adjacent room grid indexes that are outside of the grid will not be included in the returned
+-- array.
+-- 
+-- If a room grid index is provided that is outside of the grid, then an empty array will be
+-- returned.
+-- 
+-- Note that this function does not take the shape of the room into account; it only looks at a
+-- single room grid index.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.getAdjacentRoomGridIndexes(self, roomGridIndex)
+    local roomGridIndexToUse = roomGridIndex == nil and getRoomGridIndex(nil) or roomGridIndex
+    if not ____exports.isRoomGridIndexInBounds(nil, roomGridIndexToUse) then
+        return {}
+    end
+    local adjacentRoomGridIndexes = __TS__ArrayMap(
+        ADJACENT_ROOM_GRID_INDEX_DELTAS,
+        function(____, delta) return roomGridIndexToUse + delta end
+    )
+    return __TS__ArrayFilter(
+        adjacentRoomGridIndexes,
+        function(____, adjacentRoomGridIndex) return ____exports.isRoomGridIndexInBounds(nil, adjacentRoomGridIndex) end
+    )
+end
+--- Helper function to iterate through the possible doors for a room and see if any of them would be
+-- a valid spot to insert a brand new room on the floor.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns A array of tuples of `DoorSlot` and room grid index.
+function ____exports.getNewRoomCandidatesBesideRoom(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    if not ____exports.isRoomGridIndexInBounds(nil, roomDescriptor.SafeGridIndex) then
+        return {}
+    end
+    local roomData = roomDescriptor.Data
+    if roomData == nil then
+        return {}
+    end
+    local doorSlotToRoomGridIndexes = ____exports.getRoomShapeNeighborGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
+    local roomCandidates = {}
+    for ____, ____value in __TS__Iterator(doorSlotToRoomGridIndexes:entries()) do
+        local doorSlot = ____value[1]
+        local neighborRoomGridIndex = ____value[2]
+        do
+            local doorSlotFlag = doorSlotToDoorSlotFlag(nil, doorSlot)
+            if not hasFlag(nil, roomData.Doors, doorSlotFlag) then
+                goto __continue13
+            end
+            if ____exports.roomExists(nil, neighborRoomGridIndex) then
+                goto __continue13
+            end
+            if not ____exports.isDeadEnd(nil, neighborRoomGridIndex) then
+                goto __continue13
+            end
+            roomCandidates[#roomCandidates + 1] = {doorSlot, neighborRoomGridIndex}
+        end
+        ::__continue13::
+    end
+    return roomCandidates
+end
+--- Helper function to search through all of the rooms on the floor for a spot to insert a brand new
+-- room.
+-- 
+-- @returns A array of tuples of adjacent room grid index, `DoorSlot`, and new room grid index.
+function ____exports.getNewRoomCandidatesForLevel(self)
+    local rooms = getRoomsInGrid(nil)
+    local normalRooms = __TS__ArrayFilter(
+        rooms,
+        function(____, room) return room.Data ~= nil and room.Data.Type == RoomType.DEFAULT and room.Data.Subtype ~= DownpourRoomSubType.MIRROR and room.Data.Subtype ~= MinesRoomSubType.MINESHAFT_ENTRANCE end
+    )
+    local newRoomCandidates = {}
+    for ____, room in ipairs(normalRooms) do
+        local newRoomCandidatesBesideRoom = ____exports.getNewRoomCandidatesBesideRoom(nil, room.SafeGridIndex)
+        for ____, ____value in ipairs(newRoomCandidatesBesideRoom) do
+            local doorSlot = ____value[1]
+            local newRoomGridIndex = ____value[2]
+            newRoomCandidates[#newRoomCandidates + 1] = {room.SafeGridIndex, doorSlot, newRoomGridIndex}
+        end
+    end
+    return newRoomCandidates
+end
+--- Helper function to get the room grid index delta that each hypothetical door in a given room
+-- shape would go to.
+-- 
+-- This is used by the `getRoomShapeNeighborGridIndexes` function.
+-- 
+-- @returns A map of `DoorSlot` to the corresponding room grid index delta.
+function ____exports.getRoomShapeNeighborGridIndexDeltas(self, roomShape)
+    return ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
+end
+--- Helper function to get the room grid index that each hypothetical door in a given room shape
+-- would go to. (This will not include room grid indexes that are outside of the grid.)
+-- 
+-- @param safeRoomGridIndex This must be the room safe grid index (i.e. the top-left room grid index
+-- for the respective room).
+-- @param roomShape The shape of the room.
+-- @returns A map of `DoorSlot` to the corresponding room grid index.
+function ____exports.getRoomShapeNeighborGridIndexes(self, safeRoomGridIndex, roomShape)
+    local roomShapeNeighborGridIndexDeltas = ____exports.getRoomShapeNeighborGridIndexDeltas(nil, roomShape)
+    local neighborGridIndexes = __TS__New(Map)
+    for ____, ____value in __TS__Iterator(roomShapeNeighborGridIndexDeltas:entries()) do
+        local doorSlot = ____value[1]
+        local delta = ____value[2]
+        local roomGridIndex = safeRoomGridIndex + delta
+        if ____exports.isRoomGridIndexInBounds(nil, roomGridIndex) then
+            neighborGridIndexes:set(doorSlot, roomGridIndex)
+        end
+    end
+    return neighborGridIndexes
+end
+--- Helper function to check if the given room grid index is a dead end. Specifically, this is
+-- defined as having only one adjacent room that exists.
+-- 
+-- Note that this function does not take the shape of the room into account; it only looks at a
+-- single room grid index.
+-- 
+-- This function does not care if the given room grid index actually exists, so you can use it to
+-- check if a hypothetical room would be a dead end.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.isDeadEnd(self, roomGridIndex)
+    local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
+    local adjacentRoomData = __TS__ArrayMap(
+        adjacentRoomGridIndexes,
+        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) end
+    )
+    local existingRoomData = __TS__ArrayFilter(
+        adjacentRoomData,
+        function(____, data) return data ~= nil end
+    )
+    return #existingRoomData == 1
+end
+--- Helper function to determine if a given room grid index is inside of the normal 13x13 level grid.
+-- 
+-- For example, Devil Rooms and the Mega Satan room are not considered to be inside the grid.
+function ____exports.isRoomGridIndexInBounds(self, roomGridIndex)
+    return roomGridIndex >= 0 and roomGridIndex <= MAX_LEVEL_GRID_INDEX
+end
+--- Helper function to check if a room exists at the given room grid index. (A room will exist if it
+-- has non-undefined data in the room descriptor.)
+function ____exports.roomExists(self, roomGridIndex)
+    local roomData = getRoomData(nil, roomGridIndex)
+    return roomData ~= nil
+end
+local LEFT = -1
+local UP = -LEVEL_GRID_ROW_WIDTH
+local RIGHT = 1
+local DOWN = LEVEL_GRID_ROW_WIDTH
+ADJACENT_ROOM_GRID_INDEX_DELTAS = {LEFT, UP, RIGHT, DOWN}
+--- Helper function to get the room safe grid index for every room on the entire floor.
+function ____exports.getAllRoomGridIndexes(self)
+    local rooms = getRooms(nil)
+    return __TS__ArrayMap(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
+    )
+end
+--- Helper function to pick a random valid spot on the floor to insert a brand new room. Note that
+-- some floors will not have any valid spots. If this is the case, this function will return
+-- undefined.
+-- 
+-- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+-- @returns Either a tuple of adjacent room grid index, `DoorSlot`, and new room grid index, or
+-- undefined.
+function ____exports.getNewRoomCandidate(self, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    local newRoomCandidatesForLevel = ____exports.getNewRoomCandidatesForLevel(nil)
+    if #newRoomCandidatesForLevel == 0 then
+        return nil
+    end
+    return getRandomArrayElement(nil, newRoomCandidatesForLevel, seedOrRNG)
+end
+--- Helper function to get an array of all of the safe grid indexes for rooms that match the
+-- specified room type.
+-- 
+-- This function only searches through rooms in the current dimension.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to get the combined grid
+-- indexes for N room types.
+function ____exports.getRoomGridIndexesForType(self, ...)
+    local roomTypesSet = __TS__New(Set, {...})
+    local rooms = getRooms(nil)
+    local matchingRooms = __TS__ArrayFilter(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypesSet:has(roomDescriptor.Data.Type) end
+    )
+    return __TS__ArrayMap(
+        matchingRooms,
+        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
+    )
+end
+--- Helper function to get the grid indexes of all the rooms connected to the given room index,
+-- taking the shape of the room into account. (This will only include rooms with valid data.)
+-- 
+-- Returns an empty map if the provided room grid index is out of bounds or has no associated room
+-- data.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+-- @returns A map of `DoorSlot` to the corresponding room grid index.
+function ____exports.getRoomNeighbors(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    if not ____exports.isRoomGridIndexInBounds(nil, roomDescriptor.SafeGridIndex) then
+        return __TS__New(Map)
+    end
+    local roomData = roomDescriptor.Data
+    if roomData == nil then
+        return __TS__New(Map)
+    end
+    local doorSlotToRoomGridIndexes = ____exports.getRoomShapeNeighborGridIndexes(nil, roomDescriptor.SafeGridIndex, roomData.Shape)
+    local roomNeighbors = __TS__New(Map)
+    for ____, ____value in __TS__Iterator(doorSlotToRoomGridIndexes:entries()) do
+        local doorSlot = ____value[1]
+        local neighborRoomGridIndex = ____value[2]
+        if ____exports.roomExists(nil, neighborRoomGridIndex) then
+            roomNeighbors:set(doorSlot, neighborRoomGridIndex)
+        end
+    end
+    return roomNeighbors
+end
+function ____exports.isDoorSlotValidAtGridIndex(self, doorSlot, roomGridIndex)
+    local allowedDoors = getRoomAllowedDoors(nil, roomGridIndex)
+    return allowedDoors:has(doorSlot)
+end
+function ____exports.isDoorSlotValidAtGridIndexForRedRoom(self, doorSlot, roomGridIndex)
+    local doorSlotValidAtGridIndex = ____exports.isDoorSlotValidAtGridIndex(nil, doorSlot, roomGridIndex)
+    if not doorSlotValidAtGridIndex then
+        return false
+    end
+    local roomShape = getRoomShape(nil, roomGridIndex)
+    if roomShape == nil then
+        return false
+    end
+    local delta = getGridIndexDelta(nil, roomShape, doorSlot)
+    if delta == nil then
+        return false
+    end
+    local redRoomGridIndex = roomGridIndex + delta
+    return not ____exports.roomExists(nil, redRoomGridIndex) and ____exports.isRoomGridIndexInBounds(nil, redRoomGridIndex)
+end
+--- Helper function to detect if the provided room was created by the Red Key item. Under the hood,
+-- this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.isRedKeyRoom(self, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+    return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
+end
+--- Helper function to generate a new room on the floor at a valid dead end attached to a normal
+-- room.
+-- 
+-- Under the hood, this function uses the `Level.MakeRedRoomDoor` method to create the room.
+-- 
+-- The newly created room will have data corresponding to the game's randomly generated red room. If
+-- you want to modify this, use the `setRoomData` helper function.
+-- 
+-- @returns The room grid index of the new room or undefined if the floor had no valid dead ends to
+-- place a room.
+function ____exports.newRoom(self)
+    local newRoomCandidate = ____exports.getNewRoomCandidate(nil)
+    if newRoomCandidate == nil then
+        return nil
+    end
+    local adjacentRoomGridIndex, doorSlot, newRoomGridIndex = table.unpack(newRoomCandidate)
+    local level = game:GetLevel()
+    level:MakeRedRoomDoor(adjacentRoomGridIndex, doorSlot)
+    local roomDescriptor = getRoomDescriptor(nil, newRoomGridIndex)
+    roomDescriptor.Flags = removeFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.RED_ROOM)
+    local roomData = roomDescriptor.Data
+    if roomData ~= nil then
+        local hasFullMap = level:GetStateFlag(LevelStateFlag.FULL_MAP_EFFECT)
+        local hasCompass = level:GetStateFlag(LevelStateFlag.COMPASS_EFFECT)
+        local hasBlueMap = level:GetStateFlag(LevelStateFlag.BLUE_MAP_EFFECT)
+        local roomType = roomData.Type
+        local isSecretRoom = roomType == RoomType.SECRET or roomType == RoomType.SUPER_SECRET
+        if hasFullMap then
+            roomDescriptor.DisplayFlags = ALL_DISPLAY_FLAGS
+        elseif not isSecretRoom and hasCompass then
+            roomDescriptor.DisplayFlags = addFlag(nil, DisplayFlag.VISIBLE, DisplayFlag.SHOW_ICON)
+        elseif isSecretRoom and hasBlueMap then
+            roomDescriptor.DisplayFlags = addFlag(nil, DisplayFlag.VISIBLE, DisplayFlag.SHOW_ICON)
+        end
+    end
+    return newRoomGridIndex
+end
+--- Helper function to get the coordinates of a given grid index. The floor is represented by a 13x13
+-- grid.
+-- 
+-- - Since the starting room is in the center, the starting room grid index of 84 is equal to
+--   coordinates of (6, 6).
+-- - The top-left grid index of 0 is equal to coordinates of: (12, 0)
+-- - The top-right grid index of 12 is equal to coordinates of: (0, 0)
+-- - The bottom-left grid index of 156 is equal to coordinates of: (0, 12)
+-- - The bottom-right grid index of 168 is equal to coordinates of: (12, 12)
+function ____exports.roomGridIndexToXY(self, roomGridIndex)
+    local x = roomGridIndex % LEVEL_GRID_ROW_WIDTH
+    local y = math.floor(roomGridIndex / LEVEL_GRID_ROW_WIDTH)
+    return {x, y}
+end
+return ____exports

package/dist/functions/rockAlt.d.ts

@@ -24,10 +24,10 @@ export declare function getRockAltType(): RockAltType;
  * Most of the time, this function will do nothing, similar to how most of the time, when an
  * individual urn is destroyed, nothing will spawn.
  *
- * Note that in vanilla, collectibles and trinkets will not spawn if they have already been removed
- * from the respective pool. This function cannot replicate that behavior because there is no way to
- * check to see if a collectible or trinket is still in the pool. Thus, it will always have a chance
- * to spawn the respective collectible/trinket (e.g. Swallowed Penny from urns).
+ * Note that in vanilla, trinkets will not spawn if they have already been removed from the trinket
+ * pool. This function cannot replicate that behavior because there is no way to check to see if a
+ * trinket is still in the pool. Thus, it will always have a chance to spawn the respective trinket
+ * (e.g. Swallowed Penny from urns).
  *
  * The logic in this function is based on the rewards listed on the wiki:
  * https://bindingofisaacrebirth.fandom.com/wiki/Rocks

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

@@ -1 +1 @@
-{"version":3,"file":"rockAlt.d.ts","sourceRoot":"","sources":["../../src/functions/rockAlt.ts"],"names":[],"mappings":";;;AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AA8BnD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAK5C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,OAAO,SAAI,EACX,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO,CAwBT"}
+{"version":3,"file":"rockAlt.d.ts","sourceRoot":"","sources":["../../src/functions/rockAlt.ts"],"names":[],"mappings":";;;AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AA+BnD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAK5C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,OAAO,SAAI,EACX,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO,CAwBT"}

package/dist/functions/rockAlt.lua

@@ -7,6 +7,7 @@ local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local HeartSubType = ____isaac_2Dtypescript_2Ddefinitions.HeartSubType
+local ItemPoolType = ____isaac_2Dtypescript_2Ddefinitions.ItemPoolType
 local PillColor = ____isaac_2Dtypescript_2Ddefinitions.PillColor
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
@@ -21,6 +22,8 @@ local BACKDROP_TYPE_TO_ROCK_ALT_TYPE = ____backdropTypeToRockAltType.BACKDROP_TY
 local ____entitiesSpecific = require("functions.entitiesSpecific")
 local spawnEffectWithSeed = ____entitiesSpecific.spawnEffectWithSeed
 local spawnNPCWithSeed = ____entitiesSpecific.spawnNPCWithSeed
+local ____itemPool = require("functions.itemPool")
+local isCollectibleInItemPool = ____itemPool.isCollectibleInItemPool
 local ____pickupsSpecific = require("functions.pickupsSpecific")
 local spawnCardWithSeed = ____pickupsSpecific.spawnCardWithSeed
 local spawnCoinWithSeed = ____pickupsSpecific.spawnCoinWithSeed
@@ -77,8 +80,12 @@ function spawnRockAltRewardUrn(self, position, rng)
     end
     totalChance = totalChance + ROCK_ALT_CHANCES.COLLECTIBLE
     if chance < totalChance then
-        spawnCollectible(nil, CollectibleType.QUARTER, position, rng)
-        return true
+        local stillInPools = isCollectibleInItemPool(nil, CollectibleType.QUARTER, ItemPoolType.DEVIL)
+        if stillInPools then
+            spawnCollectible(nil, CollectibleType.QUARTER, position, rng)
+            return true
+        end
+        return false
     end
     local numSpidersChance = getRandom(nil, rng)
     local numSpiders = numSpidersChance < 0.5 and 1 or 2
@@ -125,14 +132,30 @@ function spawnRockAltRewardMushroom(self, position, rng)
         if roomType == RoomType.SECRET then
             local wavyCapChance = getRandom(nil, rng)
             if wavyCapChance < 0.0272 then
-                spawnCollectible(nil, CollectibleType.WAVY_CAP, position, rng)
-                return true
+                local stillInPools = isCollectibleInItemPool(nil, CollectibleType.WAVY_CAP, ItemPoolType.SECRET)
+                if stillInPools then
+                    spawnCollectible(nil, CollectibleType.WAVY_CAP, position, rng)
+                    return true
+                end
             end
         end
-        local collectibleChance = getRandom(nil, rng)
-        local collectibleType = collectibleChance < 0.5 and CollectibleType.MAGIC_MUSHROOM or CollectibleType.MINI_MUSH
-        spawnCollectible(nil, collectibleType, position, rng)
-        return true
+        local magicMushroomStillInPools = isCollectibleInItemPool(nil, CollectibleType.MAGIC_MUSHROOM, ItemPoolType.TREASURE)
+        local miniMushStillInPools = isCollectibleInItemPool(nil, CollectibleType.MINI_MUSH, ItemPoolType.TREASURE)
+        if magicMushroomStillInPools and miniMushStillInPools then
+            local collectibleChance = getRandom(nil, rng)
+            local collectibleType = collectibleChance < 0.5 and CollectibleType.MAGIC_MUSHROOM or CollectibleType.MINI_MUSH
+            spawnCollectible(nil, collectibleType, position, rng)
+            return true
+        end
+        if magicMushroomStillInPools then
+            spawnCollectible(nil, CollectibleType.MINI_MUSH, position, rng)
+            return true
+        end
+        if miniMushStillInPools then
+            spawnCollectible(nil, CollectibleType.MAGIC_MUSHROOM, position, rng)
+            return true
+        end
+        return false
     end
     spawnEffectWithSeed(
         nil,
@@ -162,10 +185,23 @@ function spawnRockAltRewardSkull(self, position, rng)
     end
     totalChance = totalChance + ROCK_ALT_CHANCES.COLLECTIBLE
     if chance < totalChance then
-        local collectibleChance = getRandom(nil, rng)
-        local collectibleType = collectibleChance < 0.5 and CollectibleType.GHOST_BABY or CollectibleType.DRY_BABY
-        spawnCollectible(nil, collectibleType, position, rng)
-        return true
+        local ghostBabyStillInPools = isCollectibleInItemPool(nil, CollectibleType.GHOST_BABY, ItemPoolType.TREASURE)
+        local dryBabyStillInPools = isCollectibleInItemPool(nil, CollectibleType.DRY_BABY, ItemPoolType.TREASURE)
+        if ghostBabyStillInPools and dryBabyStillInPools then
+            local collectibleChance = getRandom(nil, rng)
+            local collectibleType = collectibleChance < 0.5 and CollectibleType.GHOST_BABY or CollectibleType.DRY_BABY
+            spawnCollectible(nil, collectibleType, position, rng)
+            return true
+        end
+        if ghostBabyStillInPools then
+            spawnCollectible(nil, CollectibleType.DRY_BABY, position, rng)
+            return true
+        end
+        if dryBabyStillInPools then
+            spawnCollectible(nil, CollectibleType.GHOST_BABY, position, rng)
+            return true
+        end
+        return false
     end
     spawnNPCWithSeed(
         nil,
@@ -196,10 +232,23 @@ function spawnRockAltRewardPolyp(self, position, rng)
     end
     totalChance = totalChance + ROCK_ALT_CHANCES.COLLECTIBLE
     if chance < totalChance then
-        local collectibleChance = getRandom(nil, rng)
-        local collectibleType = collectibleChance < 0.5 and CollectibleType.PLACENTA or CollectibleType.BLOOD_CLOT
-        spawnCollectible(nil, collectibleType, position, rng)
-        return true
+        local placentaStillInPools = isCollectibleInItemPool(nil, CollectibleType.PLACENTA, ItemPoolType.BOSS)
+        local bloodClotStillInPools = isCollectibleInItemPool(nil, CollectibleType.BLOOD_CLOT, ItemPoolType.BOSS)
+        if bloodClotStillInPools and placentaStillInPools then
+            local collectibleChance = getRandom(nil, rng)
+            local collectibleType = collectibleChance < 0.5 and CollectibleType.PLACENTA or CollectibleType.BLOOD_CLOT
+            spawnCollectible(nil, collectibleType, position, rng)
+            return true
+        end
+        if bloodClotStillInPools then
+            spawnCollectible(nil, CollectibleType.MINI_MUSH, position, rng)
+            return true
+        end
+        if placentaStillInPools then
+            spawnCollectible(nil, CollectibleType.MAGIC_MUSHROOM, position, rng)
+            return true
+        end
+        return false
     end
     spawnEffectWithSeed(
         nil,
@@ -252,10 +301,10 @@ end
 -- Most of the time, this function will do nothing, similar to how most of the time, when an
 -- individual urn is destroyed, nothing will spawn.
 -- 
--- Note that in vanilla, collectibles and trinkets will not spawn if they have already been removed
--- from the respective pool. This function cannot replicate that behavior because there is no way to
--- check to see if a collectible or trinket is still in the pool. Thus, it will always have a chance
--- to spawn the respective collectible/trinket (e.g. Swallowed Penny from urns).
+-- Note that in vanilla, trinkets will not spawn if they have already been removed from the trinket
+-- pool. This function cannot replicate that behavior because there is no way to check to see if a
+-- trinket is still in the pool. Thus, it will always have a chance to spawn the respective trinket
+-- (e.g. Swallowed Penny from urns).
 -- 
 -- The logic in this function is based on the rewards listed on the wiki:
 -- https://bindingofisaacrebirth.fandom.com/wiki/Rocks