isaacscript-common 76.2.0 → 76.3.0

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 76.1.0
+isaacscript-common 76.2.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -16287,81 +16287,6 @@ end
 function ____exports.isUserdata(self, variable)
     return type(variable) == "userdata"
 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.sort"] = function(...) 
@@ -16507,183 +16432,7 @@ function ____exports.stableSort(self, array, sortFunc)
 end
 return ____exports
  end,
-["classes.DefaultMap"] = function(...) 
-local ____lualib = require("lualib_bundle")
-local __TS__Class = ____lualib.__TS__Class
-local Map = ____lualib.Map
-local __TS__ClassExtends = ____lualib.__TS__ClassExtends
-local __TS__TypeOf = ____lualib.__TS__TypeOf
-local __TS__New = ____lualib.__TS__New
-local ____exports = {}
-local ____types = require("functions.types")
-local isFunction = ____types.isFunction
-local isPrimitive = ____types.isPrimitive
---- `DefaultMap` is a data structure that makes working with default values easier. It extends a
--- `Map` and adds additional methods.
--- 
--- It is a common pattern to look up a value in a `Map`, and then, if the value does not exist, set
--- a default value for the key, and then return the default value. `DefaultMap` abstracts this
--- operation away by providing the `getAndSetDefault` method.
--- 
--- Using a `DefaultMap` is nice because it makes code more declarative, since you specify what the
--- default value is alongside the types of the keys/values.
--- 
--- When instantiating a new `DefaultMap`, you must specify default value as the first argument. (The
--- default value is the initial value that will be assigned to every new entry in the
--- `getAndSetDefault` method.) For example:
--- 
--- ```ts
--- // Initializes a new empty DefaultMap with a default value of "foo".
--- const defaultMapWithString = new DefaultMap<string, string>("foo");
--- 
--- const value = defaultMapWithString.getAndSetDefault("bar");
--- // value is now "foo" and an entry for "bar" is now set.
--- ```
--- 
--- Sometimes, instead of having a static initial value for every entry in the map, you will want a
--- dynamic initial value that is contingent upon the key or some other variable. In these cases, you
--- can instead specify that the `DefaultMap` should run a function that will return the initial
--- value. (This is referred to as a "factory function".) For example:
--- 
--- ```ts
--- // Initializes a new empty DefaultMap with a default value based on "someGlobalVariable".
--- const factoryFunction = () => someGlobalVariable ? 0 : 1;
--- const defaultMapWithFactoryFunction = new DefaultMap<string, string>(factoryFunction);
--- ```
--- 
--- Note that in TypeScript and Lua, booleans, numbers, and strings are "passed by value". This means
--- that when the `DefaultMap` creates a new entry, if the default value is one of these 3 types, the
--- values will be copied. On the other hand, arrays and maps and other complex data structures are
--- "passed by reference". This means that when the `DefaultMap` creates a new entry, if the default
--- value is an array, then it would not be copied. Instead, the same shared array would be assigned
--- to every entry. Thus, to solve this problem, any variable that is passed by reference must be
--- created using a factory function to ensure that each copy is unique. For example:
--- 
--- ```ts
--- // Initializes a new empty DefaultMap with a default value of a new empty array.
--- const factoryFunction = () => [];
--- const defaultMapWithArray = new DefaultMap<string, string[]>(factoryFunction);
--- ```
--- 
--- In the previous two examples, the factory functions did not have any arguments. But you can also
--- specify a factory function that takes one or more arguments:
--- 
--- ```ts
--- const factoryFunction = (arg: boolean) => arg ? 0 : 1;
--- const defaultMapWithArg = new DefaultMap<string, string, [arg: boolean]>(factoryFunction);
--- ```
--- 
--- Similar to a normal `Map`, you can also include an initializer list in the constructor as the
--- second argument:
--- 
--- ```ts
--- // Initializes a DefaultMap with a default value of "foo" and some initial values.
--- const defaultMapWithInitialValues = new DefaultMap<string, string>("foo", [
---   ["a1", "a2"],
---   ["b1", "b2"],
--- ], );
--- ```
--- 
--- Finally, note that `DefaultMap` has the following additional utility methods:
--- 
--- - `getAndSetDefault` - The method that is called inside the overridden `get` method. In most
---   cases, you can use the overridden `get` method instead of calling this function directly.
---   However, if a factory function was provided during instantiation, and the factory function has
---   one or more arguments, then you must call this method instead (and provide the corresponding
---   arguments).
--- - `getDefaultValue` - Returns the default value to be used for a new key. (If a factory function
---   was provided during instantiation, this will execute the factory function.)
--- - `getConstructorArg` - Helper method for cloning the map. Returns either the default value or
---   the reference to the factory function.
-____exports.DefaultMap = __TS__Class()
-local DefaultMap = ____exports.DefaultMap
-DefaultMap.name = "DefaultMap"
-__TS__ClassExtends(DefaultMap, Map)
-function DefaultMap.prototype.____constructor(self, defaultValueOrFactoryFunction, initializerArray)
-    local argIsPrimitive = isPrimitive(nil, defaultValueOrFactoryFunction)
-    local argIsFunction = isFunction(nil, defaultValueOrFactoryFunction)
-    if not argIsPrimitive and not argIsFunction then
-        error(("Failed to instantiate a DefaultMap since the provided default value was of type \"" .. __TS__TypeOf(defaultValueOrFactoryFunction)) .. "\". This error usually means that you are trying to use an array (or some other non-primitive data structure that is passed by reference) as the default value. Instead, return the data structure in a factory function, like \"() => []\". See the DefaultMap documentation for more details.")
-    end
-    Map.prototype.____constructor(self, initializerArray)
-    if argIsFunction then
-        self.defaultValue = nil
-        self.defaultValueFactory = defaultValueOrFactoryFunction
-    else
-        self.defaultValue = defaultValueOrFactoryFunction
-        self.defaultValueFactory = nil
-    end
-end
-function DefaultMap.prototype.getAndSetDefault(self, key, ...)
-    local value = Map.prototype.get(self, key)
-    if value ~= nil then
-        return value
-    end
-    local defaultValue = self:getDefaultValue(...)
-    self:set(key, defaultValue)
-    return defaultValue
-end
-function DefaultMap.prototype.getDefaultValue(self, ...)
-    if self.defaultValue ~= nil then
-        return self.defaultValue
-    end
-    if self.defaultValueFactory ~= nil then
-        return self:defaultValueFactory(...)
-    end
-    error("A DefaultMap was incorrectly instantiated.")
-end
-function DefaultMap.prototype.getConstructorArg(self)
-    if self.defaultValue ~= nil then
-        return self.defaultValue
-    end
-    if self.defaultValueFactory ~= nil then
-        return self.defaultValueFactory
-    end
-    error("A DefaultMap was incorrectly instantiated.")
-end
-local function test(self)
-    local myDefaultMapBoolean = __TS__New(____exports.DefaultMap, false)
-    local myDefaultMapBooleanFactory = __TS__New(
-        ____exports.DefaultMap,
-        function() return false end
-    )
-    local myDefaultMapBooleanWithoutParams = __TS__New(____exports.DefaultMap, false)
-    local myDefaultMapNumber = __TS__New(____exports.DefaultMap, 123)
-    local myDefaultMapNumberFactory = __TS__New(
-        ____exports.DefaultMap,
-        function() return 123 end
-    )
-    local myDefaultMapNumberWithoutParams = __TS__New(____exports.DefaultMap, 123)
-    local myDefaultMapString = __TS__New(____exports.DefaultMap, "foo")
-    local myDefaultMapStringFactory = __TS__New(
-        ____exports.DefaultMap,
-        function() return "foo" end
-    )
-    local myDefaultMapStringWithoutParams = __TS__New(____exports.DefaultMap, "foo")
-    local myDefaultMapArray = __TS__New(
-        ____exports.DefaultMap,
-        function() return {} end
-    )
-    local myDefaultMapArrayWithoutParams = __TS__New(
-        ____exports.DefaultMap,
-        function() return {} end
-    )
-    local myDefaultMapMap = __TS__New(
-        ____exports.DefaultMap,
-        function() return __TS__New(Map) end
-    )
-    local myDefaultMapMapWithoutParams = __TS__New(
-        ____exports.DefaultMap,
-        function() return __TS__New(Map) end
-    )
-end
-return ____exports
- end,
-["interfaces.TSTLClassMetatable"] = function(...) 
-local ____exports = {}
-return ____exports
- end,
-["types.TSTLClass"] = function(...) 
+["types.WidenLiteral"] = function(...) 
 local ____exports = {}
 return ____exports
  end,
@@ -16737,6 +16486,24 @@ ____exports.fonts.teamMeatFont12:Load("font/teammeatfont12.fnt")
 ____exports.fonts.teamMeatFont16Bold:Load("font/teammeatfont16bold.fnt")
 ____exports.fonts.terminus:Load("font/terminus.fnt")
 ____exports.fonts.upheaval:Load("font/upheaval.fnt")
+return ____exports
+ end,
+["enums.private.SerializationBrand"] = function(...) 
+local ____exports = {}
+--- During serialization, we write an arbitrary string key to the object with a value of an empty
+-- string. This is used during deserialization to instantiate the correct type of object.
+____exports.SerializationBrand = {}
+____exports.SerializationBrand.DEFAULT_MAP = "__TSTL_DEFAULT_MAP"
+____exports.SerializationBrand.MAP = "__TSTL_MAP"
+____exports.SerializationBrand.SET = "__TSTL_SET"
+____exports.SerializationBrand.BIT_SET_128 = "__BIT_SET_128"
+____exports.SerializationBrand.COLOR = "__COLOR"
+____exports.SerializationBrand.K_COLOR = "__K_COLOR"
+____exports.SerializationBrand.RNG = "__RNG"
+____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,
 ["types.PlayerIndex"] = function(...) 
@@ -17129,108 +16896,6 @@ end
 -- @allowEmptyVariadic
 function ____exports.todo(self, ...)
 end
-return ____exports
- end,
-["functions.tstlClass"] = function(...) 
-local ____exports = {}
-local ____types = require("functions.types")
-local isTable = ____types.isTable
-local ____utils = require("functions.utils")
-local assertDefined = ____utils.assertDefined
---- Helper function to get the constructor from an instantiated TypeScriptToLua class, which is
--- located on the metatable.
--- 
--- Returns undefined if passed a non-table or if the provided table does not have a metatable.
-function ____exports.getTSTLClassConstructor(self, object)
-    if not isTable(nil, object) then
-        return nil
-    end
-    local metatable = getmetatable(object)
-    if metatable == nil then
-        return nil
-    end
-    return metatable.constructor
-end
---- Helper function to get the name of a TypeScriptToLua class from the instantiated class object.
--- 
--- TSTL classes are Lua tables created with the `__TS__Class` Lua function from the TSTL lualib.
--- Their name is contained within "constructor.name" metatable key.
--- 
--- For example, a `Map` class is has a name of "Map".
--- 
--- Returns undefined if passed a non-table or if the provided table does not have a metatable.
-function ____exports.getTSTLClassName(self, object)
-    local constructor = ____exports.getTSTLClassConstructor(nil, object)
-    if constructor == nil then
-        return nil
-    end
-    return constructor.name
-end
---- Helper function to determine if a given object is a TypeScriptToLua `Map`.
--- 
--- It is not reliable to use the `instanceof` operator to determine this because each Lua module has
--- their own copies of the entire lualib and thus their own instantiated version of a `Map`.
-function ____exports.isDefaultMap(self, object)
-    local className = ____exports.getTSTLClassName(nil, object)
-    return className == "DefaultMap"
-end
---- Helper function to check if a given table is a class table created by TypeScriptToLua.
-function ____exports.isTSTLClass(self, object)
-    local tstlClassName = ____exports.getTSTLClassName(nil, object)
-    return tstlClassName ~= nil
-end
---- Helper function to determine if a given object is a TypeScriptToLua `Map`.
--- 
--- It is not reliable to use the `instanceof` operator to determine this because each Lua module
--- might have their own copy of the entire lualib and thus their own instantiated version of a
--- `Map`.
-function ____exports.isTSTLMap(self, object)
-    local className = ____exports.getTSTLClassName(nil, object)
-    return className == "Map"
-end
---- Helper function to determine if a given object is a TypeScriptToLua `Set`.
--- 
--- It is not reliable to use the `instanceof` operator to determine this because each Lua module
--- might have their own copy of the entire lualib and thus their own instantiated version of a
--- `Set`.
-function ____exports.isTSTLSet(self, object)
-    local className = ____exports.getTSTLClassName(nil, object)
-    return className == "Set"
-end
---- Initializes a new TypeScriptToLua class in the situation where you do not know what kind of class
--- it is. This function requires that you provide an instantiated class of the same type, as it will
--- use the class constructor that is present on the other object's metatable to initialize the new
--- class.
-function ____exports.newTSTLClass(self, oldClass)
-    local constructor = ____exports.getTSTLClassConstructor(nil, oldClass)
-    assertDefined(nil, constructor, "Failed to instantiate a new TypeScriptToLua class since the provided old class does not have a metatable/constructor.")
-    local newClass = {}
-    local newClassMetatable = setmetatable(newClass, constructor.prototype)
-    newClassMetatable:____constructor()
-    return newClass
-end
-return ____exports
- end,
-["types.WidenLiteral"] = function(...) 
-local ____exports = {}
-return ____exports
- end,
-["enums.private.SerializationBrand"] = function(...) 
-local ____exports = {}
---- During serialization, we write an arbitrary string key to the object with a value of an empty
--- string. This is used during deserialization to instantiate the correct type of object.
-____exports.SerializationBrand = {}
-____exports.SerializationBrand.DEFAULT_MAP = "__TSTL_DEFAULT_MAP"
-____exports.SerializationBrand.MAP = "__TSTL_MAP"
-____exports.SerializationBrand.SET = "__TSTL_SET"
-____exports.SerializationBrand.BIT_SET_128 = "__BIT_SET_128"
-____exports.SerializationBrand.COLOR = "__COLOR"
-____exports.SerializationBrand.K_COLOR = "__K_COLOR"
-____exports.SerializationBrand.RNG = "__RNG"
-____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.string"] = function(...) 
@@ -17539,6 +17204,81 @@ 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(...) 
@@ -20126,16 +19866,10 @@ local __TS__Class = ____lualib.__TS__Class
 local __TS__ClassExtends = ____lualib.__TS__ClassExtends
 local __TS__ArrayFindIndex = ____lualib.__TS__ArrayFindIndex
 local __TS__ArraySplice = ____lualib.__TS__ArraySplice
-local __TS__ArrayEntries = ____lualib.__TS__ArrayEntries
-local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local ____log = require("functions.log")
-local log = ____log.log
 local ____sort = require("functions.sort")
 local sortObjectArrayByKey = ____sort.sortObjectArrayByKey
 local stableSort = ____sort.stableSort
-local ____tstlClass = require("functions.tstlClass")
-local getTSTLClassName = ____tstlClass.getTSTLClassName
 local ____Feature = require("classes.private.Feature")
 local Feature = ____Feature.Feature
 --- The base class for a custom callback. Individual custom callbacks (and validation callbacks) will
@@ -20195,19 +19929,6 @@ function CustomCallback.prototype.removeSubscriber(self, callback)
         __TS__ArraySplice(self.subscriptions, subscriptionIndexMatchingCallback, 1)
     end
 end
-function CustomCallback.prototype.logSubscriptions(self)
-    local tstlClassName = getTSTLClassName(nil, self)
-    log("Logging subscriptions for custom callback: " .. tostring(tstlClassName))
-    if #self.subscriptions == 0 then
-        log("- n/a (no subscriptions)")
-    else
-        for ____, ____value in __TS__Iterator(__TS__ArrayEntries(self.subscriptions)) do
-            local i = ____value[1]
-            local subscription = ____value[2]
-            log((("- " .. tostring(i + 1)) .. " - priority: ") .. tostring(subscription.priority))
-        end
-    end
-end
 return ____exports
  end,
 ["classes.callbacks.EntityTakeDmgFilter"] = function(...) 
@@ -20806,6 +20527,178 @@ function ____exports.onRoomFrame(self, roomFrameCount)
     local thisGameFrameCount = room:GetFrameCount()
     return thisGameFrameCount == roomFrameCount
 end
+return ____exports
+ end,
+["classes.DefaultMap"] = function(...) 
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local Map = ____lualib.Map
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local __TS__TypeOf = ____lualib.__TS__TypeOf
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____types = require("functions.types")
+local isFunction = ____types.isFunction
+local isPrimitive = ____types.isPrimitive
+--- `DefaultMap` is a data structure that makes working with default values easier. It extends a
+-- `Map` and adds additional methods.
+-- 
+-- It is a common pattern to look up a value in a `Map`, and then, if the value does not exist, set
+-- a default value for the key, and then return the default value. `DefaultMap` abstracts this
+-- operation away by providing the `getAndSetDefault` method.
+-- 
+-- Using a `DefaultMap` is nice because it makes code more declarative, since you specify what the
+-- default value is alongside the types of the keys/values.
+-- 
+-- When instantiating a new `DefaultMap`, you must specify default value as the first argument. (The
+-- default value is the initial value that will be assigned to every new entry in the
+-- `getAndSetDefault` method.) For example:
+-- 
+-- ```ts
+-- // Initializes a new empty DefaultMap with a default value of "foo".
+-- const defaultMapWithString = new DefaultMap<string, string>("foo");
+-- 
+-- const value = defaultMapWithString.getAndSetDefault("bar");
+-- // value is now "foo" and an entry for "bar" is now set.
+-- ```
+-- 
+-- Sometimes, instead of having a static initial value for every entry in the map, you will want a
+-- dynamic initial value that is contingent upon the key or some other variable. In these cases, you
+-- can instead specify that the `DefaultMap` should run a function that will return the initial
+-- value. (This is referred to as a "factory function".) For example:
+-- 
+-- ```ts
+-- // Initializes a new empty DefaultMap with a default value based on "someGlobalVariable".
+-- const factoryFunction = () => someGlobalVariable ? 0 : 1;
+-- const defaultMapWithFactoryFunction = new DefaultMap<string, string>(factoryFunction);
+-- ```
+-- 
+-- Note that in TypeScript and Lua, booleans, numbers, and strings are "passed by value". This means
+-- that when the `DefaultMap` creates a new entry, if the default value is one of these 3 types, the
+-- values will be copied. On the other hand, arrays and maps and other complex data structures are
+-- "passed by reference". This means that when the `DefaultMap` creates a new entry, if the default
+-- value is an array, then it would not be copied. Instead, the same shared array would be assigned
+-- to every entry. Thus, to solve this problem, any variable that is passed by reference must be
+-- created using a factory function to ensure that each copy is unique. For example:
+-- 
+-- ```ts
+-- // Initializes a new empty DefaultMap with a default value of a new empty array.
+-- const factoryFunction = () => [];
+-- const defaultMapWithArray = new DefaultMap<string, string[]>(factoryFunction);
+-- ```
+-- 
+-- In the previous two examples, the factory functions did not have any arguments. But you can also
+-- specify a factory function that takes one or more arguments:
+-- 
+-- ```ts
+-- const factoryFunction = (arg: boolean) => arg ? 0 : 1;
+-- const defaultMapWithArg = new DefaultMap<string, string, [arg: boolean]>(factoryFunction);
+-- ```
+-- 
+-- Similar to a normal `Map`, you can also include an initializer list in the constructor as the
+-- second argument:
+-- 
+-- ```ts
+-- // Initializes a DefaultMap with a default value of "foo" and some initial values.
+-- const defaultMapWithInitialValues = new DefaultMap<string, string>("foo", [
+--   ["a1", "a2"],
+--   ["b1", "b2"],
+-- ], );
+-- ```
+-- 
+-- Finally, note that `DefaultMap` has the following additional utility methods:
+-- 
+-- - `getAndSetDefault` - The method that is called inside the overridden `get` method. In most
+--   cases, you can use the overridden `get` method instead of calling this function directly.
+--   However, if a factory function was provided during instantiation, and the factory function has
+--   one or more arguments, then you must call this method instead (and provide the corresponding
+--   arguments).
+-- - `getDefaultValue` - Returns the default value to be used for a new key. (If a factory function
+--   was provided during instantiation, this will execute the factory function.)
+-- - `getConstructorArg` - Helper method for cloning the map. Returns either the default value or
+--   the reference to the factory function.
+____exports.DefaultMap = __TS__Class()
+local DefaultMap = ____exports.DefaultMap
+DefaultMap.name = "DefaultMap"
+__TS__ClassExtends(DefaultMap, Map)
+function DefaultMap.prototype.____constructor(self, defaultValueOrFactoryFunction, initializerArray)
+    local argIsPrimitive = isPrimitive(nil, defaultValueOrFactoryFunction)
+    local argIsFunction = isFunction(nil, defaultValueOrFactoryFunction)
+    if not argIsPrimitive and not argIsFunction then
+        error(("Failed to instantiate a DefaultMap since the provided default value was of type \"" .. __TS__TypeOf(defaultValueOrFactoryFunction)) .. "\". This error usually means that you are trying to use an array (or some other non-primitive data structure that is passed by reference) as the default value. Instead, return the data structure in a factory function, like \"() => []\". See the DefaultMap documentation for more details.")
+    end
+    Map.prototype.____constructor(self, initializerArray)
+    if argIsFunction then
+        self.defaultValue = nil
+        self.defaultValueFactory = defaultValueOrFactoryFunction
+    else
+        self.defaultValue = defaultValueOrFactoryFunction
+        self.defaultValueFactory = nil
+    end
+end
+function DefaultMap.prototype.getAndSetDefault(self, key, ...)
+    local value = Map.prototype.get(self, key)
+    if value ~= nil then
+        return value
+    end
+    local defaultValue = self:getDefaultValue(...)
+    self:set(key, defaultValue)
+    return defaultValue
+end
+function DefaultMap.prototype.getDefaultValue(self, ...)
+    if self.defaultValue ~= nil then
+        return self.defaultValue
+    end
+    if self.defaultValueFactory ~= nil then
+        return self:defaultValueFactory(...)
+    end
+    error("A DefaultMap was incorrectly instantiated.")
+end
+function DefaultMap.prototype.getConstructorArg(self)
+    if self.defaultValue ~= nil then
+        return self.defaultValue
+    end
+    if self.defaultValueFactory ~= nil then
+        return self.defaultValueFactory
+    end
+    error("A DefaultMap was incorrectly instantiated.")
+end
+local function test(self)
+    local myDefaultMapBoolean = __TS__New(____exports.DefaultMap, false)
+    local myDefaultMapBooleanFactory = __TS__New(
+        ____exports.DefaultMap,
+        function() return false end
+    )
+    local myDefaultMapBooleanWithoutParams = __TS__New(____exports.DefaultMap, false)
+    local myDefaultMapNumber = __TS__New(____exports.DefaultMap, 123)
+    local myDefaultMapNumberFactory = __TS__New(
+        ____exports.DefaultMap,
+        function() return 123 end
+    )
+    local myDefaultMapNumberWithoutParams = __TS__New(____exports.DefaultMap, 123)
+    local myDefaultMapString = __TS__New(____exports.DefaultMap, "foo")
+    local myDefaultMapStringFactory = __TS__New(
+        ____exports.DefaultMap,
+        function() return "foo" end
+    )
+    local myDefaultMapStringWithoutParams = __TS__New(____exports.DefaultMap, "foo")
+    local myDefaultMapArray = __TS__New(
+        ____exports.DefaultMap,
+        function() return {} end
+    )
+    local myDefaultMapArrayWithoutParams = __TS__New(
+        ____exports.DefaultMap,
+        function() return {} end
+    )
+    local myDefaultMapMap = __TS__New(
+        ____exports.DefaultMap,
+        function() return __TS__New(Map) end
+    )
+    local myDefaultMapMapWithoutParams = __TS__New(
+        ____exports.DefaultMap,
+        function() return __TS__New(Map) end
+    )
+end
 return ____exports
  end,
 ["functions.playerDataStructures"] = function(...) 
@@ -21448,6 +21341,7 @@ local __TS__ArrayAt = ____lualib.__TS__ArrayAt
 local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
+local isTaintedModded
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.index")
 local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
@@ -21489,6 +21383,12 @@ function ____exports.isVanillaPlayer(self, player)
     local character = player:GetPlayerType()
     return isVanillaCharacter(nil, character)
 end
+function isTaintedModded(self, player)
+    local character = player:GetPlayerType()
+    local name = player:GetName()
+    local taintedCharacter = Isaac.GetPlayerTypeByName(name, true)
+    return character == taintedCharacter
+end
 --- Helper function to check to see if any player is holding up an item (from e.g. an active item
 -- activation, a poop from IBS, etc.).
 function ____exports.anyPlayerHoldingItem(self)
@@ -21761,13 +21661,6 @@ function ____exports.isDamageFromPlayer(self, damageSource)
     local indirectPlayer = ____exports.getPlayerFromEntity(nil, damageSource)
     return indirectPlayer ~= nil
 end
---- Not exported since end-users should use the `isTainted` helper function directly.
-local function isTaintedModded(self, player)
-    local character = player:GetPlayerType()
-    local name = player:GetName()
-    local taintedCharacter = Isaac.GetPlayerTypeByName(name, true)
-    return character == taintedCharacter
-end
 --- Helper function for detecting when a player is Eden or Tainted Eden. Useful for situations where
 -- you want to know if the starting stats were randomized, for example.
 function ____exports.isEden(self, player)
@@ -22559,6 +22452,94 @@ function ____exports.setToBitFlags(self, set)
     end
     return flags
 end
+return ____exports
+ end,
+["interfaces.TSTLClassMetatable"] = function(...) 
+local ____exports = {}
+return ____exports
+ end,
+["types.TSTLClass"] = function(...) 
+local ____exports = {}
+return ____exports
+ end,
+["functions.tstlClass"] = function(...) 
+local ____exports = {}
+local ____types = require("functions.types")
+local isTable = ____types.isTable
+local ____utils = require("functions.utils")
+local assertDefined = ____utils.assertDefined
+--- Helper function to get the constructor from an instantiated TypeScriptToLua class, which is
+-- located on the metatable.
+-- 
+-- Returns undefined if passed a non-table or if the provided table does not have a metatable.
+function ____exports.getTSTLClassConstructor(self, object)
+    if not isTable(nil, object) then
+        return nil
+    end
+    local metatable = getmetatable(object)
+    if metatable == nil then
+        return nil
+    end
+    return metatable.constructor
+end
+--- Helper function to get the name of a TypeScriptToLua class from the instantiated class object.
+-- 
+-- TSTL classes are Lua tables created with the `__TS__Class` Lua function from the TSTL lualib.
+-- Their name is contained within "constructor.name" metatable key.
+-- 
+-- For example, a `Map` class is has a name of "Map".
+-- 
+-- Returns undefined if passed a non-table or if the provided table does not have a metatable.
+function ____exports.getTSTLClassName(self, object)
+    local constructor = ____exports.getTSTLClassConstructor(nil, object)
+    if constructor == nil then
+        return nil
+    end
+    return constructor.name
+end
+--- Helper function to determine if a given object is a TypeScriptToLua `Map`.
+-- 
+-- It is not reliable to use the `instanceof` operator to determine this because each Lua module has
+-- their own copies of the entire lualib and thus their own instantiated version of a `Map`.
+function ____exports.isDefaultMap(self, object)
+    local className = ____exports.getTSTLClassName(nil, object)
+    return className == "DefaultMap"
+end
+--- Helper function to check if a given table is a class table created by TypeScriptToLua.
+function ____exports.isTSTLClass(self, object)
+    local tstlClassName = ____exports.getTSTLClassName(nil, object)
+    return tstlClassName ~= nil
+end
+--- Helper function to determine if a given object is a TypeScriptToLua `Map`.
+-- 
+-- It is not reliable to use the `instanceof` operator to determine this because each Lua module
+-- might have their own copy of the entire lualib and thus their own instantiated version of a
+-- `Map`.
+function ____exports.isTSTLMap(self, object)
+    local className = ____exports.getTSTLClassName(nil, object)
+    return className == "Map"
+end
+--- Helper function to determine if a given object is a TypeScriptToLua `Set`.
+-- 
+-- It is not reliable to use the `instanceof` operator to determine this because each Lua module
+-- might have their own copy of the entire lualib and thus their own instantiated version of a
+-- `Set`.
+function ____exports.isTSTLSet(self, object)
+    local className = ____exports.getTSTLClassName(nil, object)
+    return className == "Set"
+end
+--- Initializes a new TypeScriptToLua class in the situation where you do not know what kind of class
+-- it is. This function requires that you provide an instantiated class of the same type, as it will
+-- use the class constructor that is present on the other object's metatable to initialize the new
+-- class.
+function ____exports.newTSTLClass(self, oldClass)
+    local constructor = ____exports.getTSTLClassConstructor(nil, oldClass)
+    assertDefined(nil, constructor, "Failed to instantiate a new TypeScriptToLua class since the provided old class does not have a metatable/constructor.")
+    local newClass = {}
+    local newClassMetatable = setmetatable(newClass, constructor.prototype)
+    newClassMetatable:____constructor()
+    return newClass
+end
 return ____exports
  end,
 ["functions.doors"] = function(...) 
@@ -47196,7 +47177,7 @@ local ____ModCallbackCustom = require("enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____Feature = require("classes.private.Feature")
 local Feature = ____Feature.Feature
-local v = {room = {roomClearGameFrame = nil, roomClearRoomFrame = nil}}
+local v = {room = {roomClearGameFrame = nil, roomClearRenderFrame = nil, roomClearRoomFrame = nil}}
 ____exports.RoomClearFrame = __TS__Class()
 local RoomClearFrame = ____exports.RoomClearFrame
 RoomClearFrame.name = "RoomClearFrame"
@@ -47208,7 +47189,9 @@ function RoomClearFrame.prototype.____constructor(self)
         local gameFrameCount = game:GetFrameCount()
         local room = game:GetRoom()
         local roomFrameCount = room:GetFrameCount()
+        local renderFrameCount = Isaac.GetFrameCount()
         v.room.roomClearGameFrame = gameFrameCount
+        v.room.roomClearRenderFrame = renderFrameCount
         v.room.roomClearRoomFrame = roomFrameCount
     end
     self.customCallbacksUsed = {{ModCallbackCustom.POST_ROOM_CLEAR_CHANGED, self.postRoomClearChangedTrue}}
@@ -47217,8 +47200,12 @@ function RoomClearFrame.prototype.getRoomClearGameFrame(self)
     return v.room.roomClearGameFrame
 end
 __TS__DecorateLegacy({Exported}, RoomClearFrame.prototype, "getRoomClearGameFrame", true)
+function RoomClearFrame.prototype.getRoomClearRenderFrame(self)
+    return v.room.roomClearRenderFrame
+end
+__TS__DecorateLegacy({Exported}, RoomClearFrame.prototype, "getRoomClearRenderFrame", true)
 function RoomClearFrame.prototype.getRoomClearRoomFrame(self)
-    return v.room.roomClearGameFrame
+    return v.room.roomClearRoomFrame
 end
 __TS__DecorateLegacy({Exported}, RoomClearFrame.prototype, "getRoomClearRoomFrame", true)
 return ____exports