isaacscript-common 6.20.0 → 6.21.0

package/dist/functions/rooms.d.ts

@@ -1,4 +1,4 @@
-import { BossID, Dimension, Direction, ItemPoolType, MinibossID, RoomTransitionAnim, RoomType } from "isaac-typescript-definitions";
+import { BackdropType, BossID, Dimension, ItemPoolType, MinibossID, RoomType } from "isaac-typescript-definitions";
 /**
  * Helper function for quickly switching to a new room without playing a particular animation. Use
  * this helper function over invoking the `Game.ChangeRoom` method directly to ensure that you do
@@ -10,11 +10,26 @@ export declare function changeRoom(roomGridIndex: int): void;
  * include off-grid rooms, like the Devil Room.
  */
 export declare function getNumRooms(): int;
+/**
+ * Helper function to get a read-only copy of the room descriptor for every room on the level. This
+ * includes off-grid rooms, such as the Devil Room, and extra-dimensional rooms, if they are
+ * generated and exist.
+ *
+ * Room descriptors without any data are assumed to be non-existent and are not included.
+ *
+ * Under the hood, this is performed by iterating over the `RoomList` from the `Level.GetRooms`
+ * method. This is the best way to see if off-grid rooms have been initialized, since it is possible
+ * for mods to insert room data at non-official negative room grid indexes.
+ */
+export declare function getReadOnlyRooms(): Array<Readonly<RoomDescriptor>>;
 /**
  * Helper function to get the room data for a specific room type and variant combination. This is
  * accomplished by using the "goto" console command to load the specified room into the
  * `GridRoom.DEBUG` slot.
  *
+ * Returns undefined if the provided room type and variant combination were not found. (A warning
+ * message will also appear on the console, since the "goto" command will fail.)
+ *
  * Note that the side effect of using the "goto" console command is that it will trigger a room
  * transition after a short delay. By default, this function cancels the incoming room transition by
  * using the `Game.StartRoomTransition` method to travel to the same room.
@@ -42,39 +57,43 @@ export declare function getRoomItemPoolType(): ItemPoolType;
 export declare function getRoomTypeName(roomType: RoomType): string;
 /**
  * Helper function to get the room descriptor for every room on the level. This includes off-grid
- * rooms, such as the Devil Room. (Off-grid rooms will only be included if they the data exists,
- * which only usually happens once they have been visited at least once.)
+ * rooms, such as the Devil Room.
+ *
+ * Room descriptors without any data are assumed to be non-existent and are not included.
  *
- * Under the hood, this function uses the `Level.GetRooms` method to accomplish this. Rooms without
- * data are assumed to be non-existent and are not added to the list.
+ * - If you want just the rooms inside of the grid, use the `getRoomsInGrid` helper function.
+ * - If you want just the rooms outside of the grid, use the `getRoomsOutsideGrid` helper function.
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
- *                                 extra-dimensional rooms are automatically generated and can be
- *                                 seen when you iterate over the `RoomList`. Default is false.
+ *                                 extra-dimensional rooms are automatically generated. Default is
+ *                                 false.
  */
 export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
 /**
- * Helper function to get the room descriptor for every room on the level except for rooms that are
- * not on the grid.
+ * Helper function to get the room descriptor for every room on the level that is on the grid. (For
+ * example, Devil Rooms are excluded.)
  *
- * Under the hood, this function uses the `Level.GetRooms` method to accomplish this. Rooms without
- * data are assumed to be non-existent and are not added to the list.
+ * Room descriptors without any data are assumed to be non-existent and are not included.
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
- *                                 extra-dimensional rooms are automatically be generated and can be
- *                                 seen when you iterate over the `RoomList`. Default is false.
+ *                                 extra-dimensional rooms are automatically be generated. Default
+ *                                 is false.
  */
 export declare function getRoomsInGrid(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
 /**
  * Helper function to get the room descriptor for every room on the level in a specific dimension.
  * This will not include any off-grid rooms, such as the Devil Room.
  *
- * Under the hood, this function uses the `Level.GetRooms` method to accomplish this. Rooms without
- * data are assumed to be non-existent and are not added to the list.
- *
- * @returns A map of room ListIndex to RoomDescriptor.
+ * Room descriptors without any data are assumed to be non-existent and are not included.
  */
 export declare function getRoomsOfDimension(dimension: Dimension): RoomDescriptor[];
+/**
+ * Helper function to get the room descriptor for every room on the level that is outside of the
+ * grid (like a Devil Room).
+ *
+ * Room descriptors without any data are assumed to be non-existent and are not included.
+ */
+export declare function getRoomsOutsideGrid(): RoomDescriptor[];
 /**
  * Helper function to determine if the current room shape is equal to `RoomShape.1x2` or
  * `RoomShape.2x1`.
@@ -136,7 +155,7 @@ export declare function inStartingRoom(): boolean;
 /**
  * Helper function to loop through every room on the floor and see if it has been cleared.
  *
- * This function will only check rooms in the current dimension.
+ * This function will only check rooms inside the gird and inside the current dimension.
  *
  * @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
  *                           the array will be ignored. If not specified, then all rooms will be
@@ -150,6 +169,8 @@ export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolea
  * positions/velocities before updating the room, and then restore those positions/velocities.
  */
 export declare function roomUpdateSafe(): void;
+/** Helper function to set the backdrop of the current room. */
+export declare function setBackdrop(backdropType: BackdropType): void;
 /**
  * Helper function to convert an uncleared room to a cleared room in the `POST_NEW_ROOM` callback.
  * This is useful because if enemies are removed in this callback, a room drop will be awarded and
@@ -161,21 +182,4 @@ export declare function setRoomCleared(): void;
  * spawns an NPC.
  */
 export declare function setRoomUncleared(): void;
-/**
- * Helper function to change the current room. It can be used for both teleportation and "normal"
- * room transitions, depending on what is passed for the `direction` and `roomTransitionAnim`
- * arguments.
- *
- * Use this function instead of invoking the `Game.StartRoomTransition` method directly so that:
- * - you do not forget to set `Level.LeaveDoor` property
- * - 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.
- */
-export declare function teleport(roomGridIndex: int, direction?: Direction, roomTransitionAnim?: RoomTransitionAnim, force?: boolean): void;
 //# sourceMappingURL=rooms.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../src/functions/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,MAAM,EACN,SAAS,EACT,SAAS,EAKT,YAAY,EAEZ,UAAU,EAGV,kBAAkB,EAClB,QAAQ,EAGT,MAAM,8BAA8B,CAAC;AAgCtC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAenD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,GAAG,CAGjC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,oBAAoB,UAAO,GAC1B,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,CAgBlC;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE1D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CACtB,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAwBlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC5B,4BAA4B,UAAQ,GACnC,cAAc,EAAE,CAGlB;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,EAAE,CAc1E;AAED;;;GAGG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAKnC;AAED,wBAAgB,WAAW,IAAI,OAAO,CAOrC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAWpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAOtC;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAWhD;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,OAAO,CAGnD;AAED,wBAAgB,eAAe,IAAI,OAAO,CAMzC;AAED,wBAAgB,aAAa,IAAI,OAAO,CAKvC;AAED,+FAA+F;AAC/F,wBAAgB,OAAO,IAAI,OAAO,CAUjC;AAED,wBAAgB,eAAe,IAAI,OAAO,CAKzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAWhE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAMxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,GAAG,OAAO,CAcxE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAWrC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,IAAI,CA8BrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,QAAQ,CACtB,aAAa,EAAE,GAAG,EAClB,SAAS,YAAyB,EAClC,kBAAkB,qBAA8B,EAChD,KAAK,UAAQ,GACZ,IAAI,CA0BN"}
+{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../src/functions/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACZ,MAAM,EACN,SAAS,EAKT,YAAY,EACZ,UAAU,EAGV,QAAQ,EAGT,MAAM,8BAA8B,CAAC;AAiCtC;;;;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,cAAc,CAC5B,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,CAOrC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAWpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAOtC;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAWhD;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,OAAO,CAGnD;AAED,wBAAgB,eAAe,IAAI,OAAO,CAMzC;AAED,wBAAgB,aAAa,IAAI,OAAO,CAKvC;AAED,+FAA+F;AAC/F,wBAAgB,OAAO,IAAI,OAAO,CAUjC;AAED,wBAAgB,eAAe,IAAI,OAAO,CAKzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAWhE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAMxC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,GAAG,OAAO,CAcxE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAWrC;AAED,+DAA+D;AAC/D,wBAAgB,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAE5D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,IAAI,CA8BrC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAKvC"}

package/dist/functions/rooms.lua

@@ -1,8 +1,12 @@
 local ____lualib = require("lualib_bundle")
+local __TS__SparseArrayNew = ____lualib.__TS__SparseArrayNew
+local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
+local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local __TS__Spread = ____lualib.__TS__Spread
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__StringIncludes = ____lualib.__TS__StringIncludes
 local Set = ____lualib.Set
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
@@ -10,15 +14,12 @@ local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local AngelRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.AngelRoomSubType
 local Dimension = ____isaac_2Dtypescript_2Ddefinitions.Dimension
-local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
 local DungeonSubType = ____isaac_2Dtypescript_2Ddefinitions.DungeonSubType
 local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
 local HomeRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.HomeRoomSubType
-local LevelCurse = ____isaac_2Dtypescript_2Ddefinitions.LevelCurse
 local RoomDescriptorFlag = ____isaac_2Dtypescript_2Ddefinitions.RoomDescriptorFlag
 local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
-local RoomTransitionAnim = ____isaac_2Dtypescript_2Ddefinitions.RoomTransitionAnim
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
 local StageID = ____isaac_2Dtypescript_2Ddefinitions.StageID
@@ -27,12 +28,11 @@ local game = ____cachedClasses.game
 local sfxManager = ____cachedClasses.sfxManager
 local ____constants = require("constants")
 local MAX_LEVEL_GRID_INDEX = ____constants.MAX_LEVEL_GRID_INDEX
+local NUM_DIMENSIONS = ____constants.NUM_DIMENSIONS
 local ____roomTypeNames = require("objects.roomTypeNames")
 local ROOM_TYPE_NAMES = ____roomTypeNames.ROOM_TYPE_NAMES
 local ____mineShaftRoomSubTypesSet = require("sets.mineShaftRoomSubTypesSet")
 local MINE_SHAFT_ROOM_SUB_TYPE_SET = ____mineShaftRoomSubTypesSet.MINE_SHAFT_ROOM_SUB_TYPE_SET
-local ____curses = require("functions.curses")
-local hasCurse = ____curses.hasCurse
 local ____dimensions = require("functions.dimensions")
 local inDimension = ____dimensions.inDimension
 local ____doors = require("functions.doors")
@@ -51,109 +51,85 @@ local setEntityPositions = ____positionVelocity.setEntityPositions
 local setEntityVelocities = ____positionVelocity.setEntityVelocities
 local ____roomData = require("functions.roomData")
 local getRoomData = ____roomData.getRoomData
+local getRoomDescriptor = ____roomData.getRoomDescriptor
 local getRoomDescriptorReadOnly = ____roomData.getRoomDescriptorReadOnly
 local getRoomGridIndex = ____roomData.getRoomGridIndex
 local getRoomName = ____roomData.getRoomName
 local getRoomStageID = ____roomData.getRoomStageID
 local getRoomSubType = ____roomData.getRoomSubType
+local ____roomTransition = require("functions.roomTransition")
+local reloadRoom = ____roomTransition.reloadRoom
 local ____stage = require("functions.stage")
 local getGotoCommand = ____stage.getGotoCommand
 local ____utils = require("functions.utils")
+local erange = ____utils.erange
 local irange = ____utils.irange
---- Helper function to get the room descriptor for every room on the level. This includes off-grid
--- rooms, such as the Devil Room. (Off-grid rooms will only be included if they the data exists,
--- which only usually happens once they have been visited at least once.)
+--- Helper function to get a read-only copy of the room descriptor for every room on the level. This
+-- includes off-grid rooms, such as the Devil Room, and extra-dimensional rooms, if they are
+-- generated and exist.
 -- 
--- Under the hood, this function uses the `Level.GetRooms` method to accomplish this. Rooms without
--- data are assumed to be non-existent and are not added to the list.
+-- Room descriptors without any data are assumed to be non-existent and are not included.
 -- 
--- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
--- extra-dimensional rooms are automatically generated and can be
--- seen when you iterate over the `RoomList`. Default is false.
-function ____exports.getRooms(self, includeExtraDimensionalRooms)
-    if includeExtraDimensionalRooms == nil then
-        includeExtraDimensionalRooms = false
-    end
+-- Under the hood, this is performed by iterating over the `RoomList` from the `Level.GetRooms`
+-- method. This is the best way to see if off-grid rooms have been initialized, since it is possible
+-- for mods to insert room data at non-official negative room grid indexes.
+function ____exports.getReadOnlyRooms(self)
     local level = game:GetLevel()
     local roomList = level:GetRooms()
-    --- Indexed by room safe grid index. We use a map to avoid adding extra dimensional rooms.
-    local roomsMap = __TS__New(Map)
+    local readOnlyRoomDescriptors = {}
     do
         local i = 0
         while i < roomList.Size do
-            do
-                local roomDescriptor = roomList:Get(i)
-                if roomDescriptor == nil or roomDescriptor.Data == nil then
-                    goto __continue10
-                end
-                if not includeExtraDimensionalRooms and roomsMap:has(roomDescriptor.SafeGridIndex) then
-                    goto __continue10
-                end
-                roomsMap:set(roomDescriptor.SafeGridIndex, roomDescriptor)
+            local readOnlyRoomDescriptor = roomList:Get(i)
+            if readOnlyRoomDescriptor ~= nil and readOnlyRoomDescriptor.Data ~= nil then
+                readOnlyRoomDescriptors[#readOnlyRoomDescriptors + 1] = readOnlyRoomDescriptor
             end
-            ::__continue10::
             i = i + 1
         end
     end
-    return {__TS__Spread(roomsMap:values())}
+    return readOnlyRoomDescriptors
 end
---- Helper function to get the room descriptor for every room on the level except for rooms that are
--- not on the grid.
+--- Helper function to get the room descriptor for every room on the level that is on the grid. (For
+-- example, Devil Rooms are excluded.)
 -- 
--- Under the hood, this function uses the `Level.GetRooms` method to accomplish this. Rooms without
--- data are assumed to be non-existent and are not added to the list.
+-- Room descriptors without any data are assumed to be non-existent and are not included.
 -- 
 -- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
--- extra-dimensional rooms are automatically be generated and can be
--- seen when you iterate over the `RoomList`. Default is false.
+-- extra-dimensional rooms are automatically be generated. Default
+-- is false.
 function ____exports.getRoomsInGrid(self, includeExtraDimensionalRooms)
     if includeExtraDimensionalRooms == nil then
         includeExtraDimensionalRooms = false
     end
-    local rooms = ____exports.getRooms(nil, includeExtraDimensionalRooms)
-    return __TS__ArrayFilter(
-        rooms,
-        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex >= 0 end
-    )
-end
---- Helper function to change the current room. It can be used for both teleportation and "normal"
--- room transitions, depending on what is passed for the `direction` and `roomTransitionAnim`
--- arguments.
--- 
--- Use this function instead of invoking the `Game.StartRoomTransition` method directly so that:
--- - you do not forget to set `Level.LeaveDoor` property
--- - 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
-        level:AddCurse(LevelCurse.MAZE, false)
+    local dimensions = includeExtraDimensionalRooms and erange(nil, NUM_DIMENSIONS) or ({Dimension.CURRENT})
+    --- We use a map instead of an array because room shapes occupy more than one room grid index.
+    local roomDescriptorMap = __TS__New(Map)
+    for ____, dimension in ipairs(dimensions) do
+        for ____, roomGridIndex in ipairs(irange(nil, MAX_LEVEL_GRID_INDEX)) do
+            local roomDescriptor = level:GetRoomByIdx(roomGridIndex, dimension)
+            if roomDescriptor.Data ~= nil then
+                local ptrHash = GetPtrHash(roomDescriptor)
+                roomDescriptorMap:set(ptrHash, roomDescriptor)
+            end
+        end
     end
+    return {__TS__Spread(roomDescriptorMap:values())}
+end
+--- Helper function to get the room descriptor for every room on the level that is outside of the
+-- grid (like a Devil Room).
+-- 
+-- Room descriptors without any data are assumed to be non-existent and are not included.
+function ____exports.getRoomsOutsideGrid(self)
+    local readOnlyRooms = ____exports.getReadOnlyRooms(nil)
+    local readOnlyRoomsOffGrid = __TS__ArrayFilter(
+        readOnlyRooms,
+        function(____, readOnlyRoomDescriptor) return readOnlyRoomDescriptor.SafeGridIndex < 0 end
+    )
+    return __TS__ArrayMap(
+        readOnlyRoomsOffGrid,
+        function(____, readOnlyRoomDescriptor) return getRoomDescriptor(nil, readOnlyRoomDescriptor.SafeGridIndex) end
+    )
 end
 --- Helper function for quickly switching to a new room without playing a particular animation. Use
 -- this helper function over invoking the `Game.ChangeRoom` method directly to ensure that you do
@@ -177,6 +153,9 @@ end
 -- accomplished by using the "goto" console command to load the specified room into the
 -- `GridRoom.DEBUG` slot.
 -- 
+-- Returns undefined if the provided room type and variant combination were not found. (A warning
+-- message will also appear on the console, since the "goto" command will fail.)
+-- 
 -- Note that the side effect of using the "goto" console command is that it will trigger a room
 -- transition after a short delay. By default, this function cancels the incoming room transition by
 -- using the `Game.StartRoomTransition` method to travel to the same room.
@@ -197,14 +176,7 @@ function ____exports.getRoomDataForTypeVariant(self, roomType, roomVariant, canc
     Isaac.ExecuteCommand(command)
     local newRoomData = getRoomData(nil, GridRoom.DEBUG)
     if cancelRoomTransition then
-        local roomGridIndex = getRoomGridIndex(nil)
-        ____exports.teleport(
-            nil,
-            roomGridIndex,
-            Direction.NO_DIRECTION,
-            RoomTransitionAnim.FADE,
-            true
-        )
+        reloadRoom(nil)
     end
     return newRoomData
 end
@@ -223,13 +195,34 @@ end
 function ____exports.getRoomTypeName(self, roomType)
     return ROOM_TYPE_NAMES[roomType]
 end
+--- Helper function to get the room descriptor for every room on the level. This includes off-grid
+-- rooms, such as the Devil Room.
+-- 
+-- Room descriptors without any data are assumed to be non-existent and are not included.
+-- 
+-- - If you want just the rooms inside of the grid, use the `getRoomsInGrid` helper function.
+-- - If you want just the rooms outside of the grid, use the `getRoomsOutsideGrid` helper function.
+-- 
+-- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
+-- extra-dimensional rooms are automatically generated. Default is
+-- false.
+function ____exports.getRooms(self, includeExtraDimensionalRooms)
+    if includeExtraDimensionalRooms == nil then
+        includeExtraDimensionalRooms = false
+    end
+    local roomsInGrid = ____exports.getRoomsInGrid(nil, includeExtraDimensionalRooms)
+    local roomsOutsideGrid = ____exports.getRoomsOutsideGrid(nil)
+    local ____array_0 = __TS__SparseArrayNew(table.unpack(roomsInGrid))
+    __TS__SparseArrayPush(
+        ____array_0,
+        table.unpack(roomsOutsideGrid)
+    )
+    return {__TS__SparseArraySpread(____array_0)}
+end
 --- Helper function to get the room descriptor for every room on the level in a specific dimension.
 -- This will not include any off-grid rooms, such as the Devil Room.
 -- 
--- Under the hood, this function uses the `Level.GetRooms` method to accomplish this. Rooms without
--- data are assumed to be non-existent and are not added to the list.
--- 
--- @returns A map of room ListIndex to RoomDescriptor.
+-- Room descriptors without any data are assumed to be non-existent and are not included.
 function ____exports.getRoomsOfDimension(self, dimension)
     local level = game:GetLevel()
     --- We use a map instead of an array because room shapes occupy more than one room grid index.
@@ -237,7 +230,8 @@ function ____exports.getRoomsOfDimension(self, dimension)
     for ____, roomGridIndex in ipairs(irange(nil, MAX_LEVEL_GRID_INDEX)) do
         local roomDescriptor = level:GetRoomByIdx(roomGridIndex, dimension)
         if roomDescriptor.Data ~= nil then
-            roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
+            local ptrHash = GetPtrHash(roomDescriptor)
+            roomsMap:set(ptrHash, roomDescriptor)
         end
     end
     return {__TS__Spread(roomsMap:values())}
@@ -349,20 +343,20 @@ function ____exports.inStartingRoom(self)
 end
 --- Helper function to loop through every room on the floor and see if it has been cleared.
 -- 
--- This function will only check rooms in the current dimension.
+-- This function will only check rooms inside the gird and inside the current dimension.
 -- 
 -- @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
 -- the array will be ignored. If not specified, then all rooms will be
 -- checked. Undefined by default.
 function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
-    local ____temp_0
+    local ____temp_1
     if onlyCheckRoomTypes == nil then
-        ____temp_0 = nil
+        ____temp_1 = nil
     else
-        ____temp_0 = __TS__New(Set, onlyCheckRoomTypes)
+        ____temp_1 = __TS__New(Set, onlyCheckRoomTypes)
     end
-    local roomTypeWhitelist = ____temp_0
-    local rooms = ____exports.getRooms(nil)
+    local roomTypeWhitelist = ____temp_1
+    local rooms = ____exports.getRoomsInGrid(nil)
     local matchingRooms = roomTypeWhitelist == nil and rooms or __TS__ArrayFilter(
         rooms,
         function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypeWhitelist:has(roomDescriptor.Data.Type) end
@@ -385,6 +379,10 @@ function ____exports.roomUpdateSafe(self)
     setEntityPositions(nil, entityPositions, entities)
     setEntityVelocities(nil, entityVelocities, entities)
 end
+--- Helper function to set the backdrop of the current room.
+function ____exports.setBackdrop(self, backdropType)
+    game:ShowHallucination(0, backdropType)
+end
 --- Helper function to convert an uncleared room to a cleared room in the `POST_NEW_ROOM` callback.
 -- This is useful because if enemies are removed in this callback, a room drop will be awarded and
 -- the doors will start closed and then open.
@@ -398,12 +396,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue40
+                goto __continue48
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue40::
+        ::__continue48::
     end
     sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/index.d.ts

@@ -84,6 +84,7 @@ export * from "./functions/language";
 export * from "./functions/level";
 export * from "./functions/levelGrid";
 export * from "./functions/log";
+export * from "./functions/logEntities";
 export * from "./functions/map";
 export * from "./functions/math";
 export * from "./functions/mergeTests";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,OAAO,EACL,cAAc,EACd,eAAe,GAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,0BAA0B,GAC3B,MAAM,gCAAgC,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EACL,sBAAsB,EACtB,iCAAiC,GAClC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EACL,sBAAsB,IAAI,gBAAgB,EAC1C,qBAAqB,IAAI,eAAe,GACzC,MAAM,6BAA6B,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAClC,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACL,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,+BAA+B,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EACL,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,2BAA2B,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,cAAc,oCAAoC,CAAC;AACnD,OAAO,EACL,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,OAAO,EACL,cAAc,EACd,eAAe,GAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,0BAA0B,GAC3B,MAAM,gCAAgC,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EACL,sBAAsB,EACtB,iCAAiC,GAClC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EACL,sBAAsB,IAAI,gBAAgB,EAC1C,qBAAqB,IAAI,eAAe,GACzC,MAAM,6BAA6B,CAAC;AACrC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAClC,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACL,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,+BAA+B,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EACL,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,2BAA2B,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,cAAc,oCAAoC,CAAC;AACnD,OAAO,EACL,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC"}

package/dist/index.lua

@@ -670,6 +670,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.logEntities")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.map")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/interfaces/private/CustomTrapdoorDescription.d.ts

@@ -1,7 +1,7 @@
 import { LevelStage, StageType } from "isaac-typescript-definitions";
 export interface CustomTrapdoorDescription {
     open: boolean;
-    destination: [stage: LevelStage, stageType: StageType] | string;
+    destination: [stage: LevelStage, stageType: StageType] | [customStageName: string, floorNum: int];
     firstSpawn: boolean;
 }
 //# sourceMappingURL=CustomTrapdoorDescription.d.ts.map

package/dist/interfaces/private/CustomTrapdoorDescription.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomTrapdoorDescription.d.ts","sourceRoot":"","sources":["../../../src/interfaces/private/CustomTrapdoorDescription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAErE,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,OAAO,CAAC;IACd,WAAW,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC;IAChE,UAAU,EAAE,OAAO,CAAC;CACrB"}
+{"version":3,"file":"CustomTrapdoorDescription.d.ts","sourceRoot":"","sources":["../../../src/interfaces/private/CustomTrapdoorDescription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAErE,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,OAAO,CAAC;IACd,WAAW,EACP,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,GACzC,CAAC,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAC7C,UAAU,EAAE,OAAO,CAAC;CACrB"}

package/dist/objects/backdropTypeToRockAltType.lua

@@ -35,12 +35,12 @@ ____exports.BACKDROP_TYPE_TO_ROCK_ALT_TYPE = {
     [BackdropType.GREED_SHOP] = RockAltType.URN,
     [BackdropType.DUNGEON] = RockAltType.URN,
     [BackdropType.SACRIFICE] = RockAltType.SKULL,
-    [BackdropType.DOWNPOUR] = RockAltType.BUCKET,
+    [BackdropType.DOWNPOUR] = RockAltType.BUCKET_DOWNPOUR,
     [BackdropType.MINES] = RockAltType.MUSHROOM,
     [BackdropType.MAUSOLEUM] = RockAltType.SKULL,
     [BackdropType.CORPSE] = RockAltType.POLYP,
     [BackdropType.PLANETARIUM] = RockAltType.URN,
-    [BackdropType.DOWNPOUR_ENTRANCE] = RockAltType.BUCKET,
+    [BackdropType.DOWNPOUR_ENTRANCE] = RockAltType.BUCKET_DOWNPOUR,
     [BackdropType.MINES_ENTRANCE] = RockAltType.MUSHROOM,
     [BackdropType.MAUSOLEUM_ENTRANCE] = RockAltType.SKULL,
     [BackdropType.CORPSE_ENTRANCE] = RockAltType.SKULL,
@@ -49,7 +49,7 @@ ____exports.BACKDROP_TYPE_TO_ROCK_ALT_TYPE = {
     [BackdropType.MAUSOLEUM_4] = RockAltType.SKULL,
     [BackdropType.CORPSE_2] = RockAltType.POLYP,
     [BackdropType.CORPSE_3] = RockAltType.POLYP,
-    [BackdropType.DROSS] = RockAltType.BUCKET,
+    [BackdropType.DROSS] = RockAltType.BUCKET_DROSS,
     [BackdropType.ASHPIT] = RockAltType.MUSHROOM,
     [BackdropType.GEHENNA] = RockAltType.SKULL,
     [BackdropType.MORTIS] = RockAltType.POLYP,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "6.20.0",
+  "version": "6.21.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/index",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.1.1"
+    "isaac-typescript-definitions": "^3.1.3"
   }
 }

package/src/constants.ts

@@ -1,11 +1,19 @@
 import {
   CollectibleType,
   Dimension,
+  DisplayFlag,
   ItemPoolType,
   TrinketSlot,
 } from "isaac-typescript-definitions";
 import { NUM_NORMAL_PILL_COLORS } from "./constantsFirstLast";
 import { getEnumLength } from "./functions/enums";
+import { addFlag } from "./functions/flag";
+
+export const ALL_DISPLAY_FLAGS = addFlag(
+  DisplayFlag.VISIBLE,
+  DisplayFlag.SHADOW,
+  DisplayFlag.SHOW_ICON,
+);
 
 /**
  * The distance of the laser when Azazel does not have any range up items yet. For more info, see

package/src/constantsFirstLast.ts

@@ -21,8 +21,8 @@ export const FIRST_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION;
 /**
  * Will change depending on how many modded collectibles there are.
  *
- * Equal to `itemConfig.GetCollectibles().Size - 1`. (`Size` includes invalid collectibles. We
- * subtract one to account for `CollectibleType.NULL`.)
+ * Equal to `itemConfig.GetCollectibles().Size - 1`. (`Size` includes invalid collectibles, like
+ * 666. We subtract one to account for `CollectibleType.NULL`.)
  */
 export const LAST_COLLECTIBLE_TYPE = (itemConfig.GetCollectibles().Size -
   1) as CollectibleType;

package/src/enums/RockAltType.ts

@@ -3,5 +3,18 @@ export enum RockAltType {
   MUSHROOM,
   SKULL,
   POLYP,
-  BUCKET,
+
+  /**
+   * Destroying buckets in Downpour give different outcomes than in Dross.
+   *
+   * See: https://bindingofisaacrebirth.fandom.com/wiki/Rocks#Buckets
+   */
+  BUCKET_DOWNPOUR,
+
+  /**
+   * Destroying buckets in Dross give different outcomes than in Downpour.
+   *
+   * See: https://bindingofisaacrebirth.fandom.com/wiki/Rocks#Buckets
+   */
+  BUCKET_DROSS,
 }