isaacscript-common 3.0.0 → 3.2.0

package/functions/playerHealth.lua

@@ -1,4 +1,5 @@
 local ____lualib = require("lualib_bundle")
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
@@ -16,6 +17,79 @@ local isCharacter = ____player.isCharacter
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 local ____repeat = ____utils["repeat"]
+function ____exports.removeAllPlayerHealth(self, player)
+    local goldenHearts = player:GetGoldenHearts()
+    local eternalHearts = player:GetEternalHearts()
+    local boneHearts = player:GetBoneHearts()
+    local brokenHearts = player:GetBrokenHearts()
+    player:AddGoldenHearts(goldenHearts * -1)
+    player:AddEternalHearts(eternalHearts * -1)
+    player:AddBoneHearts(boneHearts * -1)
+    player:AddBrokenHearts(brokenHearts * -1)
+    player:AddMaxHearts(MAX_PLAYER_HEART_CONTAINERS * -2, true)
+    player:AddSoulHearts(MAX_PLAYER_HEART_CONTAINERS * -2)
+    if isCharacter(nil, player, PlayerType.THE_SOUL) then
+        local forgotten = player:GetSubPlayer()
+        if forgotten ~= nil then
+            local forgottenBoneHearts = forgotten:GetBoneHearts()
+            forgotten:AddBoneHearts(forgottenBoneHearts * -1)
+        end
+    end
+end
+--- Helper function to set a player's health to a specific state. You can use this in combination
+-- with the `getPlayerHealth` function to restore the player's health back to a certain
+-- configuration at a later time.
+-- 
+-- Based on the `REVEL.LoadHealth` function in the Revelations mod.
+function ____exports.setPlayerHealth(self, player, playerHealth)
+    local character = player:GetPlayerType()
+    local subPlayer = player:GetSubPlayer()
+    ____exports.removeAllPlayerHealth(nil, player)
+    if character == PlayerType.THE_SOUL and subPlayer ~= nil then
+        subPlayer:AddMaxHearts(playerHealth.maxHearts, false)
+    else
+        player:AddMaxHearts(playerHealth.maxHearts, false)
+    end
+    player:AddEternalHearts(playerHealth.eternalHearts)
+    local soulHeartsRemaining = playerHealth.soulHearts
+    __TS__ArrayForEach(
+        playerHealth.soulHeartTypes,
+        function(____, heartType, i)
+            local isHalf = playerHealth.soulHearts + playerHealth.boneHearts * 2 < (i + 1) * 2
+            local addAmount = 2
+            if isHalf or heartType == HeartSubType.BONE or soulHeartsRemaining < 2 then
+                addAmount = 1
+            end
+            if heartType == HeartSubType.SOUL then
+                player:AddSoulHearts(addAmount)
+                soulHeartsRemaining = soulHeartsRemaining - addAmount
+            elseif heartType == HeartSubType.BLACK then
+                player:AddBlackHearts(addAmount)
+                soulHeartsRemaining = soulHeartsRemaining - addAmount
+            elseif heartType == HeartSubType.BONE then
+                player:AddBoneHearts(addAmount)
+            end
+        end
+    )
+    player:AddRottenHearts(playerHealth.rottenHearts)
+    ____repeat(
+        nil,
+        playerHealth.hearts,
+        function()
+            player:AddHearts(1)
+            if character == PlayerType.MAGDALENE_B then
+                player:AddHearts(-1)
+            end
+        end
+    )
+    player:AddGoldenHearts(playerHealth.goldenHearts)
+    player:AddBrokenHearts(playerHealth.brokenHearts)
+    if character == PlayerType.BETHANY then
+        player:SetSoulCharge(playerHealth.soulCharges)
+    elseif character == PlayerType.BETHANY_B then
+        player:SetBloodCharge(playerHealth.bloodCharges)
+    end
+end
 function ____exports.addPlayerHealthType(self, player, healthType, numHearts)
     repeat
         local ____switch3 = healthType
@@ -220,77 +294,22 @@ function ____exports.getPlayerHealthType(self, player, healthType)
         end
     until true
 end
-function ____exports.removeAllPlayerHealth(self, player)
-    local goldenHearts = player:GetGoldenHearts()
-    local eternalHearts = player:GetEternalHearts()
-    local boneHearts = player:GetBoneHearts()
-    local brokenHearts = player:GetBrokenHearts()
-    player:AddGoldenHearts(goldenHearts * -1)
-    player:AddEternalHearts(eternalHearts * -1)
-    player:AddBoneHearts(boneHearts * -1)
-    player:AddBrokenHearts(brokenHearts * -1)
-    player:AddMaxHearts(MAX_PLAYER_HEART_CONTAINERS * -2, true)
-    player:AddSoulHearts(MAX_PLAYER_HEART_CONTAINERS * -2)
-    if isCharacter(nil, player, PlayerType.THE_SOUL) then
-        local forgotten = player:GetSubPlayer()
-        if forgotten ~= nil then
-            local forgottenBoneHearts = forgotten:GetBoneHearts()
-            forgotten:AddBoneHearts(forgottenBoneHearts * -1)
-        end
-    end
-end
---- Helper function to set a player's health to a specific state. You can use this in combination
--- with the `getPlayerHealth` function to restore the player's health back to a certain
--- configuration at a later time.
--- 
--- Based on the `REVEL.LoadHealth` function in the Revelations mod.
-function ____exports.setPlayerHealth(self, player, playerHealth)
-    local character = player:GetPlayerType()
-    local subPlayer = player:GetSubPlayer()
+function ____exports.playerConvertBlackHeartsToSoulHearts(self, player)
+    local playerHealth = ____exports.getPlayerHealth(nil, player)
     ____exports.removeAllPlayerHealth(nil, player)
-    if character == PlayerType.THE_SOUL and subPlayer ~= nil then
-        subPlayer:AddMaxHearts(playerHealth.maxHearts, false)
-    else
-        player:AddMaxHearts(playerHealth.maxHearts, false)
-    end
-    player:AddEternalHearts(playerHealth.eternalHearts)
-    local soulHeartsRemaining = playerHealth.soulHearts
-    __TS__ArrayForEach(
+    playerHealth.soulHeartTypes = __TS__ArrayMap(
         playerHealth.soulHeartTypes,
-        function(____, heartType, i)
-            local isHalf = playerHealth.soulHearts + playerHealth.boneHearts * 2 < (i + 1) * 2
-            local addAmount = 2
-            if isHalf or heartType == HeartSubType.BONE or soulHeartsRemaining < 2 then
-                addAmount = 1
-            end
-            if heartType == HeartSubType.SOUL then
-                player:AddSoulHearts(addAmount)
-                soulHeartsRemaining = soulHeartsRemaining - addAmount
-            elseif heartType == HeartSubType.BLACK then
-                player:AddBlackHearts(addAmount)
-                soulHeartsRemaining = soulHeartsRemaining - addAmount
-            elseif heartType == HeartSubType.BONE then
-                player:AddBoneHearts(addAmount)
-            end
-        end
+        function(____, soulHeartType) return soulHeartType == HeartSubType.BLACK and HeartSubType.SOUL or soulHeartType end
     )
-    player:AddRottenHearts(playerHealth.rottenHearts)
-    ____repeat(
-        nil,
-        playerHealth.hearts,
-        function()
-            player:AddHearts(1)
-            if character == PlayerType.MAGDALENE_B then
-                player:AddHearts(-1)
-            end
-        end
+    ____exports.setPlayerHealth(nil, player, playerHealth)
+end
+function ____exports.playerConvertSoulHeartsToBlackHearts(self, player)
+    local playerHealth = ____exports.getPlayerHealth(nil, player)
+    ____exports.removeAllPlayerHealth(nil, player)
+    playerHealth.soulHeartTypes = __TS__ArrayMap(
+        playerHealth.soulHeartTypes,
+        function(____, soulHeartType) return soulHeartType == HeartSubType.SOUL and HeartSubType.BLACK or soulHeartType end
     )
-    player:AddGoldenHearts(playerHealth.goldenHearts)
-    player:AddBrokenHearts(playerHealth.brokenHearts)
-    if character == PlayerType.BETHANY then
-        player:SetSoulCharge(playerHealth.soulCharges)
-    elseif character == PlayerType.BETHANY_B then
-        player:SetBloodCharge(playerHealth.bloodCharges)
-    end
+    ____exports.setPlayerHealth(nil, player, playerHealth)
 end
 return ____exports

package/functions/playerIndex.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 import { PlayerIndex } from "../types/PlayerIndex";
 /**
  * Helper function to get every player with no restrictions, by using `Game.GetNumPlayers` and

package/functions/positionVelocity.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 export declare function anyEntityCloserThan(entities: Entity[], position: Vector, distance: int): boolean;
 /** Iterates over all players and checks if any player is close enough to the specified position. */
 export declare function anyPlayerCloserThan(position: Vector, distance: float): boolean;

package/functions/random.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * This returns a random float between 0 and 1. It is inclusive on the low end, but exclusive on the
  * high end. (This is because the `RNG.RandomFloat` method will never return a value of exactly 1.)

package/functions/revive.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * Uses the player's current health and other miscellaneous things to determine if incoming damage
  * will be fatal.

package/functions/rng.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedRNG = LuaTable<string, unknown> & {

package/functions/saveFile.d.ts

@@ -0,0 +1,15 @@
+import { CollectibleType, ItemPoolType } from "isaac-typescript-definitions";
+/**
+ * Helper function to see if the given collectible is unlocked on the player's save file. This
+ * requires providing the corresponding item pool that the collectible is located in.
+ *
+ * - If any player currently has the item, then it is assumed to be unlocked. (This is because Eden
+ *   may have randomly started with the provided collectible, and it will be subsequently removed
+ *   from all pools.)
+ * - If the collectible is located in more than one item pool, then any item pool can be provided.
+ * - If the collectible is not located in any item pools, then this function will always return
+ *   false.
+ * - If any player is Tainted Lost, they will be temporarily changed to Isaac and then temporarily
+ *   changed back (because Tainted Lost is not able to retrieve some collectibles from item pools).
+ */
+export declare function isCollectibleUnlocked(collectibleTypeToCheckFor: CollectibleType, itemPoolToCheckFor: ItemPoolType): boolean;

package/functions/saveFile.lua

@@ -0,0 +1,106 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local Set = ____lualib.Set
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____collectibleSet = require("functions.collectibleSet")
+local getCollectibleSet = ____collectibleSet.getCollectibleSet
+local ____player = require("functions.player")
+local anyPlayerHasCollectible = ____player.anyPlayerHasCollectible
+local getPlayersOfType = ____player.getPlayersOfType
+local ____playerDataStructures = require("functions.playerDataStructures")
+local mapGetPlayer = ____playerDataStructures.mapGetPlayer
+local mapSetPlayer = ____playerDataStructures.mapSetPlayer
+local ____playerIndex = require("functions.playerIndex")
+local getPlayers = ____playerIndex.getPlayers
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
+local COLLECTIBLES_THAT_AFFECT_ITEM_POOLS = {CollectibleType.CHAOS, CollectibleType.SACRED_ORB, CollectibleType.TMTRAINER}
+local TRINKETS_THAT_AFFECT_ITEM_POOLS = {TrinketType.NO}
+--- Helper function to see if the given collectible is unlocked on the player's save file. This
+-- requires providing the corresponding item pool that the collectible is located in.
+-- 
+-- - If any player currently has the item, then it is assumed to be unlocked. (This is because Eden
+--   may have randomly started with the provided collectible, and it will be subsequently removed
+--   from all pools.)
+-- - If the collectible is located in more than one item pool, then any item pool can be provided.
+-- - If the collectible is not located in any item pools, then this function will always return
+--   false.
+-- - If any player is Tainted Lost, they will be temporarily changed to Isaac and then temporarily
+--   changed back (because Tainted Lost is not able to retrieve some collectibles from item pools).
+function ____exports.isCollectibleUnlocked(self, collectibleTypeToCheckFor, itemPoolToCheckFor)
+    if anyPlayerHasCollectible(nil, collectibleTypeToCheckFor) then
+        return true
+    end
+    local taintedLosts = getPlayersOfType(nil, PlayerType.THE_LOST_B)
+    for ____, player in ipairs(taintedLosts) do
+        player:ChangePlayerType(PlayerType.ISAAC)
+    end
+    local removedItemsMap = __TS__New(Map)
+    local removedTrinketsMap = __TS__New(Map)
+    for ____, player in ipairs(getPlayers(nil)) do
+        local removedItems = {}
+        for ____, itemToRemove in ipairs(COLLECTIBLES_THAT_AFFECT_ITEM_POOLS) do
+            if player:HasCollectible(itemToRemove) then
+                local numCollectibles = player:GetCollectibleNum(itemToRemove)
+                ____repeat(
+                    nil,
+                    numCollectibles,
+                    function()
+                        player:RemoveCollectible(itemToRemove)
+                        removedItems[#removedItems + 1] = itemToRemove
+                    end
+                )
+            end
+        end
+        mapSetPlayer(nil, removedItemsMap, player, removedItems)
+        local removedTrinkets = {}
+        for ____, trinketToRemove in ipairs(TRINKETS_THAT_AFFECT_ITEM_POOLS) do
+            if player:HasTrinket(trinketToRemove) then
+                local numTrinkets = player:GetTrinketMultiplier(trinketToRemove)
+                ____repeat(
+                    nil,
+                    numTrinkets,
+                    function()
+                        player:TryRemoveTrinket(trinketToRemove)
+                        removedTrinkets[#removedTrinkets + 1] = trinketToRemove
+                    end
+                )
+            end
+        end
+        mapSetPlayer(nil, removedTrinketsMap, player, removedTrinkets)
+    end
+    local itemPool = game:GetItemPool()
+    local collectibleSet = getCollectibleSet(nil)
+    for ____, collectibleType in __TS__Iterator(collectibleSet:values()) do
+        if collectibleType ~= collectibleTypeToCheckFor then
+            itemPool:AddRoomBlacklist(collectibleType)
+        end
+    end
+    local retrievedCollectibleType = itemPool:GetCollectible(itemPoolToCheckFor, false, 1)
+    local collectibleUnlocked = retrievedCollectibleType == collectibleTypeToCheckFor
+    itemPool:ResetRoomBlacklist()
+    for ____, player in ipairs(getPlayers(nil)) do
+        local removedItems = mapGetPlayer(nil, removedItemsMap, player)
+        if removedItems ~= nil then
+            for ____, collectibleType in ipairs(removedItems) do
+                player:AddCollectible(collectibleType, 0, false)
+            end
+        end
+        local removedTrinkets = mapGetPlayer(nil, removedTrinketsMap, player)
+        if removedTrinkets ~= nil then
+            for ____, trinketType in ipairs(removedTrinkets) do
+                player:AddTrinket(trinketType, false)
+            end
+        end
+    end
+    return collectibleUnlocked
+end
+return ____exports

package/functions/serialization.lua

@@ -13,7 +13,7 @@ local ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION = ____isaacAPIClassTypeToCopyFunctio
 local ____serializedIsaacAPIClassTypeToIdentityFunction = require("objects.serializedIsaacAPIClassTypeToIdentityFunction")
 local SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION = ____serializedIsaacAPIClassTypeToIdentityFunction.SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION
 local ____isaacAPIClass = require("functions.isaacAPIClass")
-local getIsaacAPIClassType = ____isaacAPIClass.getIsaacAPIClassType
+local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 function getSerializedTableType(self, serializedIsaacAPIClass)
     for ____, ____value in ipairs(__TS__ObjectEntries(ISAAC_API_CLASS_TYPE_TO_BRAND)) do
         local copyableIsaacAPIClassType = ____value[1]
@@ -29,7 +29,7 @@ function ____exports.copyIsaacAPIClass(self, isaacAPIClass, serializationType)
     if objectType ~= "userdata" then
         error("Failed to copy an Isaac API class since the provided object was of type: " .. objectType)
     end
-    local isaacAPIClassType = getIsaacAPIClassType(nil, isaacAPIClass)
+    local isaacAPIClassType = getIsaacAPIClassName(nil, isaacAPIClass)
     if isaacAPIClassType == nil then
         error("Failed to copy an Isaac API class since it does not have a class type.")
     end

package/functions/set.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to add all of the values in one set to another set. The first set passed will be
  * modified in place.

package/functions/sprite.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to clear a specific layer from a sprite.
  *

package/functions/table.d.ts

@@ -27,6 +27,18 @@ export declare function getNumbersFromTable(table: LuaTable<string, unknown>, ob
  * This function is variadic, meaning that you can specify N arguments to get N values.
  */
 export declare function getStringsFromTable(table: LuaTable<string, unknown>, objectName: string, ...keys: string[]): string[];
+/**
+ * Helper function to iterate over a table deterministically. This is useful because by default, the
+ * `pairs` function will return the keys of a Lua table in a random order.
+ *
+ * This function will sort the table entries based on the value of the key.
+ *
+ * @param table The table to iterate over.
+ * @param func The function to run for each iteration.
+ * @param deterministic Optional. Whether to iterate deterministically. True by default. You can
+ *                      dynamically set to false in situations where you need extra performance.
+ */
+export declare function iterateTableDeterministically<K, V>(table: LuaTable<K, V>, func: (key: K, value: V) => void, deterministic?: boolean): void;
 /**
  * Helper function to check if a Lua table has all of the provided keys.
  *

package/functions/table.lua

@@ -1,7 +1,10 @@
 local ____lualib = require("lualib_bundle")
 local __TS__TypeOf = ____lualib.__TS__TypeOf
+local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
+local ____utils = require("functions.utils")
+local twoDimensionalSort = ____utils.twoDimensionalSort
 --- In a Map, you can use the `clear` method to delete every element. However, in a LuaTable, the
 -- `clear` method does not exist. Use this helper function as a drop-in replacement for this.
 function ____exports.clearTable(self, ____table)
@@ -84,6 +87,37 @@ function ____exports.getStringsFromTable(self, ____table, objectName, ...)
     end
     return strings
 end
+--- Helper function to iterate over a table deterministically. This is useful because by default, the
+-- `pairs` function will return the keys of a Lua table in a random order.
+-- 
+-- This function will sort the table entries based on the value of the key.
+-- 
+-- @param table The table to iterate over.
+-- @param func The function to run for each iteration.
+-- @param deterministic Optional. Whether to iterate deterministically. True by default. You can
+-- dynamically set to false in situations where you need extra performance.
+function ____exports.iterateTableDeterministically(self, ____table, func, deterministic)
+    if deterministic == nil then
+        deterministic = true
+    end
+    if not deterministic then
+        for key, value in pairs(____table) do
+            func(nil, key, value)
+        end
+        return
+    end
+    local entriesArray = {}
+    for key, value in pairs(____table) do
+        local entry = {key, value}
+        entriesArray[#entriesArray + 1] = entry
+    end
+    __TS__ArraySort(entriesArray, twoDimensionalSort)
+    for ____, ____value in ipairs(entriesArray) do
+        local key = ____value[1]
+        local value = ____value[2]
+        func(nil, key, value)
+    end
+end
 --- Helper function to check if a Lua table has all of the provided keys.
 -- 
 -- This function is variadic, meaning that you can specify as many arguments as you want to check

package/functions/tears.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * - Converts the specified amount of tears stat into MaxFireDelay and adds it to the player.
  * - This function should only be used inside the EvaluateCache callback.

package/functions/tstlClass.d.ts

@@ -1,9 +1,43 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+import { DefaultMap } from "../classes/DefaultMap";
 import { TSTLClass } from "../types/private/TSTLClass";
+/**
+ * Helper function to get the name of a TypeScriptToLua class. 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 the object is not a table or if the aforementioned metatable key does not
+ * exist.
+ */
+export declare function getTSTLClassName(object: unknown): string | undefined;
+/**
+ * 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`.
+ */
+export declare function isDefaultMap(object: unknown): object is DefaultMap<AnyNotNil, unknown>;
 /**
  * Returns whether or not this is a class that is provided by the `isaacscript-common` library, such
  * as a `DefaultMap`.
  */
 export declare function isIsaacScriptCommonClass(object: unknown): boolean;
+/**
+ * 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`.
+ */
+export declare function isTSTLMap(object: unknown): object is Map<AnyNotNil, unknown>;
+/**
+ * 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 has
+ * their own copies of the entire lualib and thus their own instantiated version of a `Set`.
+ */
+export declare function isTSTLSet(object: unknown): object is Set<AnyNotNil>;
 /** TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys. */
 export declare function isUserDefinedTSTLClass(object: unknown): object is TSTLClass;
 /**

package/functions/tstlClass.lua

@@ -1,18 +1,38 @@
 local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
-local __TS__InstanceOf = ____lualib.__TS__InstanceOf
-local Map = ____lualib.Map
-local WeakMap = ____lualib.WeakMap
-local WeakSet = ____lualib.WeakSet
 local ____exports = {}
-local newTSTLClassFromMetatable
-local ____DefaultMap = require("classes.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
+local newTSTLClassFromMetatable, VANILLA_TSTL_CLASSES
+--- Helper function to get the name of a TypeScriptToLua class. 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 the object is not a table or if the aforementioned metatable key does not
+-- exist.
+function ____exports.getTSTLClassName(self, object)
+    if type(object) ~= "table" then
+        return nil
+    end
+    local metatable = getmetatable(object)
+    if metatable == nil then
+        return nil
+    end
+    local constructor = metatable.constructor
+    if constructor == nil then
+        return nil
+    end
+    return constructor.name
+end
 --- Returns whether or not this is a class that is provided as part of the TypeScriptToLua
 -- transpiler, such as a `Map` or a `Set`.
 function ____exports.isVanillaTSTLClass(self, object)
-    return __TS__InstanceOf(object, Map) or __TS__InstanceOf(object, Set) or __TS__InstanceOf(object, WeakMap) or __TS__InstanceOf(object, WeakSet)
+    local className = ____exports.getTSTLClassName(nil, object)
+    if className == nil then
+        return false
+    end
+    return VANILLA_TSTL_CLASSES:has(className)
 end
 function newTSTLClassFromMetatable(self, metatable)
     local newClass = {}
@@ -20,11 +40,36 @@ function newTSTLClassFromMetatable(self, metatable)
     newClassMetatable:____constructor()
     return newClass
 end
+VANILLA_TSTL_CLASSES = __TS__New(Set, {"Map", "Set", "WeakMap", "WeakSet"})
 local TSTL_CLASS_METATABLE_KEYS = __TS__New(Set, {"____constructor", "__index", "constructor"})
+--- 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
 --- Returns whether or not this is a class that is provided by the `isaacscript-common` library, such
 -- as a `DefaultMap`.
 function ____exports.isIsaacScriptCommonClass(self, object)
-    return __TS__InstanceOf(object, DefaultMap)
+    return ____exports.isDefaultMap(nil, object)
+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.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 has
+-- their own copies 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
 --- TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys.
 function ____exports.isUserDefinedTSTLClass(self, object)

package/functions/ui.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * In the options menu, players have the ability to set a HUD offset. However, mods do not have
  * access to this value. To get around this, Mod Config Menu provides a separate HUD offset setting

package/functions/utils.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to get type safety on a switch statement.
  *
@@ -111,3 +112,17 @@ export declare function repeat(n: int, func: (i: int) => void): void;
  * This function does not actually do anything. (It is an "empty" function.)
  */
 export declare function todo(): void;
+/**
+ * Helper function to sort a two-dimensional array by the first element.
+ *
+ * For example:
+ *
+ * ```ts
+ * const myArray = [[1, 2], [2, 3], [3, 4]];
+ * myArray.sort(twoDimensionalSort);
+ * ```
+ *
+ * From:
+ * https://stackoverflow.com/questions/16096872/how-to-sort-2-dimensional-array-by-column-value
+ */
+export declare function twoDimensionalSort<T>(a: T[], b: T[]): -1 | 0 | 1;

package/functions/utils.lua

@@ -179,4 +179,24 @@ end
 -- This function does not actually do anything. (It is an "empty" function.)
 function ____exports.todo(self)
 end
+--- Helper function to sort a two-dimensional array by the first element.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const myArray = [[1, 2], [2, 3], [3, 4]];
+-- myArray.sort(twoDimensionalSort);
+-- ```
+-- 
+-- From:
+-- https://stackoverflow.com/questions/16096872/how-to-sort-2-dimensional-array-by-column-value
+function ____exports.twoDimensionalSort(self, a, b)
+    if a[1] == nil or b[1] == nil then
+        error("Failed to two-dimensional sort since the first element of the array was undefined.")
+    end
+    if a[1] == b[1] then
+        return 0
+    end
+    return a[1] < b[1] and -1 or 1
+end
 return ____exports