isaacscript-common 1.2.219 → 1.2.222

package/dist/enums/private/SerializableIsaacAPIClassType.d.ts

@@ -0,0 +1,7 @@
+/** This must match the enumeration in the JSDoc comments for `deepCopy` and `merge`. */
+export declare enum SerializableIsaacAPIClassType {
+    COLOR = "Color",
+    KCOLOR = "KColor",
+    RNG = "RNG",
+    VECTOR = "Vector"
+}

package/dist/enums/private/SerializableIsaacAPIClassType.lua

@@ -0,0 +1,8 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+____exports.SerializableIsaacAPIClassType = SerializableIsaacAPIClassType or ({})
+____exports.SerializableIsaacAPIClassType.COLOR = "Color"
+____exports.SerializableIsaacAPIClassType.KCOLOR = "KColor"
+____exports.SerializableIsaacAPIClassType.RNG = "RNG"
+____exports.SerializableIsaacAPIClassType.VECTOR = "Vector"
+return ____exports

package/dist/enums/private/SerializationBrand.d.ts

@@ -11,6 +11,7 @@ export declare enum SerializationBrand {
     CLASS = "__TSTL_CLASS",
     OBJECT_WITH_NUMBER_KEYS = "__TSTL_OBJECT_WITH_NUMBER_KEYS",
     COLOR = "__COLOR",
+    KCOLOR = "__KCOLOR",
     RNG = "__RNG",
     VECTOR = "__VECTOR"
 }

package/dist/enums/private/SerializationBrand.lua

@@ -12,6 +12,7 @@ ____exports.SerializationBrand.SET = "__TSTL_SET"
 ____exports.SerializationBrand.CLASS = "__TSTL_CLASS"
 ____exports.SerializationBrand.OBJECT_WITH_NUMBER_KEYS = "__TSTL_OBJECT_WITH_NUMBER_KEYS"
 ____exports.SerializationBrand.COLOR = "__COLOR"
+____exports.SerializationBrand.KCOLOR = "__KCOLOR"
 ____exports.SerializationBrand.RNG = "__RNG"
 ____exports.SerializationBrand.VECTOR = "__VECTOR"
 local SERIALIZATION_BRANDS = getEnumValues(nil, ____exports.SerializationBrand)

package/dist/features/extraConsoleCommands/commands.lua

@@ -40,6 +40,7 @@ local ____playerIndex = require("functions.playerIndex")
 local getPlayers = ____playerIndex.getPlayers
 local ____roomData = require("functions.roomData")
 local getRoomData = ____roomData.getRoomData
+local getRoomDescriptor = ____roomData.getRoomDescriptor
 local ____rooms = require("functions.rooms")
 local changeRoom = ____rooms.changeRoom
 local getRoomGridIndexesForType = ____rooms.getRoomGridIndexesForType
@@ -129,8 +130,8 @@ function devilAngel(self, useDevil)
         local roomType = devilAngelRoomData.Type
         local conflictingType = useDevil and RoomType.ROOM_ANGEL or RoomType.ROOM_DEVIL
         if roomType == conflictingType then
-            local roomDesc = level:GetRoomByIdx(GridRooms.ROOM_DEVIL_IDX)
-            roomDesc.Data = nil
+            local roomDescriptor = getRoomDescriptor(nil, GridRooms.ROOM_DEVIL_IDX)
+            roomDescriptor.Data = nil
         end
     end
     if useDevil then

package/dist/features/saveDataManager/merge.d.ts

@@ -11,6 +11,7 @@
  * - TSTL classes
  * - `DefaultMap`
  * - Isaac `Color` objects
+ * - Isaac `KColor` objects
  * - Isaac `RNG` objects
  * - Isaac `Vector` objects
  *

package/dist/features/saveDataManager/merge.lua

@@ -3,7 +3,7 @@ local Map = ____lualib.Map
 local __TS__InstanceOf = ____lualib.__TS__InstanceOf
 local Set = ____lualib.Set
 local ____exports = {}
-local mergeArray, mergeTSTLObject, mergeTable, tryDeserializeIsaacClass
+local mergeArray, mergeTSTLObject, mergeTable
 local ____SerializationBrand = require("enums.private.SerializationBrand")
 local isSerializationBrand = ____SerializationBrand.isSerializationBrand
 local SerializationBrand = ____SerializationBrand.SerializationBrand
@@ -15,16 +15,13 @@ local ____deepCopy = require("functions.deepCopy")
 local deepCopy = ____deepCopy.deepCopy
 local ____log = require("functions.log")
 local log = ____log.log
-local ____rng = require("functions.rng")
-local copyRNG = ____rng.copyRNG
-local isSerializedRNG = ____rng.isSerializedRNG
+local ____serialization = require("functions.serialization")
+local copySerializableIsaacAPIClass = ____serialization.copySerializableIsaacAPIClass
+local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
 local ____table = require("functions.table")
 local clearTable = ____table.clearTable
 local ____utils = require("functions.utils")
 local getTraversalDescription = ____utils.getTraversalDescription
-local ____vector = require("functions.vector")
-local copyVector = ____vector.copyVector
-local isSerializedVector = ____vector.isSerializedVector
 local ____constants = require("features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 function ____exports.merge(self, oldObject, newTable, traversalDescription)
@@ -103,9 +100,9 @@ function mergeTable(self, oldTable, newTable, traversalDescription)
             if isSerializationBrand(nil, key) then
                 goto __continue23
             end
-            local deserializedIsaacClass = tryDeserializeIsaacClass(nil, value)
-            if deserializedIsaacClass ~= nil then
-                oldTable[key] = deserializedIsaacClass
+            if isSerializedIsaacAPIClass(nil, value) then
+                local deserializedObject = copySerializableIsaacAPIClass(nil, value, SerializationType.DESERIALIZE)
+                oldTable[key] = deserializedObject
                 goto __continue23
             end
             local valueType = type(value)
@@ -128,13 +125,4 @@ function mergeTable(self, oldTable, newTable, traversalDescription)
         ::__continue23::
     end
 end
-function tryDeserializeIsaacClass(self, value)
-    if isSerializedVector(nil, value) then
-        return copyVector(nil, value, SerializationType.DESERIALIZE)
-    end
-    if isSerializedRNG(nil, value) then
-        return copyRNG(nil, value, SerializationType.DESERIALIZE)
-    end
-    return nil
-end
 return ____exports

package/dist/functions/collectibles.d.ts

@@ -4,6 +4,8 @@ import { CollectibleIndex } from "../types/CollectibleIndex";
 export declare function clearCollectibleSprite(collectible: EntityPickup): void;
 export declare function collectibleHasCacheFlag(collectibleType: CollectibleType | int, cacheFlag: CacheFlag): boolean;
 export declare function collectibleHasTag(collectibleType: CollectibleType | int, tag: ItemConfigTag): boolean;
+/** Helper function to check if two collectible sprites have the same sprite sheet loaded. */
+export declare function collectibleSpriteEquals(sprite1: Sprite, sprite2: Sprite): boolean;
 /**
  * Helper function to get the in-game description for a collectible. Returns "Unknown" if the
  * provided collectible type was not valid.
@@ -15,8 +17,8 @@ export declare function getCollectibleDescription(collectibleType: CollectibleTy
  */
 export declare function getCollectibleDevilHeartPrice(collectibleType: CollectibleType | int, player: EntityPlayer): PickupPrice;
 /**
- * Helper function to get the path to a collectible's sprite. Returns
- * "gfx/items/collectibles/questionmark.png" if the provided collectible type was not valid.
+ * Helper function to get the path to a collectible's sprite. Returns the path to the question mark
+ * sprite (i.e. from Curse of the Blind) if the provided collectible type was not valid.
  */
 export declare function getCollectibleGfxFilename(collectibleType: CollectibleType | int): string;
 /**
@@ -99,6 +101,8 @@ export declare function getCollectibles(matchingSubType?: number): EntityPickup[
 export declare function getMaxCollectibleType(): int;
 /** Returns true if the item type in the item config is equal to `ItemType.ITEM_ACTIVE`. */
 export declare function isActiveCollectible(collectibleType: CollectibleType | int): boolean;
+/** Returns true if the collectible has a red question mark sprite. */
+export declare function isBlindCollectible(collectible: EntityPickup): boolean;
 /**
  * Returns whether or not the given collectible is a "glitched" item. All items are replaced by
  * glitched items once a player has TMTRAINER. However, glitched items can also "naturally" appear

package/dist/functions/collectibles.lua

@@ -1,6 +1,6 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER
+local initQuestionMarkSprite, COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local itemConfig = ____cachedClasses.itemConfig
@@ -23,6 +23,14 @@ local ____roomData = require("functions.roomData")
 local getRoomListIndex = ____roomData.getRoomListIndex
 local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
+local spriteEquals = ____sprite.spriteEquals
+function initQuestionMarkSprite(self)
+    local sprite = Sprite()
+    sprite:Load("gfx/005.100_collectible.anm2", false)
+    sprite:ReplaceSpritesheet(1, "gfx/items/collectibles/questionmark.png")
+    sprite:LoadGraphics()
+    return sprite
+end
 function ____exports.setCollectibleSprite(self, collectible, pngPath)
     if collectible.Variant ~= 100 then
         error("You cannot set a collectible sprite for pickups of variant: " .. tostring(collectible.Variant))
@@ -38,6 +46,7 @@ end
 COLLECTIBLE_SPRITE_LAYER = 1
 COLLECTIBLE_SHADOW_LAYER = 4
 local GLITCHED_ITEM_THRESHOLD = 4000000000
+local questionMarkSprite = initQuestionMarkSprite(nil)
 function ____exports.clearCollectibleSprite(self, collectible)
     ____exports.setCollectibleSprite(nil, collectible, nil)
 end
@@ -55,6 +64,26 @@ function ____exports.collectibleHasTag(self, collectibleType, tag)
     end
     return itemConfigItem:HasTags(tag)
 end
+function ____exports.collectibleSpriteEquals(self, sprite1, sprite2)
+    local xStart = -1
+    local xFinish = 1
+    local xIncrement = 1
+    local yStart = -40
+    local yFinish = 10
+    local yIncrement = 3
+    return spriteEquals(
+        nil,
+        sprite1,
+        sprite2,
+        COLLECTIBLE_SPRITE_LAYER,
+        xStart,
+        xFinish,
+        xIncrement,
+        yStart,
+        yFinish,
+        yIncrement
+    )
+end
 function ____exports.getCollectibleDescription(self, collectibleType)
     local collectibleDescription = COLLECTIBLE_DESCRIPTION_MAP:get(collectibleType)
     if collectibleDescription ~= nil then
@@ -85,7 +114,7 @@ end
 function ____exports.getCollectibleGfxFilename(self, collectibleType)
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
-        return "unknown.png"
+        return BLIND_ITEM_PNG_PATH
     end
     return itemConfigItem.GfxFileName
 end
@@ -164,6 +193,16 @@ function ____exports.isActiveCollectible(self, collectibleType)
     local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
     return itemType == ItemType.ITEM_ACTIVE
 end
+function ____exports.isBlindCollectible(self, collectible)
+    if collectible.Variant ~= 100 then
+        error("You cannot get check for question mark sprites for pickups of variant: " .. tostring(collectible.Variant))
+    end
+    local sprite = collectible:GetSprite()
+    local animation = sprite:GetAnimation()
+    local frame = sprite:GetFrame()
+    questionMarkSprite:SetFrame(animation, frame)
+    return ____exports.collectibleSpriteEquals(nil, sprite, questionMarkSprite)
+end
 function ____exports.isGlitchedCollectible(self, pickup)
     return pickup.Variant == 100 and pickup.SubType > GLITCHED_ITEM_THRESHOLD
 end

package/dist/functions/color.d.ts

@@ -1,12 +1,15 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
-declare type SerializedColor = LuaTable<string, string | number>;
+declare type SerializedColor = LuaTable<string, unknown> & {
+    __serializedColorBrand: unknown;
+};
 interface CopyColorReturn {
     [SerializationType.NONE]: Color;
     [SerializationType.SERIALIZE]: SerializedColor;
     [SerializationType.DESERIALIZE]: Color;
 }
+export declare function colorEquals(color1: Color, color2: Color): boolean;
 /**
  * Helper function to copy a `Color` object.
  *
@@ -16,9 +19,12 @@ interface CopyColorReturn {
  */
 export declare function copyColor<C extends Color | SerializedColor, S extends SerializationType>(color: C, serializationType: S): CopyColorReturn[S];
 export declare function copyColor<C extends Color | SerializedColor>(color: C): CopyColorReturn[SerializationType.NONE];
-export declare function copyKColor(kColor: KColor): KColor;
 export declare function getDefaultColor(): Color;
-export declare function getDefaultKColor(): KColor;
 /** Helper function to check if something is an instantiated Color object. */
 export declare function isColor(object: unknown): object is Color;
+/**
+ * Used to determine is the given table is a serialized `Color` object created by the save data
+ * manager and/or the `deepCopy` function.
+ */
+export declare function isSerializedColor(object: unknown): object is SerializedColor;
 export {};

package/dist/functions/color.lua

@@ -5,15 +5,17 @@ local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
+local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
 local ____table = require("functions.table")
 local copyValuesToTable = ____table.copyValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
-local ____userdata = require("functions.userdata")
-local isUserdataObject = ____userdata.isUserdataObject
+local tableHasKeys = ____table.tableHasKeys
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 function ____exports.isColor(self, object)
-    return isUserdataObject(nil, object, OBJECT_NAME)
+    return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
 end
 local KEYS = {
     "R",
@@ -25,14 +27,17 @@ local KEYS = {
     "BO"
 }
 OBJECT_NAME = "Color"
+function ____exports.colorEquals(self, color1, color2)
+    return isaacAPIClassEquals(nil, color1, color2, KEYS)
+end
 function ____exports.copyColor(self, color, serializationType)
     if serializationType == nil then
         serializationType = SerializationType.NONE
     end
     repeat
-        local ____switch3 = serializationType
-        local ____cond3 = ____switch3 == SerializationType.NONE
-        if ____cond3 then
+        local ____switch4 = serializationType
+        local ____cond4 = ____switch4 == SerializationType.NONE
+        if ____cond4 then
             do
                 if not ____exports.isColor(nil, color) then
                     error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
@@ -48,8 +53,8 @@ function ____exports.copyColor(self, color, serializationType)
                 )
             end
         end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.SERIALIZE
-        if ____cond3 then
+        ____cond4 = ____cond4 or ____switch4 == SerializationType.SERIALIZE
+        if ____cond4 then
             do
                 if not ____exports.isColor(nil, color) then
                     error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
@@ -60,8 +65,8 @@ function ____exports.copyColor(self, color, serializationType)
                 return colorTable
             end
         end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.DESERIALIZE
-        if ____cond3 then
+        ____cond4 = ____cond4 or ____switch4 == SerializationType.DESERIALIZE
+        if ____cond4 then
             do
                 local colorType = type(color)
                 if ____exports.isColor(nil, color) or colorType ~= "table" then
@@ -91,13 +96,19 @@ function ____exports.copyColor(self, color, serializationType)
         end
     until true
 end
-function ____exports.copyKColor(self, kColor)
-    return KColor(kColor.Red, kColor.Green, kColor.Blue, kColor.Alpha)
-end
 function ____exports.getDefaultColor(self)
     return Color(1, 1, 1)
 end
-function ____exports.getDefaultKColor(self)
-    return KColor(1, 1, 1, 1)
+function ____exports.isSerializedColor(self, object)
+    local objectType = type(object)
+    if objectType ~= "table" then
+        return false
+    end
+    local ____table = object
+    return tableHasKeys(
+        nil,
+        ____table,
+        table.unpack(KEYS)
+    ) and ____table[SerializationBrand.COLOR] ~= nil
 end
 return ____exports

package/dist/functions/deepCopy.d.ts

@@ -12,6 +12,7 @@ import { SerializationType } from "../enums/SerializationType";
  * - TSTL classes
  * - `DefaultMap`
  * - Isaac `Color` objects
+ * - Isaac `KColor` objects
  * - Isaac `RNG` objects
  * - Isaac `Vector` objects
  *

package/dist/functions/deepCopy.lua

@@ -5,7 +5,7 @@ local Map = ____lualib.Map
 local __TS__InstanceOf = ____lualib.__TS__InstanceOf
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local isTSTLClass, copyClass, getNewClassFromMetatable, deepCopyValue, checkMetatable, validateValue, isCopyableIsaacAPIClass, TSTL_CLASS_KEYS
+local isTSTLClass, checkMetatable, copyClass, getNewClassFromMetatable, deepCopyValue, validateValue, getNewValue, TSTL_CLASS_KEYS
 local ____DefaultMap = require("classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
 local ____SerializationBrand = require("enums.private.SerializationBrand")
@@ -15,20 +15,15 @@ local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
 local ____constants = require("features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
-local ____color = require("functions.color")
-local isColor = ____color.isColor
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local isSerializableIsaacAPIClass = ____isaacAPIClass.isSerializableIsaacAPIClass
 local ____log = require("functions.log")
 local log = ____log.log
-local ____rng = require("functions.rng")
-local copyRNG = ____rng.copyRNG
-local isRNG = ____rng.isRNG
-local isSerializedRNG = ____rng.isSerializedRNG
+local ____serialization = require("functions.serialization")
+local copySerializableIsaacAPIClass = ____serialization.copySerializableIsaacAPIClass
+local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
 local ____utils = require("functions.utils")
 local getTraversalDescription = ____utils.getTraversalDescription
-local ____vector = require("functions.vector")
-local copyVector = ____vector.copyVector
-local isSerializedVector = ____vector.isSerializedVector
-local isVector = ____vector.isVector
 function ____exports.deepCopy(self, oldObject, serializationType, traversalDescription)
     if serializationType == nil then
         serializationType = SerializationType.NONE
@@ -180,6 +175,14 @@ function isTSTLClass(self, object)
     end
     return numKeys == TSTL_CLASS_KEYS.size
 end
+function checkMetatable(self, ____table, traversalDescription)
+    local metatable = getmetatable(____table)
+    if metatable == nil then
+        return
+    end
+    local tableDescription = traversalDescription == "" and "the table to copy" or ("\"" .. traversalDescription) .. "\""
+    error(("The deepCopy function detected that \"" .. tableDescription) .. "\" has a metatable. Copying tables with metatables is not supported, unless they are explicitly handled by the save data manager. (e.g. Vectors, TypeScriptToLua Maps, etc.)")
+end
 function copyClass(self, oldClass)
     local metatable = getmetatable(oldClass)
     local newClass = getNewClassFromMetatable(nil, metatable)
@@ -208,18 +211,13 @@ function deepCopyValue(self, oldObject, newObject, key, value, traversalDescript
             log("deepCopy is converting a TSTL map with number keys to strings.")
         end
     end
-    local newValue
-    if isRNG(nil, value) or isSerializedRNG(nil, value) and serializationType == SerializationType.DESERIALIZE then
-        newValue = copyRNG(nil, value, serializationType)
-    elseif isVector(nil, value) or isSerializedVector(nil, value) and serializationType == SerializationType.DESERIALIZE then
-        newValue = copyVector(nil, value, serializationType)
-    elseif valueType == "table" then
-        local ____table = value
-        traversalDescription = getTraversalDescription(nil, key, traversalDescription)
-        newValue = ____exports.deepCopy(nil, ____table, serializationType, traversalDescription)
-    else
-        newValue = value
-    end
+    local newValue = getNewValue(
+        nil,
+        key,
+        value,
+        traversalDescription,
+        serializationType
+    )
     if __TS__InstanceOf(newObject, Map) then
         newObject:set(key, newValue)
     elseif __TS__InstanceOf(newObject, Set) then
@@ -229,24 +227,27 @@ function deepCopyValue(self, oldObject, newObject, key, value, traversalDescript
         newObject[keyToUse] = newValue
     end
 end
-function checkMetatable(self, ____table, traversalDescription)
-    local metatable = getmetatable(____table)
-    if metatable == nil then
-        return
-    end
-    local tableDescription = traversalDescription == "" and "the table to copy" or ("\"" .. traversalDescription) .. "\""
-    error(("The deepCopy function detected that \"" .. tableDescription) .. "\" has a metatable. Copying tables with metatables is not supported, unless they are explicitly handled by the save data manager. (e.g. Vectors, TypeScriptToLua Maps, etc.)")
-end
 function validateValue(self, value, valueType, traversalDescription)
-    if isCopyableIsaacAPIClass(nil, value) then
+    if isSerializableIsaacAPIClass(nil, value) then
         return
     end
     if valueType == "function" or valueType == "nil" or valueType == "thread" or valueType == "userdata" then
         error(((("The deepCopy function detected that \"" .. traversalDescription) .. "\" has a value of type \"") .. valueType) .. "\", which is not supported.")
     end
 end
-function isCopyableIsaacAPIClass(self, value)
-    return isColor(nil, value) or isRNG(nil, value) or isVector(nil, value)
+function getNewValue(self, key, value, traversalDescription, serializationType)
+    if isSerializableIsaacAPIClass(nil, value) then
+        return copySerializableIsaacAPIClass(nil, value, serializationType)
+    end
+    if isSerializedIsaacAPIClass(nil, value) and serializationType == SerializationType.DESERIALIZE then
+        return copySerializableIsaacAPIClass(nil, value, serializationType)
+    end
+    if type(value) == "table" then
+        local ____table = value
+        traversalDescription = getTraversalDescription(nil, key, traversalDescription)
+        return ____exports.deepCopy(nil, ____table, serializationType, traversalDescription)
+    end
+    return value
 end
 TSTL_CLASS_KEYS = __TS__New(Set, {"____constructor", "__index", "constructor"})
 return ____exports

package/dist/functions/isaacAPIClass.d.ts

@@ -0,0 +1,25 @@
+import { IsaacAPIClass } from "../types/private/IsaacAPIClass";
+import { SerializableIsaacAPIClass } from "../types/private/SerializableIsaacAPIClass";
+/**
+ * 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.
+ *
+ * For example, a `Vector` class is has a type 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;
+/**
+ * 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
+ * name of the class.)
+ */
+export declare function isIsaacAPIClass(object: unknown): object is IsaacAPIClass;
+export declare function isIsaacAPIClassOfType(object: unknown, classType: string): boolean;
+export declare function isSerializableIsaacAPIClass(object: unknown): object is SerializableIsaacAPIClass;
+/**
+ * Helper function to check if an instantiated Isaac API class is equal to another one of the same
+ * type. You must provide the list of keys to check for.
+ */
+export declare function isaacAPIClassEquals(object1: unknown, object2: unknown, keys: string[]): boolean;

package/dist/functions/isaacAPIClass.lua

@@ -0,0 +1,52 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
+local ____exports = {}
+local ____SerializableIsaacAPIClassType = require("enums.private.SerializableIsaacAPIClassType")
+local SerializableIsaacAPIClassType = ____SerializableIsaacAPIClassType.SerializableIsaacAPIClassType
+local ____utils = require("functions.utils")
+local getEnumValues = ____utils.getEnumValues
+local SERIALIZABLE_ISAAC_API_CLASS_TYPES_SET = __TS__New(
+    Set,
+    getEnumValues(nil, SerializableIsaacAPIClassType)
+)
+function ____exports.getIsaacAPIClassType(self, object)
+    local objectType = type(object)
+    if objectType ~= "userdata" then
+        return nil
+    end
+    local metatable = getmetatable(object)
+    if metatable == nil then
+        return nil
+    end
+    local classType = metatable.__type
+    if type(classType) ~= "string" then
+        return nil
+    end
+    return classType
+end
+function ____exports.isIsaacAPIClass(self, object)
+    local isaacAPIClassType = ____exports.getIsaacAPIClassType(nil, object)
+    return isaacAPIClassType ~= nil
+end
+function ____exports.isIsaacAPIClassOfType(self, object, classType)
+    local isaacAPIClassType = ____exports.getIsaacAPIClassType(nil, object)
+    return isaacAPIClassType == classType or isaacAPIClassType == "const " .. classType
+end
+function ____exports.isSerializableIsaacAPIClass(self, object)
+    local classType = ____exports.getIsaacAPIClassType(nil, object)
+    if classType == nil then
+        return false
+    end
+    return SERIALIZABLE_ISAAC_API_CLASS_TYPES_SET:has(classType)
+end
+function ____exports.isaacAPIClassEquals(self, object1, object2, keys)
+    local table1 = object1
+    local table2 = object2
+    return __TS__ArrayEvery(
+        keys,
+        function(____, key) return table1[key] == table2[key] end
+    )
+end
+return ____exports

package/dist/functions/kColor.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="typescript-to-lua/language-extensions" />
+import { SerializationType } from "../enums/SerializationType";
+declare type SerializedKColor = LuaTable<string, unknown> & {
+    __serializedKColorBrand: unknown;
+};
+interface CopyKColorReturn {
+    [SerializationType.NONE]: KColor;
+    [SerializationType.SERIALIZE]: SerializedKColor;
+    [SerializationType.DESERIALIZE]: KColor;
+}
+/**
+ * Helper function to copy a `KColor` object.
+ *
+ * @param kColor The KColor object to copy. In the case of deserialization, this will actually be a
+ * Lua table instead of an instantiated KColor class.
+ * @param serializationType Default is `SerializationType.NONE`.
+ */
+export declare function copyKColor<K extends KColor | SerializedKColor, S extends SerializationType>(kColor: K, serializationType: S): CopyKColorReturn[S];
+export declare function copyKColor<K extends KColor | SerializedKColor>(kColor: K): CopyKColorReturn[SerializationType.NONE];
+export declare function getDefaultKColor(): KColor;
+/** Helper function to check if something is an instantiated KColor object. */
+export declare function isKColor(object: unknown): object is KColor;
+/**
+ * Used to determine is the given table is a serialized `KColor` object created by the save data
+ * manager and/or the `deepCopy` function.
+ */
+export declare function isSerializedKColor(object: unknown): object is SerializedKColor;
+export declare function kColorEquals(kColor1: KColor, kColor2: KColor): boolean;
+export {};