isaacscript-common 79.0.0 → 79.1.1

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 78.0.0
+isaacscript-common 79.1.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -17362,6 +17362,173 @@ ____exports.SerializationBrand.VECTOR = "__VECTOR"
 ____exports.SerializationBrand.DEFAULT_MAP_VALUE = "__TSTL_DEFAULT_MAP_VALUE"
 ____exports.SerializationBrand.OBJECT_WITH_NUMBER_KEYS = "__TSTL_OBJECT_WITH_NUMBER_KEYS"
 ____exports.SerializationBrand.TSTL_CLASS = "__TSTL_CLASS"
+return ____exports
+ end,
+["functions.log"] = function(...) 
+local ____exports = {}
+local ____types = require("functions.types")
+local isNumber = ____types.isNumber
+--- Helper function to get the name and the line number of the current calling function.
+-- 
+-- For this function to work properly, the "--luadebug" flag must be enabled. Otherwise, it will
+-- always return undefined.
+-- 
+-- @param levels Optional. The amount of levels to look backwards in the call stack. Default is 3
+-- (because the first level is this function, the second level is the calling
+-- function, and the third level is the parent of the calling function).
+function ____exports.getParentFunctionDescription(levels)
+    if levels == nil then
+        levels = 3
+    end
+    if debug ~= nil then
+        local debugTable = debug.getinfo(levels)
+        if debugTable ~= nil then
+            return (tostring(debugTable.name) .. ":") .. tostring(debugTable.linedefined)
+        end
+    end
+    if SandboxGetParentFunctionDescription ~= nil then
+        return SandboxGetParentFunctionDescription(levels)
+    end
+    return nil
+end
+--- Helper function to avoid typing out `Isaac.DebugString()`.
+-- 
+-- If you have the "--luadebug" launch flag turned on, then this function will also prepend the
+-- function name and the line number before the string, like this:
+-- 
+-- ```text
+-- [INFO] - Lua Debug: saveToDisk:42494 - The save data manager wrote data to the "save#.dat" file.
+-- ```
+-- 
+-- Subsequently, it is recommended that you turn on the "--luadebug" launch flag when developing
+-- your mod so that debugging becomes a little bit easier.
+-- 
+-- @param msg The message to log.
+-- @param includeParentFunction Optional. Whether to prefix the message with the function name and
+-- line number, as shown in the above example. Default is true.
+function ____exports.log(msg, includeParentFunction)
+    if includeParentFunction == nil then
+        includeParentFunction = true
+    end
+    if isNumber(nil, msg) then
+        msg = tostring(msg)
+    end
+    local ____includeParentFunction_0
+    if includeParentFunction then
+        ____includeParentFunction_0 = ____exports.getParentFunctionDescription()
+    else
+        ____includeParentFunction_0 = nil
+    end
+    local parentFunctionDescription = ____includeParentFunction_0
+    local debugMsg = parentFunctionDescription == nil and msg or (parentFunctionDescription .. " - ") .. msg
+    Isaac.DebugString(debugMsg)
+end
+--- Helper function to log a message to the "log.txt" file and to print it to the screen at the same
+-- time.
+function ____exports.logAndPrint(self, msg)
+    ____exports.log(msg)
+    print(msg)
+end
+--- Helper function to log an error message and also print it to the console for better visibility.
+-- 
+-- This is useful in situations where using the `error` function would be dangerous (since it
+-- prevents all of the subsequent code in the callback from running).
+function ____exports.logError(msg)
+    local errorMsg = "Error: " .. msg
+    ____exports.logAndPrint(nil, errorMsg)
+end
+return ____exports
+ end,
+["functions.debugFunctions"] = function(...) 
+local ____exports = {}
+local ____log = require("functions.log")
+local log = ____log.log
+--- Helper function to get the current time for benchmarking / profiling purposes.
+-- 
+-- The return value will either be in seconds or milliseconds, depending on if the "--luadebug" flag
+-- is turned on.
+-- 
+-- If the "--luadebug" flag is present, then this function will use the `socket.gettime` method,
+-- which returns the epoch timestamp in seconds (e.g. "1640320492.5779"). This is preferable over
+-- the more conventional `Isaac.GetTime` method, since it has one extra decimal point of precision.
+-- 
+-- If the "--luadebug" flag is not present, then this function will use the `Isaac.GetTime` method,
+-- which returns the number of milliseconds since the computer's operating system was started (e.g.
+-- "739454963").
+-- 
+-- @param useSocketIfAvailable Optional. Whether to use the `socket.gettime` method, if available.
+-- Default is true. If set to false, the `Isaac.GetTime()` method will
+-- always be used.
+function ____exports.getTime(self, useSocketIfAvailable)
+    if useSocketIfAvailable == nil then
+        useSocketIfAvailable = true
+    end
+    if useSocketIfAvailable then
+        if SandboxGetTime ~= nil then
+            return SandboxGetTime()
+        end
+        if ____exports.isLuaDebugEnabled(nil) then
+            local ok, requiredSocket = pcall(require, "socket")
+            if ok then
+                local socket = requiredSocket
+                return socket.gettime()
+            end
+        end
+    end
+    return Isaac.GetTime()
+end
+--- 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.
+-- 
+-- Note that this function will return false if the Racing+ sandbox is enabled, even if the
+-- "--luadebug" flag is really turned on. If checking for this case is needed, check for the
+-- presence of the `sandboxGetTraceback` function.
+function ____exports.isLuaDebugEnabled(self)
+    return _G.package ~= nil
+end
+--- Helper function to get the amount of elapsed time for benchmarking / profiling purposes.
+-- 
+-- For more information, see the documentation for the `getTime` helper function.
+-- 
+-- @param time The milliseconds (int) or fractional seconds (float).
+-- @param useSocketIfAvailable Optional. Whether to use the `socket.gettime` method, if available.
+-- Default is true. If set to false, the `Isaac.GetTime()` method will
+-- always be used.
+function ____exports.getElapsedTimeSince(self, time, useSocketIfAvailable)
+    if useSocketIfAvailable == nil then
+        useSocketIfAvailable = true
+    end
+    return ____exports.getTime(nil, useSocketIfAvailable) - time
+end
+--- Helper function to get a stack trace.
+-- 
+-- This will only work if the `--luadebug` launch option is enabled. If it isn't, then a error
+-- string will be returned.
+function ____exports.getTraceback()
+    if SandboxGetTraceback ~= nil then
+        return SandboxGetTraceback()
+    end
+    if debug ~= nil then
+        return debug.traceback()
+    end
+    return "stack traceback:\n(the \"--luadebug\" flag is not enabled)"
+end
+--- Helper function to log 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. If it isn't, then a error
+-- string will be logged.
+function ____exports.traceback()
+    local tracebackOutput = ____exports.getTraceback()
+    log(tracebackOutput)
+end
 return ____exports
  end,
 ["types.PlayerIndex"] = function(...) 
@@ -18062,81 +18229,6 @@ function ____exports.isaacAPIClassEquals(self, object1, object2, keys)
         function(____, key) return table1[key] == table2[key] end
     )
 end
-return ____exports
- end,
-["functions.log"] = function(...) 
-local ____exports = {}
-local ____types = require("functions.types")
-local isNumber = ____types.isNumber
---- Helper function to get the name and the line number of the current calling function.
--- 
--- For this function to work properly, the "--luadebug" flag must be enabled. Otherwise, it will
--- always return undefined.
--- 
--- @param levels Optional. The amount of levels to look backwards in the call stack. Default is 3
--- (because the first level is this function, the second level is the calling
--- function, and the third level is the parent of the calling function).
-function ____exports.getParentFunctionDescription(levels)
-    if levels == nil then
-        levels = 3
-    end
-    if debug ~= nil then
-        local debugTable = debug.getinfo(levels)
-        if debugTable ~= nil then
-            return (tostring(debugTable.name) .. ":") .. tostring(debugTable.linedefined)
-        end
-    end
-    if SandboxGetParentFunctionDescription ~= nil then
-        return SandboxGetParentFunctionDescription(levels)
-    end
-    return nil
-end
---- Helper function to avoid typing out `Isaac.DebugString()`.
--- 
--- If you have the "--luadebug" launch flag turned on, then this function will also prepend the
--- function name and the line number before the string, like this:
--- 
--- ```text
--- [INFO] - Lua Debug: saveToDisk:42494 - The save data manager wrote data to the "save#.dat" file.
--- ```
--- 
--- Subsequently, it is recommended that you turn on the "--luadebug" launch flag when developing
--- your mod so that debugging becomes a little bit easier.
--- 
--- @param msg The message to log.
--- @param includeParentFunction Optional. Whether to prefix the message with the function name and
--- line number, as shown in the above example. Default is true.
-function ____exports.log(msg, includeParentFunction)
-    if includeParentFunction == nil then
-        includeParentFunction = true
-    end
-    if isNumber(nil, msg) then
-        msg = tostring(msg)
-    end
-    local ____includeParentFunction_0
-    if includeParentFunction then
-        ____includeParentFunction_0 = ____exports.getParentFunctionDescription()
-    else
-        ____includeParentFunction_0 = nil
-    end
-    local parentFunctionDescription = ____includeParentFunction_0
-    local debugMsg = parentFunctionDescription == nil and msg or (parentFunctionDescription .. " - ") .. msg
-    Isaac.DebugString(debugMsg)
-end
---- Helper function to log a message to the "log.txt" file and to print it to the screen at the same
--- time.
-function ____exports.logAndPrint(self, msg)
-    ____exports.log(msg)
-    print(msg)
-end
---- Helper function to log an error message and also print it to the console for better visibility.
--- 
--- This is useful in situations where using the `error` function would be dangerous (since it
--- prevents all of the subsequent code in the callback from running).
-function ____exports.logError(msg)
-    local errorMsg = "Error: " .. msg
-    ____exports.logAndPrint(nil, errorMsg)
-end
 return ____exports
  end,
 ["functions.table"] = function(...) 
@@ -18306,6 +18398,8 @@ local ____cachedClasses = require("core.cachedClasses")
 local game = ____cachedClasses.game
 local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
+local ____debugFunctions = require("functions.debugFunctions")
+local traceback = ____debugFunctions.traceback
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
 local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
@@ -18346,6 +18440,7 @@ function ____exports.setSeed(self, rng, seed)
     if seed == 0 then
         seed = ____exports.getRandomSeed(nil)
         logError("Failed to set a RNG object to a seed of 0. Using a random value instead.")
+        traceback()
     end
     rng:SetSeed(seed, RECOMMENDED_SHIFT_IDX)
 end
@@ -28888,14 +28983,23 @@ end
 function ____exports.getRoomShapeWidth(self, roomShape)
     return ROOM_SHAPE_TO_GRID_WIDTH[roomShape]
 end
+--- Helper function to determine if the provided room is equal to `RoomShape.1x2` (4) or
+-- `RoomShape.2x1` (6).
+function ____exports.is2x1RoomShape(self, roomShape)
+    return roomShape == RoomShape.SHAPE_1x2 or roomShape == RoomShape.SHAPE_2x1
+end
 --- Helper function to detect if the provided room shape is big. Specifically, this is all 1x2 rooms,
 -- 2x2 rooms, and L rooms.
 function ____exports.isBigRoomShape(self, roomShape)
     return BIG_ROOM_SHAPES_SET:has(roomShape)
 end
+--- Helper function to determine if the provided room is equal to `RoomShape.LTL` (9),
+-- `RoomShape.LTR` (10), `RoomShape.LBL` (11), or `RoomShape.LBR` (12).
 function ____exports.isLRoomShape(self, roomShape)
     return L_ROOM_SHAPES_SET:has(roomShape)
 end
+--- Helper function to determine if the provided room is equal to `RoomShape.IH` (2), `RoomShape.IV`
+-- (3), `RoomShape.IIV` (5), or `RoomShape.IIH` (7).
 function ____exports.isNarrowRoom(self, roomShape)
     return NARROW_ROOM_SHAPES_SET:has(roomShape)
 end
@@ -31199,9 +31303,10 @@ end
 --   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.SHAPE_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, as
+--   `Level.GetCurrentRoomIndex` method, since `SafeGridIndex` is bugged for these cases, as
 --   demonstrated by entering a Genesis room and entering `l
---   print(Game():GetLevel():GetCurrentRoomDesc().SafeGridIndex)` into the console).
+--   print(Game():GetLevel():GetCurrentRoomDesc().SafeGridIndex)` into the console. (It prints -1
+--   instead of -12.)
 -- 
 -- 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,
@@ -32347,7 +32452,6 @@ local GridRoom = ____isaac_2Dtypescript_2Ddefinitions.GridRoom
 local HomeRoomSubType = ____isaac_2Dtypescript_2Ddefinitions.HomeRoomSubType
 local ProjectileFlag = ____isaac_2Dtypescript_2Ddefinitions.ProjectileFlag
 local RoomDescriptorFlag = ____isaac_2Dtypescript_2Ddefinitions.RoomDescriptorFlag
-local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
 local StageID = ____isaac_2Dtypescript_2Ddefinitions.StageID
@@ -32386,6 +32490,7 @@ local getRoomDescriptor = ____roomData.getRoomDescriptor
 local getRoomDescriptorReadOnly = ____roomData.getRoomDescriptorReadOnly
 local getRoomGridIndex = ____roomData.getRoomGridIndex
 local ____roomShape = require("functions.roomShape")
+local is2x1RoomShape = ____roomShape.is2x1RoomShape
 local isBigRoomShape = ____roomShape.isBigRoomShape
 local isLRoomShape = ____roomShape.isLRoomShape
 local ____roomTransition = require("functions.roomTransition")
@@ -32466,7 +32571,7 @@ function ____exports.getRoomsOutsideGrid(self)
 end
 --- Helper function to determine if the provided room is equal to `RoomShape.1x2` or `RoomShape.2x1`.
 function ____exports.is2x1Room(self, roomData)
-    return roomData.Shape == RoomShape.SHAPE_1x2 or roomData.Shape == RoomShape.SHAPE_2x1
+    return is2x1RoomShape(nil, roomData.Shape)
 end
 --- Helper function to check to see if the current room is an angel shop.
 -- 
@@ -32543,8 +32648,8 @@ function ____exports.isDoubleTrouble(self, roomData)
     return roomData.Type == RoomType.BOSS and __TS__StringIncludes(roomData.Name, "Double Trouble")
 end
 --- Helper function to determine if the index of the provided room is equal to `GridRoom.GENESIS`.
-function ____exports.isGenesisRoom(self, roomDescriptor)
-    return roomDescriptor.GridIndex == asNumber(nil, GridRoom.GENESIS)
+function ____exports.isGenesisRoom(self, roomGridIndex)
+    return roomGridIndex == asNumber(nil, GridRoom.GENESIS)
 end
 --- Helper function to check if the provided room is either the left Home closet (behind the red
 -- door) or the right Home closet (with one random pickup).
@@ -32558,8 +32663,8 @@ function ____exports.isLRoom(self, roomData)
     return isLRoomShape(nil, roomData.Shape)
 end
 --- Helper function to determine if the index of the provided room is equal to `GridRoom.MEGA_SATAN`.
-function ____exports.isMegaSatanRoom(self, roomDescriptor)
-    return roomDescriptor.GridIndex == asNumber(nil, GridRoom.MEGA_SATAN)
+function ____exports.isMegaSatanRoom(self, roomGridIndex)
+    return roomGridIndex == asNumber(nil, GridRoom.MEGA_SATAN)
 end
 --- Helper function to determine if the provided room is part of the Repentance "escape sequence" in
 -- the Mines/Ashpit.
@@ -32592,8 +32697,8 @@ function ____exports.isRoomType(self, roomData, ...)
 end
 --- Helper function for checking if the provided room is a secret exit that leads to a Repentance
 -- floor.
-function ____exports.isSecretExit(self, roomDescriptor)
-    return roomDescriptor.GridIndex == asNumber(nil, GridRoom.SECRET_EXIT)
+function ____exports.isSecretExit(self, roomGridIndex)
+    return roomGridIndex == asNumber(nil, GridRoom.SECRET_EXIT)
 end
 --- Helper function for checking if the provided room is a secret shop (from the Member Card
 -- collectible).
@@ -32601,8 +32706,8 @@ end
 -- 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.
-function ____exports.isSecretShop(self, roomDescriptor)
-    return roomDescriptor.GridIndex == asNumber(nil, GridRoom.SECRET_SHOP)
+function ____exports.isSecretShop(self, roomGridIndex)
+    return roomGridIndex == asNumber(nil, GridRoom.SECRET_SHOP)
 end
 local SECRET_ROOM_TYPES = __TS__New(ReadonlySet, {RoomType.SECRET, RoomType.SUPER_SECRET, RoomType.ULTRA_SECRET})
 --- Helper function for quickly switching to a new room without playing a particular animation. Use
@@ -32680,7 +32785,7 @@ end
 --- Helper function to get the room descriptor for every room on the level. This includes off-grid
 -- rooms, such as the Devil Room.
 -- 
--- Room descriptors without any data are assumed to be non-existent and are not included.
+-- Room without any data are assumed to be non-existent and are not included.
 -- 
 -- - If you want just the rooms inside of the grid, use the `getRoomsInsideGrid` helper function.
 -- - If you want just the rooms outside of the grid, use the `getRoomsOutsideGrid` helper function.
@@ -32810,8 +32915,8 @@ function ____exports.inDoubleTrouble(self)
 end
 --- Helper function to determine if the current room index is equal to `GridRoom.GENESIS`.
 function ____exports.inGenesisRoom(self)
-    local roomDescriptor = getRoomDescriptorReadOnly(nil)
-    return ____exports.isGenesisRoom(nil, roomDescriptor)
+    local roomGridIndex = getRoomGridIndex(nil)
+    return ____exports.isGenesisRoom(nil, roomGridIndex)
 end
 --- Helper function to check if the current room is either the left Home closet (behind the red door)
 -- or the right Home closet (with one random pickup).
@@ -32828,8 +32933,8 @@ function ____exports.inLRoom(self)
 end
 --- Helper function to determine if the current room index is equal to `GridRoom.MEGA_SATAN`.
 function ____exports.inMegaSatanRoom(self)
-    local roomDescriptor = getRoomDescriptorReadOnly(nil)
-    return ____exports.isMegaSatanRoom(nil, roomDescriptor)
+    local roomGridIndex = getRoomGridIndex(nil)
+    return ____exports.isMegaSatanRoom(nil, roomGridIndex)
 end
 --- Helper function to determine if the current room is part of the Repentance "escape sequence" in
 -- the Mines/Ashpit.
@@ -32866,8 +32971,8 @@ end
 --- Helper function for checking if the current room is a secret exit that leads to a Repentance
 -- floor.
 function ____exports.inSecretExit(self)
-    local roomDescriptor = getRoomDescriptorReadOnly(nil)
-    return ____exports.isSecretExit(nil, roomDescriptor)
+    local roomGridIndex = getRoomGridIndex(nil)
+    return ____exports.isSecretExit(nil, roomGridIndex)
 end
 --- Helper function for checking if the current room is a secret shop (from the Member Card
 -- collectible).
@@ -32876,8 +32981,8 @@ end
 -- 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.
 function ____exports.inSecretShop(self)
-    local roomDescriptor = getRoomDescriptorReadOnly(nil)
-    return ____exports.isSecretShop(nil, roomDescriptor)
+    local roomGridIndex = getRoomGridIndex(nil)
+    return ____exports.isSecretShop(nil, roomGridIndex)
 end
 --- Helper function to determine whether the current room is the starting room of a floor. It only
 -- returns true for the starting room of the primary dimension (meaning that being in the starting
@@ -37001,11 +37106,10 @@ function PostPlayerInitFirst.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = shouldFirePlayer
     self.postNewRoomReordered = function()
-        if not inGenesisRoom(nil) then
-            return
-        end
-        for ____, player in ipairs(getPlayers(nil)) do
-            self:fire(player)
+        if inGenesisRoom(nil) then
+            for ____, player in ipairs(getPlayers(nil)) do
+                self:fire(player)
+            end
         end
     end
     self.postPlayerInitLate = function(____, player)
@@ -55456,7 +55560,10 @@ function ____exports.getAdjacentNonExistingRoomGridIndexes(self, roomGridIndex)
         function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) == nil end
     )
 end
---- Helper function to get the room safe grid index for every room on the entire floor.
+--- Helper function to get the room safe grid index for every room on the entire floor. This includes
+-- off-grid rooms, such as the Devil Room.
+-- 
+-- Rooms without any data are assumed to be non-existent and are not included.
 function ____exports.getAllRoomGridIndexes(self)
     local rooms = getRooms(nil)
     return __TS__ArrayMap(
@@ -63227,98 +63334,6 @@ function ____exports.getFeatures(self, mod, callbacks)
     }
     return features
 end
-return ____exports
- end,
-["functions.debugFunctions"] = function(...) 
-local ____exports = {}
-local ____log = require("functions.log")
-local log = ____log.log
---- Helper function to get the current time for benchmarking / profiling purposes.
--- 
--- The return value will either be in seconds or milliseconds, depending on if the "--luadebug" flag
--- is turned on.
--- 
--- If the "--luadebug" flag is present, then this function will use the `socket.gettime` method,
--- which returns the epoch timestamp in seconds (e.g. "1640320492.5779"). This is preferable over
--- the more conventional `Isaac.GetTime` method, since it has one extra decimal point of precision.
--- 
--- If the "--luadebug" flag is not present, then this function will use the `Isaac.GetTime` method,
--- which returns the number of milliseconds since the computer's operating system was started (e.g.
--- "739454963").
--- 
--- @param useSocketIfAvailable Optional. Whether to use the `socket.gettime` method, if available.
--- Default is true. If set to false, the `Isaac.GetTime()` method will
--- always be used.
-function ____exports.getTime(self, useSocketIfAvailable)
-    if useSocketIfAvailable == nil then
-        useSocketIfAvailable = true
-    end
-    if useSocketIfAvailable then
-        if SandboxGetTime ~= nil then
-            return SandboxGetTime()
-        end
-        if ____exports.isLuaDebugEnabled(nil) then
-            local ok, requiredSocket = pcall(require, "socket")
-            if ok then
-                local socket = requiredSocket
-                return socket.gettime()
-            end
-        end
-    end
-    return Isaac.GetTime()
-end
---- 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.
--- 
--- Note that this function will return false if the Racing+ sandbox is enabled, even if the
--- "--luadebug" flag is really turned on. If checking for this case is needed, check for the
--- presence of the `sandboxGetTraceback` function.
-function ____exports.isLuaDebugEnabled(self)
-    return _G.package ~= nil
-end
---- Helper function to get the amount of elapsed time for benchmarking / profiling purposes.
--- 
--- For more information, see the documentation for the `getTime` helper function.
--- 
--- @param time The milliseconds (int) or fractional seconds (float).
--- @param useSocketIfAvailable Optional. Whether to use the `socket.gettime` method, if available.
--- Default is true. If set to false, the `Isaac.GetTime()` method will
--- always be used.
-function ____exports.getElapsedTimeSince(self, time, useSocketIfAvailable)
-    if useSocketIfAvailable == nil then
-        useSocketIfAvailable = true
-    end
-    return ____exports.getTime(nil, useSocketIfAvailable) - time
-end
---- Helper function to get a stack trace.
--- 
--- This will only work if the `--luadebug` launch option is enabled. If it isn't, then a error
--- string will be returned.
-function ____exports.getTraceback()
-    if SandboxGetTraceback ~= nil then
-        return SandboxGetTraceback()
-    end
-    if debug ~= nil then
-        return debug.traceback()
-    end
-    return "stack traceback:\n(the \"--luadebug\" flag is not enabled)"
-end
---- Helper function to log 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. If it isn't, then a error
--- string will be logged.
-function ____exports.traceback()
-    local tracebackOutput = ____exports.getTraceback()
-    log(tracebackOutput)
-end
 return ____exports
  end,
 ["types.FunctionTuple"] = function(...) 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "79.0.0",
+  "version": "79.1.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -37,6 +37,6 @@
     "lint": "tsx --tsconfig ./scripts/tsconfig.json ./scripts/lint.mts"
   },
   "dependencies": {
-    "isaac-typescript-definitions": "^39.0.0"
+    "isaac-typescript-definitions": "^39.0.2"
   }
 }

package/src/classes/callbacks/PostPlayerInitFirst.ts

@@ -22,12 +22,12 @@ export class PostPlayerInitFirst extends CustomCallback<ModCallbackCustom.POST_P
     // trinkets, pocket items, and stats, so they will need to be re-initialized like they would be
     // at the beginning of a run. However, in this case, the `POST_PLAYER_INIT_FIRST` callback will
     // not fire, because that only fires once per run. Thus, we explicitly handle this special case.
-    if (!inGenesisRoom()) {
-      return;
-    }
-
-    for (const player of getPlayers()) {
-      this.fire(player);
+    // Note that whichever player uses Genesis, items will be removed from all players (at least in
+    // the case of Jacob & Esau).
+    if (inGenesisRoom()) {
+      for (const player of getPlayers()) {
+        this.fire(player);
+      }
     }
   };
 

package/src/enums/ModCallbackCustom.ts

@@ -1466,7 +1466,7 @@ export enum ModCallbackCustom {
    *   pickup: EntityPickup,
    *   variant: PickupVariant,
    *   subType: int,
-   * ): [PickupVariant, int] | undefined {}
+   * ): [pickupVariant: PickupVariant, subType: int] | undefined {}
    * ```
    */
   POST_PICKUP_SELECTION_FILTER,

package/src/functions/levelGrid.ts

@@ -115,7 +115,12 @@ export function getAdjacentRoomGridIndexes(
   );
 }
 
-/** Helper function to get the room safe grid index for every room on the entire floor. */
+/**
+ * Helper function to get the room safe grid index for every room on the entire floor. This includes
+ * off-grid rooms, such as the Devil Room.
+ *
+ * Rooms without any data are assumed to be non-existent and are not included.
+ */
 export function getAllRoomGridIndexes(): readonly int[] {
   const rooms = getRooms();
   return rooms.map((roomDescriptor) => roomDescriptor.SafeGridIndex);

package/src/functions/rng.ts

@@ -1,6 +1,7 @@
 import type { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
 import { SerializationBrand } from "../enums/private/SerializationBrand";
+import { traceback } from "./debugFunctions";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { logError } from "./log";
 import { getNumbersFromTable, tableHasKeys } from "./table";
@@ -160,6 +161,7 @@ export function setSeed(rng: RNG, seed: Seed): void {
     logError(
       "Failed to set a RNG object to a seed of 0. Using a random value instead.",
     );
+    traceback();
   }
 
   // The game expects seeds in the range of 1 to 4294967295 (1^32 - 1).

package/src/functions/roomData.ts

@@ -86,9 +86,10 @@ export function getRoomDescriptorReadOnly(): Readonly<RoomDescriptor> {
  *   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.SHAPE_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, as
+ *   `Level.GetCurrentRoomIndex` method, since `SafeGridIndex` is bugged for these cases, as
  *   demonstrated by entering a Genesis room and entering `l
- *   print(Game():GetLevel():GetCurrentRoomDesc().SafeGridIndex)` into the console).
+ *   print(Game():GetLevel():GetCurrentRoomDesc().SafeGridIndex)` into the console. (It prints -1
+ *   instead of -12.)
  *
  * 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,