isaacscript-common 1.2.219 → 1.2.222

package/dist/functions/kColor.lua

@@ -0,0 +1,90 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local OBJECT_NAME
+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 tableHasKeys = ____table.tableHasKeys
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
+function ____exports.isKColor(self, object)
+    return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
+end
+local KEYS = {"Red", "Green", "Blue", "Alpha"}
+OBJECT_NAME = "KColor"
+function ____exports.copyKColor(self, kColor, serializationType)
+    if serializationType == nil then
+        serializationType = SerializationType.NONE
+    end
+    repeat
+        local ____switch3 = serializationType
+        local ____cond3 = ____switch3 == SerializationType.NONE
+        if ____cond3 then
+            do
+                if not ____exports.isKColor(nil, kColor) then
+                    error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+                end
+                return KColor(kColor.Red, kColor.Green, kColor.Blue, kColor.Alpha)
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == SerializationType.SERIALIZE
+        if ____cond3 then
+            do
+                if not ____exports.isKColor(nil, kColor) then
+                    error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+                end
+                local kColorTable = {}
+                copyValuesToTable(nil, kColor, KEYS, kColorTable)
+                kColorTable[SerializationBrand.KCOLOR] = ""
+                return kColorTable
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == SerializationType.DESERIALIZE
+        if ____cond3 then
+            do
+                local kColorType = type(kColor)
+                if ____exports.isKColor(nil, kColor) or kColorType ~= "table" then
+                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
+                end
+                local r, g, b, a = table.unpack(getNumbersFromTable(
+                    nil,
+                    kColor,
+                    OBJECT_NAME,
+                    table.unpack(KEYS)
+                ))
+                return KColor(r, g, b, a)
+            end
+        end
+        do
+            do
+                return ensureAllCases(nil, serializationType)
+            end
+        end
+    until true
+end
+function ____exports.getDefaultKColor(self)
+    return KColor(1, 1, 1, 1)
+end
+function ____exports.isSerializedKColor(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.KCOLOR] ~= nil
+end
+function ____exports.kColorEquals(self, kColor1, kColor2)
+    return isaacAPIClassEquals(nil, kColor1, kColor2, KEYS)
+end
+return ____exports

package/dist/functions/log.lua

@@ -20,6 +20,8 @@ local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
 local ____gridEntity = require("functions.gridEntity")
 local getGridEntities = ____gridEntity.getGridEntities
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local getIsaacAPIClassType = ____isaacAPIClass.getIsaacAPIClassType
 local ____math = require("functions.math")
 local range = ____math.range
 local ____player = require("functions.player")
@@ -35,8 +37,6 @@ local ____set = require("functions.set")
 local getSortedSetValues = ____set.getSortedSetValues
 local ____trinkets = require("functions.trinkets")
 local getTrinketName = ____trinkets.getTrinketName
-local ____userdata = require("functions.userdata")
-local getUserdataType = ____userdata.getUserdataType
 local ____utils = require("functions.utils")
 local printConsole = ____utils.printConsole
 function ____exports.getDebugPrependString(self, msg, numParentFunctions)
@@ -434,7 +434,7 @@ function ____exports.logUserdata(userdata)
         ____exports.log("Userdata: [no metatable]")
         return
     end
-    local classType = getUserdataType(nil, userdata)
+    local classType = getIsaacAPIClassType(nil, userdata)
     if classType == nil then
         ____exports.log("Userdata: [no class type]")
     else

package/dist/functions/rng.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
-declare type SerializedRNG = LuaTable<string, string | number>;
+declare type SerializedRNG = LuaTable<string, unknown> & {
+    __serializedRNGBrand: unknown;
+};
 interface CopyRNGReturn {
     [SerializationType.NONE]: RNG;
     [SerializationType.SERIALIZE]: SerializedRNG;
@@ -25,8 +27,8 @@ export declare function getRandomSeed(): Seed;
 /** Helper function to check if something is an instantiated RNG object. */
 export declare function isRNG(object: unknown): object is RNG;
 /**
- * Used to determine is the given table is a serialized Vector created by the save data manager
- * and/or the `deepCopy` function.
+ * Used to determine is the given table is a serialized `RNG` object created by the save data
+ * manager and/or the `deepCopy` function.
  */
 export declare function isSerializedRNG(object: unknown): object is SerializedRNG;
 /**
@@ -35,6 +37,7 @@ export declare function isSerializedRNG(object: unknown): object is SerializedRN
  * @param seed The seed to initialize it with. Default is `getRandomSeed()`.
  */
 export declare function newRNG(seed?: Seed): RNG;
+export declare function rngEquals(rng1: RNG, rng2: RNG): boolean;
 /**
  * Helper function to iterate over the provided object and set the seed for all of the values that
  * are RNG objects equal to a particular seed.

package/dist/functions/rng.lua

@@ -8,11 +8,12 @@ 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 getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
-local ____userdata = require("functions.userdata")
-local isUserdataObject = ____userdata.isUserdataObject
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 function ____exports.getRandomSeed(self)
@@ -21,7 +22,7 @@ function ____exports.getRandomSeed(self)
     return safeRandomNumber
 end
 function ____exports.isRNG(self, object)
-    return isUserdataObject(nil, object, OBJECT_NAME)
+    return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
 end
 function ____exports.newRNG(self, seed)
     if seed == nil then
@@ -105,6 +106,9 @@ function ____exports.isSerializedRNG(self, object)
         table.unpack(KEYS)
     ) and ____table[SerializationBrand.RNG] ~= nil
 end
+function ____exports.rngEquals(self, rng1, rng2)
+    return isaacAPIClassEquals(nil, rng1, rng2, KEYS)
+end
 function ____exports.setAllRNGToSeed(self, object, seed)
     local objectType = type(object)
     if objectType ~= "table" then

package/dist/functions/roomData.d.ts

@@ -56,6 +56,13 @@ export declare function getRoomListIndex(roomGridIndex?: int): int;
  * @returns The room name. Returns "Unknown" if the type was not found.
  */
 export declare function getRoomName(roomGridIndex?: int): string;
+/**
+ * Helper function to get the name of the room as it appears in the STB/XML data.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room name. Returns "Unknown" if the type was not found.
+ */
+export declare function getRoomShape(roomGridIndex?: int): RoomShape | undefined;
 /**
  * Helper function to get the stage ID for a room from the XML/STB data. The room stage ID will
  * correspond to the first number in the filename of the XML/STB file. For example, a Depths room

package/dist/functions/roomData.lua

@@ -61,6 +61,16 @@ function ____exports.getRoomName(self, roomGridIndex)
     local roomData = ____exports.getRoomData(nil, roomGridIndex)
     return roomData == nil and "Unknown" or roomData.Name
 end
+function ____exports.getRoomShape(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local ____temp_0
+    if roomData == nil then
+        ____temp_0 = nil
+    else
+        ____temp_0 = roomData.Shape
+    end
+    return ____temp_0
+end
 function ____exports.getRoomStageID(self, roomGridIndex)
     local roomData = ____exports.getRoomData(nil, roomGridIndex)
     return roomData == nil and -1 or roomData.StageID

package/dist/functions/rooms.d.ts

@@ -114,6 +114,8 @@ export declare function inStartingRoom(): boolean;
  * default.
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean;
+export declare function isDoorSlotValidAtGridIndex(doorSlot: DoorSlot, roomGridIndex: int): boolean;
+export declare function isDoorSlotValidAtGridIndexForRedRoom(doorSlot: DoorSlot, roomGridIndex: int): boolean;
 /**
  * Helper function to detect if the provided room was created by the Red Key item. Under the hood,
  * this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
@@ -128,6 +130,8 @@ export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function isRoomInsideMap(roomGridIndex?: int): boolean;
+/** Helper function to check if a room exists at the given room grid index. */
+export declare function roomExists(roomGridIndex: int): boolean;
 /**
  * If the `Room.Update` method is called in a PostNewRoom callback, then some entities will slide
  * around (such as the player). Since those entity velocities are already at zero, setting them to

package/dist/functions/rooms.lua

@@ -33,9 +33,11 @@ local setEntityPositions = ____positionVelocity.setEntityPositions
 local setEntityVelocities = ____positionVelocity.setEntityVelocities
 local ____roomData = require("functions.roomData")
 local getCurrentRoomDescriptorReadOnly = ____roomData.getCurrentRoomDescriptorReadOnly
+local getRoomAllowedDoors = ____roomData.getRoomAllowedDoors
 local getRoomData = ____roomData.getRoomData
 local getRoomDescriptor = ____roomData.getRoomDescriptor
 local getRoomGridIndex = ____roomData.getRoomGridIndex
+local getRoomShape = ____roomData.getRoomShape
 local getRoomStageID = ____roomData.getRoomStageID
 local getRoomSubType = ____roomData.getRoomSubType
 function ____exports.getRooms(self, includeExtraDimensionalRooms)
@@ -75,6 +77,10 @@ function ____exports.inDeathCertificateArea(self)
     local roomSubType = getRoomSubType(nil)
     return roomStageID == 35 and (roomSubType == 33 or roomSubType == 34)
 end
+function ____exports.roomExists(self, roomGridIndex)
+    local roomData = getRoomData(nil, roomGridIndex)
+    return roomData ~= nil
+end
 function ____exports.changeRoom(self, roomGridIndex)
     local level = game:GetLevel()
     local roomData = getRoomData(nil, roomGridIndex)
@@ -97,11 +103,11 @@ function ____exports.getCurrentDimension(self)
         return 2
     end
     local startingRoomGridIndex = level:GetStartingRoomIndex()
-    local startingRoomDesc = level:GetRoomByIdx(startingRoomGridIndex, -1)
-    local startingRoomHash = GetPtrHash(startingRoomDesc)
+    local startingRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, -1)
+    local startingRoomHash = GetPtrHash(startingRoomDescription)
     for ____, dimension in ipairs(range(nil, 0, NUM_DIMENSIONS - 1)) do
-        local dimensionRoomDesc = level:GetRoomByIdx(startingRoomGridIndex, dimension)
-        local dimensionRoomHash = GetPtrHash(dimensionRoomDesc)
+        local dimensionRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, dimension)
+        local dimensionRoomHash = GetPtrHash(dimensionRoomDescription)
         if dimensionRoomHash == startingRoomHash then
             return dimension
         end
@@ -226,6 +232,26 @@ function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
         function(____, roomDescriptor) return roomDescriptor.Clear end
     )
 end
+function ____exports.isDoorSlotValidAtGridIndex(self, doorSlot, roomGridIndex)
+    local allowedDoors = getRoomAllowedDoors(nil, roomGridIndex)
+    return allowedDoors:has(doorSlot)
+end
+function ____exports.isDoorSlotValidAtGridIndexForRedRoom(self, doorSlot, roomGridIndex)
+    local doorSlotValidAtGridIndex = ____exports.isDoorSlotValidAtGridIndex(nil, doorSlot, roomGridIndex)
+    if not doorSlotValidAtGridIndex then
+        return false
+    end
+    local roomShape = getRoomShape(nil, roomGridIndex)
+    if roomShape == nil then
+        return false
+    end
+    local delta = ____exports.getGridIndexDelta(nil, roomShape, doorSlot)
+    if delta == nil then
+        return false
+    end
+    local redRoomGridIndex = roomGridIndex + delta
+    return not ____exports.roomExists(nil, redRoomGridIndex)
+end
 function ____exports.isRedKeyRoom(self, roomGridIndex)
     local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
     return hasFlag(nil, roomDescriptor.Flags, 1024)
@@ -255,12 +281,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue48
+                goto __continue54
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue48::
+        ::__continue54::
     end
     sfxManager:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/functions/serialization.d.ts

@@ -0,0 +1,5 @@
+import { SerializationType } from "../enums/SerializationType";
+import { SerializableIsaacAPIClass } from "../types/private/SerializableIsaacAPIClass";
+import { SerializedIsaacAPIClass } from "../types/private/SerializedIsaacAPIClass";
+export declare function copySerializableIsaacAPIClass(isaacAPIClassOrSerializedTable: SerializableIsaacAPIClass | SerializedIsaacAPIClass, serializationType: SerializationType): unknown;
+export declare function isSerializedIsaacAPIClass(object: unknown): object is SerializedIsaacAPIClass;

package/dist/functions/serialization.lua

@@ -0,0 +1,115 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local ____SerializableIsaacAPIClassType = require("enums.private.SerializableIsaacAPIClassType")
+local SerializableIsaacAPIClassType = ____SerializableIsaacAPIClassType.SerializableIsaacAPIClassType
+local ____color = require("functions.color")
+local copyColor = ____color.copyColor
+local isSerializedColor = ____color.isSerializedColor
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local getIsaacAPIClassType = ____isaacAPIClass.getIsaacAPIClassType
+local ____kColor = require("functions.kColor")
+local copyKColor = ____kColor.copyKColor
+local isSerializedKColor = ____kColor.isSerializedKColor
+local ____rng = require("functions.rng")
+local copyRNG = ____rng.copyRNG
+local isSerializedRNG = ____rng.isSerializedRNG
+local ____utils = require("functions.utils")
+local ensureAllCases = ____utils.ensureAllCases
+local getEnumValues = ____utils.getEnumValues
+local ____vector = require("functions.vector")
+local copyVector = ____vector.copyVector
+local isSerializedVector = ____vector.isSerializedVector
+function ____exports.copySerializableIsaacAPIClass(self, isaacAPIClassOrSerializedTable, serializationType)
+    local isaacAPIClassType = getIsaacAPIClassType(nil, isaacAPIClassOrSerializedTable)
+    repeat
+        local ____switch3 = isaacAPIClassType
+        local ____cond3 = ____switch3 == SerializableIsaacAPIClassType.COLOR
+        if ____cond3 then
+            do
+                local color = isaacAPIClassOrSerializedTable
+                return copyColor(nil, color, serializationType)
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == SerializableIsaacAPIClassType.KCOLOR
+        if ____cond3 then
+            do
+                local kColor = isaacAPIClassOrSerializedTable
+                return copyKColor(nil, kColor, serializationType)
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == SerializableIsaacAPIClassType.RNG
+        if ____cond3 then
+            do
+                local rng = isaacAPIClassOrSerializedTable
+                return copyRNG(nil, rng)
+            end
+        end
+        ____cond3 = ____cond3 or ____switch3 == SerializableIsaacAPIClassType.VECTOR
+        if ____cond3 then
+            do
+                local vector = isaacAPIClassOrSerializedTable
+                return copyVector(nil, vector)
+            end
+        end
+        do
+            do
+                return ensureAllCases(nil, isaacAPIClassType)
+            end
+        end
+    until true
+end
+function ____exports.isSerializedIsaacAPIClass(self, object)
+    local objectType = type(object)
+    if objectType ~= "table" then
+        return false
+    end
+    local serializableIsaacAPIClassTypes = getEnumValues(nil, SerializableIsaacAPIClassType)
+    for ____, serializableIsaacAPIClassType in ipairs(serializableIsaacAPIClassTypes) do
+        repeat
+            local ____switch12 = serializableIsaacAPIClassType
+            local ____cond12 = ____switch12 == SerializableIsaacAPIClassType.COLOR
+            if ____cond12 then
+                do
+                    if isSerializedColor(nil, object) then
+                        return true
+                    end
+                    break
+                end
+            end
+            ____cond12 = ____cond12 or ____switch12 == SerializableIsaacAPIClassType.KCOLOR
+            if ____cond12 then
+                do
+                    if isSerializedKColor(nil, object) then
+                        return true
+                    end
+                    break
+                end
+            end
+            ____cond12 = ____cond12 or ____switch12 == SerializableIsaacAPIClassType.RNG
+            if ____cond12 then
+                do
+                    if isSerializedRNG(nil, object) then
+                        return true
+                    end
+                    break
+                end
+            end
+            ____cond12 = ____cond12 or ____switch12 == SerializableIsaacAPIClassType.VECTOR
+            if ____cond12 then
+                do
+                    if isSerializedVector(nil, object) then
+                        return true
+                    end
+                    break
+                end
+            end
+            do
+                do
+                    ensureAllCases(nil, serializableIsaacAPIClassType)
+                end
+            end
+        until true
+    end
+    return false
+end
+return ____exports

package/dist/functions/sprite.d.ts

@@ -24,3 +24,13 @@ export declare function clearSprite(sprite: Sprite, ...layerIDs: int[]): void;
  * as player animations.
  */
 export declare function getFinalFrameOfAnimation(sprite: Sprite, animation?: string): int;
+/**
+ * Helper function to check if two sprite layers have the same sprite sheet by using the
+ * `Sprite.GetTexel` method.
+ *
+ * Since checking every single texel in the entire sprite is very expensive, this function requires
+ * that you provide a range of specific texels to check.
+ */
+export declare function spriteEquals(sprite1: Sprite, sprite2: Sprite, layerID: int, xStart: int, xFinish: int, xIncrement: int, yStart: int, yFinish: int, yIncrement: int): boolean;
+/** Helper function to check if two texels on a sprite are equivalent to each other. */
+export declare function texelEquals(sprite1: Sprite, sprite2: Sprite, position: Vector, layerID: int): boolean;

package/dist/functions/sprite.lua

@@ -2,8 +2,15 @@
 local ____exports = {}
 local ____constants = require("constants")
 local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
+local ____kColor = require("functions.kColor")
+local kColorEquals = ____kColor.kColorEquals
 local ____math = require("functions.math")
 local range = ____math.range
+function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
+    local kColor1 = sprite1:GetTexel(position, Vector.Zero, 1, layerID)
+    local kColor2 = sprite2:GetTexel(position, Vector.Zero, 1, layerID)
+    return kColorEquals(nil, kColor1, kColor2)
+end
 function ____exports.clearSprite(self, sprite, ...)
     local layerIDs = {...}
     if #layerIDs == 0 then
@@ -29,4 +36,29 @@ function ____exports.getFinalFrameOfAnimation(self, sprite, animation)
     sprite:SetFrame(currentFrame)
     return finalFrame
 end
+function ____exports.spriteEquals(self, sprite1, sprite2, layerID, xStart, xFinish, xIncrement, yStart, yFinish, yIncrement)
+    do
+        local x = xStart
+        while x <= xFinish do
+            do
+                local y = yStart
+                while y <= yFinish do
+                    local position = Vector(x, y)
+                    if not ____exports.texelEquals(
+                        nil,
+                        sprite1,
+                        sprite2,
+                        position,
+                        layerID
+                    ) then
+                        return false
+                    end
+                    y = y + yIncrement
+                end
+            end
+            x = x + xIncrement
+        end
+    end
+    return true
+end
 return ____exports

package/dist/functions/table.d.ts

@@ -5,28 +5,28 @@
  */
 export declare function clearTable(table: LuaTable): void;
 /** Helper function to copy specific values from a object to a table. */
-export declare function copyValuesToTable(object: unknown, keys: string[], table: LuaTable<string, string | number>): void;
+export declare function copyValuesToTable(object: unknown, keys: string[], table: LuaTable<string, unknown>): void;
 /**
  * Helper function to safely get boolean values from a Lua table. Will throw an error if the
  * specific value does not exist on the table.
  *
  * This function is variadic, meaning that you can specify N arguments to get N values.
  */
-export declare function getBooleansFromTable(table: LuaTable<string, string | number>, objectName: string, ...keys: string[]): boolean[];
+export declare function getBooleansFromTable(table: LuaTable<string, unknown>, objectName: string, ...keys: string[]): boolean[];
 /**
  * Helper function to safely get number values from a Lua table. Will throw an error if the specific
  * value does not exist on the table or if it cannot be converted to a number.
  *
  * This function is variadic, meaning that you can specify N arguments to get N values.
  */
-export declare function getNumbersFromTable(table: LuaTable<string, string | number>, objectName: string, ...keys: string[]): number[];
+export declare function getNumbersFromTable(table: LuaTable<string, unknown>, objectName: string, ...keys: string[]): number[];
 /**
  * Helper function to safely get string values from a Lua table. Will throw an error if the specific
  * value does not exist on the table.
  *
  * This function is variadic, meaning that you can specify N arguments to get N values.
  */
-export declare function getStringsFromTable(table: LuaTable<string, string | number>, objectName: string, ...keys: string[]): string[];
+export declare function getStringsFromTable(table: LuaTable<string, unknown>, objectName: string, ...keys: string[]): string[];
 /**
  * Helper function to check if a Lua table has all of the provided keys.
  *

package/dist/functions/vector.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
-declare type SerializedVector = LuaTable<string, string | number>;
+declare type SerializedVector = LuaTable<string, unknown> & {
+    __serializedVectorBrand: unknown;
+};
 interface CopyVectorReturn {
     [SerializationType.NONE]: Vector;
     [SerializationType.SERIALIZE]: SerializedVector;
@@ -28,12 +30,13 @@ export declare function getOneVector(): Vector;
  */
 export declare function getZeroVector(): Vector;
 /**
- * Used to determine is the given table is a serialized Vector created by the save data manager
- * and/or the `deepCopy` function.
+ * Used to determine is the given table is a serialized `Vector` object created by the save data
+ * manager and/or the `deepCopy` function.
  */
 export declare function isSerializedVector(object: unknown): object is SerializedVector;
 /** Helper function to check if something is an instantiated Vector object. */
 export declare function isVector(object: unknown): object is Vector;
+export declare function vectorEquals(vector1: Vector, vector2: Vector): boolean;
 /** Helper function for finding out which way a vector is pointing. */
 export declare function vectorToDirection(vector: Vector): Direction;
 export {};

package/dist/functions/vector.lua

@@ -7,16 +7,17 @@ local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
 local ____directionToVector = require("objects.directionToVector")
 local DIRECTION_TO_VECTOR = ____directionToVector.DIRECTION_TO_VECTOR
+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 tableHasKeys = ____table.tableHasKeys
-local ____userdata = require("functions.userdata")
-local isUserdataObject = ____userdata.isUserdataObject
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 function ____exports.isVector(self, object)
-    return isUserdataObject(nil, object, OBJECT_NAME)
+    return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
 end
 local KEYS = {"X", "Y"}
 OBJECT_NAME = "Vector"
@@ -91,6 +92,9 @@ function ____exports.isSerializedVector(self, object)
         table.unpack(KEYS)
     ) and ____table[SerializationBrand.VECTOR] ~= nil
 end
+function ____exports.vectorEquals(self, vector1, vector2)
+    return isaacAPIClassEquals(nil, vector1, vector2, KEYS)
+end
 function ____exports.vectorToDirection(self, vector)
     local degrees = vector:GetAngleDegrees()
     if degrees > -45 and degrees < 45 then

package/dist/index.d.ts

@@ -51,8 +51,10 @@ export * from "./functions/flying";
 export * from "./functions/globals";
 export * from "./functions/gridEntity";
 export * from "./functions/input";
+export * from "./functions/isaacAPIClass";
 export * from "./functions/jsonHelpers";
 export * from "./functions/jsonRoom";
+export * from "./functions/kColor";
 export * from "./functions/language";
 export * from "./functions/log";
 export * from "./functions/map";
@@ -74,6 +76,7 @@ export * from "./functions/roomData";
 export * from "./functions/rooms";
 export * from "./functions/run";
 export * from "./functions/seeds";
+export * from "./functions/serialization";
 export * from "./functions/set";
 export * from "./functions/sound";
 export * from "./functions/spawnCollectible";
@@ -88,7 +91,6 @@ export * from "./functions/trinketGive";
 export * from "./functions/trinkets";
 export * from "./functions/trinketSet";
 export * from "./functions/ui";
-export * from "./functions/userdata";
 export * from "./functions/utils";
 export * from "./functions/vector";
 export * from "./maps/cardMap";