isaacscript-common 9.19.3 → 10.0.1

package/dist/index.d.ts

@@ -1,6 +1,6 @@
+/// <reference types="@typescript-to-lua/language-extensions" />
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="lua-types/5.3" />
-/// <reference types="typescript-to-lua/language-extensions" />
 
 import { ActiveSlot } from 'isaac-typescript-definitions';
 import { BackdropType } from 'isaac-typescript-definitions';
@@ -950,8 +950,8 @@ export declare function copyRNG(rng: RNG): RNG;
 /** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
 export declare function copySet<T>(oldSet: Set<T> | ReadonlySet<T>): Set<T>;
 
-/** Helper function to copy specific values from a object to a table. */
-export declare function copyValuesToTable(object: unknown, keys: string[], luaMap: LuaMap<string, unknown>): void;
+/** Helper function to copy specific values from a userdata object (e.g. `Vector`) to a table. */
+export declare function copyUserdataValuesToTable(object: unknown, keys: string[], luaMap: LuaMap<string, unknown>): void;
 
 /** Helper function to copy a `Vector` Isaac API class. */
 export declare function copyVector(vector: Vector): Vector;
@@ -2157,8 +2157,10 @@ export declare function find<T>(array: T[], func: (value: T, index: number, arra
  * @param startingPosition The position to start searching from. If this position is not overlapping
  *                         with anything, then it will be returned.
  * @param avoidActiveEntities Optional. Default is false.
+ * @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): Vector;
+export declare function findFreePosition(startingPosition: Vector, avoidActiveEntities?: boolean, minimumDistance?: float): Vector;
 
 /**
  * Helper function to make an NPC fire one or more projectiles. Returns the fired projectile(s).
@@ -6475,7 +6477,7 @@ export declare const itemConfig: ItemConfig;
  *                false in situations where iterating randomly would not matter and you need the
  *                extra performance.
  */
-export declare function iterateTableInOrder<K, V>(luaMap: LuaMap<K, V>, func: (key: K, value: V) => void, inOrder?: boolean): void;
+export declare function iterateTableInOrder<K extends AnyNotNil, V>(luaMap: LuaMap<K, V>, func: (key: K, value: V) => void, inOrder?: boolean): void;
 
 /**
  * Helper function for non-TypeScript users to convert an array to a string with the specified
@@ -6824,7 +6826,7 @@ export declare function logTable(luaTable: unknown, parentTables?: number): void
  * Helper function to print out the differences between the entries of two tables. Note that this
  * will only do a shallow comparison.
  */
-export declare function logTableDifferences<K, V>(table1: LuaMap<K, V>, table2: LuaMap<K, V>): void;
+export declare function logTableDifferences<K extends AnyNotNil, V>(table1: LuaMap<K, V>, table2: LuaMap<K, V>): void;
 
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 export declare function logTearFlags(flags: TearFlag | BitFlags<TearFlag>): void;

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 9.19.3
+isaacscript-common 10.0.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -304,11 +304,15 @@ local function __TS__ArrayPushArray(self, items)
     return len
 end
 
+local function __TS__CountVarargs(...)
+    return select("#", ...)
+end
+
 local function __TS__ArrayReduce(self, callbackFn, ...)
     local len = #self
     local k = 0
     local accumulator = nil
-    if select("#", ...) ~= 0 then
+    if __TS__CountVarargs(...) ~= 0 then
         accumulator = ...
     elseif len > 0 then
         accumulator = self[1]
@@ -332,7 +336,7 @@ local function __TS__ArrayReduceRight(self, callbackFn, ...)
     local len = #self
     local k = len - 1
     local accumulator = nil
-    if select("#", ...) ~= 0 then
+    if __TS__CountVarargs(...) ~= 0 then
         accumulator = ...
     elseif len > 0 then
         accumulator = self[k + 1]
@@ -448,7 +452,7 @@ end
 local function __TS__ArraySplice(self, ...)
     local args = {...}
     local len = #self
-    local actualArgumentCount = select("#", ...)
+    local actualArgumentCount = __TS__CountVarargs(...)
     local start = args[1]
     local deleteCount = args[2]
     if start < 0 then
@@ -1065,6 +1069,16 @@ local function __TS__DecorateParam(paramIndex, decorator)
     return function(____, target, key) return decorator(nil, target, key, paramIndex) end
 end
 
+local function __TS__StringIncludes(self, searchString, position)
+    if not position then
+        position = 1
+    else
+        position = position + 1
+    end
+    local index = string.find(self, searchString, position, true)
+    return index ~= nil
+end
+
 local Error, RangeError, ReferenceError, SyntaxError, TypeError, URIError
 do
     local function getErrorStack(self, constructor)
@@ -1079,13 +1093,18 @@ do
                 break
             end
         end
-        return debug.traceback(nil, level)
+        if __TS__StringIncludes(_VERSION, "Lua 5.0") then
+            return debug.traceback(("[Level " .. tostring(level)) .. "]")
+        else
+            return debug.traceback(nil, level)
+        end
     end
     local function wrapErrorToString(self, getDescription)
         return function(self)
             local description = getDescription(self)
             local caller = debug.getinfo(3, "f")
-            if _VERSION == "Lua 5.1" or caller and caller.func ~= error then
+            local isClassicLua = __TS__StringIncludes(_VERSION, "Lua 5.0") or _VERSION == "Lua 5.1"
+            if isClassicLua or caller and caller.func ~= error then
                 return description
             else
                 return (tostring(description) .. "\n") .. self.stack
@@ -1234,16 +1253,9 @@ do
     function __TS__Generator(fn)
         return function(...)
             local args = {...}
-            local argsLength = select("#", ...)
+            local argsLength = __TS__CountVarargs(...)
             return {
-                ____coroutine = coroutine.create(function()
-                    local ____fn_1 = fn
-                    local ____unpack_0 = unpack
-                    if ____unpack_0 == nil then
-                        ____unpack_0 = table.unpack
-                    end
-                    return ____fn_1(____unpack_0(args, 1, argsLength))
-                end),
+                ____coroutine = coroutine.create(function() return fn(__TS__Unpack(args, 1, argsLength)) end),
                 [Symbol.iterator] = generatorIterator,
                 next = generatorNext
             }
@@ -1407,8 +1419,12 @@ do
     Map[Symbol.species] = Map
 end
 
+local __TS__Match = string.match
+
 local __TS__MathAtan2 = math.atan2 or math.atan
 
+local __TS__MathModf = math.modf
+
 local function __TS__MathSign(val)
     if val > 0 then
         return 1
@@ -1418,6 +1434,10 @@ local function __TS__MathSign(val)
     return 0
 end
 
+local function __TS__Modulo50(a, b)
+    return a - math.floor(a / b) * b
+end
+
 local function __TS__Number(value)
     local valueType = type(value)
     if valueType == "number" then
@@ -1464,7 +1484,7 @@ do
         if radix < 2 or radix > 36 then
             error("toString() radix argument must be between 2 and 36", 0)
         end
-        local integer, fraction = math.modf(math.abs(self))
+        local integer, fraction = __TS__MathModf(math.abs(self))
         local result = ""
         if radix == 8 then
             result = string.format("%o", integer)
@@ -1620,7 +1640,7 @@ local function __TS__ObjectValues(obj)
 end
 
 local function __TS__ParseFloat(numberString)
-    local infinityMatch = string.match(numberString, "^%s*(-?Infinity)")
+    local infinityMatch = __TS__Match(numberString, "^%s*(-?Infinity)")
     if infinityMatch then
         local ____temp_0
         if __TS__StringAccess(infinityMatch, 0) == "-" then
@@ -1630,7 +1650,7 @@ local function __TS__ParseFloat(numberString)
         end
         return ____temp_0
     end
-    local number = tonumber(string.match(numberString, "^%s*(-?%d+%.?%d*)"))
+    local number = tonumber(__TS__Match(numberString, "^%s*(-?%d+%.?%d*)"))
     local ____number_1 = number
     if ____number_1 == nil then
         ____number_1 = 0 / 0
@@ -1678,16 +1698,16 @@ do
     function __TS__ParseInt(numberString, base)
         if base == nil then
             base = 10
-            local hexMatch = string.match(numberString, "^%s*-?0[xX]")
+            local hexMatch = __TS__Match(numberString, "^%s*-?0[xX]")
             if hexMatch then
                 base = 16
-                local ____string_match_result__0_0
-                if string.match(hexMatch, "-") then
-                    ____string_match_result__0_0 = "-" .. __TS__StringSubstr(numberString, #hexMatch)
+                local ____TS__Match_result__0_0
+                if __TS__Match(hexMatch, "-") then
+                    ____TS__Match_result__0_0 = "-" .. __TS__StringSubstr(numberString, #hexMatch)
                 else
-                    ____string_match_result__0_0 = __TS__StringSubstr(numberString, #hexMatch)
+                    ____TS__Match_result__0_0 = __TS__StringSubstr(numberString, #hexMatch)
                 end
-                numberString = ____string_match_result__0_0
+                numberString = ____TS__Match_result__0_0
             end
         end
         if base < 2 or base > 36 then
@@ -1702,7 +1722,7 @@ do
         local allowedDigits = ____temp_1
         local pattern = ("^%s*(-?[" .. allowedDigits) .. "]*)"
         local number = tonumber(
-            string.match(numberString, pattern),
+            __TS__Match(numberString, pattern),
             base
         )
         if number == nil then
@@ -2014,13 +2034,13 @@ end
 
 local function __TS__SparseArrayNew(...)
     local sparseArray = {...}
-    sparseArray.sparseLength = select("#", ...)
+    sparseArray.sparseLength = __TS__CountVarargs(...)
     return sparseArray
 end
 
 local function __TS__SparseArrayPush(sparseArray, ...)
     local args = {...}
-    local argsLen = select("#", ...)
+    local argsLen = __TS__CountVarargs(...)
     local listLen = sparseArray.sparseLength
     for i = 1, argsLen do
         sparseArray[listLen + i] = args[i]
@@ -2135,6 +2155,8 @@ local function __TS__SourceMapTraceBack(fileName, sourceMap)
             local trace
             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)
             else
                 trace = originalTraceback(thread, message, level)
             end
@@ -2160,7 +2182,7 @@ local function __TS__SourceMapTraceBack(fileName, sourceMap)
             local function stringReplacer(____, file, line)
                 local fileSourceMap = _G.__TS__sourcemap[file]
                 if fileSourceMap and fileSourceMap[line] then
-                    local chunkName = string.match(file, "%[string \"([^\"]+)\"%]")
+                    local chunkName = __TS__Match(file, "%[string \"([^\"]+)\"%]")
                     local sourceName = string.gsub(chunkName, ".lua$", ".ts")
                     local data = fileSourceMap[line]
                     if type(data) == "number" then
@@ -2227,16 +2249,6 @@ local function __TS__StringEndsWith(self, searchString, endPosition)
     return string.sub(self, endPosition - #searchString + 1, endPosition) == searchString
 end
 
-local function __TS__StringIncludes(self, searchString, position)
-    if not position then
-        position = 1
-    else
-        position = position + 1
-    end
-    local index = string.find(self, searchString, position, true)
-    return index ~= nil
-end
-
 local function __TS__StringPadEnd(self, maxLength, fillString)
     if fillString == nil then
         fillString = " "
@@ -2492,6 +2504,7 @@ return {
   __TS__Class = __TS__Class,
   __TS__ClassExtends = __TS__ClassExtends,
   __TS__CloneDescriptor = __TS__CloneDescriptor,
+  __TS__CountVarargs = __TS__CountVarargs,
   __TS__Decorate = __TS__Decorate,
   __TS__DecorateParam = __TS__DecorateParam,
   __TS__Delete = __TS__Delete,
@@ -2509,8 +2522,11 @@ return {
   __TS__Iterator = __TS__Iterator,
   __TS__LuaIteratorSpread = __TS__LuaIteratorSpread,
   Map = Map,
+  __TS__Match = __TS__Match,
   __TS__MathAtan2 = __TS__MathAtan2,
+  __TS__MathModf = __TS__MathModf,
   __TS__MathSign = __TS__MathSign,
+  __TS__Modulo50 = __TS__Modulo50,
   __TS__New = __TS__New,
   __TS__Number = __TS__Number,
   __TS__NumberIsFinite = __TS__NumberIsFinite,
@@ -4837,7 +4853,7 @@ return ____exports
 ["lua_modules.isaac-typescript-definitions.dist.package"] = function(...) 
 return {
     name = "isaac-typescript-definitions",
-    version = "6.0.0",
+    version = "7.0.0",
     description = "TypeScript definitions for The Binding of Isaac: Repentance.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",
@@ -4848,7 +4864,7 @@ return {
     type = "commonjs",
     main = "dist/src/index",
     types = "dist/src/index.d.ts",
-    dependencies = {["lua-types"] = "^2.12.2"}
+    dependencies = {["lua-types"] = "^2.13.0"}
 }
  end,
 ["lua_modules.isaac-typescript-definitions.dist.src.enums.ActiveSlot"] = function(...) 
@@ -18391,6 +18407,7 @@ local ____types = require("src.functions.types")
 local isBoolean = ____types.isBoolean
 local isNumber = ____types.isNumber
 local isString = ____types.isString
+local isUserdata = ____types.isUserdata
 --- In a `Map`, you can use the `clear` method to delete every element. However, in a `LuaMap`, the
 -- `clear` method does not exist. Use this helper function as a drop-in replacement for this.
 function ____exports.clearTable(self, luaMap)
@@ -18398,11 +18415,14 @@ function ____exports.clearTable(self, luaMap)
         luaMap[key] = nil
     end
 end
---- Helper function to copy specific values from a object to a table.
-function ____exports.copyValuesToTable(self, object, keys, luaMap)
-    local otherTable = object
+--- Helper function to copy specific values from a userdata object (e.g. `Vector`) to a table.
+function ____exports.copyUserdataValuesToTable(self, object, keys, luaMap)
+    if not isUserdata(nil, object) then
+        error("Failed to copy an object values to a table, since the object was of type: " .. type(object))
+    end
+    local userdata = object
     for ____, key in ipairs(keys) do
-        local value = otherTable[key]
+        local value = userdata[key]
         luaMap[key] = value
     end
 end
@@ -20182,7 +20202,7 @@ local getRandomSeed = ____rng.getRandomSeed
 local isRNG = ____rng.isRNG
 local newRNG = ____rng.newRNG
 local ____table = require("src.functions.table")
-local copyValuesToTable = ____table.copyValuesToTable
+local copyUserdataValuesToTable = ____table.copyUserdataValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
 local ____types = require("src.functions.types")
@@ -20256,7 +20276,7 @@ function ____exports.serializeVector(self, vector)
         error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
     end
     local vectorTable = {}
-    copyValuesToTable(nil, vector, KEYS, vectorTable)
+    copyUserdataValuesToTable(nil, vector, KEYS, vectorTable)
     vectorTable[SerializationBrand.VECTOR] = ""
     return vectorTable
 end
@@ -24900,7 +24920,7 @@ local getRandomSeed = ____rng.getRandomSeed
 local isRNG = ____rng.isRNG
 local newRNG = ____rng.newRNG
 local ____table = require("src.functions.table")
-local copyValuesToTable = ____table.copyValuesToTable
+local copyUserdataValuesToTable = ____table.copyUserdataValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
 local ____types = require("src.functions.types")
@@ -24984,7 +25004,7 @@ function ____exports.serializeKColor(self, kColor)
         error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
     end
     local kColorTable = {}
-    copyValuesToTable(nil, kColor, KEYS, kColorTable)
+    copyUserdataValuesToTable(nil, kColor, KEYS, kColorTable)
     kColorTable[SerializationBrand.K_COLOR] = ""
     return kColorTable
 end
@@ -26728,7 +26748,9 @@ end
 -- @param startingPosition The position to start searching from. If this position is not overlapping
 -- with anything, then it will be returned.
 -- @param avoidActiveEntities Optional. Default is false.
-function ____exports.findFreePosition(self, startingPosition, avoidActiveEntities)
+-- @param minimumDistance Optional. If specified, will ensure that the randomly generated position
+-- is equal to or greater than the distance provided.
+function ____exports.findFreePosition(self, startingPosition, avoidActiveEntities, minimumDistance)
     if avoidActiveEntities == nil then
         avoidActiveEntities = false
     end
@@ -26747,6 +26769,12 @@ function ____exports.findFreePosition(self, startingPosition, avoidActiveEntitie
                 if isCloseHeavenDoor then
                     goto __continue7
                 end
+                if minimumDistance ~= nil then
+                    local distance = startingPosition:Distance(position)
+                    if distance < minimumDistance then
+                        goto __continue7
+                    end
+                end
                 return position
             end
             ::__continue7::
@@ -29612,7 +29640,7 @@ local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____isaacAPIClass = require("src.functions.isaacAPIClass")
 local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
 local ____table = require("src.functions.table")
-local copyValuesToTable = ____table.copyValuesToTable
+local copyUserdataValuesToTable = ____table.copyUserdataValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
 local ____types = require("src.functions.types")
@@ -29671,7 +29699,7 @@ function ____exports.serializeBitSet128(self, bitSet128)
         error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
     end
     local bitSet128Table = {}
-    copyValuesToTable(nil, bitSet128, KEYS, bitSet128Table)
+    copyUserdataValuesToTable(nil, bitSet128, KEYS, bitSet128Table)
     bitSet128Table[SerializationBrand.BIT_SET_128] = ""
     return bitSet128Table
 end
@@ -29692,7 +29720,7 @@ local getRandomSeed = ____rng.getRandomSeed
 local isRNG = ____rng.isRNG
 local newRNG = ____rng.newRNG
 local ____table = require("src.functions.table")
-local copyValuesToTable = ____table.copyValuesToTable
+local copyUserdataValuesToTable = ____table.copyUserdataValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
 local ____types = require("src.functions.types")
@@ -29797,7 +29825,7 @@ function ____exports.serializeColor(self, color)
         error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
     end
     local colorTable = {}
-    copyValuesToTable(nil, color, KEYS, colorTable)
+    copyUserdataValuesToTable(nil, color, KEYS, colorTable)
     colorTable[SerializationBrand.COLOR] = ""
     return colorTable
 end
@@ -46818,7 +46846,7 @@ return ____exports
 ["package"] = function(...) 
 return {
     name = "isaacscript-common",
-    version = "9.19.3",
+    version = "10.0.1",
     description = "Helper functions and features for IsaacScript mods.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",
@@ -46829,7 +46857,7 @@ return {
     type = "commonjs",
     main = "dist/src/index",
     types = "dist/src/index.d.ts",
-    dependencies = {["isaac-typescript-definitions"] = "^6.0.0"}
+    dependencies = {["isaac-typescript-definitions"] = "^7.0.0"}
 }
  end,
 ["src.functions.map"] = function(...)