isaacscript-common 3.0.0 → 3.1.0

package/functions/globals.lua

@@ -4,7 +4,6 @@ local __TS__New = ____lualib.__TS__New
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
 local ____exports = {}
-local twoDimensionalSort
 local ____debug = require("functions.debug")
 local isLuaDebugEnabled = ____debug.isLuaDebugEnabled
 local ____log = require("functions.log")
@@ -12,15 +11,8 @@ local log = ____log.log
 local ____set = require("functions.set")
 local addSetsToSet = ____set.addSetsToSet
 local copySet = ____set.copySet
-function 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
+local ____utils = require("functions.utils")
+local twoDimensionalSort = ____utils.twoDimensionalSort
 local DEFAULT_GLOBALS = __TS__New(Set, {
     "ActionTriggers",
     "ActiveSlot",

package/functions/gridEntitySpecific.d.ts

@@ -1,4 +1,9 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /** Helper function to get all of the `GridEntityPit` in the room. */
 export declare function getPits(): GridEntityPit[];
 /** Helper function to get all of the `GridEntityPoop` in the room. */

package/functions/isaacAPIClass.d.ts

@@ -1,14 +1,14 @@
 import { IsaacAPIClass } from "../types/private/IsaacAPIClass";
 /**
- * Helper function to get the type of a class from the Isaac API. This is contained within the
- * "__type" metatable key. In this context, the type of the class is equivalent to the name.
+ * Helper function to get the name of a class from the Isaac API. This is contained within the
+ * "__type" metatable key.
  *
- * For example, a `Vector` class is has a type of "Vector".
+ * For example, a `Vector` class is has a name of "Vector".
  *
  * Returns undefined if the object is not of type `userdata` or if the "__type" metatable key does
  * not exist.
  */
-export declare function getIsaacAPIClassType(object: unknown): string | undefined;
+export declare function getIsaacAPIClassName(object: unknown): string | undefined;
 /**
  * Helper function to check if something is an instantiated class from the Isaac API. (All classes
  * from the Isaac API have a type of "userdata" in Lua with a metatable key of "__type" equal to the

package/functions/isaacAPIClass.lua

@@ -1,14 +1,14 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
---- Helper function to get the type of a class from the Isaac API. This is contained within the
--- "__type" metatable key. In this context, the type of the class is equivalent to the name.
+--- Helper function to get the name of a class from the Isaac API. This is contained within the
+-- "__type" metatable key.
 -- 
--- For example, a `Vector` class is has a type of "Vector".
+-- For example, a `Vector` class is has a name of "Vector".
 -- 
 -- Returns undefined if the object is not of type `userdata` or if the "__type" metatable key does
 -- not exist.
-function ____exports.getIsaacAPIClassType(self, object)
+function ____exports.getIsaacAPIClassName(self, object)
     local objectType = type(object)
     if objectType ~= "userdata" then
         return nil
@@ -27,11 +27,11 @@ end
 -- from the Isaac API have a type of "userdata" in Lua with a metatable key of "__type" equal to the
 -- name of the class.)
 function ____exports.isIsaacAPIClass(self, object)
-    local isaacAPIClassType = ____exports.getIsaacAPIClassType(nil, object)
+    local isaacAPIClassType = ____exports.getIsaacAPIClassName(nil, object)
     return isaacAPIClassType ~= nil
 end
 function ____exports.isIsaacAPIClassOfType(self, object, classType)
-    local isaacAPIClassType = ____exports.getIsaacAPIClassType(nil, object)
+    local isaacAPIClassType = ____exports.getIsaacAPIClassName(nil, object)
     return isaacAPIClassType == classType or isaacAPIClassType == "const " .. classType
 end
 --- Helper function to check if an instantiated Isaac API class is equal to another one of the same

package/functions/jsonRoom.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 import { JSONRoom } from "../interfaces/JSONRoom";
 export declare function getJSONRoomOfVariant(jsonRooms: JSONRoom[], variant: int): JSONRoom | undefined;
 export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[], subType: int): JSONRoom[];

package/functions/log.lua

@@ -35,7 +35,7 @@ local hasFlag = ____flag.hasFlag
 local ____gridEntity = require("functions.gridEntity")
 local getGridEntities = ____gridEntity.getGridEntities
 local ____isaacAPIClass = require("functions.isaacAPIClass")
-local getIsaacAPIClassType = ____isaacAPIClass.getIsaacAPIClassType
+local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 local ____player = require("functions.player")
 local getEffectsList = ____player.getEffectsList
 local getPlayerName = ____player.getPlayerName
@@ -474,7 +474,7 @@ function ____exports.logTable(____table, parentTables)
         end
         numKeys = numKeys + 1
     end
-    ____exports.log("The size of the table was: " .. tostring(numKeys))
+    ____exports.log((indentation .. "The size of the table was: ") .. tostring(numKeys))
 end
 --- Helper function for printing out every tear flag that is turned on. Useful when debugging.
 function ____exports.logTearFlags(flags)
@@ -497,7 +497,7 @@ function ____exports.logUserdata(userdata)
         ____exports.log("Userdata: [no metatable]")
         return
     end
-    local classType = getIsaacAPIClassType(nil, userdata)
+    local classType = getIsaacAPIClassName(nil, userdata)
     if classType == nil then
         ____exports.log("Userdata: [no class type]")
     else

package/functions/pickups.d.ts

@@ -33,7 +33,7 @@ export declare function isRedHeart(pickup: EntityPickup): boolean;
  * @param cap Optional. If specified, will only remove the given amount of cards.
  * @returns True if one or more cards were removed, false otherwise.
  */
-export declare function removeAllBatteries(batterySubType?: BatterySubType, cap?: int): boolean;
+export declare function removeAllBatteries(batterySubType?: BatterySubType, cap?: int): EntityPickupBattery[];
 /**
  * Helper function to remove all of the cards in the room.
  *
@@ -41,7 +41,7 @@ export declare function removeAllBatteries(batterySubType?: BatterySubType, cap?
  * @param cap Optional. If specified, will only remove the given amount of cards.
  * @returns True if one or more cards were removed, false otherwise.
  */
-export declare function removeAllCards(card?: Card, cap?: int): boolean;
+export declare function removeAllCards(card?: Card, cap?: int): EntityPickupCard[];
 /**
  * Helper function to remove all of the coins in the room.
  *
@@ -49,7 +49,7 @@ export declare function removeAllCards(card?: Card, cap?: int): boolean;
  * @param cap Optional. If specified, will only remove the given amount of coins.
  * @returns True if one or more coins were removed, false otherwise.
  */
-export declare function removeAllCoins(coinSubType?: CoinSubType, cap?: int): boolean;
+export declare function removeAllCoins(coinSubType?: CoinSubType, cap?: int): EntityPickupCoin[];
 /**
  * Helper function to remove all of the collectibles in the room.
  *
@@ -58,7 +58,7 @@ export declare function removeAllCoins(coinSubType?: CoinSubType, cap?: int): bo
  * @param cap Optional. If specified, will only remove the given amount of collectibles.
  * @returns True if one or more collectibles were removed, false otherwise.
  */
-export declare function removeAllCollectibles(collectibleType?: CollectibleType, cap?: int): boolean;
+export declare function removeAllCollectibles(collectibleType?: CollectibleType, cap?: int): EntityPickupCollectible[];
 /**
  * Helper function to remove all of the hearts in the room.
  *
@@ -66,7 +66,7 @@ export declare function removeAllCollectibles(collectibleType?: CollectibleType,
  * @param cap Optional. If specified, will only remove the given amount of hearts.
  * @returns True if one or more hearts were removed, false otherwise.
  */
-export declare function removeAllHearts(heartSubType?: HeartSubType, cap?: int): boolean;
+export declare function removeAllHearts(heartSubType?: HeartSubType, cap?: int): EntityPickupHeart[];
 /**
  * Helper function to remove all of the keys in the room.
  *
@@ -74,7 +74,7 @@ export declare function removeAllHearts(heartSubType?: HeartSubType, cap?: int):
  * @param cap Optional. If specified, will only remove the given amount of keys.
  * @returns True if one or more keys were removed, false otherwise.
  */
-export declare function removeAllKeys(keySubType?: KeySubType, cap?: int): boolean;
+export declare function removeAllKeys(keySubType?: KeySubType, cap?: int): EntityPickupKey[];
 /**
  * Helper function to remove all of the pills in the room.
  *
@@ -82,7 +82,7 @@ export declare function removeAllKeys(keySubType?: KeySubType, cap?: int): boole
  * @param cap Optional. If specified, will only remove the given amount of pills.
  * @returns True if one or more pills were removed, false otherwise.
  */
-export declare function removeAllPills(pillColor?: PillColor, cap?: int): boolean;
+export declare function removeAllPills(pillColor?: PillColor, cap?: int): EntityPickupPill[];
 /**
  * Helper function to remove all of the sacks (i.e. grab bags) in the room.
  *
@@ -90,7 +90,7 @@ export declare function removeAllPills(pillColor?: PillColor, cap?: int): boolea
  * @param cap Optional. If specified, will only remove the given amount of trinkets.
  * @returns True if one or more trinkets were removed, false otherwise.
  */
-export declare function removeAllSacks(sackSubType?: SackSubType, cap?: int): boolean;
+export declare function removeAllSacks(sackSubType?: SackSubType, cap?: int): EntityPickupSack[];
 /**
  * Helper function to remove all of the trinkets in the room.
  *
@@ -99,7 +99,7 @@ export declare function removeAllSacks(sackSubType?: SackSubType, cap?: int): bo
  * @param cap Optional. If specified, will only remove the given amount of trinkets.
  * @returns True if one or more trinkets were removed, false otherwise.
  */
-export declare function removeAllTrinkets(trinketType?: TrinketType, cap?: int): boolean;
+export declare function removeAllTrinkets(trinketType?: TrinketType, cap?: int): EntityPickupTrinket[];
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90).
  */

package/functions/playerHealth.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 import { HealthType } from "../enums/HealthType";
 import { PlayerHealth } from "../interfaces/PlayerHealth";
 export declare function addPlayerHealthType(player: EntityPlayer, healthType: HealthType, numHearts: int): void;

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/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

package/functions/vector.lua

@@ -1,11 +1,11 @@
 local ____exports = {}
 local OBJECT_NAME
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
+local ____direction = require("functions.direction")
+local angleToDirection = ____direction.angleToDirection
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
 local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
@@ -101,20 +101,8 @@ function ____exports.vectorEquals(self, vector1, vector2)
 end
 --- Helper function for finding out which way a vector is pointing.
 function ____exports.vectorToDirection(self, vector)
-    local degrees = vector:GetAngleDegrees()
-    if degrees > -45 and degrees < 45 then
-        return Direction.RIGHT
-    end
-    if degrees >= 45 and degrees <= 135 then
-        return Direction.DOWN
-    end
-    if degrees <= -45 and degrees >= -135 then
-        return Direction.UP
-    end
-    if degrees > 135 or degrees < -135 then
-        return Direction.LEFT
-    end
-    return Direction.NO_DIRECTION
+    local angleDegrees = vector:GetAngleDegrees()
+    return angleToDirection(nil, angleDegrees)
 end
 function ____exports.vectorToString(self, vector, round)
     if round == nil then

package/initCustomCallbacks.lua

@@ -89,6 +89,8 @@ local ____postRoomClearChanged = require("callbacks.postRoomClearChanged")
 local postRoomClearChangedCallbackInit = ____postRoomClearChanged.postRoomClearChangedCallbackInit
 local ____postSacrifice = require("callbacks.postSacrifice")
 local postSacrificeCallbackInit = ____postSacrifice.postSacrificeCallbackInit
+local ____postSlotDestroyed = require("callbacks.postSlotDestroyed")
+local postSlotDestroyedCallbacksInit = ____postSlotDestroyed.postSlotDestroyedCallbacksInit
 local ____postSlotInitUpdate = require("callbacks.postSlotInitUpdate")
 local postSlotInitUpdateCallbacksInit = ____postSlotInitUpdate.postSlotInitUpdateCallbacksInit
 local ____postSlotRender = require("callbacks.postSlotRender")
@@ -161,6 +163,7 @@ function ____exports.initCustomCallbacks(self, mod)
     postRockUpdateInit(nil, mod)
     postRoomClearChangedCallbackInit(nil, mod)
     postSacrificeCallbackInit(nil, mod)
+    postSlotDestroyedCallbacksInit(nil, mod)
     postSlotInitUpdateCallbacksInit(nil, mod)
     postSlotRenderCallbacksInit(nil, mod)
     postSpikesRenderInit(nil, mod)

package/interfaces/ChargeBarSprites.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * A collection of the four sprites necessary in order to render a charge bar.
  *

package/interfaces/private/TSTLClassMetatable.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="lua-types/5.3" />
+/// <reference types="lua-types/5.3" />
+/// <reference types="lua-types/5.3" />
 /// <reference types="typescript-to-lua/language-extensions" />
 export interface TSTLClassMetatable {
     ____constructor: () => void;

package/objects/oppositeDoorSlots.d.ts

@@ -0,0 +1,4 @@
+import { DoorSlot } from "isaac-typescript-definitions";
+export declare const OPPOSITE_DOOR_SLOTS: {
+    readonly [key in DoorSlot]: DoorSlot | undefined;
+};

package/objects/oppositeDoorSlots.lua

@@ -0,0 +1,15 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+____exports.OPPOSITE_DOOR_SLOTS = {
+    [DoorSlot.NO_DOOR_SLOT] = nil,
+    [DoorSlot.LEFT_0] = DoorSlot.RIGHT_0,
+    [DoorSlot.UP_0] = DoorSlot.DOWN_0,
+    [DoorSlot.RIGHT_0] = DoorSlot.LEFT_0,
+    [DoorSlot.LEFT_1] = DoorSlot.RIGHT_1,
+    [DoorSlot.DOWN_0] = DoorSlot.UP_0,
+    [DoorSlot.UP_1] = DoorSlot.DOWN_1,
+    [DoorSlot.RIGHT_1] = DoorSlot.LEFT_1,
+    [DoorSlot.DOWN_1] = DoorSlot.UP_1
+}
+return ____exports