isaacscript-common 6.17.1 → 6.20.0

package/dist/functions/rooms.lua

@@ -1,11 +1,10 @@
 local ____lualib = require("lualib_bundle")
-local __TS__ArrayMap = ____lualib.__TS__ArrayMap
-local Set = ____lualib.Set
+local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
-local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__Spread = ____lualib.__TS__Spread
-local Map = ____lualib.Map
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__StringIncludes = ____lualib.__TS__StringIncludes
+local Set = ____lualib.Set
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
@@ -16,6 +15,7 @@ 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
@@ -26,15 +26,15 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local sfxManager = ____cachedClasses.sfxManager
 local ____constants = require("constants")
-local LEVEL_GRID_ROW_WIDTH = ____constants.LEVEL_GRID_ROW_WIDTH
 local MAX_LEVEL_GRID_INDEX = ____constants.MAX_LEVEL_GRID_INDEX
-local NUM_DIMENSIONS = ____constants.NUM_DIMENSIONS
-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 ____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")
 local closeAllDoors = ____doors.closeAllDoors
 local getDoors = ____doors.getDoors
@@ -50,26 +50,22 @@ local getEntityVelocities = ____positionVelocity.getEntityVelocities
 local setEntityPositions = ____positionVelocity.setEntityPositions
 local setEntityVelocities = ____positionVelocity.setEntityVelocities
 local ____roomData = require("functions.roomData")
-local getRoomAllowedDoors = ____roomData.getRoomAllowedDoors
 local getRoomData = ____roomData.getRoomData
-local getRoomDescriptor = ____roomData.getRoomDescriptor
 local getRoomDescriptorReadOnly = ____roomData.getRoomDescriptorReadOnly
 local getRoomGridIndex = ____roomData.getRoomGridIndex
 local getRoomName = ____roomData.getRoomName
-local getRoomShape = ____roomData.getRoomShape
 local getRoomStageID = ____roomData.getRoomStageID
 local getRoomSubType = ____roomData.getRoomSubType
-local ____roomShape = require("functions.roomShape")
-local getGridIndexDelta = ____roomShape.getGridIndexDelta
+local ____stage = require("functions.stage")
+local getGotoCommand = ____stage.getGotoCommand
 local ____utils = require("functions.utils")
-local erange = ____utils.erange
 local irange = ____utils.irange
-function ____exports.getRoomShapeNeighborGridIndexDeltas(self, roomShape)
-    return {__TS__Spread(ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]:values())}
-end
---- Helper function to get the room descriptor for every room on the level, including off-grid rooms.
--- Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be
--- non-existent and are not added to the list.
+--- 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.)
+-- 
+-- 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.
 -- 
 -- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
 -- extra-dimensional rooms are automatically generated and can be
@@ -80,32 +76,84 @@ function ____exports.getRooms(self, includeExtraDimensionalRooms)
     end
     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)
-    if includeExtraDimensionalRooms then
-        do
-            local i = 0
-            while i < roomList.Size do
+    do
+        local i = 0
+        while i < roomList.Size do
+            do
                 local roomDescriptor = roomList:Get(i)
-                if roomDescriptor ~= nil and roomDescriptor.Data ~= nil then
-                    roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
+                if roomDescriptor == nil or roomDescriptor.Data == nil then
+                    goto __continue10
                 end
-                i = i + 1
-            end
-        end
-    else
-        for ____, roomGridIndex in ipairs(irange(nil, MAX_LEVEL_GRID_INDEX)) do
-            local roomDescriptor = level:GetRoomByIdx(roomGridIndex)
-            if roomDescriptor.Data ~= nil then
-                roomsMap:set(roomDescriptor.ListIndex, roomDescriptor)
+                if not includeExtraDimensionalRooms and roomsMap:has(roomDescriptor.SafeGridIndex) then
+                    goto __continue10
+                end
+                roomsMap:set(roomDescriptor.SafeGridIndex, roomDescriptor)
             end
+            ::__continue10::
+            i = i + 1
         end
     end
     return {__TS__Spread(roomsMap:values())}
 end
---- Helper function to check if a room exists at the given room grid index.
-function ____exports.roomExists(self, roomGridIndex)
+--- Helper function to get the room descriptor for every room on the level except for rooms that are
+-- not on the grid.
+-- 
+-- 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.
+-- 
+-- @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.
+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)
-    return roomData ~= nil
+    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)
+    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
@@ -119,58 +167,46 @@ function ____exports.changeRoom(self, roomGridIndex)
     level.LeaveDoor = DoorSlot.NO_DOOR_SLOT
     game:ChangeRoom(roomGridIndex)
 end
---- Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
-function ____exports.getAllDimensions(self)
-    return erange(nil, NUM_DIMENSIONS)
-end
---- Helper function to get the grid index for every room on the entire floor.
-function ____exports.getAllRoomGridIndexes(self)
-    local rooms = ____exports.getRooms(nil)
-    return __TS__ArrayMap(
-        rooms,
-        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex end
-    )
-end
---- Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,
--- but it can change if e.g. the player is in the mirror world of Downpour/Dross.
-function ____exports.getDimension(self)
-    local level = game:GetLevel()
-    local roomGridIndex = getRoomGridIndex(nil)
-    local roomDescription = level:GetRoomByIdx(roomGridIndex, Dimension.CURRENT)
-    local currentRoomHash = GetPtrHash(roomDescription)
-    for ____, dimension in ipairs(____exports.getAllDimensions(nil)) do
-        local dimensionRoomDescription = level:GetRoomByIdx(roomGridIndex, dimension)
-        local dimensionRoomHash = GetPtrHash(dimensionRoomDescription)
-        if dimensionRoomHash == currentRoomHash then
-            return dimension
-        end
-    end
-    error("Failed to get the current dimension.")
-end
 --- Helper function to get the number of rooms that are currently on the floor layout. This does not
 -- include off-grid rooms, like the Devil Room.
 function ____exports.getNumRooms(self)
-    local rooms = ____exports.getRooms(nil)
+    local rooms = ____exports.getRoomsInGrid(nil)
     return #rooms
 end
---- Helper function to get an array of all of the safe grid indexes for rooms that match the
--- specified room type.
+--- 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.
 -- 
--- This function only searches through rooms in the current dimension.
+-- 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.
 -- 
--- 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 = ____exports.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
-    )
+-- @param roomType The type of room to retrieve.
+-- @param roomVariant The room variant to retrieve. (The room variant is the "ID" of the room in
+-- Basement Renovator.)
+-- @param cancelRoomTransition Optional. Whether to cancel the room transition by using the
+-- `Game.StartRoomTransition` method to travel to the same room. Default
+-- is true. Set this to false if you are getting the data for many rooms
+-- at the same time, and then use the `teleport` helper function when
+-- you are finished.
+function ____exports.getRoomDataForTypeVariant(self, roomType, roomVariant, cancelRoomTransition)
+    if cancelRoomTransition == nil then
+        cancelRoomTransition = true
+    end
+    local command = getGotoCommand(nil, roomType, roomVariant)
+    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
+        )
+    end
+    return newRoomData
 end
 --- Helper function to get the item pool type for the current room. For example, this returns
 -- `ItemPoolType.ItemPoolType.POOL_ANGEL` if you are in an Angel Room.
@@ -181,59 +217,22 @@ function ____exports.getRoomItemPoolType(self)
     local roomSeed = room:GetSpawnSeed()
     return itemPool:GetPoolForRoom(roomType, roomSeed)
 end
---- Helper function to get the grid indexes of all the rooms connected to the given room index.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
-function ____exports.getRoomNeighbors(self, roomGridIndex)
-    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
-    if roomDescriptor.SafeGridIndex < 0 or roomDescriptor.SafeGridIndex > MAX_LEVEL_GRID_INDEX then
-        return {}
-    end
-    local roomData = roomDescriptor.Data
-    if roomData == nil then
-        return {}
-    end
-    local roomShape = roomData.Shape
-    local gridIndexDeltas = ____exports.getRoomShapeNeighborGridIndexDeltas(nil, roomShape)
-    local gridIndexes = __TS__ArrayMap(
-        gridIndexDeltas,
-        function(____, gridIndexDelta) return roomDescriptor.SafeGridIndex + gridIndexDelta end
-    )
-    return __TS__ArrayFilter(
-        gridIndexes,
-        function(____, gridIndex) return ____exports.roomExists(nil, gridIndex) end
-    )
-end
 --- Helper function to get the proper name of a room type.
 -- 
 -- For example, `RoomType.TREASURE` will return "Treasure Room".
 function ____exports.getRoomTypeName(self, roomType)
     return ROOM_TYPE_NAMES[roomType]
 end
---- Helper function to get the room descriptor for every room on the level except for rooms that are
--- not on the grid. Uses the `Level.GetRooms` method to accomplish this. Rooms without data are
--- assumed to be non-existent and are not added to the list.
--- 
--- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
--- extra-dimensional rooms are automatically be generated and can be
--- seen when you iterate over the `RoomList`. 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 get the room descriptor for every room on the level in a specific dimension.
--- Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be
--- non-existent and are not added to the list.
+-- 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.
 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.
     local roomsMap = __TS__New(Map)
     for ____, roomGridIndex in ipairs(irange(nil, MAX_LEVEL_GRID_INDEX)) do
         local roomDescriptor = level:GetRoomByIdx(roomGridIndex, dimension)
@@ -294,9 +293,6 @@ function ____exports.inDevilsCrownTreasureRoom(self)
     local roomDescriptor = getRoomDescriptorReadOnly(nil)
     return hasFlag(nil, roomDescriptor.Flags, RoomDescriptorFlag.DEVIL_TREASURE)
 end
-function ____exports.inDimension(self, dimension)
-    return dimension == ____exports.getDimension(nil)
-end
 function ____exports.inDoubleTrouble(self)
     local room = game:GetRoom()
     local roomType = room:GetType()
@@ -349,7 +345,7 @@ function ____exports.inStartingRoom(self)
     local level = game:GetLevel()
     local startingRoomGridIndex = level:GetStartingRoomIndex()
     local roomGridIndex = getRoomGridIndex(nil)
-    return roomGridIndex == startingRoomGridIndex and ____exports.inDimension(nil, Dimension.MAIN)
+    return roomGridIndex == startingRoomGridIndex and inDimension(nil, Dimension.MAIN)
 end
 --- Helper function to loop through every room on the floor and see if it has been cleared.
 -- 
@@ -376,52 +372,6 @@ function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
         function(____, roomDescriptor) return roomDescriptor.Clear end
     )
 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 redRoomGridIndex >= 0 and redRoomGridIndex <= MAX_LEVEL_GRID_INDEX
-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 determine if the provided room is part of the floor layout. For example, Devil
--- Rooms and the Mega Satan room are not considered to be inside the map.
--- 
--- @param roomGridIndex Optional. Default is the current room index.
-function ____exports.isRoomInsideMap(self, roomGridIndex)
-    if roomGridIndex == nil then
-        roomGridIndex = getRoomGridIndex(nil)
-    end
-    return roomGridIndex >= 0
-end
---- Helper function to get the coordinates of a given grid index. The floor is represented by a 13x13
--- grid. For example, since the starting room is in the center, the starting room grid index of 84
--- be equal to coordinates of (?, ?).
-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
 --- If the `Room.Update` method is called in a `POST_NEW_ROOM` callback, then some entities will
 -- slide around (such as the player). Since those entity velocities are already at zero, setting
 -- them to zero will have no effect. Thus, a generic solution is to record all of the entity
@@ -448,12 +398,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue69
+                goto __continue40
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue69::
+        ::__continue40::
     end
     sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)
@@ -465,28 +415,4 @@ function ____exports.setRoomUncleared(self)
     room:SetClear(false)
     closeAllDoors(nil)
 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 and to prevent crashing on invalid
--- room grid indexes.
--- 
--- @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`.
-function ____exports.teleport(self, roomGridIndex, direction, roomTransitionAnim)
-    if direction == nil then
-        direction = Direction.NO_DIRECTION
-    end
-    if roomTransitionAnim == nil then
-        roomTransitionAnim = RoomTransitionAnim.TELEPORT
-    end
-    local level = game:GetLevel()
-    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)
-end
 return ____exports

package/dist/functions/saveFile.d.ts

@@ -1,7 +1,7 @@
 import { CollectibleType, ItemPoolType } from "isaac-typescript-definitions";
 /**
  * Helper function to see if the given collectible is unlocked on the current save file. This
- * requires providing the corresponding item pool that the collectible is located in.
+ * requires providing the corresponding item pool that the collectible is normally located in.
  *
  * - If any player currently has the collectible, then it is assumed to be unlocked. (This is
  *   because in almost all cases, when a collectible is added to a player's inventory, it is

package/dist/functions/saveFile.lua

@@ -4,7 +4,7 @@ local isCollectibleInItemPool = ____itemPool.isCollectibleInItemPool
 local ____players = require("functions.players")
 local anyPlayerHasCollectible = ____players.anyPlayerHasCollectible
 --- Helper function to see if the given collectible is unlocked on the current save file. This
--- requires providing the corresponding item pool that the collectible is located in.
+-- requires providing the corresponding item pool that the collectible is normally located in.
 -- 
 -- - If any player currently has the collectible, then it is assumed to be unlocked. (This is
 --   because in almost all cases, when a collectible is added to a player's inventory, it is

package/dist/index.d.ts

@@ -54,9 +54,11 @@ export * from "./functions/collectibles";
 export * from "./functions/collectibleSet";
 export * from "./functions/collectibleTag";
 export * from "./functions/color";
+export * from "./functions/curses";
 export * from "./functions/debug";
 export * from "./functions/deepCopy";
 export * from "./functions/deepCopyTests";
+export * from "./functions/dimensions";
 export * from "./functions/direction";
 export * from "./functions/doors";
 export * from "./functions/easing";
@@ -80,6 +82,7 @@ export * from "./functions/jsonRoom";
 export * from "./functions/kColor";
 export * from "./functions/language";
 export * from "./functions/level";
+export * from "./functions/levelGrid";
 export * from "./functions/log";
 export * from "./functions/map";
 export * from "./functions/math";

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,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,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,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,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

@@ -430,6 +430,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.curses")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.debug")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -454,6 +462,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.dimensions")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.direction")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -638,6 +654,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.levelGrid")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.log")
     for ____exportKey, ____exportValue in pairs(____export) do

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "6.17.1",
+  "version": "6.20.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.0"
+    "isaac-typescript-definitions": "^3.1.1"
   }
 }

package/src/features/customStage/exports.ts

@@ -1,6 +1,5 @@
 import {
   EntityType,
-  GridRoom,
   LevelStage,
   RoomShape,
   RoomType,
@@ -11,9 +10,8 @@ import { reorderedCallbacksSetStage } from "../../callbacks/reorderedCallbacks";
 import { getEntityIDFromConstituents } from "../../functions/entities";
 import { log, logError } from "../../functions/log";
 import { newRNG } from "../../functions/rng";
-import { getRoomData } from "../../functions/roomData";
-import { getRooms } from "../../functions/rooms";
-import { getGotoCommand, setStage } from "../../functions/stage";
+import { getRoomDataForTypeVariant, getRooms } from "../../functions/rooms";
+import { setStage } from "../../functions/stage";
 import { getRandomCustomStageRoom } from "./customStageUtils";
 import { topStreakTextStart } from "./streakText";
 import v, {
@@ -103,18 +101,19 @@ export function setCustomStage(name: string, verbose = false): void {
 
     let newRoomData = customStageCachedRoomData.get(randomRoom.variant);
     if (newRoomData === undefined) {
-      // We need the room data for this room. We can leverage the "goto" console command to load it
-      // into the "debug" slot. This is convenient because we do not actually have to travel to the
-      // room.
-      const command = getGotoCommand(roomType, randomRoom.variant);
-      Isaac.ExecuteCommand(command);
-      newRoomData = getRoomData(GridRoom.DEBUG);
+      // We do not already have the room data for this room cached.
+      newRoomData = getRoomDataForTypeVariant(
+        roomType,
+        randomRoom.variant,
+        false,
+      );
       if (newRoomData === undefined) {
         logError(
           `Failed to get the room data for room variant ${randomRoom.variant} for custom stage: ${name}`,
         );
         continue;
       }
+
       customStageCachedRoomData.set(randomRoom.variant, newRoomData);
     }
 
@@ -134,7 +133,7 @@ export function setCustomStage(name: string, verbose = false): void {
   // Furthermore, we need to cancel the queued warp to the `GridRoom.DEBUG` room. We can accomplish
   // both of these things by initiating a room transition to an arbitrary room. However, we rely on
   // the parent function to do this, since for normal purposes, we need to initiate a room
-  // transition for pixelation purposes.
+  // transition for the pixelation effect.
 }
 
 export function setCustomStageDebug(): void {