isaacscript-common 6.20.1 → 6.22.0

package/dist/functions/rockAlt.lua

@@ -1,5 +1,5 @@
 local ____exports = {}
-local spawnRockAltRewardUrn, spawnRockAltRewardMushroom, spawnRockAltRewardSkull, spawnRockAltRewardPolyp, spawnRockAltRewardBucket, ROCK_ALT_CHANCES, POLYP_PROJECTILE_SPEED, POLYP_NUM_PROJECTILES
+local spawnRockAltRewardUrn, spawnRockAltRewardMushroom, spawnRockAltRewardSkull, spawnRockAltRewardPolyp, spawnRockAltRewardBucketDownpour, spawnRockAltRewardBucketDross, ROCK_ALT_CHANCES, COIN_VELOCITY_MULTIPLIER, POLYP_PROJECTILE_SPEED, POLYP_NUM_PROJECTILES
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local Card = ____isaac_2Dtypescript_2Ddefinitions.Card
 local CoinSubType = ____isaac_2Dtypescript_2Ddefinitions.CoinSubType
@@ -55,13 +55,12 @@ function spawnRockAltRewardUrn(self, position, rng)
     if chance < totalChance then
         local numCoinsChance = getRandom(nil, rng)
         local numCoins = numCoinsChance < 0.5 and 1 or 2
-        local length = DISTANCE_OF_GRID_TILE
         ____repeat(
             nil,
             numCoins,
             function()
                 local randomVector = getRandomVector(nil, rng)
-                local velocity = randomVector * length
+                local velocity = randomVector * COIN_VELOCITY_MULTIPLIER
                 spawnCoinWithSeed(
                     nil,
                     CoinSubType.NULL,
@@ -87,12 +86,12 @@ function spawnRockAltRewardUrn(self, position, rng)
         end
         return false
     end
-    local numSpidersChance = getRandom(nil, rng)
-    local numSpiders = numSpidersChance < 0.5 and 1 or 2
+    local numEnemiesChance = getRandom(nil, rng)
+    local numEnemies = numEnemiesChance < 0.5 and 1 or 2
     local length = DISTANCE_OF_GRID_TILE * 3
     ____repeat(
         nil,
-        numSpiders,
+        numEnemies,
         function()
             local randomVector = getRandomVector(nil, rng)
             local offset = randomVector * length
@@ -266,16 +265,142 @@ function spawnRockAltRewardPolyp(self, position, rng)
     )
     return true
 end
-function spawnRockAltRewardBucket(self, _position, rng, _variant)
+function spawnRockAltRewardBucketDownpour(self, position, rng)
     local chance = getRandom(nil, rng)
     local totalChance = 0
     totalChance = totalChance + ROCK_ALT_CHANCES.NOTHING
     if chance < totalChance then
         return false
     end
-    return false
+    totalChance = totalChance + ROCK_ALT_CHANCES.BASIC_DROP
+    if chance < totalChance then
+        local numCoinsChance = getRandom(nil, rng)
+        local numCoins = numCoinsChance < 0.5 and 1 or 2
+        ____repeat(
+            nil,
+            numCoins,
+            function()
+                local randomVector = getRandomVector(nil, rng)
+                local velocity = randomVector * COIN_VELOCITY_MULTIPLIER
+                spawnCoinWithSeed(
+                    nil,
+                    CoinSubType.NULL,
+                    position,
+                    rng,
+                    velocity
+                )
+            end
+        )
+        return true
+    end
+    totalChance = totalChance + ROCK_ALT_CHANCES.TRINKET
+    if chance < totalChance then
+        spawnTrinketWithSeed(nil, TrinketType.SWALLOWED_PENNY, position, rng)
+        return true
+    end
+    totalChance = totalChance + ROCK_ALT_CHANCES.COLLECTIBLE
+    if chance < totalChance then
+        local stillInPools = isCollectibleInItemPool(nil, CollectibleType.LEECH, ItemPoolType.TREASURE)
+        if stillInPools then
+            spawnCollectible(nil, CollectibleType.LEECH, position, rng)
+            return true
+        end
+        return false
+    end
+    local enemiesChance = getRandom(nil, rng)
+    local entityType = enemiesChance < 0.5 and EntityType.SPIDER or EntityType.SMALL_LEECH
+    local numEnemiesChance = getRandom(nil, rng)
+    local numEnemies = numEnemiesChance < 0.5 and 1 or 2
+    local jumpDistance = DISTANCE_OF_GRID_TILE * 3
+    ____repeat(
+        nil,
+        numEnemies,
+        function()
+            local randomVector = getRandomVector(nil, rng)
+            local offset = randomVector * jumpDistance
+            local targetPos = position + offset
+            local spider = EntityNPC.ThrowSpider(
+                position,
+                nil,
+                targetPos,
+                false,
+                0
+            )
+            if entityType == EntityType.SMALL_LEECH and spider.Type ~= entityType then
+                spider:Morph(entityType, 0, 0, -1)
+            end
+        end
+    )
+    return true
+end
+function spawnRockAltRewardBucketDross(self, position, rng)
+    local chance = getRandom(nil, rng)
+    local totalChance = 0
+    totalChance = totalChance + ROCK_ALT_CHANCES.NOTHING
+    if chance < totalChance then
+        return false
+    end
+    totalChance = totalChance + ROCK_ALT_CHANCES.BASIC_DROP
+    if chance < totalChance then
+        local numCoinsChance = getRandom(nil, rng)
+        local numCoins = numCoinsChance < 0.5 and 1 or 2
+        ____repeat(
+            nil,
+            numCoins,
+            function()
+                local randomVector = getRandomVector(nil, rng)
+                local velocity = randomVector * COIN_VELOCITY_MULTIPLIER
+                spawnCoinWithSeed(
+                    nil,
+                    CoinSubType.NULL,
+                    position,
+                    rng,
+                    velocity
+                )
+            end
+        )
+        return true
+    end
+    totalChance = totalChance + ROCK_ALT_CHANCES.TRINKET
+    if chance < totalChance then
+        spawnTrinketWithSeed(nil, TrinketType.BUTT_PENNY, position, rng)
+        return true
+    end
+    totalChance = totalChance + ROCK_ALT_CHANCES.COLLECTIBLE
+    if chance < totalChance then
+        local stillInPools = isCollectibleInItemPool(nil, CollectibleType.POOP, ItemPoolType.TREASURE)
+        if stillInPools then
+            spawnCollectible(nil, CollectibleType.POOP, position, rng)
+            return true
+        end
+        return false
+    end
+    local enemiesChance = getRandom(nil, rng)
+    local entityType = enemiesChance < 0.5 and EntityType.DRIP or EntityType.SMALL_LEECH
+    local numEnemiesChance = getRandom(nil, rng)
+    local numEnemies = numEnemiesChance < 0.5 and 1 or 2
+    local jumpDistance = DISTANCE_OF_GRID_TILE * 3
+    ____repeat(
+        nil,
+        numEnemies,
+        function()
+            local randomVector = getRandomVector(nil, rng)
+            local offset = randomVector * jumpDistance
+            local targetPos = position + offset
+            local spider = EntityNPC.ThrowSpider(
+                position,
+                nil,
+                targetPos,
+                false,
+                0
+            )
+            spider:Morph(entityType, 0, 0, -1)
+        end
+    )
+    return true
 end
 ROCK_ALT_CHANCES = {NOTHING = 0.68, BASIC_DROP = 0.0967, TRINKET = 0.025, COLLECTIBLE = 0.005}
+COIN_VELOCITY_MULTIPLIER = 2
 POLYP_PROJECTILE_SPEED = 10
 POLYP_NUM_PROJECTILES = 6
 --- Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
@@ -306,24 +431,22 @@ end
 -- trinket is still in the pool. Thus, it will always have a chance to spawn the respective trinket
 -- (e.g. Swallowed Penny from urns).
 -- 
+-- When filled buckets are destroyed, 6 projectiles will always spawn in a random pattern (in
+-- addition to any other rewards that are spawned). This function does not account for this, so if
+-- you want to specifically emulate destroying a filled bucket, you have to account for the
+-- projectiles yourself.
+-- 
 -- The logic in this function is based on the rewards listed on the wiki:
 -- https://bindingofisaacrebirth.fandom.com/wiki/Rocks
 -- 
 -- @param position The place to spawn the reward.
 -- @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a chance
 -- at spawning coins and spiders.
--- @param variant Optional. The variant of the grid entity to emulate. Default is 0, which
--- corresponds to a "normal" grid entity or an empty bucket. This only matters when
--- spawning the reward for buckets. (Empty buckets have different rewards than full
--- buckets.)
 -- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
 -- `RNG.Next` method will be called. Default is `getRandomSeed()`. Normally, you
 -- should pass the `InitSeed` of the grid entity that was broken.
 -- @returns Whether or not this function spawned something.
-function ____exports.spawnRockAltReward(self, position, rockAltType, variant, seedOrRNG)
-    if variant == nil then
-        variant = 0
-    end
+function ____exports.spawnRockAltReward(self, position, rockAltType, seedOrRNG)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
@@ -354,10 +477,16 @@ function ____exports.spawnRockAltReward(self, position, rockAltType, variant, se
                 return spawnRockAltRewardPolyp(nil, position, rng)
             end
         end
-        ____cond4 = ____cond4 or ____switch4 == RockAltType.BUCKET
+        ____cond4 = ____cond4 or ____switch4 == RockAltType.BUCKET_DOWNPOUR
+        if ____cond4 then
+            do
+                return spawnRockAltRewardBucketDownpour(nil, position, rng)
+            end
+        end
+        ____cond4 = ____cond4 or ____switch4 == RockAltType.BUCKET_DROSS
         if ____cond4 then
             do
-                return spawnRockAltRewardBucket(nil, position, rng, variant)
+                return spawnRockAltRewardBucketDross(nil, position, rng)
             end
         end
     until true

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/roomTransition.d.ts

@@ -0,0 +1,26 @@
+import { Direction, RoomTransitionAnim } from "isaac-typescript-definitions";
+/**
+ * Helper function to reload the current room using `Game.StartRoomTransition`.
+ *
+ * This is useful for canceling the "goto" console command or to make the `Level.SetStage` method
+ * take effect.
+ */
+export declare function reloadRoom(): 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=roomTransition.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"roomTransition.d.ts","sourceRoot":"","sources":["../../src/functions/roomTransition.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAGT,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AAMtC;;;;;GAKG;AACH,wBAAgB,UAAU,IAAI,IAAI,CAQjC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,QAAQ,CACtB,aAAa,EAAE,GAAG,EAClB,SAAS,YAAyB,EAClC,kBAAkB,qBAA8B,EAChD,KAAK,UAAQ,GACZ,IAAI,CA6BN"}

package/dist/functions/roomTransition.lua

@@ -0,0 +1,75 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+local LevelCurse = ____isaac_2Dtypescript_2Ddefinitions.LevelCurse
+local RoomTransitionAnim = ____isaac_2Dtypescript_2Ddefinitions.RoomTransitionAnim
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____runNextRoom = require("features.runNextRoom")
+local runNextRoom = ____runNextRoom.runNextRoom
+local ____curses = require("functions.curses")
+local hasCurse = ____curses.hasCurse
+local ____roomData = require("functions.roomData")
+local getRoomData = ____roomData.getRoomData
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+--- 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
+        runNextRoom(
+            nil,
+            function()
+                local futureLevel = game:GetLevel()
+                futureLevel:AddCurse(LevelCurse.MAZE, false)
+            end
+        )
+    end
+end
+--- Helper function to reload the current room using `Game.StartRoomTransition`.
+-- 
+-- This is useful for canceling the "goto" console command or to make the `Level.SetStage` method
+-- take effect.
+function ____exports.reloadRoom(self)
+    local roomGridIndex = getRoomGridIndex(nil)
+    ____exports.teleport(
+        nil,
+        roomGridIndex,
+        Direction.NO_DIRECTION,
+        RoomTransitionAnim.FADE,
+        true
+    )
+end
+return ____exports

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,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.
  *
- * 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.
+ *
+ * - 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
@@ -164,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;;;;;;;;;;;;;;;;;;;;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,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"}