isaacscript-common 1.0.497 → 1.0.501

package/dist/features/getCollectibleItemPoolType.lua

@@ -1,49 +1,27 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 require("lualib_bundle");
 local ____exports = {}
-local postPickupInitCollectible, preGetCollectible, v
+local postPickupInitCollectible, v
 local ____errors = require("errors")
 local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
-local ____array = require("functions.array")
-local arrayEmpty = ____array.arrayEmpty
 local ____rooms = require("functions.rooms")
-local getRoomIndex = ____rooms.getRoomIndex
 local getRoomItemPoolType = ____rooms.getRoomItemPoolType
-local getRoomVisitedCount = ____rooms.getRoomVisitedCount
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 function postPickupInitCollectible(self, pickup)
-    local itemPoolType = __TS__ArrayShift(v.run.collectibleQueue)
-    if itemPoolType == nil then
-        return
-    end
+    local game = Game()
+    local itemPool = game:GetItemPool()
     local ptrHash = GetPtrHash(pickup)
-    v.run.collectibleItemPoolTypeMap:set(ptrHash, itemPoolType)
-end
-function preGetCollectible(self, itemPoolType, _decrease, _seed)
-    local roomIndex = getRoomIndex(nil)
-    local roomVisitedCount = getRoomVisitedCount(nil)
-    if roomIndex ~= v.run.currentRoomIndex or roomVisitedCount ~= v.run.currentRoomVisitedCount then
-        v.run.currentRoomIndex = roomIndex
-        v.run.currentRoomVisitedCount = roomVisitedCount
-        arrayEmpty(nil, v.run.collectibleQueue)
-        v.run.collectibleItemPoolTypeMap:clear()
-    end
-    __TS__ArrayPush(v.run.collectibleQueue, itemPoolType)
+    local lastItemPoolType = itemPool:GetLastPool()
+    v.run.collectibleItemPoolTypeMap:set(ptrHash, lastItemPoolType)
 end
 local FEATURE_NAME = "get collectible item pool type"
 local initialized = false
-v = {run = {
-    collectibleQueue = {},
-    collectibleItemPoolTypeMap = __TS__New(Map),
-    currentRoomIndex = nil,
-    currentRoomVisitedCount = nil
-}}
+v = {run = {collectibleItemPoolTypeMap = __TS__New(Map)}}
 function ____exports.getCollectibleItemPoolTypeInit(self, mod)
     initialized = true
     saveDataManager(nil, "getCollectibleItemPoolType", v)
     mod:AddCallback(ModCallbacks.MC_POST_PICKUP_INIT, postPickupInitCollectible, PickupVariant.PICKUP_COLLECTIBLE)
-    mod:AddCallback(ModCallbacks.MC_PRE_GET_COLLECTIBLE, preGetCollectible)
 end
 function ____exports.getCollectibleItemPoolType(self, collectible)
     if not initialized then

package/dist/functions/collectibles.d.ts

@@ -56,6 +56,12 @@ export declare function isGlitchedCollectible(entity: Entity): boolean;
  */
 export declare function isPassiveCollectible(collectibleType: CollectibleType | int): boolean;
 export declare function isQuestCollectible(collectibleType: CollectibleType | int): boolean;
+/**
+ * Helper function to determine if a particular collectible will disappear from the player's
+ * inventory upon use. Note that this will not work will modded items, as there is no way to
+ * dynamically know if a modded item will disappear.
+ */
+export declare function isSingleUseCollectible(collectibleType: CollectibleType | int): boolean;
 /**
  * Helper function to remove all of the collectibles in the room.
  *
@@ -78,7 +84,26 @@ export declare function removeCollectiblePickupDelay(collectible: EntityPickup):
  */
 export declare function removeCollectibleFromItemTracker(collectibleType: CollectibleType | int): void;
 export declare function setCollectibleBlind(collectible: EntityPickup): void;
-export declare function setCollectibleSprite(collectible: EntityPickup, pngPath: string): void;
+/**
+ * Helper function to remove the collectible from a collectible pedestal and make it appear as if a
+ * player has already taken the item. This is accomplished by setting its sprite to an empty/missing
+ * PNG file.
+ *
+ * For more information, see the documentation for the "emptySprite" helper function.
+ */
+export declare function setCollectibleEmpty(collectible: EntityPickup): void;
+/**
+ * Helper function to change the sprite of a collectible pedestal entity.
+ *
+ * For more information about removing the collectible sprite, see the documentation for the
+ * "emptySprite" helper function.
+ *
+ * @param collectible The collectible whose sprite you want to modify.
+ * @param pngPath Optional. Equal to the spritesheet path to load (e.g.
+ * "gfx/items/collectibles/collectibles_001_thesadonion.png"). If not specified, will remove the
+ * sprite, making it appear like the collectible has already been taken by the player.
+ */
+export declare function setCollectibleSprite(collectible: EntityPickup, pngPath?: string): void;
 /**
  * Helper function to change the collectible on a pedestal. Simply updating the SubType property is
  * not sufficient because the sprite will not change.

package/dist/functions/collectibles.lua

@@ -1,23 +1,32 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 require("lualib_bundle");
 local ____exports = {}
-local COLLECTIBLE_SPRITE_LAYER
+local COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER
+local ____constants = require("constants")
+local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
+local SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES = ____constants.SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES
 local ____collectibleDescriptionMap = require("maps.collectibleDescriptionMap")
 local COLLECTIBLE_DESCRIPTION_MAP = ____collectibleDescriptionMap.COLLECTIBLE_DESCRIPTION_MAP
 local ____collectibleNameMap = require("maps.collectibleNameMap")
 local COLLECTIBLE_NAME_MAP = ____collectibleNameMap.COLLECTIBLE_NAME_MAP
 local ____entity = require("functions.entity")
 local removeAllPickups = ____entity.removeAllPickups
+local ____sprite = require("functions.sprite")
+local clearSprite = ____sprite.clearSprite
 function ____exports.setCollectibleSprite(self, collectible, pngPath)
     if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
         error("You cannot set a collectible sprite for pickups of variant: " .. tostring(collectible.Variant))
     end
     local sprite = collectible:GetSprite()
-    sprite:ReplaceSpritesheet(COLLECTIBLE_SPRITE_LAYER, pngPath)
-    sprite:LoadGraphics()
+    if pngPath == nil then
+        clearSprite(nil, sprite, COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER)
+    else
+        sprite:ReplaceSpritesheet(COLLECTIBLE_SPRITE_LAYER, pngPath)
+        sprite:LoadGraphics()
+    end
 end
 COLLECTIBLE_SPRITE_LAYER = 1
-local BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png"
+COLLECTIBLE_SHADOW_LAYER = 4
 local GLITCHED_ITEM_THRESHOLD = 4000000000
 function ____exports.collectibleHasTag(self, collectibleType, tag)
     local itemConfig = Isaac.GetItemConfig()
@@ -136,6 +145,9 @@ end
 function ____exports.isQuestCollectible(self, collectibleType)
     return ____exports.collectibleHasTag(nil, collectibleType, 32768)
 end
+function ____exports.isSingleUseCollectible(self, collectibleType)
+    return SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES:has(collectibleType)
+end
 function ____exports.removeAllCollectibles(self, collectibleType, cap)
     removeAllPickups(nil, PickupVariant.PICKUP_COLLECTIBLE, collectibleType, cap)
 end
@@ -155,10 +167,21 @@ function ____exports.setCollectibleBlind(self, collectible)
     end
     ____exports.setCollectibleSprite(nil, collectible, BLIND_ITEM_PNG_PATH)
 end
+function ____exports.setCollectibleEmpty(self, collectible)
+    if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
+        error("You cannot set a collectible to be empty for pickups of variant: " .. tostring(collectible.Variant))
+    end
+    collectible.SubType = CollectibleType.COLLECTIBLE_NULL
+    ____exports.setCollectibleSprite(nil, collectible)
+end
 function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
     if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
         error("You cannot set a collectible sub type for pickups of variant: " .. tostring(collectible.Variant))
     end
+    if newCollectibleType == CollectibleType.COLLECTIBLE_NULL then
+        ____exports.setCollectibleEmpty(nil, collectible)
+        return
+    end
     collectible:Morph(
         EntityType.ENTITY_PICKUP,
         PickupVariant.PICKUP_COLLECTIBLE,

package/dist/functions/flag.d.ts

@@ -23,7 +23,7 @@
  */
 export declare function addFlag(flags: int, ...flag: int[]): int;
 /**
- * Helper function to check to see if a particular bit flag is set to true.
+ * Helper function to determine if a particular bit flag is set to true.
  * This is a variadic function, so pass as many flags as you want to check for.
  * If passed multiple flags, it will only return true if all of the flags are set.
  *

package/dist/functions/gridEntity.d.ts

@@ -26,10 +26,16 @@ export declare function convertXMLGridEntityType(gridEntityXMLType: int, gridEnt
  * ```
  */
 export declare function getGridEntities(...gridEntityTypes: GridEntityType[]): GridEntity[];
+export declare function getTopLeftWall(): GridEntity | undefined;
+/**
+ * Helper function to get the grid index of the top left wall.
+ * (This will depend on what the current room shape is.)
+ */
+export declare function getTopLeftWallGridIndex(): int;
 export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
 /**
- * Helper function to see if all of the pressure plates in the current room are pushed. Returns true
- * if there are no pressure plates in the room.
+ * Helper function to determine if all of the pressure plates in the current room are pushed.
+ * Returns true if there are no pressure plates in the room.
  */
 export declare function isAllPressurePlatesPushed(): boolean;
 /**
@@ -78,10 +84,9 @@ export declare function removeAllMatchingGridEntities(...gridEntityType: GridEnt
 export declare function removeGridEntity(gridEntity: GridEntity, updateRoom?: boolean): void;
 /**
  * Helper function to make a grid entity invisible. This is accomplished by setting its sprite to
- * "gfx/none.png" (a non-existent PNG file).
+ * an empty/missing PNG file.
  *
- * Using this function will cause spurious errors in the "log.txt file". If you want to remove them,
- * create a transparent 1 pixel PNG file in your resources folder at "gfx/none.png".
+ * For more information, see the documentation for the "EMPTY_PNG_FILENAME" constant.
  */
 export declare function setGridEntityInvisible(gridEntity: GridEntity): void;
 export declare function spawnGiantPoop(topLeftGridIndex: int): void;

package/dist/functions/gridEntity.lua

@@ -1,10 +1,22 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 require("lualib_bundle");
 local ____exports = {}
+local ____constants = require("constants")
+local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
 local ____gridEntityXMLMap = require("maps.gridEntityXMLMap")
 local GRID_ENTITY_XML_MAP = ____gridEntityXMLMap.GRID_ENTITY_XML_MAP
+local ____roomShapeToTopLeftWallGridIndexMap = require("maps.roomShapeToTopLeftWallGridIndexMap")
+local DEFAULT_TOP_LEFT_WALL_GRID_INDEX = ____roomShapeToTopLeftWallGridIndexMap.DEFAULT_TOP_LEFT_WALL_GRID_INDEX
+local ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP = ____roomShapeToTopLeftWallGridIndexMap.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP
 local ____rooms = require("functions.rooms")
 local roomUpdateSafe = ____rooms.roomUpdateSafe
+function ____exports.getTopLeftWallGridIndex(self)
+    local game = Game()
+    local room = game:GetRoom()
+    local roomShape = room:GetRoomShape()
+    local topLeftWallGridIndex = ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP:get(roomShape)
+    return topLeftWallGridIndex == nil and DEFAULT_TOP_LEFT_WALL_GRID_INDEX or topLeftWallGridIndex
+end
 function ____exports.removeGridEntity(self, gridEntity, updateRoom)
     if updateRoom == nil then
         updateRoom = true
@@ -75,6 +87,12 @@ function ____exports.getGridEntities(self, ...)
     end
     return gridEntities
 end
+function ____exports.getTopLeftWall(self)
+    local game = Game()
+    local room = game:GetRoom()
+    local topLeftWallGridIndex = ____exports.getTopLeftWallGridIndex(nil)
+    return room:GetGridEntity(topLeftWallGridIndex)
+end
 function ____exports.getSurroundingGridEntities(self, gridEntity)
     local game = Game()
     local room = game:GetRoom()
@@ -139,7 +157,7 @@ function ____exports.removeAllMatchingGridEntities(self, ...)
 end
 function ____exports.setGridEntityInvisible(self, gridEntity)
     local sprite = gridEntity:GetSprite()
-    sprite:ReplaceSpritesheet(0, "gfx/none.png")
+    sprite:ReplaceSpritesheet(0, EMPTY_PNG_PATH)
     sprite:LoadGraphics()
 end
 function ____exports.spawnGiantPoop(self, topLeftGridIndex)

package/dist/functions/input.d.ts

@@ -1,13 +1,11 @@
 /// <reference types="isaac-typescript-definitions" />
 /** Helper function to get the enum name for the specified `Controller` value. */
 export declare function controllerToString(controller: Controller): string;
-/**
- * Iterates over all 4 inputs to see if a particular button is pressed (i.e. held down).
- */
+/** Iterates over all 4 inputs to determine if a particular button is pressed (i.e. held down). */
 export declare function isActionPressedOnAnyInput(buttonAction: ButtonAction): boolean;
 /**
- * Iterates over all 4 inputs to see if a particular button is triggered
- * (i.e. held down and then released).
+ * Iterates over all 4 inputs to determine if a particular button is triggered (i.e. held down and
+ * then released).
  */
 export declare function isActionTriggeredOnAnyInput(buttonAction: ButtonAction): boolean;
 export declare function isKeyboardPressed(key: Keyboard): boolean;

package/dist/functions/player.d.ts

@@ -21,14 +21,14 @@ export declare function anyPlayerHasCollectible(collectibleType: CollectibleType
 export declare function anyPlayerHasTrinket(trinketType: TrinketType | int): boolean;
 export declare function anyPlayerIs(matchingCharacter: PlayerType): boolean;
 /**
- * Helper function to see if the provided character can have red heart containers. Returns true for
- * characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
- * though coin containers are not technically the same as red heart containers. Returns false for
- * characters like Blue Baby. Returns false for The Lost and Tainted Lost.
+ * Helper function to determine if the provided character can have red heart containers. Returns
+ * true for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper,
+ * even though coin containers are not technically the same as red heart containers. Returns false
+ * for characters like Blue Baby. Returns false for The Lost and Tainted Lost.
  */
 export declare function characterCanHaveRedHearts(character: PlayerType): boolean;
 /**
- * Helper function to see if the provided character can have soul hearts. Returns true for
+ * Helper function to determine if the provided character can have soul hearts. Returns true for
  * characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
  * false for The Lost and Tainted Lost.
  */

package/dist/functions/revive.d.ts

@@ -14,7 +14,7 @@ export declare function willPlayerRevive(player: EntityPlayer): boolean;
  */
 export declare function willMysteriousPaperRevive(player: EntityPlayer): boolean;
 /**
- * Helper function to see if the Spirit Shackles item is in an enabled state.
- * (It can be either enabled or disabled.)
+ * Helper function to determine if the Spirit Shackles item is in an enabled state. (It can be
+ * either enabled or disabled.)
  */
 export declare function willReviveFromSpiritShackles(player: EntityPlayer): boolean;

package/dist/functions/rooms.d.ts

@@ -4,13 +4,7 @@
  * Always use this helper function over invoking `Game().ChangeRoom()` directly to ensure that you
  * do not forget to set the LeaveDoor property.
  */
-export declare function changeRoom(roomIndex: int): void;
-/**
- * This function will not work properly for the Death Certificate dimension. When in the Death
- * Certificate dimension, this function will randomly return either `Dimension.SECONDARY` or
- * `Dimension.DEATH_CERTIFICATE`. Use the `inDeathCertificateArea` function instead for that
- * purpose.
- */
+export declare function changeRoom(roomGridIndex: int): void;
 export declare function getCurrentDimension(): Dimension;
 export declare function getRoomData(): RoomConfig | undefined;
 /**
@@ -23,23 +17,38 @@ export declare function getRoomData(): RoomConfig | undefined;
  */
 export declare function getRoomDataType(): int;
 /**
- * Helper function to get the room index of the current room. Use this instead of calling
- * `Level.GetCurrentRoomIndex()` directly to avoid bugs with big rooms. (Big rooms will return the
- * specific 1x1 quadrant that the player entered the room at, which can break data structures that
- * use the room index as an index.)
+ * Helper function to get the list grid index of the current room, which is equal to the index in
+ * the `Level.GetRooms().Get()` method. In other words, this is equal to the order that the room was
+ * created by the floor generation algorithm.
+ *
+ * Use this as an index for data structures that store data per room, since it is unique across
+ * different dimensions.
  */
-export declare function getRoomIndex(): int;
+export declare function getRoomListIndex(): int;
+/**
+ * Helper function to get the safe grid index of the current room. The safe grid index is defined as
+ * the top-left 1x1 section that the room overlaps with (or the top-right 1x1 section of a
+ * `RoomType.ROOMSHAPE_LTL` room).
+ *
+ * In most situations, using the safe grid index is more reliable than using the `GridIndex` or the
+ * `Level.GetCurrentRoomIndex()` method directly. `GridIndex` can return quadrants that are not on
+ * the map, and `Level.GetCurrentRoomIndex()` returns the specific 1x1 quadrant that the player
+ * entered the room at.
+ *
+ * Data structures that store data per room should use the room's `ListIndex` instead of
+ * `SafeGridIndex`, since the former is unique across different dimensions.
+ */
+export declare function getRoomSafeGridIndex(): int;
 /**
  * Helper function to get an array of all of the safe grid indexes for rooms that match the
  * specified room type.
  *
  * This function only searches through rooms in the current dimension.
  */
-export declare function getRoomIndexesForType(roomType: RoomType): Set<int>;
+export declare function getRoomGridIndexesForType(roomType: RoomType): Set<int>;
 /**
  * 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. Returns
- * `DEFAULT_ITEM_POOL_TYPE` if there is no particular pool associated with the current room type.
+ * `ItemPoolType.ItemPoolType.POOL_ANGEL` if you are in an Angel Room.
  */
 export declare function getRoomItemPoolType(): ItemPoolType;
 /**
@@ -73,6 +82,11 @@ export declare function getRoomSubType(): int;
  * @returns The room variant. Returns -1 if the variant was not found.
  */
 export declare function getRoomVariant(): int;
+/**
+ * The room visited count will be inaccurate during the period before the PostNewRoom callback has
+ * fired (i.e. when entities are initializing and performing their first update). This is because
+ * the variable is only incremented immediately before the PostNewRoom callback fires.
+ */
 export declare function getRoomVisitedCount(): int;
 /**
  * Converts a room X and Y coordinate to a position. For example, the coordinates of 0, 0 are
@@ -80,7 +94,7 @@ export declare function getRoomVisitedCount(): int;
  */
 export declare function gridToPos(x: int, y: int): Vector;
 /**
- * Helper function to see if the current room shape is equal to `RoomShape.ROOMSHAPE_1x2` or
+ * Helper function to determine if the current room shape is equal to `RoomShape.ROOMSHAPE_1x2` or
  * `RoomShape.ROOMSHAPE_2x1`.
  */
 export declare function in2x1Room(): boolean;
@@ -98,16 +112,22 @@ export declare function inBossRoomOf(bossID: BossID): boolean;
  */
 export declare function inCrawlspace(): boolean;
 /**
- * We cannot use the `inDimension` function for this since it is bugged with the Death Certificate
- * area.
+ * We cannot use the standard code in the `inDimension` function for this purpose since it is bugged
+ * with the Death Certificate area.
  */
 export declare function inDeathCertificateArea(): boolean;
-export declare function isDevilsCrownTreasureRoom(): boolean;
+export declare function inDevilsCrownTreasureRoom(): boolean;
 export declare function inDimension(dimension: Dimension): boolean;
-/** Helper function to see if the current room shape is one of the four L room shapes. */
+/** Helper function to determine if the current room shape is one of the four L room shapes. */
 export declare function inLRoom(): boolean;
 export declare function inGenesisRoom(): boolean;
+/** Helper function to determine whether or not the current room is the starting room of a floor. */
 export declare function inStartingRoom(): boolean;
+/**
+ * Helper function to determine whether or not the current room is part of the floor layout. For
+ * example, Devil Rooms and the Mega Satan room are not considered to be inside the map.
+ */
+export declare function isRoomInsideMap(): boolean;
 /**
  * If `Room.Update()` is called in a PostNewRoom callback, then some entities will slide around
  * (such as the player). Since those entity velocities are already at zero, setting them to zero

package/dist/functions/rooms.lua

@@ -2,12 +2,9 @@
 require("lualib_bundle");
 local ____exports = {}
 local ____constants = require("constants")
-local DEFAULT_ITEM_POOL_TYPE = ____constants.DEFAULT_ITEM_POOL_TYPE
 local GENESIS_ROOM_SUBTYPE = ____constants.GENESIS_ROOM_SUBTYPE
 local GENESIS_ROOM_VARIANT = ____constants.GENESIS_ROOM_VARIANT
 local MAX_ROOM_INDEX = ____constants.MAX_ROOM_INDEX
-local ____roomTypeToItemPoolMap = require("maps.roomTypeToItemPoolMap")
-local ROOM_TYPE_TO_ITEM_POOL_TYPE_MAP = ____roomTypeToItemPoolMap.ROOM_TYPE_TO_ITEM_POOL_TYPE_MAP
 local ____doors = require("functions.doors")
 local closeAllDoors = ____doors.closeAllDoors
 local getDoors = ____doors.getDoors
@@ -20,28 +17,57 @@ local setEntityPositions = ____entity.setEntityPositions
 local setEntityVelocities = ____entity.setEntityVelocities
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-function ____exports.getRoomIndex(self)
+function ____exports.getRoomData(self)
+    local game = Game()
+    local level = game:GetLevel()
+    local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
+    local roomDesc = level:GetRoomByIdx(roomSafeGridIndex)
+    return roomDesc.Data
+end
+function ____exports.getRoomSafeGridIndex(self)
     local game = Game()
     local level = game:GetLevel()
     local roomDesc = level:GetCurrentRoomDesc()
     return roomDesc.SafeGridIndex
 end
-function ____exports.changeRoom(self, roomIndex)
+function ____exports.getRoomStageID(self)
+    local roomData = ____exports.getRoomData(nil)
+    if roomData == nil then
+        return -1
+    end
+    return roomData.StageID
+end
+function ____exports.getRoomSubType(self)
+    local roomData = ____exports.getRoomData(nil)
+    if roomData == nil then
+        return -1
+    end
+    return roomData.Subtype
+end
+function ____exports.inDeathCertificateArea(self)
+    local roomStageID = ____exports.getRoomStageID(nil)
+    local roomSubType = ____exports.getRoomSubType(nil)
+    return roomStageID == 35 and (roomSubType == 33 or roomSubType == 33)
+end
+function ____exports.changeRoom(self, roomGridIndex)
     local game = Game()
     local level = game:GetLevel()
     level.LeaveDoor = -1
-    game:ChangeRoom(roomIndex)
+    game:ChangeRoom(roomGridIndex)
 end
 function ____exports.getCurrentDimension(self)
     local game = Game()
     local level = game:GetLevel()
-    local startingRoomIndex = level:GetStartingRoomIndex()
-    local startingRoomDesc = level:GetRoomByIdx(startingRoomIndex, -1)
+    if ____exports.inDeathCertificateArea(nil) then
+        return 2
+    end
+    local startingRoomGridIndex = level:GetStartingRoomIndex()
+    local startingRoomDesc = level:GetRoomByIdx(startingRoomGridIndex, -1)
     local startingRoomHash = GetPtrHash(startingRoomDesc)
     do
         local dimension = 0
         while dimension <= 2 do
-            local dimensionRoomDesc = level:GetRoomByIdx(startingRoomIndex, dimension)
+            local dimensionRoomDesc = level:GetRoomByIdx(startingRoomGridIndex, dimension)
             local dimensionRoomHash = GetPtrHash(dimensionRoomDesc)
             if dimensionRoomHash == startingRoomHash then
                 return dimension
@@ -49,16 +75,9 @@ function ____exports.getCurrentDimension(self)
             dimension = dimension + 1
         end
     end
-    error("Failed to get the current dimension using the starting room index of: " .. tostring(startingRoomIndex))
+    error("Failed to get the current dimension using the starting room index of: " .. tostring(startingRoomGridIndex))
     return 0
 end
-function ____exports.getRoomData(self)
-    local game = Game()
-    local level = game:GetLevel()
-    local roomIndex = ____exports.getRoomIndex(nil)
-    local roomDesc = level:GetRoomByIdx(roomIndex)
-    return roomDesc.Data
-end
 function ____exports.getRoomDataType(self)
     local roomData = ____exports.getRoomData(nil)
     if roomData == nil then
@@ -66,28 +85,35 @@ function ____exports.getRoomDataType(self)
     end
     return roomData.Type
 end
-function ____exports.getRoomIndexesForType(self, roomType)
+function ____exports.getRoomListIndex(self)
+    local game = Game()
+    local level = game:GetLevel()
+    local roomDesc = level:GetCurrentRoomDesc()
+    return roomDesc.ListIndex
+end
+function ____exports.getRoomGridIndexesForType(self, roomType)
     local game = Game()
     local level = game:GetLevel()
-    local roomIndexes = __TS__New(Set)
+    local roomGridIndexes = __TS__New(Set)
     do
         local i = 0
         while i <= MAX_ROOM_INDEX do
             local room = level:GetRoomByIdx(i)
             if room ~= nil and room.Data ~= nil and room.Data.Type == roomType then
-                roomIndexes:add(room.SafeGridIndex)
+                roomGridIndexes:add(room.SafeGridIndex)
             end
             i = i + 1
         end
     end
-    return roomIndexes
+    return roomGridIndexes
 end
 function ____exports.getRoomItemPoolType(self)
     local game = Game()
+    local itemPool = game:GetItemPool()
     local room = game:GetRoom()
     local roomType = room:GetType()
-    local itemPoolType = ROOM_TYPE_TO_ITEM_POOL_TYPE_MAP:get(roomType)
-    return itemPoolType == nil and DEFAULT_ITEM_POOL_TYPE or itemPoolType
+    local roomSeed = room:GetSpawnSeed()
+    return itemPool:GetPoolForRoom(roomType, roomSeed)
 end
 function ____exports.getRoomName(self)
     local roomData = ____exports.getRoomData(nil)
@@ -96,20 +122,6 @@ function ____exports.getRoomName(self)
     end
     return roomData.Name
 end
-function ____exports.getRoomStageID(self)
-    local roomData = ____exports.getRoomData(nil)
-    if roomData == nil then
-        return -1
-    end
-    return roomData.StageID
-end
-function ____exports.getRoomSubType(self)
-    local roomData = ____exports.getRoomData(nil)
-    if roomData == nil then
-        return -1
-    end
-    return roomData.Subtype
-end
 function ____exports.getRoomVariant(self)
     local roomData = ____exports.getRoomData(nil)
     if roomData == nil then
@@ -145,9 +157,9 @@ function ____exports.inAngelShop(self)
     return roomType == RoomType.ROOM_ANGEL and roomSubType == 1
 end
 function ____exports.inBeastRoom(self)
-    local roomIndex = ____exports.getRoomIndex(nil)
+    local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
     local roomSubType = ____exports.getRoomSubType(nil)
-    return roomIndex == GridRooms.ROOM_DUNGEON_IDX and roomSubType == 4
+    return roomSafeGridIndex == GridRooms.ROOM_DUNGEON_IDX and roomSubType == 4
 end
 function ____exports.inBossRoomOf(self, bossID)
     local game = Game()
@@ -158,16 +170,11 @@ function ____exports.inBossRoomOf(self, bossID)
     return roomType == RoomType.ROOM_BOSS and roomStageID == 0 and roomSubType == bossID
 end
 function ____exports.inCrawlspace(self)
-    local roomIndex = ____exports.getRoomIndex(nil)
+    local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
     local roomSubType = ____exports.getRoomSubType(nil)
-    return roomIndex == GridRooms.ROOM_DUNGEON_IDX and roomSubType ~= 4
+    return roomSafeGridIndex == GridRooms.ROOM_DUNGEON_IDX and roomSubType ~= 4
 end
-function ____exports.inDeathCertificateArea(self)
-    local roomStageID = ____exports.getRoomStageID(nil)
-    local roomSubType = ____exports.getRoomSubType(nil)
-    return roomStageID == 35 and (roomSubType == 33 or roomSubType == 33)
-end
-function ____exports.isDevilsCrownTreasureRoom(self)
+function ____exports.inDevilsCrownTreasureRoom(self)
     local game = Game()
     local level = game:GetLevel()
     local roomDesc = level:GetCurrentRoomDesc()
@@ -193,9 +200,13 @@ end
 function ____exports.inStartingRoom(self)
     local game = Game()
     local level = game:GetLevel()
-    local startingRoomIndex = level:GetStartingRoomIndex()
-    local roomIndex = ____exports.getRoomIndex(nil)
-    return roomIndex == startingRoomIndex
+    local startingRoomGridIndex = level:GetStartingRoomIndex()
+    local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
+    return roomSafeGridIndex == startingRoomGridIndex
+end
+function ____exports.isRoomInsideMap(self)
+    local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
+    return roomSafeGridIndex >= 0
 end
 function ____exports.roomUpdateSafe(self)
     local game = Game()
@@ -219,14 +230,14 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue38
+                goto __continue41
             end
             door.State = DoorState.STATE_OPEN
             local sprite = door:GetSprite()
             sprite:Play("Opened", true)
             door.ExtraVisible = false
         end
-        ::__continue38::
+        ::__continue41::
     end
     sfx:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/functions/sprite.d.ts

@@ -1,4 +1,15 @@
 /// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to clear a specific layer from a sprite. This function is variadic, so pass as
+ * many layer IDs as you want to clear.
+ *
+ * Since there is no official API method to "clear" a sprite, we can work around it by setting the
+ * spritesheet to a non-existent or completely transparent file. If the path to the spritesheet does
+ * not exist, then this function might cause spurious errors to appear in the "log.txt file". To
+ * silence these errors, create a transparent 1 pixel PNG file in your mod's resources folder at the
+ * path corresponding to the "EMPTY_PNG_PATH" constant.
+ */
+export declare function clearSprite(sprite: Sprite, ...layerIDs: int[]): void;
 /**
  * Helper function that returns the number of the final frame in a particular animation for a
  * sprite. By default, it will use the currently playing animation, but you can also specify a