isaacscript-common 1.0.571 → 1.0.572

package/dist/functions/doors.lua

@@ -140,8 +140,8 @@ end
 function ____exports.lockDoor(self, door)
     local game = Game()
     local level = game:GetLevel()
-    local roomDesc = level:GetRoomByIdx(door.TargetRoomIndex)
-    roomDesc.VisitedCount = 0
+    local roomDescriptor = level:GetRoomByIdx(door.TargetRoomIndex)
+    roomDescriptor.VisitedCount = 0
     door:SetVariant(DoorVariant.DOOR_LOCKED)
     door:SetLocked(true)
     door:Close(true)

package/dist/functions/rooms.d.ts

@@ -10,45 +10,34 @@ export declare function getAllRoomGridIndexes(): int[];
  * 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.
  *
- * Note that this function does correctly handle detecting the Death Certificate dimension, which is
+ * Note that this function correctly handles detecting the Death Certificate dimension, which is
  * tricky to properly detect.
  */
 export declare function getCurrentDimension(): Dimension;
-/** An alias to the `Level.GetCurrentRoomDesc()` method. */
-export declare function getCurrentRoomDescReadOnly(): RoomDescriptorReadOnly;
-export declare function getRoomData(): RoomConfig | undefined;
+/** Alias for the `Level.GetCurrentRoomDesc()` method. */
+export declare function getCurrentRoomDescriptorReadOnly(): RoomDescriptorReadOnly;
 /**
- * Helper function to get the type for the room from the XML/STB data. The room data type will
+ * Helper function to get the room data for the provided room.
+ *
+ * @param roomGridIndex Optional. Equal to the current room index by default.
+ */
+export declare function getRoomData(roomGridIndex?: int): RoomConfig | undefined;
+/**
+ * Helper function to get the type of a room from the XML/STB data. The room data type will
  * correspond to different things depending on what XML/STB file it draws from. For example, in the
  * "00.special rooms.stb" file, a room type of 2 corresponds to a shop, a room type of 3 corresponds
  * to an I AM ERROR room, and so on.
  *
+ * @param roomGridIndex Optional. Equal to the current room index by default.
  * @returns The room data type. Returns -1 if the type was not found.
  */
-export declare function getRoomDataType(): int;
+export declare function getRoomDataType(roomGridIndex?: int): int;
 /**
- * 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 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.
+ * Helper function to get the descriptor for a room.
  *
- * Data structures that store data per room should use the room's `ListIndex` instead of
- * `SafeGridIndex`, since the former is unique across different dimensions.
+ * @param roomGridIndex Optional. Equal to the current room index by default.
  */
-export declare function getRoomSafeGridIndex(): int;
+export declare function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor;
 /**
  * Helper function to get an array of all of the safe grid indexes for rooms that match the
  * specified room type.
@@ -61,43 +50,76 @@ export declare function getRoomGridIndexesForType(roomType: RoomType): int[];
  * `ItemPoolType.ItemPoolType.POOL_ANGEL` if you are in an Angel Room.
  */
 export declare function getRoomItemPoolType(): ItemPoolType;
+/**
+ * Helper function to get the list grid index of the provided 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.
+ *
+ * @param roomGridIndex Optional. Equal to the current room index by default.
+ */
+export declare function getRoomListIndex(roomGridIndex?: int): int;
 /**
  * Helper function to get the name of the room as it appears in the STB/XML data.
  *
+ * @param roomGridIndex Optional. Equal to the current room index by default.
  * @returns The room name. Returns "Unknown" if the type was not found.
  */
-export declare function getRoomName(): string;
+export declare function getRoomName(roomGridIndex?: int): string;
 /**
- * Helper function to get the stage ID for the room from the XML/STB data. The room stage ID will
+ * Helper function to get the safe grid index of the provided 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.
+ *
+ * @param roomGridIndex Optional. Equal to the current room index by default.
+ */
+export declare function getRoomSafeGridIndex(roomGridIndex?: int): int;
+/**
+ * Helper function to get the stage ID for a room from the XML/STB data. The room stage ID will
  * correspond to the first number in the filename of the XML/STB file. For example, a Depths room
  * would have a stage ID of 7.
  *
+ * @param roomGridIndex Optional. Equal to the current room index by default.
  * @returns The room stage ID. Returns -1 if the stage ID was not found.
  */
-export declare function getRoomStageID(): StageID;
+export declare function getRoomStageID(roomGridIndex?: int): StageID;
 /**
- * Helper function to get the subtype for the room from the XML/STB data. The room subtype will
+ * Helper function to get the subtype for a room from the XML/STB data. The room subtype will
  * correspond to different things depending on what XML/STB file it draws from. For example, in the
  * "00.special rooms.stb" file, an Angel Room with a subtype of 0 will correspond to a normal Angel
  * Room and a subtype of 1 will correspond to an Angel Room shop for The Stairway.
  *
+ * @param roomGridIndex Optional. Equal to the current room index by default.
  * @returns The room subtype. Returns -1 if the subtype was not found.
  */
-export declare function getRoomSubType(): int;
+export declare function getRoomSubType(roomGridIndex?: int): int;
 /**
- * Helper function to get the variant for the current room from the XML/STB data. You can think of a
- * room variant as its identifier. For example, to go to Basement room #123, you would use a console
+ * Helper function to get the variant for a room from the XML/STB data. You can think of a room
+ * variant as its identifier. For example, to go to Basement room #123, you would use a console
  * command of `goto d.123` while on the Basement.
  *
+ * @param roomGridIndex Optional. Equal to the current room index by default.
  * @returns The room variant. Returns -1 if the variant was not found.
  */
-export declare function getRoomVariant(): int;
+export declare function getRoomVariant(roomGridIndex?: int): 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.
+ * Note that 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.
+ *
+ * @param roomGridIndex Optional. Equal to the current room index by default.
  */
-export declare function getRoomVisitedCount(): int;
+export declare function getRoomVisitedCount(roomGridIndex?: int): int;
 /**
  * Helper function to get the room descriptor for every room on the level. Uses the
  * `Level.GetRooms()` method to accomplish this.
@@ -167,15 +189,19 @@ export declare function inStartingRoom(): boolean;
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean;
 /**
- * Helper function to detect if the current room was created by the Red Key item. Under the hood,
+ * 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. Equal to the current room index by default.
  */
-export declare function isRedKeyRoom(): boolean;
+export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
 /**
- * Helper function to determine whether or not the current room is part of the floor layout. For
+ * 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. Equal to the current room index by default.
  */
-export declare function isRoomInsideMap(): boolean;
+export declare function isRoomInsideMap(roomGridIndex?: int): 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

@@ -17,35 +17,31 @@ local setEntityPositions = ____entity.setEntityPositions
 local setEntityVelocities = ____entity.setEntityVelocities
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-function ____exports.getCurrentRoomDescReadOnly(self)
+function ____exports.getCurrentRoomDescriptorReadOnly(self)
     local game = Game()
     local level = game:GetLevel()
     return level:GetCurrentRoomDesc()
 end
-function ____exports.getRoomData(self)
+function ____exports.getRoomData(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.Data
+end
+function ____exports.getRoomDescriptor(self, roomGridIndex)
     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 roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
-    return roomDesc.SafeGridIndex
-end
-function ____exports.getRoomStageID(self)
-    local roomData = ____exports.getRoomData(nil)
-    if roomData == nil then
-        return -1
+    if roomGridIndex == nil then
+        local currentRoomDescriptor = ____exports.getCurrentRoomDescriptorReadOnly(nil)
+        roomGridIndex = currentRoomDescriptor.SafeGridIndex
     end
-    return roomData.StageID
+    return level:GetRoomByIdx(roomGridIndex)
 end
-function ____exports.getRoomSubType(self)
-    local roomData = ____exports.getRoomData(nil)
-    if roomData == nil then
-        return -1
-    end
-    return roomData.Subtype
+function ____exports.getRoomStageID(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return ((roomData == nil) and -1) or roomData.StageID
+end
+function ____exports.getRoomSubType(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return ((roomData == nil) and -1) or roomData.Subtype
 end
 function ____exports.getRooms(self, includeExtraDimensionalRooms)
     if includeExtraDimensionalRooms == nil then
@@ -59,9 +55,9 @@ function ____exports.getRooms(self, includeExtraDimensionalRooms)
         do
             local i = 0
             while i < roomList.Size do
-                local roomDesc = roomList:Get(i)
-                if roomDesc ~= nil then
-                    __TS__ArrayPush(rooms, roomDesc)
+                local roomDescriptor = roomList:Get(i)
+                if roomDescriptor ~= nil then
+                    __TS__ArrayPush(rooms, roomDescriptor)
                 end
                 i = i + 1
             end
@@ -70,9 +66,9 @@ function ____exports.getRooms(self, includeExtraDimensionalRooms)
         do
             local i = 0
             while i <= MAX_ROOM_INDEX do
-                local roomDesc = level:GetRoomByIdx(i)
-                if roomDesc ~= nil then
-                    __TS__ArrayPush(rooms, roomDesc)
+                local roomDescriptor = level:GetRoomByIdx(i)
+                if roomDescriptor ~= nil then
+                    __TS__ArrayPush(rooms, roomDescriptor)
                 end
                 i = i + 1
             end
@@ -93,10 +89,10 @@ function ____exports.changeRoom(self, roomGridIndex)
 end
 function ____exports.getAllRoomGridIndexes(self)
     local allRoomGridIndexes = {}
-    for ____, roomDesc in ipairs(
+    for ____, roomDescriptor in ipairs(
         ____exports.getRooms(nil)
     ) do
-        __TS__ArrayPush(allRoomGridIndexes, roomDesc.SafeGridIndex)
+        __TS__ArrayPush(allRoomGridIndexes, roomDescriptor.SafeGridIndex)
     end
     return allRoomGridIndexes
 end
@@ -125,24 +121,17 @@ function ____exports.getCurrentDimension(self)
     )
     return 0
 end
-function ____exports.getRoomDataType(self)
-    local roomData = ____exports.getRoomData(nil)
-    if roomData == nil then
-        return -1
-    end
-    return roomData.Type
-end
-function ____exports.getRoomListIndex(self)
-    local roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
-    return roomDesc.ListIndex
+function ____exports.getRoomDataType(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return ((roomData == nil) and -1) or roomData.Type
 end
 function ____exports.getRoomGridIndexesForType(self, roomType)
     local roomGridIndexes = {}
-    for ____, roomDesc in ipairs(
+    for ____, roomDescriptor in ipairs(
         ____exports.getRooms(nil)
     ) do
-        if (roomDesc.Data ~= nil) and (roomDesc.Data.Type == roomType) then
-            __TS__ArrayPush(roomGridIndexes, roomDesc.SafeGridIndex)
+        if (roomDescriptor.Data ~= nil) and (roomDescriptor.Data.Type == roomType) then
+            __TS__ArrayPush(roomGridIndexes, roomDescriptor.SafeGridIndex)
         end
     end
     return roomGridIndexes
@@ -155,23 +144,25 @@ function ____exports.getRoomItemPoolType(self)
     local roomSeed = room:GetSpawnSeed()
     return itemPool:GetPoolForRoom(roomType, roomSeed)
 end
-function ____exports.getRoomName(self)
-    local roomData = ____exports.getRoomData(nil)
-    if roomData == nil then
-        return "Unknown"
-    end
-    return roomData.Name
+function ____exports.getRoomListIndex(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.ListIndex
 end
-function ____exports.getRoomVariant(self)
-    local roomData = ____exports.getRoomData(nil)
-    if roomData == nil then
-        return -1
-    end
-    return roomData.Variant
+function ____exports.getRoomName(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return ((roomData == nil) and "Unknown") or roomData.Name
+end
+function ____exports.getRoomSafeGridIndex(self, roomGridIndex)
+    local roomDescriptor = ((roomGridIndex == nil) and ____exports.getCurrentRoomDescriptorReadOnly(nil)) or ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.SafeGridIndex
 end
-function ____exports.getRoomVisitedCount(self)
-    local roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
-    return roomDesc.VisitedCount
+function ____exports.getRoomVariant(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return ((roomData == nil) and -1) or roomData.Variant
+end
+function ____exports.getRoomVisitedCount(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.VisitedCount
 end
 function ____exports.gridToPos(self, x, y)
     local game = Game()
@@ -213,8 +204,8 @@ function ____exports.inCrawlspace(self)
     return (roomSafeGridIndex == GridRooms.ROOM_DUNGEON_IDX) and (roomSubType ~= 4)
 end
 function ____exports.inDevilsCrownTreasureRoom(self)
-    local roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
-    return hasFlag(nil, roomDesc.Flags, 2048)
+    local roomDescriptor = ____exports.getCurrentRoomDescriptorReadOnly(nil)
+    return hasFlag(nil, roomDescriptor.Flags, 2048)
 end
 function ____exports.inDimension(self, dimension)
     return dimension == ____exports.getCurrentDimension(nil)
@@ -250,33 +241,35 @@ function ____exports.inStartingRoom(self)
 end
 function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
     local roomTypeWhitelist = (((onlyCheckRoomTypes == nil) and (function() return nil end)) or (function() return __TS__New(Set, onlyCheckRoomTypes) end))()
-    for ____, roomDesc in ipairs(
+    for ____, roomDescriptor in ipairs(
         ____exports.getRooms(nil)
     ) do
         do
-            local roomData = roomDesc.Data
+            local roomData = roomDescriptor.Data
             if roomData == nil then
-                goto __continue49
+                goto __continue46
             end
             local roomType = roomData.Type
             if (roomTypeWhitelist ~= nil) and (not roomTypeWhitelist:has(roomType)) then
-                goto __continue49
+                goto __continue46
             end
-            if not roomDesc.Clear then
+            if not roomDescriptor.Clear then
                 return false
             end
         end
-        ::__continue49::
+        ::__continue46::
     end
     return true
 end
-function ____exports.isRedKeyRoom(self)
-    local roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
-    return hasFlag(nil, roomDesc.Flags, 1024)
+function ____exports.isRedKeyRoom(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return hasFlag(nil, roomDescriptor.Flags, 1024)
 end
-function ____exports.isRoomInsideMap(self)
-    local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
-    return roomSafeGridIndex >= 0
+function ____exports.isRoomInsideMap(self, roomGridIndex)
+    if roomGridIndex == nil then
+        roomGridIndex = ____exports.getRoomSafeGridIndex(nil)
+    end
+    return roomGridIndex >= 0
 end
 function ____exports.roomUpdateSafe(self)
     local game = Game()
@@ -302,14 +295,14 @@ function ____exports.setRoomCleared(self)
     ) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue58
+                goto __continue56
             end
             door.State = DoorState.STATE_OPEN
             local sprite = door:GetSprite()
             sprite:Play("Opened", true)
             door.ExtraVisible = false
         end
-        ::__continue58::
+        ::__continue56::
     end
     sfx:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.571",
+  "version": "1.0.572",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",