isaacscript-common 1.0.513 → 1.0.517

package/dist/debug.d.ts

@@ -1 +1,2 @@
+/** Set this to true to enable more verbosity in the save data manger. */
 export declare const DEBUG = false;

package/dist/functions/debug.d.ts

@@ -1,5 +1,15 @@
+/**
+ * Helper function to get a stack trace.
+ *
+ * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+ * enabled.
+ */
+export declare function getTraceback(): string;
 /**
  * Helper function to print a stack trace to the "log.txt" file, similar to JavaScript's
- * `console.trace()` function. This will only work if the `--luadebug` launch option is enabled.
+ * `console.trace()` function.
+ *
+ * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+ * enabled.
  */
 export declare function traceback(): void;

package/dist/functions/debug.lua

@@ -1,15 +1,16 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-function ____exports.traceback(self)
+function ____exports.getTraceback(self)
     if debug ~= nil then
-        local tracebackMsg = debug.traceback()
-        Isaac.DebugString(tracebackMsg)
-        return
+        return debug.traceback()
     end
-    if sandboxTraceback ~= nil then
-        sandboxTraceback()
-        return
+    if sandboxGetTraceback ~= nil then
+        return sandboxGetTraceback()
     end
-    Isaac.DebugString("Error: Cannot perform a traceback since --luadebug is not enabled.")
+    return "stack traceback:\n(the \"--luadebug\" flag is not enabled)"
+end
+function ____exports.traceback(self)
+    local tracebackOutput = ____exports.getTraceback(nil)
+    Isaac.DebugString(tracebackOutput)
 end
 return ____exports

package/dist/functions/random.lua

@@ -1,14 +1,11 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
 local RECOMMENDED_SHIFT_IDX
-local ____debug = require("functions.debug")
-local traceback = ____debug.traceback
 function ____exports.initRNG(self, seed)
     if seed == nil then
         seed = Random()
     end
     if seed == 0 then
-        traceback(nil)
         error("You cannot initialize an RNG object with a seed of 0, or the game will crash.")
     end
     local rng = RNG()

package/dist/functions/rooms.d.ts

@@ -5,6 +5,7 @@
  * do not forget to set the LeaveDoor property.
  */
 export declare function changeRoom(roomGridIndex: int): void;
+export declare function getAllRoomGridIndexes(): int[];
 export declare function getCurrentDimension(): Dimension;
 export declare function getRoomData(): RoomConfig | undefined;
 /**
@@ -132,6 +133,14 @@ export declare function inMinibossRoomOf(minibossID: MinibossID): boolean;
  * starting room of the mirror world does not count).
  */
 export declare function inStartingRoom(): boolean;
+/**
+ * Helper function to loop through every room on the floor and see if it has been cleared.
+ *
+ * @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
+ * the array will be ignored. If not specified, then all rooms will be checked. Undefined by
+ * default.
+ */
+export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean;
 /**
  * Helper function to determine whether or not the current room is part of the floor layout. For
  * example, Devil Rooms and the Mega Satan room are not considered to be inside the map.

package/dist/functions/rooms.lua

@@ -55,6 +55,23 @@ function ____exports.changeRoom(self, roomGridIndex)
     level.LeaveDoor = -1
     game:ChangeRoom(roomGridIndex)
 end
+function ____exports.getAllRoomGridIndexes(self)
+    local game = Game()
+    local level = game:GetLevel()
+    local rooms = level:GetRooms()
+    local allRoomGridIndexes = {}
+    do
+        local i = 0
+        while i < rooms.Size do
+            local roomDesc = rooms:Get(i)
+            if roomDesc ~= nil then
+                __TS__ArrayPush(allRoomGridIndexes, roomDesc.SafeGridIndex)
+            end
+            i = i + 1
+        end
+    end
+    return allRoomGridIndexes
+end
 function ____exports.getCurrentDimension(self)
     local game = Game()
     local level = game:GetLevel()
@@ -214,6 +231,37 @@ function ____exports.inStartingRoom(self)
     local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
     return (roomSafeGridIndex == startingRoomGridIndex) and ____exports.inDimension(nil, 0)
 end
+function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
+    local game = Game()
+    local level = game:GetLevel()
+    local rooms = level:GetRooms()
+    local roomTypeWhitelist = (((onlyCheckRoomTypes == nil) and (function() return nil end)) or (function() return __TS__New(Set, onlyCheckRoomTypes) end))()
+    do
+        local i = 0
+        while i < rooms.Size do
+            do
+                local roomDesc = rooms:Get(i)
+                if roomDesc == nil then
+                    goto __continue42
+                end
+                local roomData = roomDesc.Data
+                if roomData == nil then
+                    goto __continue42
+                end
+                local roomType = roomData.Type
+                if (roomTypeWhitelist ~= nil) and (not roomTypeWhitelist:has(roomType)) then
+                    goto __continue42
+                end
+                if not roomDesc.Clear then
+                    return false
+                end
+            end
+            ::__continue42::
+            i = i + 1
+        end
+    end
+    return true
+end
 function ____exports.isRoomInsideMap(self)
     local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
     return roomSafeGridIndex >= 0
@@ -242,14 +290,14 @@ function ____exports.setRoomCleared(self)
     ) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue42
+                goto __continue51
             end
             door.State = DoorState.STATE_OPEN
             local sprite = door:GetSprite()
             sprite:Play("Opened", true)
             door.ExtraVisible = false
         end
-        ::__continue42::
+        ::__continue51::
     end
     sfx:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/functions/util.d.ts

@@ -57,6 +57,18 @@ export declare function getEnumValues(transpiledEnum: unknown): int[];
  */
 export declare function hexToKColor(hexString: string, alpha: float): KColor;
 export declare function isGreedMode(): boolean;
+/**
+ * Players can boot the game with an launch option called "--luadebug", which will enable additional
+ * functionality that is considered to be unsafe. For more information about this flag, see the
+ * wiki: https://bindingofisaacrebirth.fandom.com/wiki/Launch_Options
+ *
+ * When this flag is enabled, the global environment will be slightly different. The differences are
+ * documented here: https://wofsauge.github.io/IsaacDocs/rep/Globals.html
+ *
+ * This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
+ * is enabled or not.
+ */
+export declare function isLuaDebugEnabled(): boolean;
 /**
  * Whether or not the player is playing on a set seed (i.e. that they entered in a specific seed by
  * pressing tab on the character selection screen). When the player resets the game on a set seed,

package/dist/functions/util.lua

@@ -51,6 +51,9 @@ function ____exports.isGreedMode(self)
     local game = Game()
     return (game.Difficulty == Difficulty.DIFFICULTY_GREED) or (game.Difficulty == Difficulty.DIFFICULTY_GREEDIER)
 end
+function ____exports.isLuaDebugEnabled(self)
+    return package ~= nil
+end
 function ____exports.onSetSeed(self)
     local game = Game()
     local seeds = game:GetSeeds()

package/dist/patchErrorFunctions.d.ts

@@ -0,0 +1,9 @@
+/**
+ * In Lua, the `error` function will tell you the line number of the error, but not give you a full
+ * traceback of the parent functions, which is unlike how JavaScript works. This function monkey
+ * patches the `error` function to add this functionality.
+ *
+ * Traceback functionality can only be added if the "--luadebug" flag is turned on, so this function
+ * does nothing if the "--luadebug" flag is disabled.
+ */
+export declare function patchErrorFunction(): void;

package/dist/patchErrorFunctions.lua

@@ -0,0 +1,44 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+require("lualib_bundle");
+local ____exports = {}
+local errorWithTraceback, slimTracebackOutput, vanillaError
+local ____debug = require("functions.debug")
+local getTraceback = ____debug.getTraceback
+local ____util = require("functions.util")
+local isLuaDebugEnabled = ____util.isLuaDebugEnabled
+function errorWithTraceback(message, level)
+    if vanillaError == nil then
+        error(message, level)
+    end
+    if level == nil then
+        level = 1
+    end
+    local tracebackOutput = getTraceback(nil)
+    local slimmedTracebackOutput = slimTracebackOutput(nil, tracebackOutput)
+    Isaac.DebugString(slimmedTracebackOutput)
+    vanillaError(message, level + 1)
+end
+function slimTracebackOutput(self, tracebackOutput)
+    local lineSeparator = "\n"
+    local lines = __TS__StringSplit(tracebackOutput, lineSeparator)
+    if __TS__StringIncludes(lines[2], "in upvalue 'getTraceback'") then
+        __TS__ArraySplice(lines, 1, 1)
+    end
+    if __TS__StringIncludes(lines[2], "in function 'error'") then
+        __TS__ArraySplice(lines, 1, 1)
+    end
+    local slimmedTracebackOutput = table.concat(lines, lineSeparator or ",")
+    return slimmedTracebackOutput
+end
+function ____exports.patchErrorFunction(self)
+    if not isLuaDebugEnabled(nil) then
+        return
+    end
+    if __PATCHED_ERROR ~= nil then
+        return
+    end
+    __PATCHED_ERROR = true
+    vanillaError = error
+    error = errorWithTraceback
+end
+return ____exports

package/dist/patchPrintFunction.d.ts

@@ -0,0 +1,8 @@
+/**
+ * When the "--luadebug" flag is enabled, the `print` function will no longer print messages to the
+ * "log.txt" file or the in-game console. This function monkey patches the `print` function to
+ * restore this functionality.
+ *
+ * If the "--luadebug" flag is disabled, this function will do nothing.
+ */
+export declare function patchPrintFunction(): void;

package/dist/patchPrintFunction.lua

@@ -0,0 +1,45 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local printForLuaDebug, getPrintMsg, getValueToPrint
+local ____util = require("functions.util")
+local isLuaDebugEnabled = ____util.isLuaDebugEnabled
+local ____vector = require("functions.vector")
+local isVector = ____vector.isVector
+function printForLuaDebug(...)
+    local args = {...}
+    local msg = getPrintMsg(nil, args)
+    Isaac.DebugString(msg)
+    local msgWithNewline = msg .. "\n"
+    Isaac.ConsoleOutput(msgWithNewline)
+end
+function getPrintMsg(self, args)
+    if #args == 0 then
+        return tostring(nil)
+    end
+    local msg = ""
+    for ____, arg in ipairs(args) do
+        if msg ~= "" then
+            msg = msg .. " "
+        end
+        msg = msg .. getValueToPrint(nil, arg)
+    end
+    return msg
+end
+function getValueToPrint(self, arg)
+    if isVector(nil, arg) then
+        local vector = arg
+        return ((("Vector(" .. tostring(vector.X)) .. ", ") .. tostring(vector.Y)) .. ")"
+    end
+    return tostring(arg)
+end
+function ____exports.patchPrintFunction(self)
+    if not isLuaDebugEnabled(nil) then
+        return
+    end
+    if __PATCHED_PRINT ~= nil then
+        return
+    end
+    __PATCHED_PRINT = true
+    print = printForLuaDebug
+end
+return ____exports

package/dist/upgradeMod.lua

@@ -77,6 +77,10 @@ local sirenHelpersInit = ____sirenHelpers.sirenHelpersInit
 local ____initialized = require("initialized")
 local areFeaturesInitialized = ____initialized.areFeaturesInitialized
 local setFeaturesInitialized = ____initialized.setFeaturesInitialized
+local ____patchErrorFunctions = require("patchErrorFunctions")
+local patchErrorFunction = ____patchErrorFunctions.patchErrorFunction
+local ____patchPrintFunction = require("patchPrintFunction")
+local patchPrintFunction = ____patchPrintFunction.patchPrintFunction
 local ____ModUpgraded = require("types.ModUpgraded")
 local ModUpgraded = ____ModUpgraded.ModUpgraded
 function initCustomCallbacks(self, mod)
@@ -121,6 +125,8 @@ function ____exports.upgradeMod(self, modVanilla, verbose)
     if verbose == nil then
         verbose = false
     end
+    patchErrorFunction(nil)
+    patchPrintFunction(nil)
     local mod = __TS__New(ModUpgraded, modVanilla, verbose)
     if not areFeaturesInitialized(nil) then
         setFeaturesInitialized(nil)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.513",
+  "version": "1.0.517",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.294",
+    "isaac-typescript-definitions": "^1.0.295",
     "isaacscript-lint": "^1.0.71",
     "typedoc": "^0.22.10",
     "typescript": "4.4.4",