isaacscript-common 1.2.101 → 1.2.102

package/dist/functions/familiars.d.ts

@@ -3,7 +3,7 @@
  * Helper function to add and remove familiars based on a target amount that you specify. Use this
  * instead of the `EntityPlayer.CheckFamiliar` method so that the InitSeed of the spawned familiar
  * will be set properly. Note that when using this function, you need to manually account for Box of
- * Friends (by looking at the number of collectible effects on the player for Box of Friends).
+ * Friends and Monster Manual (by looking at the number of collectible effects for the familiar).
  *
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
  * to `CacheFlag.CACHE_FAMILIARS`).
@@ -33,8 +33,9 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: int
  * to `CacheFlag.CACHE_FAMILIARS`).
  *
  * Use this function when the amount of familiars should be equal to the amount of associated
- * collectibles that the player has (plus any extras from having used Box of Friends). If you
- * instead need to have a custom amount of familiars, use the `checkFamiliars` function instead.
+ * collectibles that the player has (plus any extras from having used Box of Friends or Monster
+ * Manual). If you instead need to have a custom amount of familiars, use the `checkFamiliars`
+ * function instead.
  *
  * @param player The player that owns the familiars and collectibles.
  * @param collectibleType The collectible type of the collectible associated with this familiar.

package/dist/functions/familiars.lua

@@ -74,8 +74,8 @@ end
 function ____exports.checkFamiliarFromCollectibles(self, player, collectibleType, familiarVariant, familiarSubType)
     local numCollectibles = player:GetCollectibleNum(collectibleType)
     local effects = player:GetEffects()
-    local numBoxOfFriendsUses = effects:GetCollectibleEffectNum(CollectibleType.COLLECTIBLE_BOX_OF_FRIENDS)
-    local numTargetFamiliars = numCollectibles * (numBoxOfFriendsUses + 1)
+    local numCollectibleEffects = effects:GetCollectibleEffectNum(collectibleType)
+    local numTargetFamiliars = numCollectibles + numCollectibleEffects
     return ____exports.checkFamiliar(
         nil,
         player,

package/dist/functions/log.lua

@@ -15,8 +15,8 @@ local hasFlag = ____flag.hasFlag
 local ____player = require("functions.player")
 local getEffectsList = ____player.getEffectsList
 local ____rooms = require("functions.rooms")
+local getRoomGridIndex = ____rooms.getRoomGridIndex
 local getRoomListIndex = ____rooms.getRoomListIndex
-local getRoomSafeGridIndex = ____rooms.getRoomSafeGridIndex
 local getRoomSubType = ____rooms.getRoomSubType
 local getRoomVariant = ____rooms.getRoomVariant
 local ____trinkets = require("functions.trinkets")
@@ -135,10 +135,10 @@ function ____exports.logRoom()
     local roomType = room:GetType()
     local roomVariant = getRoomVariant(nil)
     local roomSubType = getRoomSubType(nil)
-    local roomSafeGridIndex = getRoomSafeGridIndex(nil)
+    local roomGridIndex = getRoomGridIndex(nil)
     local roomListIndex = getRoomListIndex(nil)
     ____exports.log((((("Current room type/variant/sub-type: " .. tostring(roomType)) .. ".") .. tostring(roomVariant)) .. ".") .. tostring(roomSubType))
-    ____exports.log("Current room safe grid index: " .. tostring(roomSafeGridIndex))
+    ____exports.log("Current room grid index: " .. tostring(roomGridIndex))
     ____exports.log("Current room list index: " .. tostring(roomListIndex))
 end
 function ____exports.logTable(____table, parentTables)

package/dist/functions/rooms.d.ts

@@ -34,6 +34,23 @@ export declare function getRoomType(roomGridIndex: int): RoomType;
  * @param roomGridIndex Optional. Equal to the current room index by default.
  */
 export declare function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor;
+/**
+ * Helper function to get the grid index of the current room.
+ *
+ * - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
+ *   the room descriptor. (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.)
+ * - If the current room is outside of the grid, it will return the index from the
+ *   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases).
+ *
+ * Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
+ * will return the specific 1x1 quadrant that the player entered the room at. For most situations,
+ * using the safe grid index is more reliable than this.
+ *
+ * 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 getRoomGridIndex(): int;
 /**
  * Helper function to get an array of all of the safe grid indexes for rooms that match the
  * specified room type.
@@ -67,22 +84,6 @@ 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 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

package/dist/functions/rooms.lua

@@ -133,6 +133,16 @@ function ____exports.getRoomType(self, roomGridIndex)
     local roomData = ____exports.getRoomData(nil, roomGridIndex)
     return roomData == nil and -1 or roomData.Type
 end
+function ____exports.getRoomGridIndex(self)
+    local game = Game()
+    local level = game:GetLevel()
+    local currentRoomIndex = level:GetCurrentRoomIndex()
+    if currentRoomIndex < 0 then
+        return currentRoomIndex
+    end
+    local roomDescriptor = ____exports.getCurrentRoomDescriptorReadOnly(nil)
+    return roomDescriptor.SafeGridIndex
+end
 function ____exports.getRoomGridIndexesForType(self, ...)
     local roomTypes = {...}
     local rooms = ____exports.getRooms(nil)
@@ -161,10 +171,6 @@ 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.getRoomVariant(self, roomGridIndex)
     local roomData = ____exports.getRoomData(nil, roomGridIndex)
     return roomData == nil and -1 or roomData.Variant
@@ -246,14 +252,14 @@ function ____exports.inMinibossRoomOf(self, minibossID)
     return roomType == RoomType.ROOM_MINIBOSS and roomStageID == 0 and roomSubType == minibossID
 end
 function ____exports.inSecretShop(self)
-    return ____exports.getRoomSafeGridIndex(nil) == GridRooms.ROOM_SECRET_SHOP_IDX
+    return ____exports.getRoomGridIndex(nil) == GridRooms.ROOM_SECRET_SHOP_IDX
 end
 function ____exports.inStartingRoom(self)
     local game = Game()
     local level = game:GetLevel()
     local startingRoomGridIndex = level:GetStartingRoomIndex()
-    local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
-    return roomSafeGridIndex == startingRoomGridIndex and ____exports.inDimension(nil, 0)
+    local roomGridIndex = ____exports.getRoomGridIndex(nil)
+    return roomGridIndex == startingRoomGridIndex and ____exports.inDimension(nil, 0)
 end
 function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
     local ____temp_0
@@ -279,7 +285,7 @@ function ____exports.isRedKeyRoom(self, roomGridIndex)
 end
 function ____exports.isRoomInsideMap(self, roomGridIndex)
     if roomGridIndex == nil then
-        roomGridIndex = ____exports.getRoomSafeGridIndex(nil)
+        roomGridIndex = ____exports.getRoomGridIndex(nil)
     end
     return roomGridIndex >= 0
 end
@@ -305,12 +311,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue57
+                goto __continue58
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue57::
+        ::__continue58::
     end
     sfx:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/package.json

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