isaacscript-common 6.6.1-dev.2 → 6.6.1

package/dist/functions/tstlClass.lua

@@ -0,0 +1,112 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local newTSTLClassFromMetatable, VANILLA_TSTL_CLASSES
+local ____types = require("functions.types")
+local isString = ____types.isString
+local isTable = ____types.isTable
+--- 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 not isTable(nil, object) 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)
+    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 = {}
+    local newClassMetatable = setmetatable(newClass, metatable.constructor.prototype)
+    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 ____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)
+    if ____exports.isVanillaTSTLClass(nil, object) or ____exports.isIsaacScriptCommonClass(nil, object) then
+        return false
+    end
+    if not isTable(nil, object) then
+        return false
+    end
+    local metatable = getmetatable(object)
+    if metatable == nil then
+        return false
+    end
+    local numKeys = 0
+    for key in pairs(metatable) do
+        numKeys = numKeys + 1
+        if not isString(nil, key) then
+            return false
+        end
+        if not TSTL_CLASS_METATABLE_KEYS:has(key) then
+            return false
+        end
+    end
+    return numKeys == TSTL_CLASS_METATABLE_KEYS.size
+end
+--- Initializes a new TypeScriptToLua class in the situation where you do not know what kind of class
+-- it is. This function requires that you provide an instantiated class of the same type, as it will
+-- use the class constructor that is present on the other object's metatable to initialize the new
+-- class.
+function ____exports.newTSTLClass(self, oldClass)
+    local metatable = getmetatable(oldClass)
+    if metatable == nil then
+        error("Failed to instantiate a new TypeScriptToLua class since the provided old class does not have a metatable.")
+    end
+    return newTSTLClassFromMetatable(nil, metatable)
+end
+return ____exports

package/dist/functions/types.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+/// <reference types="lua-types/5.3" />
+export declare function isBoolean(variable: unknown): variable is boolean;
+export declare function isFunction(variable: unknown): variable is Function;
+export declare function isNumber(variable: unknown): variable is number;
+/** Helper function to detect if a variable is a boolean, number, or string. */
+export declare function isPrimitive(variable: unknown): variable is boolean | number | string;
+export declare function isString(variable: unknown): variable is string;
+export declare function isTable(variable: unknown): variable is LuaTable;
+export declare function isUserdata(variable: unknown): variable is LuaUserdata;
+//# sourceMappingURL=types.d.ts.map

package/dist/functions/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/types.ts"],"names":[],"mappings":";;AAAA,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,OAAO,CAEhE;AAGD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,QAAQ,CAElE;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,CACzB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,OAAO,GAAG,MAAM,GAAG,MAAM,CAOvC;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,wBAAgB,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,QAAQ,CAE/D;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,WAAW,CAErE"}

package/dist/functions/types.lua

@@ -0,0 +1,25 @@
+local ____exports = {}
+function ____exports.isBoolean(self, variable)
+    return type(variable) == "boolean"
+end
+function ____exports.isFunction(self, variable)
+    return type(variable) == "function"
+end
+function ____exports.isNumber(self, variable)
+    return type(variable) == "number"
+end
+--- Helper function to detect if a variable is a boolean, number, or string.
+function ____exports.isPrimitive(self, variable)
+    local variableType = type(variable)
+    return variableType == "boolean" or variableType == "number" or variableType == "string"
+end
+function ____exports.isString(self, variable)
+    return type(variable) == "string"
+end
+function ____exports.isTable(self, variable)
+    return type(variable) == "table"
+end
+function ____exports.isUserdata(self, variable)
+    return type(variable) == "userdata"
+end
+return ____exports

package/dist/functions/ui.d.ts

@@ -0,0 +1,39 @@
+/// <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
+ * on the first page of the menu. This is intended to be set by end-users to match their vanilla HUD
+ * offset setting so that mods can render UI elements to the screen in the correct position.
+ *
+ * @returns If the user does not have Mod Config Menu enabled, or does not have this option set,
+ *          then this function will return `Vector.Zero.` Otherwise, it will return a Vector that
+ *          represents a HUD offset that should be added to the position of a UI element.
+ */
+export declare function getHUDOffsetVector(): Vector;
+/**
+ * Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
+ * function will return 6.
+ */
+export declare function getHeartRowLength(player: EntityPlayer): int;
+/**
+ * Helper function to get the width of the first player's hearts on the UI. This is useful for
+ * drawing UI elements to the right of where the player's hearts are. Make sure to use this in
+ * combination with the the `getHUDOffsetVector` helper function.
+ */
+export declare function getHeartsUIWidth(): int;
+export declare function getScreenBottomCenterPos(): Vector;
+export declare function getScreenBottomLeftPos(): Vector;
+export declare function getScreenBottomRightPos(): Vector;
+export declare function getScreenCenterPos(): Vector;
+export declare function getScreenTopCenterPos(): Vector;
+export declare function getScreenTopLeftPos(): Vector;
+export declare function getScreenTopRightPos(): Vector;
+/**
+ * Get how many hearts are currently being shown on the hearts UI.
+ *
+ * This function is originally from piber20 Helper.
+ */
+export declare function getVisibleHearts(player: EntityPlayer): int;
+//# sourceMappingURL=ui.d.ts.map

package/dist/functions/ui.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/ui.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,CAqB3C;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAU3D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAgCtC;AAED,wBAAgB,wBAAwB,IAAI,MAAM,CAGjD;AAED,wBAAgB,sBAAsB,IAAI,MAAM,CAG/C;AAED,wBAAgB,uBAAuB,IAAI,MAAM,CAKhD;AAED,wBAAgB,kBAAkB,IAAI,MAAM,CAG3C;AAED,wBAAgB,qBAAqB,IAAI,MAAM,CAG9C;AAED,wBAAgB,mBAAmB,IAAI,MAAM,CAE5C;AAED,wBAAgB,oBAAoB,IAAI,MAAM,CAG7C;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAa1D"}

package/dist/functions/ui.lua

@@ -0,0 +1,119 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local LevelCurse = ____isaac_2Dtypescript_2Ddefinitions.LevelCurse
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("constants")
+local UI_HEART_WIDTH = ____constants.UI_HEART_WIDTH
+local VectorZero = ____constants.VectorZero
+local ____vector = require("functions.vector")
+local copyVector = ____vector.copyVector
+function ____exports.getScreenBottomRightPos(self)
+    local screenWidth = Isaac.GetScreenWidth()
+    local screenHeight = Isaac.GetScreenHeight()
+    return Vector(screenWidth, screenHeight)
+end
+--- 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
+-- on the first page of the menu. This is intended to be set by end-users to match their vanilla HUD
+-- offset setting so that mods can render UI elements to the screen in the correct position.
+-- 
+-- @returns If the user does not have Mod Config Menu enabled, or does not have this option set,
+-- then this function will return `Vector.Zero.` Otherwise, it will return a Vector that
+-- represents a HUD offset that should be added to the position of a UI element.
+function ____exports.getHUDOffsetVector(self)
+    local defaultVector = copyVector(nil, VectorZero)
+    local hudOffset = math.floor(Options.HUDOffset * 10)
+    if hudOffset < 1 or hudOffset > 10 then
+        return defaultVector
+    end
+    local x = hudOffset * 2
+    local y = hudOffset
+    if y >= 4 then
+        y = y + 1
+    end
+    if y >= 9 then
+        y = y + 1
+    end
+    return Vector(x, y)
+end
+--- Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
+-- function will return 6.
+function ____exports.getHeartRowLength(self, player)
+    local maxHearts = player:GetMaxHearts()
+    local soulHearts = player:GetSoulHearts()
+    local boneHearts = player:GetBoneHearts()
+    local combinedHearts = maxHearts + soulHearts + boneHearts * 2
+    local heartRowLength = combinedHearts / 2
+    return math.min(heartRowLength, 6)
+end
+--- Helper function to get the width of the first player's hearts on the UI. This is useful for
+-- drawing UI elements to the right of where the player's hearts are. Make sure to use this in
+-- combination with the the `getHUDOffsetVector` helper function.
+function ____exports.getHeartsUIWidth(self)
+    local level = game:GetLevel()
+    local curses = level:GetCurses()
+    local player = Isaac.GetPlayer()
+    local extraLives = player:GetExtraLives()
+    local effects = player:GetEffects()
+    local hasHolyMantleEffect = effects:HasCollectibleEffect(CollectibleType.HOLY_MANTLE)
+    local heartRowLength = ____exports.getHeartRowLength(nil, player)
+    if hasHolyMantleEffect then
+        heartRowLength = heartRowLength + 1
+    end
+    if curses == LevelCurse.UNKNOWN then
+        heartRowLength = 1
+    end
+    local width = heartRowLength * UI_HEART_WIDTH
+    if extraLives > 9 then
+        width = width + 20
+        if player:HasCollectible(CollectibleType.GUPPYS_COLLAR) then
+            width = width + 6
+        end
+    elseif extraLives > 0 then
+        width = width + 16
+        if player:HasCollectible(CollectibleType.GUPPYS_COLLAR) then
+            width = width + 4
+        end
+    end
+    return width
+end
+function ____exports.getScreenBottomCenterPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRight.X / 2, bottomRight.Y)
+end
+function ____exports.getScreenBottomLeftPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(0, bottomRight.Y)
+end
+function ____exports.getScreenCenterPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return bottomRight / 2
+end
+function ____exports.getScreenTopCenterPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRight.X / 2, 0)
+end
+function ____exports.getScreenTopLeftPos(self)
+    return copyVector(nil, VectorZero)
+end
+function ____exports.getScreenTopRightPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRight.X, 0)
+end
+--- Get how many hearts are currently being shown on the hearts UI.
+-- 
+-- This function is originally from piber20 Helper.
+function ____exports.getVisibleHearts(self, player)
+    local effectiveMaxHearts = player:GetEffectiveMaxHearts()
+    local soulHearts = player:GetSoulHearts()
+    local boneHearts = player:GetBoneHearts()
+    local maxHearts = math.max(effectiveMaxHearts, boneHearts * 2)
+    local visibleHearts = math.ceil((maxHearts + soulHearts) / 2)
+    if visibleHearts < 1 then
+        visibleHearts = 1
+    end
+    return visibleHearts
+end
+return ____exports

package/dist/functions/utils.d.ts

@@ -0,0 +1,98 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to return an array with the elements from start to end. It is inclusive at the
+ * start and exclusive at the end. (The "e" stands for exclusive.)
+ *
+ * If only one argument is specified, then it will assume that the start is 0.
+ *
+ * - For example, `erange(1, 3)` will return `[1, 2]`.
+ * - For example, `erange(2)` will return `[0, 1]`.
+ */
+export declare function erange(start: int, end?: int): int[];
+/**
+ * Helper function to log what is happening in functions that recursively move through nested data
+ * structures.
+ */
+export declare function getTraversalDescription(key: unknown, traversalDescription: string): string;
+/**
+ * Converts a hex string like "#33aa33" to a KColor object.
+ *
+ * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
+ */
+export declare function hexToKColor(hexString: string, alpha: float): KColor;
+/**
+ * Helper function to return an array with the elements from start to end, inclusive. (The "i"
+ * stands for inclusive.)
+ *
+ * If only one argument is specified, then it will assume that the start is 0.
+ *
+ * - For example, `irange(1, 3)` will return `[1, 2, 3]`.
+ * - For example, `irange(2)` will return `[0, 1, 2]`.
+ */
+export declare function irange(start: int, end?: int): int[];
+/**
+ * Since this is a UI element, we do not want to draw it in water reflections. `renderOffset` will
+ * be a non-zero value in reflections.
+ */
+export declare function isReflectionRender(): boolean;
+/**
+ * Helper function to see if a particular command is a vanilla console command. This is useful
+ * because the `EXECUTE_CMD` callback will not fire for any vanilla commands.
+ */
+export declare function isVanillaConsoleCommand(commandName: string): boolean;
+/**
+ * Helper function to print something to the in-game console. Use this instead of invoking the
+ * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end
+ * of the message (which `Isaac.ConsoleOutput` does not do by default).
+ */
+export declare function printConsole(msg: string): void;
+/** Helper function to print whether something was enabled or disabled to the in-game console. */
+export declare function printEnabled(enabled: boolean, description: string): void;
+/**
+ * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
+ *
+ * For example:
+ *
+ * ```ts
+ * const player = Isaac.GetPlayer();
+ * repeat(10, () => {
+ *   player.AddCollectible(CollectibleType.STEVEN);
+ * });
+ * ```
+ *
+ * The repeated function is passed the index of the iteration, if needed:
+ *
+ * ```ts
+ * repeat(3, (i) => {
+ *   print(i); // Prints "0", "1", "2"
+ * });
+ * ```
+ */
+export declare function repeat(n: int, func: (i: int) => void): void;
+/**
+ * Helper function to signify that the enclosing code block is not yet complete. Using this function
+ * is similar to writing a "TODO" comment, but it has the benefit of preventing ESLint errors due to
+ * early returns.
+ *
+ * When you see this function, it simply means that the programmer intends to add in more code to
+ * this spot later.
+ *
+ * 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;
+//# sourceMappingURL=utils.d.ts.map

package/dist/functions/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/utils.ts"],"names":[],"mappings":";;AAMA;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAYnD;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,oBAAoB,EAAE,MAAM,GAC3B,MAAM,CAQR;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,CA2BnE;AAED;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAYnD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAI5C;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAEpE;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAE9C;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAGxE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAI3D;AAED;;;;;;;;;GASG;AACH,wBAAgB,IAAI,IAAI,IAAI,CAAG;AAE/B;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAYhE"}

package/dist/functions/utils.lua

@@ -0,0 +1,171 @@
+local ____lualib = require("lualib_bundle")
+local __TS__StringReplace = ____lualib.__TS__StringReplace
+local __TS__StringSubstr = ____lualib.__TS__StringSubstr
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local RenderMode = ____isaac_2Dtypescript_2Ddefinitions.RenderMode
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____consoleCommandsSet = require("sets.consoleCommandsSet")
+local CONSOLE_COMMANDS_SET = ____consoleCommandsSet.CONSOLE_COMMANDS_SET
+local HEX_STRING_LENGTH = 6
+--- Helper function to return an array with the elements from start to end. It is inclusive at the
+-- start and exclusive at the end. (The "e" stands for exclusive.)
+-- 
+-- If only one argument is specified, then it will assume that the start is 0.
+-- 
+-- - For example, `erange(1, 3)` will return `[1, 2]`.
+-- - For example, `erange(2)` will return `[0, 1]`.
+function ____exports.erange(self, start, ____end)
+    if ____end == nil then
+        ____end = start
+        start = 0
+    end
+    local array = {}
+    do
+        local i = start
+        while i < ____end do
+            array[#array + 1] = i
+            i = i + 1
+        end
+    end
+    return array
+end
+--- Helper function to log what is happening in functions that recursively move through nested data
+-- structures.
+function ____exports.getTraversalDescription(self, key, traversalDescription)
+    if traversalDescription ~= "" then
+        traversalDescription = traversalDescription .. " --> "
+    end
+    traversalDescription = traversalDescription .. tostring(key)
+    return traversalDescription
+end
+--- Converts a hex string like "#33aa33" to a KColor object.
+-- 
+-- @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
+function ____exports.hexToKColor(self, hexString, alpha)
+    hexString = __TS__StringReplace(hexString, "#", "")
+    if #hexString ~= HEX_STRING_LENGTH then
+        error(("Hex strings must be of length " .. tostring(HEX_STRING_LENGTH)) .. ".")
+    end
+    local rString = __TS__StringSubstr(hexString, 0, 2)
+    local R = tonumber("0x" .. rString)
+    if R == nil then
+        error(("Failed to convert `0x" .. rString) .. "` to a number.")
+    end
+    local gString = __TS__StringSubstr(hexString, 2, 2)
+    local G = tonumber("0x" .. gString)
+    if G == nil then
+        error(("Failed to convert `0x" .. gString) .. "` to a number.")
+    end
+    local bString = __TS__StringSubstr(hexString, 4, 2)
+    local B = tonumber("0x" .. bString)
+    if B == nil then
+        error(("Failed to convert `0x" .. bString) .. "` to a number.")
+    end
+    local base = 255
+    return KColor(R / base, G / base, B / base, alpha)
+end
+--- Helper function to return an array with the elements from start to end, inclusive. (The "i"
+-- stands for inclusive.)
+-- 
+-- If only one argument is specified, then it will assume that the start is 0.
+-- 
+-- - For example, `irange(1, 3)` will return `[1, 2, 3]`.
+-- - For example, `irange(2)` will return `[0, 1, 2]`.
+function ____exports.irange(self, start, ____end)
+    if ____end == nil then
+        ____end = start
+        start = 0
+    end
+    local array = {}
+    do
+        local i = start
+        while i <= ____end do
+            array[#array + 1] = i
+            i = i + 1
+        end
+    end
+    return array
+end
+--- Since this is a UI element, we do not want to draw it in water reflections. `renderOffset` will
+-- be a non-zero value in reflections.
+function ____exports.isReflectionRender(self)
+    local room = game:GetRoom()
+    local renderMode = room:GetRenderMode()
+    return renderMode == RenderMode.WATER_REFLECT
+end
+--- Helper function to see if a particular command is a vanilla console command. This is useful
+-- because the `EXECUTE_CMD` callback will not fire for any vanilla commands.
+function ____exports.isVanillaConsoleCommand(self, commandName)
+    return CONSOLE_COMMANDS_SET:has(commandName)
+end
+--- Helper function to print something to the in-game console. Use this instead of invoking the
+-- `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end
+-- of the message (which `Isaac.ConsoleOutput` does not do by default).
+function ____exports.printConsole(self, msg)
+    Isaac.ConsoleOutput(msg .. "\n")
+end
+--- Helper function to print whether something was enabled or disabled to the in-game console.
+function ____exports.printEnabled(self, enabled, description)
+    local enabledText = enabled and "Enabled" or "Disabled"
+    ____exports.printConsole(nil, ((enabledText .. " ") .. description) .. ".")
+end
+--- Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const player = Isaac.GetPlayer();
+-- repeat(10, () => {
+--   player.AddCollectible(CollectibleType.STEVEN);
+-- });
+-- ```
+-- 
+-- The repeated function is passed the index of the iteration, if needed:
+-- 
+-- ```ts
+-- repeat(3, (i) => {
+--   print(i); // Prints "0", "1", "2"
+-- });
+-- ```
+____exports["repeat"] = function(self, n, func)
+    do
+        local i = 0
+        while i < n do
+            func(nil, i)
+            i = i + 1
+        end
+    end
+end
+--- Helper function to signify that the enclosing code block is not yet complete. Using this function
+-- is similar to writing a "TODO" comment, but it has the benefit of preventing ESLint errors due to
+-- early returns.
+-- 
+-- When you see this function, it simply means that the programmer intends to add in more code to
+-- this spot later.
+-- 
+-- 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/dist/functions/vector.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+import { Direction } from "isaac-typescript-definitions";
+import { SerializationType } from "../enums/SerializationType";
+declare type SerializedVector = LuaTable<string, unknown> & {
+    readonly __serializedVectorBrand: symbol;
+};
+interface CopyVectorReturn {
+    [SerializationType.NONE]: Vector;
+    [SerializationType.SERIALIZE]: SerializedVector;
+    [SerializationType.DESERIALIZE]: Vector;
+}
+/**
+ * Helper function to copy a `Vector` object.
+ *
+ * @param vector The vector to copy. In the case of deserialization, this will actually be a Lua
+ *               table instead of an instantiated Vector class.
+ * @param serializationType Default is `SerializationType.NONE`.
+ */
+export declare function copyVector<V extends Vector | SerializedVector, S extends SerializationType>(vector: V, serializationType: S): CopyVectorReturn[S];
+export declare function copyVector<V extends Vector | SerializedVector>(vector: V): CopyVectorReturn[SerializationType.NONE];
+/**
+ * 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 declare function vectorToString(vector: Vector, round?: boolean): string;
+export {};
+//# sourceMappingURL=vector.d.ts.map

package/dist/functions/vector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAM/D,aAAK,gBAAgB,GAAG,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAClD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC1C,CAAC;AAEF,UAAU,gBAAgB;IACxB,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACjC,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAChD,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CACzC;AAKD;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,CAAC,SAAS,MAAM,GAAG,gBAAgB,EACnC,CAAC,SAAS,iBAAiB,EAC3B,MAAM,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;AACxD,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,GAAG,gBAAgB,EAC5D,MAAM,EAAE,CAAC,GACR,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;AA0D5C;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,8EAA8E;AAC9E,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}