isaacscript-common 21.9.0 → 22.0.0

package/dist/index.rollup.d.ts

@@ -3876,7 +3876,7 @@ export declare function find<T>(array: T[], func: (value: T, index: number, arra
  * @param minimumDistance Optional. If specified, will ensure that the randomly generated position
  *                        is equal to or greater than the distance provided.
  */
-export declare function findFreePosition(startingPosition: Vector, avoidActiveEntities?: boolean, minimumDistance?: float): Vector;
+export declare function findFreePosition(startingPosition: Vector, avoidActiveEntities?: boolean, minimumDistance?: float): Readonly<Vector>;
 
 declare type FireArgs<T extends ModCallbackCustom> = Parameters<AddCallbackParametersCustom[T][0]>;
 
@@ -5111,7 +5111,7 @@ export declare function getHorsePillColors(): PillColor[];
  * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
  * - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
  */
-export declare function getHUDOffsetVector(): Vector;
+export declare function getHUDOffsetVector(): Readonly<Vector>;
 
 /**
  * Helper function to get the name of a class from the Isaac API. This is contained within the
@@ -5871,7 +5871,7 @@ export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seedOr
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param alpha Optional. The alpha value to use. Default is 1.
  */
-export declare function getRandomColor(seedOrRNG?: Seed | RNG, alpha?: number): Color;
+export declare function getRandomColor(seedOrRNG?: Seed | RNG, alpha?: number): Readonly<Color>;
 
 /**
  * Helper function to get a random value from the provided enum.
@@ -5985,7 +5985,7 @@ export declare function getRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: See
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param alpha Optional. The alpha value to use. Default is 1.
  */
-export declare function getRandomKColor(seedOrRNG?: Seed | RNG, alpha?: number): KColor;
+export declare function getRandomKColor(seedOrRNG?: Seed | RNG, alpha?: number): Readonly<KColor>;
 
 /**
  * Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
@@ -6014,7 +6014,7 @@ export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, see
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  */
-export declare function getRandomVector(seedOrRNG?: Seed | RNG): Vector;
+export declare function getRandomVector(seedOrRNG?: Seed | RNG): Readonly<Vector>;
 
 /**
  * Helper function to get a read-only copy of the room descriptor for every room on the level. This
@@ -6443,19 +6443,19 @@ export declare function getRoomVisitedCount(roomGridIndex?: int): int;
  */
 export declare function getSacks(sackSubType?: SackSubType): EntityPickupSack[];
 
-export declare function getScreenBottomCenterPos(): Vector;
+export declare function getScreenBottomCenterPos(): Readonly<Vector>;
 
-export declare function getScreenBottomLeftPos(): Vector;
+export declare function getScreenBottomLeftPos(): Readonly<Vector>;
 
-export declare function getScreenBottomRightPos(): Vector;
+export declare function getScreenBottomRightPos(): Readonly<Vector>;
 
-export declare function getScreenCenterPos(): Vector;
+export declare function getScreenCenterPos(): Readonly<Vector>;
 
-export declare function getScreenTopCenterPos(): Vector;
+export declare function getScreenTopCenterPos(): Readonly<Vector>;
 
-export declare function getScreenTopLeftPos(): Vector;
+export declare function getScreenTopLeftPos(): Readonly<Vector>;
 
-export declare function getScreenTopRightPos(): Vector;
+export declare function getScreenTopRightPos(): Readonly<Vector>;
 
 /**
  * Helper function to get all possible combinations of the given set. This includes the combination
@@ -6817,7 +6817,7 @@ export declare const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
  *
  * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
  */
-export declare function gridCoordinatesToWorldPosition(x: int, y: int): Vector;
+export declare function gridCoordinatesToWorldPosition(x: int, y: int): Readonly<Vector>;
 
 declare class GridEntityCollisionDetection extends Feature {
     v: {
@@ -6909,14 +6909,14 @@ declare class GridEntityUpdateDetection extends Feature {
  * For example, in a 1x1 room, grid index 0 is equal to "Vector(-1, -1) and grid index 16 is equal
  * to "Vector(0, 0)".
  */
-export declare function gridIndexToGridPosition(gridIndex: int, roomShape: RoomShape): Vector;
+export declare function gridIndexToGridPosition(gridIndex: int, roomShape: RoomShape): Readonly<Vector>;
 
 /**
  * Helper function to convert a grid position `Vector` to a world position `Vector`.
  *
  * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
  */
-export declare function gridPositionToWorldPosition(gridPosition: Vector): Vector;
+export declare function gridPositionToWorldPosition(gridPosition: Vector): Readonly<Vector>;
 
 /**
  * Helper function to see if a particular entity has armor. In this context, armor refers to the
@@ -7015,7 +7015,7 @@ export declare enum HealthType {
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
  * @param alpha Optional. Range is from 0 to 1. Default is 1. (The same as the `Color` constructor.)
  */
-export declare function hexToColor(hexString: string, alpha?: number): Color;
+export declare function hexToColor(hexString: string, alpha?: number): Readonly<Color>;
 
 /**
  * Converts a hex string like "#33aa33" to a Color object.
@@ -7023,7 +7023,7 @@ export declare function hexToColor(hexString: string, alpha?: number): Color;
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
  * @param alpha Range is from 0 to 1. Default is 1.
  */
-export declare function hexToKColor(hexString: string, alpha?: number): KColor;
+export declare function hexToKColor(hexString: string, alpha?: number): Readonly<KColor>;
 
 /**
  * Helper type to make the given array/map/set/object recursively read-only.
@@ -8617,7 +8617,7 @@ export declare function lockDoor(door: GridEntityDoor): void;
  * @param includeParentFunction Optional. Whether to prefix the message with the function name and
  *                              line number, as shown in the above example. Default is true.
  */
-export declare function log(this: void, msg: string, includeParentFunction?: boolean): void;
+export declare function log(this: void, msg: string | number, includeParentFunction?: boolean): void;
 
 /** Helper function for printing out every entity (or filtered entity) in the current room. */
 export declare function logAllEntities(this: void, includeBackgroundEffects: boolean, entityTypeFilter?: EntityType): void;
@@ -15651,7 +15651,7 @@ export declare function willReviveFromSpiritShackles(player: EntityPlayer): bool
  *
  * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
  */
-export declare function worldPositionToGridPosition(worldPos: Vector): Vector;
+export declare function worldPositionToGridPosition(worldPos: Vector): Readonly<Vector>;
 
 /**
  * Helper function to convert a world position `Vector` to a grid position `Vector`.
@@ -15660,7 +15660,7 @@ export declare function worldPositionToGridPosition(worldPos: Vector): Vector;
  *
  * This is similar to the `worldPositionToGridPosition` function, but the values are not rounded.
  */
-export declare function worldPositionToGridPositionFast(worldPos: Vector): Vector;
+export declare function worldPositionToGridPositionFast(worldPos: Vector): Readonly<Vector>;
 
 /**
  * Helper function to see if a certain damage amount would deal "permanent" damage to Tainted

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 21.9.0
+isaacscript-common 22.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -813,13 +813,7 @@ local function __TS__AsyncAwaiter(generator)
         function(____, resolve, reject)
             local adopt, fulfilled, step, resolved, asyncCoroutine
             function adopt(self, value)
-                local ____temp_0
-                if __TS__InstanceOf(value, __TS__Promise) then
-                    ____temp_0 = value
-                else
-                    ____temp_0 = __TS__Promise.resolve(value)
-                end
-                return ____temp_0
+                return __TS__InstanceOf(value, __TS__Promise) and value or __TS__Promise.resolve(value)
             end
             function fulfilled(self, value)
                 local success, resultOrError = coroutine.resume(asyncCoroutine, value)
@@ -836,8 +830,8 @@ local function __TS__AsyncAwaiter(generator)
                 if coroutine.status(asyncCoroutine) == "dead" then
                     resolve(nil, result)
                 else
-                    local ____self_1 = adopt(nil, result)
-                    ____self_1["then"](____self_1, fulfilled, reject)
+                    local ____self_0 = adopt(nil, result)
+                    ____self_0["then"](____self_0, fulfilled, reject)
                 end
             end
             resolved = false
@@ -846,8 +840,8 @@ local function __TS__AsyncAwaiter(generator)
                 asyncCoroutine,
                 function(____, v)
                     resolved = true
-                    local ____self_2 = adopt(nil, v)
-                    ____self_2["then"](____self_2, resolve, reject)
+                    local ____self_1 = adopt(nil, v)
+                    ____self_1["then"](____self_1, resolve, reject)
                 end
             )
             if success then
@@ -954,7 +948,7 @@ do
             local descriptors = rawget(metatable, "_descriptors")
             if descriptors then
                 local descriptor = descriptors[key]
-                if descriptor then
+                if descriptor ~= nil then
                     if descriptor.get then
                         return descriptor.get(self)
                     end
@@ -970,7 +964,7 @@ do
             local descriptors = rawget(metatable, "_descriptors")
             if descriptors then
                 local descriptor = descriptors[key]
-                if descriptor then
+                if descriptor ~= nil then
                     if descriptor.set then
                         descriptor.set(self, value)
                     else
@@ -1023,7 +1017,7 @@ local function __TS__Decorate(decorators, target, key, desc)
         local i = #decorators
         while i >= 0 do
             local decorator = decorators[i + 1]
-            if decorator then
+            if decorator ~= nil then
                 local oldResult = result
                 if key == nil then
                     result = decorator(nil, result)
@@ -1096,7 +1090,7 @@ do
             if isClassicLua or caller and caller.func ~= error then
                 return description
             else
-                return (tostring(description) .. "\n") .. self.stack
+                return (description .. "\n") .. tostring(self.stack)
             end
         end
     end
@@ -1107,7 +1101,7 @@ do
             {__call = function(____, _self, message) return __TS__New(Type, message) end}
         )
     end
-    local ____initErrorClass_2 = initErrorClass
+    local ____initErrorClass_1 = initErrorClass
     local ____class_0 = __TS__Class()
     ____class_0.name = ""
     function ____class_0.prototype.____constructor(self, message)
@@ -1118,31 +1112,25 @@ do
         self.name = "Error"
         self.stack = getErrorStack(nil, self.constructor.new)
         local metatable = getmetatable(self)
-        if not metatable.__errorToStringPatched then
+        if metatable and not metatable.__errorToStringPatched then
             metatable.__errorToStringPatched = true
             metatable.__tostring = wrapErrorToString(nil, metatable.__tostring)
         end
     end
     function ____class_0.prototype.__tostring(self)
-        local ____temp_1
-        if self.message ~= "" then
-            ____temp_1 = (self.name .. ": ") .. self.message
-        else
-            ____temp_1 = self.name
-        end
-        return ____temp_1
+        return self.message ~= "" and (self.name .. ": ") .. self.message or self.name
     end
-    Error = ____initErrorClass_2(nil, ____class_0, "Error")
+    Error = ____initErrorClass_1(nil, ____class_0, "Error")
     local function createErrorClass(self, name)
-        local ____initErrorClass_4 = initErrorClass
-        local ____class_3 = __TS__Class()
-        ____class_3.name = ____class_3.name
-        __TS__ClassExtends(____class_3, Error)
-        function ____class_3.prototype.____constructor(self, ...)
-            ____class_3.____super.prototype.____constructor(self, ...)
+        local ____initErrorClass_3 = initErrorClass
+        local ____class_2 = __TS__Class()
+        ____class_2.name = ____class_2.name
+        __TS__ClassExtends(____class_2, Error)
+        function ____class_2.prototype.____constructor(self, ...)
+            ____class_2.____super.prototype.____constructor(self, ...)
             self.name = name
         end
-        return ____initErrorClass_4(nil, ____class_3, name)
+        return ____initErrorClass_3(nil, ____class_2, name)
     end
     RangeError = createErrorClass(nil, "RangeError")
     ReferenceError = createErrorClass(nil, "ReferenceError")
@@ -1312,13 +1300,13 @@ do
             self.size = self.size - 1
             local next = self.nextKey[key]
             local previous = self.previousKey[key]
-            if next and previous then
+            if next ~= nil and previous ~= nil then
                 self.nextKey[previous] = next
                 self.previousKey[next] = previous
-            elseif next then
+            elseif next ~= nil then
                 self.firstKey = next
                 self.previousKey[next] = nil
-            elseif previous then
+            elseif previous ~= nil then
                 self.lastKey = previous
                 self.nextKey[previous] = nil
             else
@@ -1504,13 +1492,7 @@ do
 end
 
 local function __TS__ObjectDefineProperty(target, key, desc)
-    local ____temp_0
-    if type(key) == "number" then
-        ____temp_0 = key + 1
-    else
-        ____temp_0 = key
-    end
-    local luaKey = ____temp_0
+    local luaKey = type(key) == "number" and key + 1 or key
     local value = rawget(target, luaKey)
     local hasGetterOrSetter = desc.get ~= nil or desc.set ~= nil
     local descriptor
@@ -1524,39 +1506,39 @@ local function __TS__ObjectDefineProperty(target, key, desc)
         descriptor = desc
     else
         local valueExists = value ~= nil
-        local ____desc_set_5 = desc.set
-        local ____desc_get_6 = desc.get
-        local ____temp_1
+        local ____desc_set_4 = desc.set
+        local ____desc_get_5 = desc.get
+        local ____temp_0
         if desc.configurable ~= nil then
-            ____temp_1 = desc.configurable
+            ____temp_0 = desc.configurable
         else
-            ____temp_1 = valueExists
+            ____temp_0 = valueExists
         end
-        local ____temp_2
+        local ____temp_1
         if desc.enumerable ~= nil then
-            ____temp_2 = desc.enumerable
+            ____temp_1 = desc.enumerable
         else
-            ____temp_2 = valueExists
+            ____temp_1 = valueExists
         end
-        local ____temp_3
+        local ____temp_2
         if desc.writable ~= nil then
-            ____temp_3 = desc.writable
+            ____temp_2 = desc.writable
         else
-            ____temp_3 = valueExists
+            ____temp_2 = valueExists
         end
-        local ____temp_4
+        local ____temp_3
         if desc.value ~= nil then
-            ____temp_4 = desc.value
+            ____temp_3 = desc.value
         else
-            ____temp_4 = value
+            ____temp_3 = value
         end
         descriptor = {
-            set = ____desc_set_5,
-            get = ____desc_get_6,
-            configurable = ____temp_1,
-            enumerable = ____temp_2,
-            writable = ____temp_3,
-            value = ____temp_4
+            set = ____desc_set_4,
+            get = ____desc_get_5,
+            configurable = ____temp_0,
+            enumerable = ____temp_1,
+            writable = ____temp_2,
+            value = ____temp_3
         }
     end
     __TS__SetDescriptor(target, luaKey, descriptor)
@@ -1626,14 +1608,8 @@ end
 
 local function __TS__ParseFloat(numberString)
     local infinityMatch = __TS__Match(numberString, "^%s*(-?Infinity)")
-    if infinityMatch then
-        local ____temp_0
-        if __TS__StringAccess(infinityMatch, 0) == "-" then
-            ____temp_0 = -math.huge
-        else
-            ____temp_0 = math.huge
-        end
-        return ____temp_0
+    if infinityMatch ~= nil then
+        return __TS__StringAccess(infinityMatch, 0) == "-" and -math.huge or math.huge
     end
     local number = tonumber(__TS__Match(numberString, "^%s*(-?%d+%.?%d*)"))
     return number or 0 / 0
@@ -1664,27 +1640,15 @@ do
         if base == nil then
             base = 10
             local hexMatch = __TS__Match(numberString, "^%s*-?0[xX]")
-            if hexMatch then
+            if hexMatch ~= nil then
                 base = 16
-                local ____TS__Match_result__0_0
-                if __TS__Match(hexMatch, "-") then
-                    ____TS__Match_result__0_0 = "-" .. __TS__StringSubstring(numberString, #hexMatch)
-                else
-                    ____TS__Match_result__0_0 = __TS__StringSubstring(numberString, #hexMatch)
-                end
-                numberString = ____TS__Match_result__0_0
+                numberString = __TS__Match(hexMatch, "-") and "-" .. __TS__StringSubstring(numberString, #hexMatch) or __TS__StringSubstring(numberString, #hexMatch)
             end
         end
         if base < 2 or base > 36 then
             return 0 / 0
         end
-        local ____temp_1
-        if base <= 10 then
-            ____temp_1 = __TS__StringSubstring(parseIntBasePattern, 0, base)
-        else
-            ____temp_1 = __TS__StringSubstring(parseIntBasePattern, 0, 10 + 2 * (base - 10))
-        end
-        local allowedDigits = ____temp_1
+        local allowedDigits = base <= 10 and __TS__StringSubstring(parseIntBasePattern, 0, base) or __TS__StringSubstring(parseIntBasePattern, 0, 10 + 2 * (base - 10))
         local pattern = ("^%s*(-?[" .. allowedDigits) .. "]*)"
         local number = tonumber(
             __TS__Match(numberString, pattern),
@@ -1923,13 +1887,13 @@ do
             self.size = self.size - 1
             local next = self.nextKey[value]
             local previous = self.previousKey[value]
-            if next and previous then
+            if next ~= nil and previous ~= nil then
                 self.nextKey[previous] = next
                 self.previousKey[next] = previous
-            elseif next then
+            elseif next ~= nil then
                 self.firstKey = next
                 self.previousKey[next] = nil
-            elseif previous then
+            elseif previous ~= nil then
                 self.lastKey = previous
                 self.nextKey[previous] = nil
             else
@@ -2117,7 +2081,7 @@ local function __TS__SourceMapTraceBack(fileName, sourceMap)
             if thread == nil and message == nil and level == nil then
                 trace = originalTraceback()
             elseif __TS__StringIncludes(_VERSION, "Lua 5.0") then
-                trace = originalTraceback((("[Level " .. tostring(level)) .. "] ") .. message)
+                trace = originalTraceback((("[Level " .. tostring(level)) .. "] ") .. tostring(message))
             else
                 trace = originalTraceback(thread, message, level)
             end
@@ -2126,12 +2090,12 @@ local function __TS__SourceMapTraceBack(fileName, sourceMap)
             end
             local function replacer(____, file, srcFile, line)
                 local fileSourceMap = _G.__TS__sourcemap[file]
-                if fileSourceMap and fileSourceMap[line] then
+                if fileSourceMap ~= nil and fileSourceMap[line] ~= nil then
                     local data = fileSourceMap[line]
                     if type(data) == "number" then
                         return (srcFile .. ":") .. tostring(data)
                     end
-                    return (tostring(data.file) .. ":") .. tostring(data.line)
+                    return (data.file .. ":") .. tostring(data.line)
                 end
                 return (file .. ":") .. line
             end
@@ -2142,14 +2106,14 @@ local function __TS__SourceMapTraceBack(fileName, sourceMap)
             )
             local function stringReplacer(____, file, line)
                 local fileSourceMap = _G.__TS__sourcemap[file]
-                if fileSourceMap and fileSourceMap[line] then
+                if fileSourceMap ~= nil and fileSourceMap[line] ~= nil then
                     local chunkName = __TS__Match(file, "%[string \"([^\"]+)\"%]")
                     local sourceName = string.gsub(chunkName, ".lua$", ".ts")
                     local data = fileSourceMap[line]
                     if type(data) == "number" then
                         return (sourceName .. ":") .. tostring(data)
                     end
-                    return (tostring(data.file) .. ":") .. tostring(data.line)
+                    return (data.file .. ":") .. tostring(data.line)
                 end
                 return (file .. ":") .. line
             end
@@ -2269,13 +2233,7 @@ do
             return source
         end
         local before = sub(source, 1, startPos - 1)
-        local ____temp_0
-        if type(replaceValue) == "string" then
-            ____temp_0 = replaceValue
-        else
-            ____temp_0 = replaceValue(nil, searchValue, startPos - 1, source)
-        end
-        local replacement = ____temp_0
+        local replacement = type(replaceValue) == "string" and replaceValue or replaceValue(nil, searchValue, startPos - 1, source)
         local after = sub(source, endPos + 1)
         return (before .. replacement) .. after
     end
@@ -2430,6 +2388,7 @@ do
                 return key
             end
         end
+        return nil
     end
 end
 
@@ -15469,43 +15428,6 @@ function ____exports.shouldFireTrinketType(self, fireArgs, optionalArgs)
     local callbackTrinketType = table.unpack(optionalArgs)
     return callbackTrinketType == nil or callbackTrinketType == trinketType
 end
-return ____exports
- end,
-["src.functions.log"] = function(...) 
-local ____exports = {}
-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
-function ____exports.log(msg, includeParentFunction)
-    if includeParentFunction == nil then
-        includeParentFunction = true
-    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
-function ____exports.logAndPrint(self, msg)
-    ____exports.log(msg)
-    print(msg)
-end
 return ____exports
  end,
 ["src.functions.types"] = function(...) 
@@ -15562,6 +15484,48 @@ end
 function ____exports.isUserdata(self, variable)
     return type(variable) == "userdata"
 end
+return ____exports
+ end,
+["src.functions.log"] = function(...) 
+local ____exports = {}
+local ____types = require("src.functions.types")
+local isNumber = ____types.isNumber
+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
+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
+function ____exports.logAndPrint(self, msg)
+    ____exports.log(msg)
+    print(msg)
+end
 return ____exports
  end,
 ["src.functions.sort"] = function(...)