isaacscript-common 6.20.1 → 6.20.2

package/dist/features/customStage/exports.d.ts

@@ -4,8 +4,13 @@ import { EntityType } from "isaac-typescript-definitions";
  *
  * Custom stages/levels must first be defined in the "tsconfig.json" file. See the documentation for
  * more details: https://isaacscript.github.io/main/custom-stages/
+ *
+ * @param name The name of the custom stage, corresponding to what is in the "tsconfig.json" file.
+ * @param _firstFloor Whether to go to the first floor or the second floor. For example, if you have
+ *                    a custom stage emulating Caves, then the first floor would be Caves 1, and the
+ *                    second floor would be Caves 2.
  */
-export declare function setCustomStage(name: string, verbose?: boolean): void;
+export declare function setCustomStage(name: string, _firstFloor?: boolean, verbose?: boolean): void;
 export declare function setCustomStageDebug(): void;
 /**
  * By default, unknown bosses will be drawn on the boss "versus" screen as "???". If your custom

package/dist/features/customStage/exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/exports.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAKX,MAAM,8BAA8B,CAAC;AAmBtC;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,UAAQ,GAAG,IAAI,CAyGlE;AAED,wBAAgB,mBAAmB,IAAI,IAAI,CAQ1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,GACtB,IAAI,CAGN"}
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../src/features/customStage/exports.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAKX,MAAM,8BAA8B,CAAC;AAsBtC;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,WAAW,UAAO,EAClB,OAAO,UAAQ,GACd,IAAI,CAyGN;AAED,wBAAgB,mBAAmB,IAAI,IAAI,CAQ1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,GACtB,IAAI,CAGN"}

package/dist/features/customStage/exports.lua

@@ -19,7 +19,7 @@ local ____rng = require("functions.rng")
 local newRNG = ____rng.newRNG
 local ____rooms = require("functions.rooms")
 local getRoomDataForTypeVariant = ____rooms.getRoomDataForTypeVariant
-local getRooms = ____rooms.getRooms
+local getRoomsInGrid = ____rooms.getRoomsInGrid
 local ____stage = require("functions.stage")
 local setStage = ____stage.setStage
 local ____customStageUtils = require("features.customStage.customStageUtils")
@@ -37,13 +37,21 @@ local DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL
 -- 
 -- Custom stages/levels must first be defined in the "tsconfig.json" file. See the documentation for
 -- more details: https://isaacscript.github.io/main/custom-stages/
-function ____exports.setCustomStage(self, name, verbose)
+-- 
+-- @param name The name of the custom stage, corresponding to what is in the "tsconfig.json" file.
+-- @param _firstFloor Whether to go to the first floor or the second floor. For example, if you have
+-- a custom stage emulating Caves, then the first floor would be Caves 1, and the
+-- second floor would be Caves 2.
+function ____exports.setCustomStage(self, name, _firstFloor, verbose)
+    if _firstFloor == nil then
+        _firstFloor = true
+    end
     if verbose == nil then
         verbose = false
     end
     local customStage = customStagesMap:get(name)
     if customStage == nil then
-        error(("Failed to set the custom stage of \"" .. name) .. "\" because it was not found in the custom stages map. (Try restarting IsaacScript / recompiling the mod, and try again. If that does not work, you probably forgot to define it in your \"tsconfig.json\" file.) See the website for more details on how to set up custom stages.")
+        error(("Failed to set the custom stage of \"" .. name) .. "\" because it was not found in the custom stages map. (Try restarting IsaacScript / recompiling the mod / restarting the game, and try again. If that does not work, you probably forgot to define it in your \"tsconfig.json\" file.) See the website for more details on how to set up custom stages.")
     end
     local level = game:GetLevel()
     local startingRoomGridIndex = level:GetStartingRoomIndex()
@@ -54,7 +62,7 @@ function ____exports.setCustomStage(self, name, verbose)
     local baseStage = customStage.baseStage == nil and DEFAULT_BASE_STAGE or customStage.baseStage
     local baseStageType = customStage.baseStageType == nil and DEFAULT_BASE_STAGE_TYPE or customStage.baseStageType
     setStage(nil, baseStage, baseStageType)
-    for ____, room in ipairs(getRooms(nil)) do
+    for ____, room in ipairs(getRoomsInGrid(nil)) do
         do
             if room.SafeGridIndex == startingRoomGridIndex then
                 goto __continue4

package/dist/features/customTrapdoor/blackSprite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blackSprite.d.ts","sourceRoot":"","sources":["../../../src/features/customTrapdoor/blackSprite.ts"],"names":[],"mappings":"AAUA,wBAAgB,eAAe,IAAI,IAAI,CAWtC"}
+{"version":3,"file":"blackSprite.d.ts","sourceRoot":"","sources":["../../../src/features/customTrapdoor/blackSprite.ts"],"names":[],"mappings":"AAUA,wBAAgB,eAAe,IAAI,IAAI,CAYtC"}

package/dist/features/customTrapdoor/blackSprite.lua

@@ -13,6 +13,7 @@ function ____exports.drawBlackSprite(self)
     if not blackSprite:IsLoaded() then
         blackSprite:Load("gfx/ui/boss/versusscreen.anm2", true)
         blackSprite:SetFrame("Scene", 0)
+        blackSprite.Scale = Vector(100, 100)
     end
     blackSprite:RenderLayer(0, VectorZero)
 end

package/dist/functions/levelGrid.lua

@@ -229,7 +229,7 @@ end
 -- indexes for N room types.
 function ____exports.getRoomGridIndexesForType(self, ...)
     local roomTypesSet = __TS__New(Set, {...})
-    local rooms = getRooms(nil)
+    local rooms = getRoomsInGrid(nil)
     local matchingRooms = __TS__ArrayFilter(
         rooms,
         function(____, roomDescriptor) return roomDescriptor.Data ~= nil and roomTypesSet:has(roomDescriptor.Data.Type) end

package/dist/functions/roomData.d.ts

@@ -20,7 +20,7 @@ export declare function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor;
  * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
  * `RoomDescriptor` object that you are retrieving.
  */
-export declare function getRoomDescriptorReadOnly(): ReadonlyRoomDescriptor;
+export declare function getRoomDescriptorReadOnly(): Readonly<RoomDescriptor>;
 /**
  * Helper function to get the grid index of the current room.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"roomData.d.ts","sourceRoot":"","sources":["../../src/functions/roomData.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAER,SAAS,EACT,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAMtC;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,CAiBtE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAGvE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,cAAc,CAQrE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,sBAAsB,CAGlE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAatC;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,MAAM,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAGvE;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAG3D;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,QAAQ,CAGzD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAG5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CACzB,aAAa,EAAE,GAAG,EAClB,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,GAC7B,IAAI,CAGN"}
+{"version":3,"file":"roomData.d.ts","sourceRoot":"","sources":["../../src/functions/roomData.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAER,SAAS,EACT,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAMtC;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,CAiBtE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAGvE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,cAAc,CAQrE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,QAAQ,CAAC,cAAc,CAAC,CAGpE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAatC;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,MAAM,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAGvE;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAG3D;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,QAAQ,CAGzD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAG5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CACzB,aAAa,EAAE,GAAG,EAClB,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,GAC7B,IAAI,CAGN"}

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, Direction, ItemPoolType, MinibossID, RoomTransitionAnim, RoomType } from "isaac-typescript-definitions";
 /**
  * Helper function for quickly switching to a new room without playing a particular animation. Use
  * this helper function over invoking the `Game.ChangeRoom` method directly to ensure that you do
@@ -10,6 +10,18 @@ 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
@@ -45,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`.
@@ -139,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
@@ -153,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

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;;;;;;;;;;;;;;;;;;;;GAoBG;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,EACT,SAAS,EAKT,YAAY,EAEZ,UAAU,EAGV,kBAAkB,EAClB,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,CAgBlC;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;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,QAAQ,CACtB,aAAa,EAAE,GAAG,EAClB,SAAS,YAAyB,EAClC,kBAAkB,qBAA8B,EAChD,KAAK,UAAQ,GACZ,IAAI,CA0BN"}

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
@@ -27,6 +31,7 @@ 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")
@@ -51,6 +56,7 @@ 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
@@ -59,61 +65,73 @@ local getRoomSubType = ____roomData.getRoomSubType
 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
+    local level = game:GetLevel()
+    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 to change the current room. It can be used for both teleportation and "normal"
@@ -226,13 +244,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.
@@ -240,7 +279,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())}
@@ -352,20 +392,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
@@ -388,6 +428,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.
@@ -401,12 +445,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "6.20.1",
+  "version": "6.20.2",
   "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/features/customStage/exports.ts

@@ -10,7 +10,10 @@ import { reorderedCallbacksSetStage } from "../../callbacks/reorderedCallbacks";
 import { getEntityIDFromConstituents } from "../../functions/entities";
 import { log, logError } from "../../functions/log";
 import { newRNG } from "../../functions/rng";
-import { getRoomDataForTypeVariant, getRooms } from "../../functions/rooms";
+import {
+  getRoomDataForTypeVariant,
+  getRoomsInGrid,
+} from "../../functions/rooms";
 import { setStage } from "../../functions/stage";
 import { getRandomCustomStageRoom } from "./customStageUtils";
 import { topStreakTextStart } from "./streakText";
@@ -28,12 +31,21 @@ const DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL;
  *
  * Custom stages/levels must first be defined in the "tsconfig.json" file. See the documentation for
  * more details: https://isaacscript.github.io/main/custom-stages/
+ *
+ * @param name The name of the custom stage, corresponding to what is in the "tsconfig.json" file.
+ * @param _firstFloor Whether to go to the first floor or the second floor. For example, if you have
+ *                    a custom stage emulating Caves, then the first floor would be Caves 1, and the
+ *                    second floor would be Caves 2.
  */
-export function setCustomStage(name: string, verbose = false): void {
+export function setCustomStage(
+  name: string,
+  _firstFloor = true,
+  verbose = false,
+): void {
   const customStage = customStagesMap.get(name);
   if (customStage === undefined) {
     error(
-      `Failed to set the custom stage of "${name}" because it was not found in the custom stages map. (Try restarting IsaacScript / recompiling the mod, and try again. If that does not work, you probably forgot to define it in your "tsconfig.json" file.) See the website for more details on how to set up custom stages.`,
+      `Failed to set the custom stage of "${name}" because it was not found in the custom stages map. (Try restarting IsaacScript / recompiling the mod / restarting the game, and try again. If that does not work, you probably forgot to define it in your "tsconfig.json" file.) See the website for more details on how to set up custom stages.`,
     );
   }
 
@@ -56,7 +68,7 @@ export function setCustomStage(name: string, verbose = false): void {
   setStage(baseStage, baseStageType);
 
   // Now, we need to pick a custom room for each vanilla room.
-  for (const room of getRooms()) {
+  for (const room of getRoomsInGrid()) {
     // The starting floor of each room should stay empty.
     if (room.SafeGridIndex === startingRoomGridIndex) {
       continue;

package/src/features/customTrapdoor/blackSprite.ts

@@ -16,6 +16,7 @@ export function drawBlackSprite(): void {
   if (!blackSprite.IsLoaded()) {
     blackSprite.Load("gfx/ui/boss/versusscreen.anm2", true);
     blackSprite.SetFrame("Scene", 0);
+    blackSprite.Scale = Vector(100, 100);
   }
 
   blackSprite.RenderLayer(0, VectorZero);

package/src/functions/levelGrid.ts

@@ -207,7 +207,7 @@ export function getNewRoomCandidatesForLevel(): Array<
 export function getRoomGridIndexesForType(...roomTypes: RoomType[]): int[] {
   const roomTypesSet = new Set<RoomType>([...roomTypes]);
 
-  const rooms = getRooms();
+  const rooms = getRoomsInGrid();
   const matchingRooms = rooms.filter(
     (roomDescriptor) =>
       roomDescriptor.Data !== undefined &&

package/src/functions/roomData.ts

@@ -62,7 +62,7 @@ export function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor {
  * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
  * `RoomDescriptor` object that you are retrieving.
  */
-export function getRoomDescriptorReadOnly(): ReadonlyRoomDescriptor {
+export function getRoomDescriptorReadOnly(): Readonly<RoomDescriptor> {
   const level = game.GetLevel();
   return level.GetCurrentRoomDesc();
 }

package/src/functions/rooms.ts

@@ -1,5 +1,6 @@
 import {
   AngelRoomSubType,
+  BackdropType,
   BossID,
   Dimension,
   Direction,
@@ -18,7 +19,7 @@ import {
   StageID,
 } from "isaac-typescript-definitions";
 import { game, sfxManager } from "../cachedClasses";
-import { MAX_LEVEL_GRID_INDEX } from "../constants";
+import { MAX_LEVEL_GRID_INDEX, NUM_DIMENSIONS } from "../constants";
 import { ROOM_TYPE_NAMES } from "../objects/roomTypeNames";
 import { MINE_SHAFT_ROOM_SUB_TYPE_SET } from "../sets/mineShaftRoomSubTypesSet";
 import { hasCurse } from "./curses";
@@ -39,6 +40,7 @@ import {
 } from "./positionVelocity";
 import {
   getRoomData,
+  getRoomDescriptor,
   getRoomDescriptorReadOnly,
   getRoomGridIndex,
   getRoomName,
@@ -46,7 +48,7 @@ import {
   getRoomSubType,
 } from "./roomData";
 import { getGotoCommand } from "./stage";
-import { irange } from "./utils";
+import { erange, irange } from "./utils";
 
 /**
  * Helper function for quickly switching to a new room without playing a particular animation. Use
@@ -79,6 +81,36 @@ export function getNumRooms(): int {
   return rooms.length;
 }
 
+/**
+ * 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 function getReadOnlyRooms(): Array<Readonly<RoomDescriptor>> {
+  const level = game.GetLevel();
+  const roomList = level.GetRooms();
+
+  const readOnlyRoomDescriptors: Array<Readonly<RoomDescriptor>> = [];
+
+  for (let i = 0; i < roomList.Size; i++) {
+    const readOnlyRoomDescriptor = roomList.Get(i);
+    if (
+      readOnlyRoomDescriptor !== undefined &&
+      readOnlyRoomDescriptor.Data !== undefined
+    ) {
+      readOnlyRoomDescriptors.push(readOnlyRoomDescriptor);
+    }
+  }
+
+  return readOnlyRoomDescriptors;
+}
+
 /**
  * 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
@@ -146,87 +178,105 @@ export 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 function getRooms(
   includeExtraDimensionalRooms = false,
 ): RoomDescriptor[] {
-  const level = game.GetLevel();
-  const roomList = level.GetRooms();
-
-  /** Indexed by room safe grid index. We use a map to avoid adding extra dimensional rooms. */
-  const roomsMap = new Map<int, RoomDescriptor>();
-
-  for (let i = 0; i < roomList.Size; i++) {
-    const roomDescriptor = roomList.Get(i);
-    if (roomDescriptor === undefined || roomDescriptor.Data === undefined) {
-      continue;
-    }
-
-    if (
-      !includeExtraDimensionalRooms &&
-      roomsMap.has(roomDescriptor.SafeGridIndex)
-    ) {
-      continue;
-    }
-
-    roomsMap.set(roomDescriptor.SafeGridIndex, roomDescriptor);
-  }
-
-  return [...roomsMap.values()];
+  // The obvious way to get all of the rooms would be to iterate over the `RoomList` from the
+  // `Level.GetRooms` method. However, this results in read-only data, and we want to return a
+  // writable object. Instead, we let the heavy lifting be handled by other functions.
+  const roomsInGrid = getRoomsInGrid(includeExtraDimensionalRooms);
+  const roomsOutsideGrid = getRoomsOutsideGrid();
+  return [...roomsInGrid, ...roomsOutsideGrid];
 }
 
 /**
- * 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 function getRoomsInGrid(
   includeExtraDimensionalRooms = false,
 ): RoomDescriptor[] {
-  const rooms = getRooms(includeExtraDimensionalRooms);
-  return rooms.filter((roomDescriptor) => roomDescriptor.SafeGridIndex >= 0);
+  const level = game.GetLevel();
+
+  const dimensions = includeExtraDimensionalRooms
+    ? (erange(NUM_DIMENSIONS) as Dimension[])
+    : [Dimension.CURRENT];
+
+  /** We use a map instead of an array because room shapes occupy more than one room grid index. */
+  const roomDescriptorMap = new Map<PtrHash, RoomDescriptor>();
+
+  for (const dimension of dimensions) {
+    for (const roomGridIndex of irange(MAX_LEVEL_GRID_INDEX)) {
+      const roomDescriptor = level.GetRoomByIdx(roomGridIndex, dimension);
+      if (roomDescriptor.Data !== undefined) {
+        const ptrHash = GetPtrHash(roomDescriptor);
+        roomDescriptorMap.set(ptrHash, roomDescriptor);
+      }
+    }
+  }
+
+  return [...roomDescriptorMap.values()];
 }
 
 /**
  * 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 function getRoomsOfDimension(dimension: Dimension): RoomDescriptor[] {
   const level = game.GetLevel();
 
   /** We use a map instead of an array because room shapes occupy more than one room grid index. */
-  const roomsMap = new Map<int, RoomDescriptor>();
+  const roomsMap = new Map<PtrHash, RoomDescriptor>();
 
   for (const roomGridIndex of irange(MAX_LEVEL_GRID_INDEX)) {
     const roomDescriptor = level.GetRoomByIdx(roomGridIndex, dimension);
     if (roomDescriptor.Data !== undefined) {
-      roomsMap.set(roomDescriptor.ListIndex, roomDescriptor);
+      const ptrHash = GetPtrHash(roomDescriptor);
+      roomsMap.set(ptrHash, roomDescriptor);
     }
   }
 
   return [...roomsMap.values()];
 }
 
+/**
+ * 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 function getRoomsOutsideGrid(): RoomDescriptor[] {
+  // We filter an array of all rooms instead of iterating over the `GridRoom` enum because it is
+  // possible for mods to insert data at arbitrary negative room grid indexes.
+  const readOnlyRooms = getReadOnlyRooms();
+  const readOnlyRoomsOffGrid = readOnlyRooms.filter(
+    (readOnlyRoomDescriptor) => readOnlyRoomDescriptor.SafeGridIndex < 0,
+  );
+
+  return readOnlyRoomsOffGrid.map((readOnlyRoomDescriptor) =>
+    getRoomDescriptor(readOnlyRoomDescriptor.SafeGridIndex),
+  );
+}
+
 /**
  * Helper function to determine if the current room shape is equal to `RoomShape.1x2` or
  * `RoomShape.2x1`.
@@ -413,7 +463,7 @@ export 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
@@ -422,7 +472,7 @@ export function inStartingRoom(): boolean {
 export function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean {
   const roomTypeWhitelist =
     onlyCheckRoomTypes === undefined ? null : new Set(onlyCheckRoomTypes);
-  const rooms = getRooms();
+  const rooms = getRoomsInGrid();
   const matchingRooms =
     roomTypeWhitelist === null
       ? rooms
@@ -454,6 +504,11 @@ export function roomUpdateSafe(): void {
   setEntityVelocities(entityVelocities, entities);
 }
 
+/** Helper function to set the backdrop of the current room. */
+export function setBackdrop(backdropType: BackdropType): void {
+  game.ShowHallucination(0, backdropType);
+}
+
 /**
  * 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