isaacscript-common 1.2.88 → 1.2.91

package/dist/functions/log.d.ts

@@ -10,18 +10,18 @@ export declare function getDebugPrependString(msg: string, numParentFunctions?:
  * and the line number before the string.
  */
 export declare function log(this: void, msg: string): void;
-/** Helper function for printing out every damage flag that is turned on. Helpful when debugging. */
+/** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
 export declare function logAllDamageFlags(this: void, flags: int): void;
-/** Helper function for printing out every entity flag that is turned on. Helpful when debugging. */
+/** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
 export declare function logAllEntityFlags(this: void, flags: int): void;
-/** Helper function for printing out every flag that is turned on. Helpful when debugging. */
+/** Helper function for printing out every flag that is turned on. Useful when debugging. */
 export declare function logAllFlags(this: void, flags: int, flagEnum: LuaTable, description?: string): void;
 /**
- * Helper function for printing out every game state flag that is turned on. Helpful when debugging.
+ * Helper function for printing out every game state flag that is turned on. Useful when debugging.
  */
 export declare function logAllGameStateFlags(this: void): void;
 /**
- * Helper function for printing out every projectile flag that is turned on. Helpful when debugging.
+ * Helper function for printing out every projectile flag that is turned on. Useful when debugging.
  */
 export declare function logAllProjectileFlags(this: void, flags: int): void;
 /**
@@ -29,15 +29,17 @@ export declare function logAllProjectileFlags(this: void, flags: int): void;
  * particular run.
  */
 export declare function logAllSeedEffects(this: void): void;
-/** Helper function for printing out every use flag that is turned on. Helpful when debugging. */
+/** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 export declare function logAllTearFlags(this: void, flags: int): void;
-/** Helper function for printing out every use flag that is turned on. Helpful when debugging. */
+/** Helper function for printing out every use flag that is turned on. Useful when debugging. */
 export declare function logAllUseFlags(this: void, flags: int): void;
 export declare function logArray<T>(this: void, array: T[]): void;
 export declare function logColor(this: void, color: Color): void;
 export declare function logEntity(this: void, entity: Entity): void;
 export declare function logKColor(this: void, kColor: KColor): void;
 export declare function logMap(this: void, map: Map<AnyNotNil, unknown>): void;
+/** Helper function for printing out information about the current room. */
+export declare function logRoom(this: void): void;
 export declare function logTable(this: void, table: unknown, parentTables?: number): void;
 export declare function logTemporaryEffects(this: void, player: EntityPlayer): void;
 export declare function logSet(this: void, set: Set<AnyNotNil>): void;

package/dist/functions/log.lua

@@ -1,7 +1,8 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
-local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__Spread = ____lualib.__TS__Spread
+local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
 local Set = ____lualib.Set
 local ____exports = {}
@@ -13,6 +14,11 @@ local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
 local ____player = require("functions.player")
 local getEffectsList = ____player.getEffectsList
+local ____rooms = require("functions.rooms")
+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)
@@ -115,13 +121,26 @@ function ____exports.logKColor(kColor)
 end
 function ____exports.logMap(map)
     ____exports.log("Printing out a TSTL Map:")
-    for ____, ____value in __TS__Iterator(map:entries()) do
-        local key = ____value[1]
-        local value = ____value[2]
+    local mapKeys = {__TS__Spread(map:keys())}
+    __TS__ArraySort(mapKeys)
+    for ____, key in ipairs(mapKeys) do
+        local value = map:get(key)
         ____exports.log((("  Key: " .. tostring(key)) .. ", Value: ") .. tostring(value))
     end
     ____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 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 list index: " .. tostring(roomListIndex))
+end
 function ____exports.logTable(____table, parentTables)
     if parentTables == nil then
         parentTables = 0
@@ -134,13 +153,16 @@ function ____exports.logTable(____table, parentTables)
         " ",
         math.floor(numSpaces)
     )
+    local numKeys = 0
     for key, value in pairs(____table) do
         ____exports.log((((indentation .. "Key: ") .. tostring(key)) .. ", Value: ") .. tostring(value))
         local valueType = type(value)
         if valueType == "table" then
             ____exports.logTable(value, parentTables + 1)
         end
+        numKeys = numKeys + 1
     end
+    ____exports.log("The size of the table was: " .. tostring(numKeys))
 end
 function ____exports.logTemporaryEffects(player)
     local effects = getEffectsList(nil, player)
@@ -168,7 +190,9 @@ function ____exports.logTemporaryEffects(player)
 end
 function ____exports.logSet(set)
     ____exports.log("Printing out a TSTL Set:")
-    for ____, value in __TS__Iterator(set:values()) do
+    local setValues = {__TS__Spread(set:values())}
+    __TS__ArraySort(setValues)
+    for ____, value in ipairs(setValues) do
         ____exports.log("  Value: " .. tostring(value))
     end
     ____exports.log("The size of the set was: " .. tostring(set.size))
@@ -192,6 +216,7 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logEntity = ____exports.logEntity
     globals.logKColor = ____exports.logKColor
     globals.logMap = ____exports.logMap
+    globals.logRoom = ____exports.logRoom
     globals.logTable = ____exports.logTable
     globals.logTemporaryEffects = ____exports.logTemporaryEffects
     globals.logSet = ____exports.logSet

package/dist/functions/rooms.d.ts

@@ -147,8 +147,8 @@ export declare function inBeastRoom(): boolean;
 export declare function inBossRoomOf(bossID: BossID): boolean;
 /**
  * Helper function for determining whether the current room is a crawlspace. Use this function over
- * comparing to `GridRooms.ROOM_DUNGEON_IDX` directly since there is a special case of the player
- * being in The Beast room.
+ * comparing to `RoomType.ROOM_DUNGEON` or `GridRooms.ROOM_DUNGEON_IDX` since there is a special
+ * case of the player being in a boss fight that take place in a dungeon.
  */
 export declare function inCrawlspace(): boolean;
 /**
@@ -171,6 +171,14 @@ export declare function inGenesisRoom(): boolean;
  * will only work for minibosses that have dedicated boss rooms in the "00.special rooms.stb" file.
  */
 export declare function inMinibossRoomOf(minibossID: MinibossID): boolean;
+/**
+ * Helper function for checking if the room room is a secret shop from the Member Card collectible.
+ *
+ * Secret shops are simply copies of normal shops but with the backdrop of a secret room. In other
+ * words, they will have the same room type, room variant, and room sub-type of a normal shop. Thus,
+ * the only way to detect them is by using the grid index.
+ */
+export declare function inSecretShop(): boolean;
 /**
  * Helper function to determine whether or not the current room is the starting room of a floor.
  * Only returns true for the starting room of the primary dimension (meaning that being in the

package/dist/functions/rooms.lua

@@ -92,7 +92,7 @@ end
 function ____exports.inDeathCertificateArea(self)
     local roomStageID = ____exports.getRoomStageID(nil)
     local roomSubType = ____exports.getRoomSubType(nil)
-    return roomStageID == 35 and (roomSubType == 33 or roomSubType == 33)
+    return roomStageID == 35 and (roomSubType == 33 or roomSubType == 34)
 end
 function ____exports.changeRoom(self, roomGridIndex)
     local game = Game()
@@ -195,9 +195,11 @@ function ____exports.inAngelShop(self)
     return roomType == RoomType.ROOM_ANGEL and roomSubType == 1
 end
 function ____exports.inBeastRoom(self)
-    local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
+    local game = Game()
+    local room = game:GetRoom()
+    local roomType = room:GetType()
     local roomSubType = ____exports.getRoomSubType(nil)
-    return roomSafeGridIndex == GridRooms.ROOM_DUNGEON_IDX and roomSubType == 4
+    return roomType == RoomType.ROOM_DUNGEON and roomSubType == 4
 end
 function ____exports.inBossRoomOf(self, bossID)
     local game = Game()
@@ -208,9 +210,11 @@ function ____exports.inBossRoomOf(self, bossID)
     return roomType == RoomType.ROOM_BOSS and roomStageID == 0 and roomSubType == bossID
 end
 function ____exports.inCrawlspace(self)
-    local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
+    local game = Game()
+    local room = game:GetRoom()
+    local roomType = room:GetType()
     local roomSubType = ____exports.getRoomSubType(nil)
-    return roomSafeGridIndex == GridRooms.ROOM_DUNGEON_IDX and roomSubType ~= 4
+    return roomType == RoomType.ROOM_DUNGEON and roomSubType ~= 4
 end
 function ____exports.inDevilsCrownTreasureRoom(self)
     local roomDescriptor = ____exports.getCurrentRoomDescriptorReadOnly(nil)
@@ -241,6 +245,9 @@ function ____exports.inMinibossRoomOf(self, minibossID)
     local roomSubType = ____exports.getRoomSubType(nil)
     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
+end
 function ____exports.inStartingRoom(self)
     local game = Game()
     local level = game:GetLevel()
@@ -298,12 +305,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue56
+                goto __continue57
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue56::
+        ::__continue57::
     end
     sfx:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.88",
+  "version": "1.2.91",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.0",
-    "isaac-typescript-definitions": "^1.0.354",
+    "isaac-typescript-definitions": "^1.0.355",
     "isaacscript-lint": "^1.0.81",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.12",