isaacscript-common 1.2.220 → 1.2.223

package/dist/features/extraConsoleCommands/commands.lua

@@ -40,6 +40,7 @@ local ____playerIndex = require("functions.playerIndex")
 local getPlayers = ____playerIndex.getPlayers
 local ____roomData = require("functions.roomData")
 local getRoomData = ____roomData.getRoomData
+local getRoomDescriptor = ____roomData.getRoomDescriptor
 local ____rooms = require("functions.rooms")
 local changeRoom = ____rooms.changeRoom
 local getRoomGridIndexesForType = ____rooms.getRoomGridIndexesForType
@@ -129,8 +130,8 @@ function devilAngel(self, useDevil)
         local roomType = devilAngelRoomData.Type
         local conflictingType = useDevil and RoomType.ROOM_ANGEL or RoomType.ROOM_DEVIL
         if roomType == conflictingType then
-            local roomDesc = level:GetRoomByIdx(GridRooms.ROOM_DEVIL_IDX)
-            roomDesc.Data = nil
+            local roomDescriptor = getRoomDescriptor(nil, GridRooms.ROOM_DEVIL_IDX)
+            roomDescriptor.Data = nil
         end
     end
     if useDevil then

package/dist/features/saveDataManager/main.lua

@@ -77,7 +77,7 @@ function restoreDefaults(self, childTableName)
             end
             local childTableDefaults = saveDataDefaults[childTableName]
             if childTableDefaults == nil then
-                logError((("Failed to find the default copy of the child table \"" .. childTableName) .. "\" for subscriber: ") .. subscriberName)
+                logError(((("Failed to find the default copy of the child table \"" .. childTableName) .. "\" for subscriber \"") .. subscriberName) .. "\". This error usually means that your save data is out of date. You can try purging all of your save data by deleting the following directory: C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\data")
                 goto __continue14
             end
             local childTableDefaultsTable = childTableDefaults

package/dist/functions/collectibles.d.ts

@@ -17,8 +17,8 @@ export declare function getCollectibleDescription(collectibleType: CollectibleTy
  */
 export declare function getCollectibleDevilHeartPrice(collectibleType: CollectibleType | int, player: EntityPlayer): PickupPrice;
 /**
- * Helper function to get the path to a collectible's sprite. Returns
- * "gfx/items/collectibles/questionmark.png" if the provided collectible type was not valid.
+ * Helper function to get the path to a collectible's sprite. Returns the path to the question mark
+ * sprite (i.e. from Curse of the Blind) if the provided collectible type was not valid.
  */
 export declare function getCollectibleGfxFilename(collectibleType: CollectibleType | int): string;
 /**

package/dist/functions/collectibles.lua

@@ -114,7 +114,7 @@ end
 function ____exports.getCollectibleGfxFilename(self, collectibleType)
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
-        return "unknown.png"
+        return BLIND_ITEM_PNG_PATH
     end
     return itemConfigItem.GfxFileName
 end

package/dist/functions/roomData.d.ts

@@ -56,6 +56,13 @@ export declare function getRoomListIndex(roomGridIndex?: int): int;
  * @returns The room name. Returns "Unknown" if the type was not found.
  */
 export declare function getRoomName(roomGridIndex?: int): string;
+/**
+ * Helper function to get the name of the room as it appears in the STB/XML data.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room name. Returns "Unknown" if the type was not found.
+ */
+export declare function getRoomShape(roomGridIndex?: int): RoomShape | undefined;
 /**
  * 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

package/dist/functions/roomData.lua

@@ -61,6 +61,16 @@ function ____exports.getRoomName(self, roomGridIndex)
     local roomData = ____exports.getRoomData(nil, roomGridIndex)
     return roomData == nil and "Unknown" or roomData.Name
 end
+function ____exports.getRoomShape(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local ____temp_0
+    if roomData == nil then
+        ____temp_0 = nil
+    else
+        ____temp_0 = roomData.Shape
+    end
+    return ____temp_0
+end
 function ____exports.getRoomStageID(self, roomGridIndex)
     local roomData = ____exports.getRoomData(nil, roomGridIndex)
     return roomData == nil and -1 or roomData.StageID

package/dist/functions/rooms.d.ts

@@ -114,6 +114,8 @@ export declare function inStartingRoom(): boolean;
  * default.
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean;
+export declare function isDoorSlotValidAtGridIndex(doorSlot: DoorSlot, roomGridIndex: int): boolean;
+export declare function isDoorSlotValidAtGridIndexForRedRoom(doorSlot: DoorSlot, roomGridIndex: int): boolean;
 /**
  * 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.
@@ -128,6 +130,8 @@ export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function isRoomInsideMap(roomGridIndex?: int): boolean;
+/** Helper function to check if a room exists at the given room grid index. */
+export declare function roomExists(roomGridIndex: int): boolean;
 /**
  * If the `Room.Update` method 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

package/dist/functions/rooms.lua

@@ -33,9 +33,11 @@ local setEntityPositions = ____positionVelocity.setEntityPositions
 local setEntityVelocities = ____positionVelocity.setEntityVelocities
 local ____roomData = require("functions.roomData")
 local getCurrentRoomDescriptorReadOnly = ____roomData.getCurrentRoomDescriptorReadOnly
+local getRoomAllowedDoors = ____roomData.getRoomAllowedDoors
 local getRoomData = ____roomData.getRoomData
 local getRoomDescriptor = ____roomData.getRoomDescriptor
 local getRoomGridIndex = ____roomData.getRoomGridIndex
+local getRoomShape = ____roomData.getRoomShape
 local getRoomStageID = ____roomData.getRoomStageID
 local getRoomSubType = ____roomData.getRoomSubType
 function ____exports.getRooms(self, includeExtraDimensionalRooms)
@@ -75,6 +77,10 @@ function ____exports.inDeathCertificateArea(self)
     local roomSubType = getRoomSubType(nil)
     return roomStageID == 35 and (roomSubType == 33 or roomSubType == 34)
 end
+function ____exports.roomExists(self, roomGridIndex)
+    local roomData = getRoomData(nil, roomGridIndex)
+    return roomData ~= nil
+end
 function ____exports.changeRoom(self, roomGridIndex)
     local level = game:GetLevel()
     local roomData = getRoomData(nil, roomGridIndex)
@@ -97,11 +103,11 @@ function ____exports.getCurrentDimension(self)
         return 2
     end
     local startingRoomGridIndex = level:GetStartingRoomIndex()
-    local startingRoomDesc = level:GetRoomByIdx(startingRoomGridIndex, -1)
-    local startingRoomHash = GetPtrHash(startingRoomDesc)
+    local startingRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, -1)
+    local startingRoomHash = GetPtrHash(startingRoomDescription)
     for ____, dimension in ipairs(range(nil, 0, NUM_DIMENSIONS - 1)) do
-        local dimensionRoomDesc = level:GetRoomByIdx(startingRoomGridIndex, dimension)
-        local dimensionRoomHash = GetPtrHash(dimensionRoomDesc)
+        local dimensionRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, dimension)
+        local dimensionRoomHash = GetPtrHash(dimensionRoomDescription)
         if dimensionRoomHash == startingRoomHash then
             return dimension
         end
@@ -226,6 +232,26 @@ 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 = ____exports.getGridIndexDelta(nil, roomShape, doorSlot)
+    if delta == nil then
+        return false
+    end
+    local redRoomGridIndex = roomGridIndex + delta
+    return not ____exports.roomExists(nil, redRoomGridIndex)
+end
 function ____exports.isRedKeyRoom(self, roomGridIndex)
     local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
     return hasFlag(nil, roomDescriptor.Flags, 1024)
@@ -255,12 +281,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue48
+                goto __continue54
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue48::
+        ::__continue54::
     end
     sfxManager:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/package.json

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