isaacscript-common 1.2.101 → 1.2.104

package/dist/constants.d.ts

@@ -63,8 +63,6 @@ export declare const FINAL_STAGE: number;
  * second TMTRAINER item subtracts one from that, and so on.
  */
 export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: number;
-export declare const GENESIS_ROOM_VARIANT = -1;
-export declare const GENESIS_ROOM_SUBTYPE = -1;
 export declare const GOLDEN_TRINKET_SHIFT: number;
 export declare const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
 export declare const GAME_FRAMES_PER_SECOND = 30;

package/dist/constants.lua

@@ -79,8 +79,6 @@ ____exports.FAMILIARS_THAT_SHOOT_PLAYER_TEARS = __TS__New(Set, {
 })
 ____exports.FINAL_STAGE = LevelStage.NUM_STAGES - 1
 ____exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = (1 << 32) - 1
-____exports.GENESIS_ROOM_VARIANT = -1
-____exports.GENESIS_ROOM_SUBTYPE = -1
 ____exports.GOLDEN_TRINKET_SHIFT = 1 << 15
 ____exports.GRID_INDEX_CENTER_OF_1X1_ROOM = 67
 ____exports.GAME_FRAMES_PER_SECOND = 30

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,10 +15,9 @@ local hasFlag = ____flag.hasFlag
 local ____player = require("functions.player")
 local getEffectsList = ____player.getEffectsList
 local ____rooms = require("functions.rooms")
+local getRoomData = ____rooms.getRoomData
+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")
 local getTrinketName = ____trinkets.getTrinketName
 function ____exports.getDebugPrependString(self, msg, numParentFunctions)
@@ -130,15 +129,15 @@ function ____exports.logMap(map)
     ____exports.log("The size of the map was: " .. tostring(map.size))
 end
 function ____exports.logRoom()
-    local game = Game()
-    local room = game:GetRoom()
-    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))
+    local roomData = getRoomData(nil)
+    if roomData == nil then
+        ____exports.log("Current room data is undefined.")
+    else
+        ____exports.log((((("Current room type/variant/sub-type: " .. tostring(roomData.Type)) .. ".") .. tostring(roomData.Variant)) .. ".") .. tostring(roomData.Subtype))
+    end
+    ____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

@@ -14,7 +14,10 @@ export declare function getAllRoomGridIndexes(): int[];
  * tricky to properly detect.
  */
 export declare function getCurrentDimension(): Dimension;
-/** Alias for the `Level.GetCurrentRoomDesc()` method. */
+/**
+ * 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 getCurrentRoomDescriptorReadOnly(): RoomDescriptorReadOnly;
 /**
  * Helper function to get the room data for the provided room.
@@ -25,15 +28,33 @@ export declare function getRoomData(roomGridIndex?: int): RoomConfig | undefined
 /**
  * Helper function for getting the type of the room with the given grid index.
  *
+ * @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 getRoomType(roomGridIndex: int): RoomType;
+export declare function getRoomType(roomGridIndex?: int): RoomType;
 /**
  * Helper function to get the descriptor for a room.
  *
  * @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 +88,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
@@ -166,6 +171,7 @@ export declare function inDimension(dimension: Dimension): boolean;
 /** 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;
+export declare function inMegaSatanRoom(): boolean;
 /**
  * Helper function to check if the current room is a miniboss room for a particular miniboss. This
  * will only work for minibosses that have dedicated boss rooms in the "00.special rooms.stb" file.

package/dist/functions/rooms.lua

@@ -10,8 +10,6 @@ local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local Map = ____lualib.Map
 local ____exports = {}
 local ____constants = require("constants")
-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 NUM_DIMENSIONS = ____constants.NUM_DIMENSIONS
 local ____doors = require("functions.doors")
@@ -43,11 +41,20 @@ function ____exports.getRoomDescriptor(self, roomGridIndex)
     local game = Game()
     local level = game:GetLevel()
     if roomGridIndex == nil then
-        local currentRoomDescriptor = ____exports.getCurrentRoomDescriptorReadOnly(nil)
-        roomGridIndex = currentRoomDescriptor.SafeGridIndex
+        roomGridIndex = ____exports.getRoomGridIndex(nil)
     end
     return level:GetRoomByIdx(roomGridIndex)
 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.getRoomStageID(self, roomGridIndex)
     local roomData = ____exports.getRoomData(nil, roomGridIndex)
     return roomData == nil and -1 or roomData.StageID
@@ -161,10 +168,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
@@ -233,9 +236,12 @@ function ____exports.inGenesisRoom(self)
     local game = Game()
     local room = game:GetRoom()
     local roomType = room:GetType()
-    local roomVariant = ____exports.getRoomVariant(nil)
     local roomSubType = ____exports.getRoomSubType(nil)
-    return roomType == RoomType.ROOM_ISAACS and roomVariant == GENESIS_ROOM_VARIANT and roomSubType == GENESIS_ROOM_SUBTYPE
+    return roomType == RoomType.ROOM_ISAACS and roomSubType == 99
+end
+function ____exports.inMegaSatanRoom(self)
+    local roomGridIndex = ____exports.getRoomGridIndex(nil)
+    return roomGridIndex == GridRooms.ROOM_MEGA_SATAN_IDX
 end
 function ____exports.inMinibossRoomOf(self, minibossID)
     local game = Game()
@@ -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 __continue59
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue57::
+        ::__continue59::
     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.104",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",