isaacscript-common 6.6.1-dev.1 → 6.6.1-dev.2

package/functions/trinkets.js

@@ -0,0 +1,169 @@
+import { PlayerType, TrinketSlot, TrinketType, } from "isaac-typescript-definitions";
+import { itemConfig } from "../cachedClasses";
+import { FIRST_MODDED_TRINKET_TYPE, FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE, LAST_VANILLA_TRINKET_TYPE, } from "../constantsFirstLast";
+import { DEFAULT_TRINKET_DESCRIPTION, TRINKET_DESCRIPTION_MAP, } from "../maps/trinketDescriptionMap";
+import { DEFAULT_TRINKET_NAME, TRINKET_NAME_MAP } from "../maps/trinketNameMap";
+import { getEntityID } from "./entity";
+import { hasFlag } from "./flag";
+import { isTrinket } from "./pickupVariants";
+import { isCharacter } from "./player";
+import { clearSprite } from "./sprite";
+import { irange } from "./utils";
+/**
+ * Add this to a `TrinketType` to get the corresponding golden trinket type.
+ *
+ * Corresponds to the vanilla `PillColor.TRINKET_GOLDEN_FLAG` value.
+ *
+ * 1 << 15
+ */
+const GOLDEN_TRINKET_ADJUSTMENT = 32768;
+const TRINKET_SPRITE_LAYER = 0;
+/**
+ * Helper function to get the corresponding golden trinket type from a normal trinket type.
+ *
+ * For example, passing `TrinketType.SWALLOWED_PENNY` would result in 32769, which is the value that
+ * corresponds to the golden trinket sub-type for Swallowed Penny.
+ */
+export function getGoldenTrinketType(trinketType) {
+    return trinketType + GOLDEN_TRINKET_ADJUSTMENT; // eslint-disable-line isaacscript/strict-enums
+}
+/**
+ * Helper function to get an array that represents every modded trinket type.
+ *
+ * Returns an empty array if there are no modded trinket types.
+ */
+export function getModdedTrinketTypes() {
+    if (LAST_VANILLA_TRINKET_TYPE === LAST_TRINKET_TYPE) {
+        return [];
+    }
+    return irange(FIRST_MODDED_TRINKET_TYPE, LAST_TRINKET_TYPE);
+}
+/**
+ * Returns the slot number corresponding to where a trinket can be safely inserted.
+ *
+ * For example:
+ *
+ * ```ts
+ * const player = Isaac.GetPlayer();
+ * const trinketSlot = getOpenTrinketSlotNum(player);
+ * if (trinketSlot !== undefined) {
+ *   // They have one or more open trinket slots
+ *   player.AddTrinket(TrinketType.SWALLOWED_PENNY);
+ * }
+ * ```
+ */
+export function getOpenTrinketSlot(player) {
+    const maxTrinkets = player.GetMaxTrinkets();
+    const trinketType1 = player.GetTrinket(TrinketSlot.SLOT_1);
+    const trinketType2 = player.GetTrinket(TrinketSlot.SLOT_2);
+    if (maxTrinkets === 1) {
+        return trinketType1 === TrinketType.NULL ? 0 : undefined;
+    }
+    if (maxTrinkets === 2) {
+        if (trinketType1 === TrinketType.NULL) {
+            return 0;
+        }
+        return trinketType2 === TrinketType.NULL ? 1 : undefined;
+    }
+    error(`The player has an unknown number of trinket slots: ${maxTrinkets}`);
+}
+/**
+ * Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
+ * trinket type was not valid.
+ */
+export function getTrinketDescription(trinketType) {
+    // "ItemConfigItem.Description" is bugged with vanilla items on patch v1.7.6, so we use a
+    // hard-coded map as a workaround.
+    const trinketDescription = TRINKET_DESCRIPTION_MAP.get(trinketType);
+    if (trinketDescription !== undefined) {
+        return trinketDescription;
+    }
+    const itemConfigItem = itemConfig.GetTrinket(trinketType);
+    if (itemConfigItem !== undefined) {
+        return itemConfigItem.Description;
+    }
+    return DEFAULT_TRINKET_DESCRIPTION;
+}
+/**
+ * Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
+ * not valid.
+ *
+ * For example:
+ *
+ * ```ts
+ * const trinketType = TrinketType.SWALLOWED_PENNY;
+ * const trinketName = getTrinketName(trinketType); // trinketName is "Swallowed Penny"
+ * ```
+ */
+export function getTrinketName(trinketType) {
+    // "ItemConfigItem.Name" is bugged with vanilla items on patch v1.7.6, so we use a hard-coded map
+    // as a workaround.
+    const trinketName = TRINKET_NAME_MAP.get(trinketType);
+    if (trinketName !== undefined) {
+        return trinketName;
+    }
+    const itemConfigItem = itemConfig.GetTrinket(trinketType);
+    if (itemConfigItem !== undefined) {
+        return itemConfigItem.Name;
+    }
+    return DEFAULT_TRINKET_NAME;
+}
+/** Helper function to get an array that contains every trinket type. */
+export function getTrinketTypes() {
+    return irange(FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE);
+}
+/** Helper function to get an array that represents every vanilla trinket type. */
+export function getVanillaTrinketTypes() {
+    return irange(FIRST_TRINKET_TYPE, LAST_VANILLA_TRINKET_TYPE);
+}
+/**
+ * Returns whether or not the player can hold an additional trinket, beyond what they are currently
+ * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
+ *
+ * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
+ * items. (Only Tainted Forgotten can pick up items.)
+ */
+export function hasOpenTrinketSlot(player) {
+    if (isCharacter(player, PlayerType.THE_SOUL_B)) {
+        return false;
+    }
+    const openTrinketSlot = getOpenTrinketSlot(player);
+    return openTrinketSlot !== undefined;
+}
+export function isGoldenTrinket(trinketType) {
+    return trinketType > GOLDEN_TRINKET_ADJUSTMENT;
+}
+/**
+ * Helper function to change the sprite of a trinket entity.
+ *
+ * For more information about removing the trinket sprite, see the documentation for the
+ * "clearSprite" helper function.
+ *
+ * @param trinket The trinket whose sprite you want to modify.
+ * @param pngPath Equal to either the spritesheet path to load (e.g.
+ *                "gfx/items/trinkets/trinket_001_swallowedpenny.png") or undefined. If undefined,
+ *                the sprite will be removed, making it appear like the collectible has already been
+ *                taken by the player.
+ */
+export function setTrinketSprite(trinket, pngPath) {
+    if (!isTrinket(trinket)) {
+        const entityID = getEntityID(trinket);
+        error(`The "setTrinketSprite" function was given a non-trinket: ${entityID}`);
+    }
+    const sprite = trinket.GetSprite();
+    if (pngPath === undefined) {
+        clearSprite(sprite, TRINKET_SPRITE_LAYER);
+    }
+    else {
+        sprite.ReplaceSpritesheet(TRINKET_SPRITE_LAYER, pngPath);
+        sprite.LoadGraphics();
+    }
+}
+export function trinketHasCacheFlag(trinketType, cacheFlag) {
+    const itemConfigItem = itemConfig.GetTrinket(trinketType);
+    if (itemConfigItem === undefined) {
+        return false;
+    }
+    return hasFlag(itemConfigItem.CacheFlags, cacheFlag);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJpbmtldHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9pc2FhY3NjcmlwdC1jb21tb24vc3JjL2Z1bmN0aW9ucy90cmlua2V0cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBRUwsVUFBVSxFQUNWLFdBQVcsRUFDWCxXQUFXLEdBQ1osTUFBTSw4QkFBOEIsQ0FBQztBQUN0QyxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFDOUMsT0FBTyxFQUNMLHlCQUF5QixFQUN6QixrQkFBa0IsRUFDbEIsaUJBQWlCLEVBQ2pCLHlCQUF5QixHQUMxQixNQUFNLHVCQUF1QixDQUFDO0FBQy9CLE9BQU8sRUFDTCwyQkFBMkIsRUFDM0IsdUJBQXVCLEdBQ3hCLE1BQU0sK0JBQStCLENBQUM7QUFDdkMsT0FBTyxFQUFFLG9CQUFvQixFQUFFLGdCQUFnQixFQUFFLE1BQU0sd0JBQXdCLENBQUM7QUFDaEYsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLFVBQVUsQ0FBQztBQUN2QyxPQUFPLEVBQUUsT0FBTyxFQUFFLE1BQU0sUUFBUSxDQUFDO0FBQ2pDLE9BQU8sRUFBRSxTQUFTLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUM3QyxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBQ3ZDLE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSxVQUFVLENBQUM7QUFDdkMsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLFNBQVMsQ0FBQztBQUVqQzs7Ozs7O0dBTUc7QUFDSCxNQUFNLHlCQUF5QixHQUFHLEtBQUssQ0FBQztBQUV4QyxNQUFNLG9CQUFvQixHQUFHLENBQUMsQ0FBQztBQUUvQjs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxvQkFBb0IsQ0FBQyxXQUF3QjtJQUMzRCxPQUFPLFdBQVcsR0FBRyx5QkFBeUIsQ0FBQyxDQUFDLCtDQUErQztBQUNqRyxDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSxxQkFBcUI7SUFDbkMsSUFBSSx5QkFBeUIsS0FBSyxpQkFBaUIsRUFBRTtRQUNuRCxPQUFPLEVBQUUsQ0FBQztLQUNYO0lBRUQsT0FBTyxNQUFNLENBQUMseUJBQXlCLEVBQUUsaUJBQWlCLENBQWtCLENBQUM7QUFDL0UsQ0FBQztBQUVEOzs7Ozs7Ozs7Ozs7O0dBYUc7QUFDSCxNQUFNLFVBQVUsa0JBQWtCLENBQUMsTUFBb0I7SUFDckQsTUFBTSxXQUFXLEdBQUcsTUFBTSxDQUFDLGNBQWMsRUFBRSxDQUFDO0lBQzVDLE1BQU0sWUFBWSxHQUFHLE1BQU0sQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQzNELE1BQU0sWUFBWSxHQUFHLE1BQU0sQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBRTNELElBQUksV0FBVyxLQUFLLENBQUMsRUFBRTtRQUNyQixPQUFPLFlBQVksS0FBSyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQztLQUMxRDtJQUVELElBQUksV0FBVyxLQUFLLENBQUMsRUFBRTtRQUNyQixJQUFJLFlBQVksS0FBSyxXQUFXLENBQUMsSUFBSSxFQUFFO1lBQ3JDLE9BQU8sQ0FBQyxDQUFDO1NBQ1Y7UUFFRCxPQUFPLFlBQVksS0FBSyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQztLQUMxRDtJQUVELEtBQUssQ0FBQyxzREFBc0QsV0FBVyxFQUFFLENBQUMsQ0FBQztBQUM3RSxDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLHFCQUFxQixDQUFDLFdBQXdCO0lBQzVELHlGQUF5RjtJQUN6RixrQ0FBa0M7SUFDbEMsTUFBTSxrQkFBa0IsR0FBRyx1QkFBdUIsQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDcEUsSUFBSSxrQkFBa0IsS0FBSyxTQUFTLEVBQUU7UUFDcEMsT0FBTyxrQkFBa0IsQ0FBQztLQUMzQjtJQUVELE1BQU0sY0FBYyxHQUFHLFVBQVUsQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDMUQsSUFBSSxjQUFjLEtBQUssU0FBUyxFQUFFO1FBQ2hDLE9BQU8sY0FBYyxDQUFDLFdBQVcsQ0FBQztLQUNuQztJQUVELE9BQU8sMkJBQTJCLENBQUM7QUFDckMsQ0FBQztBQUVEOzs7Ozs7Ozs7O0dBVUc7QUFDSCxNQUFNLFVBQVUsY0FBYyxDQUFDLFdBQXdCO0lBQ3JELGlHQUFpRztJQUNqRyxtQkFBbUI7SUFDbkIsTUFBTSxXQUFXLEdBQUcsZ0JBQWdCLENBQUMsR0FBRyxDQUFDLFdBQVcsQ0FBQyxDQUFDO0lBQ3RELElBQUksV0FBVyxLQUFLLFNBQVMsRUFBRTtRQUM3QixPQUFPLFdBQVcsQ0FBQztLQUNwQjtJQUVELE1BQU0sY0FBYyxHQUFHLFVBQVUsQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDMUQsSUFBSSxjQUFjLEtBQUssU0FBUyxFQUFFO1FBQ2hDLE9BQU8sY0FBYyxDQUFDLElBQUksQ0FBQztLQUM1QjtJQUVELE9BQU8sb0JBQW9CLENBQUM7QUFDOUIsQ0FBQztBQUVELHdFQUF3RTtBQUN4RSxNQUFNLFVBQVUsZUFBZTtJQUM3QixPQUFPLE1BQU0sQ0FBQyxrQkFBa0IsRUFBRSxpQkFBaUIsQ0FBa0IsQ0FBQztBQUN4RSxDQUFDO0FBRUQsa0ZBQWtGO0FBQ2xGLE1BQU0sVUFBVSxzQkFBc0I7SUFDcEMsT0FBTyxNQUFNLENBQUMsa0JBQWtCLEVBQUUseUJBQXlCLENBQWtCLENBQUM7QUFDaEYsQ0FBQztBQUVEOzs7Ozs7R0FNRztBQUNILE1BQU0sVUFBVSxrQkFBa0IsQ0FBQyxNQUFvQjtJQUNyRCxJQUFJLFdBQVcsQ0FBQyxNQUFNLEVBQUUsVUFBVSxDQUFDLFVBQVUsQ0FBQyxFQUFFO1FBQzlDLE9BQU8sS0FBSyxDQUFDO0tBQ2Q7SUFFRCxNQUFNLGVBQWUsR0FBRyxrQkFBa0IsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNuRCxPQUFPLGVBQWUsS0FBSyxTQUFTLENBQUM7QUFDdkMsQ0FBQztBQUVELE1BQU0sVUFBVSxlQUFlLENBQUMsV0FBd0I7SUFDdEQsT0FBTyxXQUFXLEdBQUkseUJBQXlDLENBQUM7QUFDbEUsQ0FBQztBQUVEOzs7Ozs7Ozs7OztHQVdHO0FBQ0gsTUFBTSxVQUFVLGdCQUFnQixDQUM5QixPQUFxQixFQUNyQixPQUEyQjtJQUUzQixJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxFQUFFO1FBQ3ZCLE1BQU0sUUFBUSxHQUFHLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUN0QyxLQUFLLENBQ0gsNERBQTRELFFBQVEsRUFBRSxDQUN2RSxDQUFDO0tBQ0g7SUFFRCxNQUFNLE1BQU0sR0FBRyxPQUFPLENBQUMsU0FBUyxFQUFFLENBQUM7SUFDbkMsSUFBSSxPQUFPLEtBQUssU0FBUyxFQUFFO1FBQ3pCLFdBQVcsQ0FBQyxNQUFNLEVBQUUsb0JBQW9CLENBQUMsQ0FBQztLQUMzQztTQUFNO1FBQ0wsTUFBTSxDQUFDLGtCQUFrQixDQUFDLG9CQUFvQixFQUFFLE9BQU8sQ0FBQyxDQUFDO1FBQ3pELE1BQU0sQ0FBQyxZQUFZLEVBQUUsQ0FBQztLQUN2QjtBQUNILENBQUM7QUFFRCxNQUFNLFVBQVUsbUJBQW1CLENBQ2pDLFdBQXdCLEVBQ3hCLFNBQW9CO0lBRXBCLE1BQU0sY0FBYyxHQUFHLFVBQVUsQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDMUQsSUFBSSxjQUFjLEtBQUssU0FBUyxFQUFFO1FBQ2hDLE9BQU8sS0FBSyxDQUFDO0tBQ2Q7SUFFRCxPQUFPLE9BQU8sQ0FBQyxjQUFjLENBQUMsVUFBVSxFQUFFLFNBQVMsQ0FBQyxDQUFDO0FBQ3ZELENBQUMifQ==

package/functions/tstlClass.js

@@ -0,0 +1,125 @@
+import { isString, isTable } from "./types";
+const VANILLA_TSTL_CLASSES = new Set(["Map", "Set", "WeakMap", "WeakSet"]);
+const TSTL_CLASS_METATABLE_KEYS = new Set([
+    "____constructor",
+    "__index",
+    "constructor",
+]);
+/**
+ * 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 function getTSTLClassName(object) {
+    if (!isTable(object)) {
+        return undefined;
+    }
+    const metatable = getmetatable(object);
+    if (metatable === undefined) {
+        return undefined;
+    }
+    const { constructor } = metatable;
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (constructor === undefined) {
+        return undefined;
+    }
+    return constructor.name;
+}
+/**
+ * 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 function isDefaultMap(object) {
+    const className = getTSTLClassName(object);
+    return className === "DefaultMap";
+}
+/**
+ * Returns whether or not this is a class that is provided by the `isaacscript-common` library, such
+ * as a `DefaultMap`.
+ */
+export function isIsaacScriptCommonClass(object) {
+    return isDefaultMap(object);
+}
+/**
+ * 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 function isTSTLMap(object) {
+    const className = getTSTLClassName(object);
+    return className === "Map";
+}
+/**
+ * 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 function isTSTLSet(object) {
+    const className = getTSTLClassName(object);
+    return className === "Set";
+}
+/** TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys. */
+export function isUserDefinedTSTLClass(object) {
+    if (isVanillaTSTLClass(object) || isIsaacScriptCommonClass(object)) {
+        return false;
+    }
+    if (!isTable(object)) {
+        return false;
+    }
+    const metatable = getmetatable(object);
+    if (metatable === undefined) {
+        return false;
+    }
+    let numKeys = 0;
+    for (const [key] of pairs(metatable)) {
+        numKeys += 1;
+        if (!isString(key)) {
+            return false;
+        }
+        if (!TSTL_CLASS_METATABLE_KEYS.has(key)) {
+            return false;
+        }
+    }
+    return numKeys === TSTL_CLASS_METATABLE_KEYS.size;
+}
+/**
+ * Returns whether or not this is a class that is provided as part of the TypeScriptToLua
+ * transpiler, such as a `Map` or a `Set`.
+ */
+export function isVanillaTSTLClass(object) {
+    const className = getTSTLClassName(object);
+    if (className === undefined) {
+        return false;
+    }
+    return VANILLA_TSTL_CLASSES.has(className);
+}
+/**
+ * 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.
+ */
+export function newTSTLClass(oldClass) {
+    const metatable = getmetatable(oldClass);
+    if (metatable === undefined) {
+        error("Failed to instantiate a new TypeScriptToLua class since the provided old class does not have a metatable.");
+    }
+    return newTSTLClassFromMetatable(metatable);
+}
+/** This is a re-implementation of the transpiled "__TS__New" function. */
+function newTSTLClassFromMetatable(metatable) {
+    const newClass = new LuaTable();
+    const newClassMetatable = setmetatable(newClass, metatable.constructor.prototype);
+    newClassMetatable.____constructor(); // eslint-disable-line no-underscore-dangle
+    return newClass;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHN0bENsYXNzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vcGFja2FnZXMvaXNhYWNzY3JpcHQtY29tbW9uL3NyYy9mdW5jdGlvbnMvdHN0bENsYXNzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUdBLE9BQU8sRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLE1BQU0sU0FBUyxDQUFDO0FBRTVDLE1BQU0sb0JBQW9CLEdBQUcsSUFBSSxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsS0FBSyxFQUFFLFNBQVMsRUFBRSxTQUFTLENBQUMsQ0FBQyxDQUFDO0FBRTNFLE1BQU0seUJBQXlCLEdBQXdCLElBQUksR0FBRyxDQUFDO0lBQzdELGlCQUFpQjtJQUNqQixTQUFTO0lBQ1QsYUFBYTtDQUNkLENBQUMsQ0FBQztBQUVIOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sVUFBVSxnQkFBZ0IsQ0FBQyxNQUFlO0lBQzlDLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUU7UUFDcEIsT0FBTyxTQUFTLENBQUM7S0FDbEI7SUFFRCxNQUFNLFNBQVMsR0FBRyxZQUFZLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDdkMsSUFBSSxTQUFTLEtBQUssU0FBUyxFQUFFO1FBQzNCLE9BQU8sU0FBUyxDQUFDO0tBQ2xCO0lBRUQsTUFBTSxFQUFFLFdBQVcsRUFBRSxHQUFHLFNBQVMsQ0FBQztJQUNsQyx1RUFBdUU7SUFDdkUsSUFBSSxXQUFXLEtBQUssU0FBUyxFQUFFO1FBQzdCLE9BQU8sU0FBUyxDQUFDO0tBQ2xCO0lBRUQsT0FBTyxXQUFXLENBQUMsSUFBSSxDQUFDO0FBQzFCLENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxZQUFZLENBQzFCLE1BQWU7SUFFZixNQUFNLFNBQVMsR0FBRyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUMzQyxPQUFPLFNBQVMsS0FBSyxZQUFZLENBQUM7QUFDcEMsQ0FBQztBQUVEOzs7R0FHRztBQUNILE1BQU0sVUFBVSx3QkFBd0IsQ0FBQyxNQUFlO0lBQ3RELE9BQU8sWUFBWSxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQzlCLENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxTQUFTLENBQUMsTUFBZTtJQUN2QyxNQUFNLFNBQVMsR0FBRyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUMzQyxPQUFPLFNBQVMsS0FBSyxLQUFLLENBQUM7QUFDN0IsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLFNBQVMsQ0FBQyxNQUFlO0lBQ3ZDLE1BQU0sU0FBUyxHQUFHLGdCQUFnQixDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQzNDLE9BQU8sU0FBUyxLQUFLLEtBQUssQ0FBQztBQUM3QixDQUFDO0FBRUQsa0dBQWtHO0FBQ2xHLE1BQU0sVUFBVSxzQkFBc0IsQ0FBQyxNQUFlO0lBQ3BELElBQUksa0JBQWtCLENBQUMsTUFBTSxDQUFDLElBQUksd0JBQXdCLENBQUMsTUFBTSxDQUFDLEVBQUU7UUFDbEUsT0FBTyxLQUFLLENBQUM7S0FDZDtJQUVELElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUU7UUFDcEIsT0FBTyxLQUFLLENBQUM7S0FDZDtJQUVELE1BQU0sU0FBUyxHQUFHLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN2QyxJQUFJLFNBQVMsS0FBSyxTQUFTLEVBQUU7UUFDM0IsT0FBTyxLQUFLLENBQUM7S0FDZDtJQUVELElBQUksT0FBTyxHQUFHLENBQUMsQ0FBQztJQUNoQixLQUFLLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBSSxLQUFLLENBQUMsU0FBUyxDQUFDLEVBQUU7UUFDcEMsT0FBTyxJQUFJLENBQUMsQ0FBQztRQUViLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLEVBQUU7WUFDbEIsT0FBTyxLQUFLLENBQUM7U0FDZDtRQUVELElBQUksQ0FBQyx5QkFBeUIsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLEVBQUU7WUFDdkMsT0FBTyxLQUFLLENBQUM7U0FDZDtLQUNGO0lBRUQsT0FBTyxPQUFPLEtBQUsseUJBQXlCLENBQUMsSUFBSSxDQUFDO0FBQ3BELENBQUM7QUFFRDs7O0dBR0c7QUFDSCxNQUFNLFVBQVUsa0JBQWtCLENBQUMsTUFBZTtJQUNoRCxNQUFNLFNBQVMsR0FBRyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUMzQyxJQUFJLFNBQVMsS0FBSyxTQUFTLEVBQUU7UUFDM0IsT0FBTyxLQUFLLENBQUM7S0FDZDtJQUVELE9BQU8sb0JBQW9CLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQzdDLENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxZQUFZLENBQUMsUUFBbUI7SUFDOUMsTUFBTSxTQUFTLEdBQUcsWUFBWSxDQUFDLFFBQVEsQ0FBbUMsQ0FBQztJQUMzRSxJQUFJLFNBQVMsS0FBSyxTQUFTLEVBQUU7UUFDM0IsS0FBSyxDQUNILDJHQUEyRyxDQUM1RyxDQUFDO0tBQ0g7SUFFRCxPQUFPLHlCQUF5QixDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQzlDLENBQUM7QUFFRCwwRUFBMEU7QUFDMUUsU0FBUyx5QkFBeUIsQ0FBQyxTQUE2QjtJQUM5RCxNQUFNLFFBQVEsR0FBRyxJQUFJLFFBQVEsRUFBc0IsQ0FBQztJQUNwRCxNQUFNLGlCQUFpQixHQUFHLFlBQVksQ0FDcEMsUUFBUSxFQUNSLFNBQVMsQ0FBQyxXQUFXLENBQUMsU0FBUyxDQUNDLENBQUM7SUFDbkMsaUJBQWlCLENBQUMsZUFBZSxFQUFFLENBQUMsQ0FBQywyQ0FBMkM7SUFFaEYsT0FBTyxRQUFnQyxDQUFDO0FBQzFDLENBQUMifQ==

package/functions/types.js

@@ -0,0 +1,27 @@
+export function isBoolean(variable) {
+    return type(variable) === "boolean";
+}
+// eslint-disable-next-line @typescript-eslint/ban-types
+export function isFunction(variable) {
+    return type(variable) === "function";
+}
+export function isNumber(variable) {
+    return type(variable) === "number";
+}
+/** Helper function to detect if a variable is a boolean, number, or string. */
+export function isPrimitive(variable) {
+    const variableType = type(variable);
+    return (variableType === "boolean" ||
+        variableType === "number" ||
+        variableType === "string");
+}
+export function isString(variable) {
+    return type(variable) === "string";
+}
+export function isTable(variable) {
+    return type(variable) === "table";
+}
+export function isUserdata(variable) {
+    return type(variable) === "userdata";
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9pc2FhY3NjcmlwdC1jb21tb24vc3JjL2Z1bmN0aW9ucy90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLFVBQVUsU0FBUyxDQUFDLFFBQWlCO0lBQ3pDLE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FBQyxLQUFLLFNBQVMsQ0FBQztBQUN0QyxDQUFDO0FBRUQsd0RBQXdEO0FBQ3hELE1BQU0sVUFBVSxVQUFVLENBQUMsUUFBaUI7SUFDMUMsT0FBTyxJQUFJLENBQUMsUUFBUSxDQUFDLEtBQUssVUFBVSxDQUFDO0FBQ3ZDLENBQUM7QUFFRCxNQUFNLFVBQVUsUUFBUSxDQUFDLFFBQWlCO0lBQ3hDLE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FBQyxLQUFLLFFBQVEsQ0FBQztBQUNyQyxDQUFDO0FBRUQsK0VBQStFO0FBQy9FLE1BQU0sVUFBVSxXQUFXLENBQ3pCLFFBQWlCO0lBRWpCLE1BQU0sWUFBWSxHQUFHLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUNwQyxPQUFPLENBQ0wsWUFBWSxLQUFLLFNBQVM7UUFDMUIsWUFBWSxLQUFLLFFBQVE7UUFDekIsWUFBWSxLQUFLLFFBQVEsQ0FDMUIsQ0FBQztBQUNKLENBQUM7QUFFRCxNQUFNLFVBQVUsUUFBUSxDQUFDLFFBQWlCO0lBQ3hDLE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FBQyxLQUFLLFFBQVEsQ0FBQztBQUNyQyxDQUFDO0FBRUQsTUFBTSxVQUFVLE9BQU8sQ0FBQyxRQUFpQjtJQUN2QyxPQUFPLElBQUksQ0FBQyxRQUFRLENBQUMsS0FBSyxPQUFPLENBQUM7QUFDcEMsQ0FBQztBQUVELE1BQU0sVUFBVSxVQUFVLENBQUMsUUFBaUI7SUFDMUMsT0FBTyxJQUFJLENBQUMsUUFBUSxDQUFDLEtBQUssVUFBVSxDQUFDO0FBQ3ZDLENBQUMifQ==

package/functions/ui.js

@@ -0,0 +1,124 @@
+import { CollectibleType, LevelCurse } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { UI_HEART_WIDTH, VectorZero } from "../constants";
+import { copyVector } from "./vector";
+/**
+ * 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 function getHUDOffsetVector() {
+    const defaultVector = copyVector(VectorZero);
+    // Convert e.g. 0.4 to 4.
+    const hudOffset = math.floor(Options.HUDOffset * 10);
+    // Expected values are integers between 1 and 10.
+    if (hudOffset < 1 || hudOffset > 10) {
+        return defaultVector;
+    }
+    const x = hudOffset * 2;
+    let y = hudOffset;
+    if (y >= 4) {
+        y += 1;
+    }
+    if (y >= 9) {
+        y += 1;
+    }
+    return Vector(x, y);
+}
+/**
+ * Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
+ * function will return 6.
+ */
+export function getHeartRowLength(player) {
+    const maxHearts = player.GetMaxHearts();
+    const soulHearts = player.GetSoulHearts();
+    const boneHearts = player.GetBoneHearts();
+    const combinedHearts = maxHearts + soulHearts + boneHearts * 2; // There are no half bone hearts
+    const heartRowLength = combinedHearts / 2;
+    // After 6 hearts, the hearts wrap to a second row.
+    return Math.min(heartRowLength, 6);
+}
+/**
+ * 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 function getHeartsUIWidth() {
+    const level = game.GetLevel();
+    const curses = level.GetCurses();
+    const player = Isaac.GetPlayer();
+    const extraLives = player.GetExtraLives();
+    const effects = player.GetEffects();
+    const hasHolyMantleEffect = effects.HasCollectibleEffect(CollectibleType.HOLY_MANTLE);
+    let heartRowLength = getHeartRowLength(player);
+    if (hasHolyMantleEffect) {
+        heartRowLength += 1;
+    }
+    if (curses === LevelCurse.UNKNOWN) {
+        heartRowLength = 1;
+    }
+    let width = heartRowLength * UI_HEART_WIDTH;
+    if (extraLives > 9) {
+        width += 20;
+        if (player.HasCollectible(CollectibleType.GUPPYS_COLLAR)) {
+            width += 6;
+        }
+    }
+    else if (extraLives > 0) {
+        width += 16;
+        if (player.HasCollectible(CollectibleType.GUPPYS_COLLAR)) {
+            width += 4;
+        }
+    }
+    return width;
+}
+export function getScreenBottomCenterPos() {
+    const bottomRight = getScreenBottomRightPos();
+    return Vector(bottomRight.X / 2, bottomRight.Y);
+}
+export function getScreenBottomLeftPos() {
+    const bottomRight = getScreenBottomRightPos();
+    return Vector(0, bottomRight.Y);
+}
+export function getScreenBottomRightPos() {
+    const screenWidth = Isaac.GetScreenWidth();
+    const screenHeight = Isaac.GetScreenHeight();
+    return Vector(screenWidth, screenHeight);
+}
+export function getScreenCenterPos() {
+    const bottomRight = getScreenBottomRightPos();
+    return bottomRight.div(2);
+}
+export function getScreenTopCenterPos() {
+    const bottomRight = getScreenBottomRightPos();
+    return Vector(bottomRight.X / 2, 0);
+}
+export function getScreenTopLeftPos() {
+    return copyVector(VectorZero);
+}
+export function getScreenTopRightPos() {
+    const bottomRight = getScreenBottomRightPos();
+    return Vector(bottomRight.X, 0);
+}
+/**
+ * Get how many hearts are currently being shown on the hearts UI.
+ *
+ * This function is originally from piber20 Helper.
+ */
+export function getVisibleHearts(player) {
+    const effectiveMaxHearts = player.GetEffectiveMaxHearts();
+    const soulHearts = player.GetSoulHearts();
+    const boneHearts = player.GetBoneHearts();
+    const maxHearts = math.max(effectiveMaxHearts, boneHearts * 2);
+    let visibleHearts = math.ceil((maxHearts + soulHearts) / 2);
+    if (visibleHearts < 1) {
+        visibleHearts = 1;
+    }
+    return visibleHearts;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidWkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9pc2FhY3NjcmlwdC1jb21tb24vc3JjL2Z1bmN0aW9ucy91aS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsZUFBZSxFQUFFLFVBQVUsRUFBRSxNQUFNLDhCQUE4QixDQUFDO0FBQzNFLE9BQU8sRUFBRSxJQUFJLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUN4QyxPQUFPLEVBQUUsY0FBYyxFQUFFLFVBQVUsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUMxRCxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBRXRDOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sVUFBVSxrQkFBa0I7SUFDaEMsTUFBTSxhQUFhLEdBQUcsVUFBVSxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBRTdDLHlCQUF5QjtJQUN6QixNQUFNLFNBQVMsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxTQUFTLEdBQUcsRUFBRSxDQUFDLENBQUM7SUFFckQsaURBQWlEO0lBQ2pELElBQUksU0FBUyxHQUFHLENBQUMsSUFBSSxTQUFTLEdBQUcsRUFBRSxFQUFFO1FBQ25DLE9BQU8sYUFBYSxDQUFDO0tBQ3RCO0lBRUQsTUFBTSxDQUFDLEdBQUcsU0FBUyxHQUFHLENBQUMsQ0FBQztJQUN4QixJQUFJLENBQUMsR0FBRyxTQUFTLENBQUM7SUFDbEIsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ1YsQ0FBQyxJQUFJLENBQUMsQ0FBQztLQUNSO0lBQ0QsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ1YsQ0FBQyxJQUFJLENBQUMsQ0FBQztLQUNSO0lBRUQsT0FBTyxNQUFNLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDO0FBQ3RCLENBQUM7QUFFRDs7O0dBR0c7QUFDSCxNQUFNLFVBQVUsaUJBQWlCLENBQUMsTUFBb0I7SUFDcEQsTUFBTSxTQUFTLEdBQUcsTUFBTSxDQUFDLFlBQVksRUFBRSxDQUFDO0lBQ3hDLE1BQU0sVUFBVSxHQUFHLE1BQU0sQ0FBQyxhQUFhLEVBQUUsQ0FBQztJQUMxQyxNQUFNLFVBQVUsR0FBRyxNQUFNLENBQUMsYUFBYSxFQUFFLENBQUM7SUFFMUMsTUFBTSxjQUFjLEdBQUcsU0FBUyxHQUFHLFVBQVUsR0FBRyxVQUFVLEdBQUcsQ0FBQyxDQUFDLENBQUMsZ0NBQWdDO0lBQ2hHLE1BQU0sY0FBYyxHQUFHLGNBQWMsR0FBRyxDQUFDLENBQUM7SUFFMUMsbURBQW1EO0lBQ25ELE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxjQUFjLEVBQUUsQ0FBQyxDQUFDLENBQUM7QUFDckMsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsZ0JBQWdCO0lBQzlCLE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztJQUM5QixNQUFNLE1BQU0sR0FBRyxLQUFLLENBQUMsU0FBUyxFQUFFLENBQUM7SUFDakMsTUFBTSxNQUFNLEdBQUcsS0FBSyxDQUFDLFNBQVMsRUFBRSxDQUFDO0lBQ2pDLE1BQU0sVUFBVSxHQUFHLE1BQU0sQ0FBQyxhQUFhLEVBQUUsQ0FBQztJQUMxQyxNQUFNLE9BQU8sR0FBRyxNQUFNLENBQUMsVUFBVSxFQUFFLENBQUM7SUFDcEMsTUFBTSxtQkFBbUIsR0FBRyxPQUFPLENBQUMsb0JBQW9CLENBQ3RELGVBQWUsQ0FBQyxXQUFXLENBQzVCLENBQUM7SUFFRixJQUFJLGNBQWMsR0FBRyxpQkFBaUIsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUMvQyxJQUFJLG1CQUFtQixFQUFFO1FBQ3ZCLGNBQWMsSUFBSSxDQUFDLENBQUM7S0FDckI7SUFDRCxJQUFJLE1BQU0sS0FBSyxVQUFVLENBQUMsT0FBTyxFQUFFO1FBQ2pDLGNBQWMsR0FBRyxDQUFDLENBQUM7S0FDcEI7SUFFRCxJQUFJLEtBQUssR0FBRyxjQUFjLEdBQUcsY0FBYyxDQUFDO0lBQzVDLElBQUksVUFBVSxHQUFHLENBQUMsRUFBRTtRQUNsQixLQUFLLElBQUksRUFBRSxDQUFDO1FBQ1osSUFBSSxNQUFNLENBQUMsY0FBYyxDQUFDLGVBQWUsQ0FBQyxhQUFhLENBQUMsRUFBRTtZQUN4RCxLQUFLLElBQUksQ0FBQyxDQUFDO1NBQ1o7S0FDRjtTQUFNLElBQUksVUFBVSxHQUFHLENBQUMsRUFBRTtRQUN6QixLQUFLLElBQUksRUFBRSxDQUFDO1FBQ1osSUFBSSxNQUFNLENBQUMsY0FBYyxDQUFDLGVBQWUsQ0FBQyxhQUFhLENBQUMsRUFBRTtZQUN4RCxLQUFLLElBQUksQ0FBQyxDQUFDO1NBQ1o7S0FDRjtJQUVELE9BQU8sS0FBSyxDQUFDO0FBQ2YsQ0FBQztBQUVELE1BQU0sVUFBVSx3QkFBd0I7SUFDdEMsTUFBTSxXQUFXLEdBQUcsdUJBQXVCLEVBQUUsQ0FBQztJQUM5QyxPQUFPLE1BQU0sQ0FBQyxXQUFXLENBQUMsQ0FBQyxHQUFHLENBQUMsRUFBRSxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDbEQsQ0FBQztBQUVELE1BQU0sVUFBVSxzQkFBc0I7SUFDcEMsTUFBTSxXQUFXLEdBQUcsdUJBQXVCLEVBQUUsQ0FBQztJQUM5QyxPQUFPLE1BQU0sQ0FBQyxDQUFDLEVBQUUsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQ2xDLENBQUM7QUFFRCxNQUFNLFVBQVUsdUJBQXVCO0lBQ3JDLE1BQU0sV0FBVyxHQUFHLEtBQUssQ0FBQyxjQUFjLEVBQUUsQ0FBQztJQUMzQyxNQUFNLFlBQVksR0FBRyxLQUFLLENBQUMsZUFBZSxFQUFFLENBQUM7SUFFN0MsT0FBTyxNQUFNLENBQUMsV0FBVyxFQUFFLFlBQVksQ0FBQyxDQUFDO0FBQzNDLENBQUM7QUFFRCxNQUFNLFVBQVUsa0JBQWtCO0lBQ2hDLE1BQU0sV0FBVyxHQUFHLHVCQUF1QixFQUFFLENBQUM7SUFDOUMsT0FBTyxXQUFXLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQzVCLENBQUM7QUFFRCxNQUFNLFVBQVUscUJBQXFCO0lBQ25DLE1BQU0sV0FBVyxHQUFHLHVCQUF1QixFQUFFLENBQUM7SUFDOUMsT0FBTyxNQUFNLENBQUMsV0FBVyxDQUFDLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUM7QUFDdEMsQ0FBQztBQUVELE1BQU0sVUFBVSxtQkFBbUI7SUFDakMsT0FBTyxVQUFVLENBQUMsVUFBVSxDQUFDLENBQUM7QUFDaEMsQ0FBQztBQUVELE1BQU0sVUFBVSxvQkFBb0I7SUFDbEMsTUFBTSxXQUFXLEdBQUcsdUJBQXVCLEVBQUUsQ0FBQztJQUM5QyxPQUFPLE1BQU0sQ0FBQyxXQUFXLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDO0FBQ2xDLENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLGdCQUFnQixDQUFDLE1BQW9CO0lBQ25ELE1BQU0sa0JBQWtCLEdBQUcsTUFBTSxDQUFDLHFCQUFxQixFQUFFLENBQUM7SUFDMUQsTUFBTSxVQUFVLEdBQUcsTUFBTSxDQUFDLGFBQWEsRUFBRSxDQUFDO0lBQzFDLE1BQU0sVUFBVSxHQUFHLE1BQU0sQ0FBQyxhQUFhLEVBQUUsQ0FBQztJQUUxQyxNQUFNLFNBQVMsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLGtCQUFrQixFQUFFLFVBQVUsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUUvRCxJQUFJLGFBQWEsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO0lBQzVELElBQUksYUFBYSxHQUFHLENBQUMsRUFBRTtRQUNyQixhQUFhLEdBQUcsQ0FBQyxDQUFDO0tBQ25CO0lBRUQsT0FBTyxhQUFhLENBQUM7QUFDdkIsQ0FBQyJ9

package/functions/utils.js

@@ -0,0 +1,172 @@
+import { RenderMode } from "isaac-typescript-definitions";
+import { game } from "../cachedClasses";
+import { CONSOLE_COMMANDS_SET } from "../sets/consoleCommandsSet";
+const 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]`.
+ */
+export function erange(start, end) {
+    if (end === undefined) {
+        end = start;
+        start = 0;
+    }
+    const array = [];
+    for (let i = start; i < end; i++) {
+        array.push(i);
+    }
+    return array;
+}
+/**
+ * Helper function to log what is happening in functions that recursively move through nested data
+ * structures.
+ */
+export function getTraversalDescription(key, traversalDescription) {
+    if (traversalDescription !== "") {
+        traversalDescription += " --> ";
+    }
+    traversalDescription += tostring(key);
+    return traversalDescription;
+}
+/**
+ * Converts a hex string like "#33aa33" to a KColor object.
+ *
+ * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
+ */
+export function hexToKColor(hexString, alpha) {
+    hexString = hexString.replace("#", "");
+    if (hexString.length !== HEX_STRING_LENGTH) {
+        error(`Hex strings must be of length ${HEX_STRING_LENGTH}.`);
+    }
+    const rString = hexString.substr(0, 2);
+    const R = tonumber(`0x${rString}`);
+    if (R === undefined) {
+        error(`Failed to convert \`0x${rString}\` to a number.`);
+    }
+    const gString = hexString.substr(2, 2);
+    const G = tonumber(`0x${gString}`);
+    if (G === undefined) {
+        error(`Failed to convert \`0x${gString}\` to a number.`);
+    }
+    const bString = hexString.substr(4, 2);
+    const B = tonumber(`0x${bString}`);
+    if (B === undefined) {
+        error(`Failed to convert \`0x${bString}\` to a number.`);
+    }
+    // KColor values should be between 0 and 1.
+    const base = 255;
+    return KColor(R / base, G / base, B / base, alpha);
+}
+/**
+ * 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 function irange(start, end) {
+    if (end === undefined) {
+        end = start;
+        start = 0;
+    }
+    const array = [];
+    for (let i = start; i <= end; i++) {
+        array.push(i);
+    }
+    return array;
+}
+/**
+ * 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 function isReflectionRender() {
+    const room = game.GetRoom();
+    const renderMode = room.GetRenderMode();
+    return renderMode === RenderMode.WATER_REFLECT;
+}
+/**
+ * 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 function isVanillaConsoleCommand(commandName) {
+    return CONSOLE_COMMANDS_SET.has(commandName);
+}
+/**
+ * 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 function printConsole(msg) {
+    Isaac.ConsoleOutput(`${msg}\n`);
+}
+/** Helper function to print whether something was enabled or disabled to the in-game console. */
+export function printEnabled(enabled, description) {
+    const enabledText = enabled ? "Enabled" : "Disabled";
+    printConsole(`${enabledText} ${description}.`);
+}
+/**
+ * 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 function repeat(n, func) {
+    for (let i = 0; i < n; i++) {
+        func(i);
+    }
+}
+/**
+ * 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 function todo() { }
+/**
+ * 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 function twoDimensionalSort(a, b) {
+    if (a[0] === undefined || b[0] === undefined) {
+        error("Failed to two-dimensional sort since the first element of the array was undefined.");
+    }
+    if (a[0] === b[0]) {
+        return 0;
+    }
+    return a[0] < b[0] ? -1 : 1;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9pc2FhY3NjcmlwdC1jb21tb24vc3JjL2Z1bmN0aW9ucy91dGlscy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sOEJBQThCLENBQUM7QUFDMUQsT0FBTyxFQUFFLElBQUksRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBQ3hDLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLDRCQUE0QixDQUFDO0FBRWxFLE1BQU0saUJBQWlCLEdBQUcsQ0FBQyxDQUFDO0FBRTVCOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxVQUFVLE1BQU0sQ0FBQyxLQUFVLEVBQUUsR0FBUztJQUMxQyxJQUFJLEdBQUcsS0FBSyxTQUFTLEVBQUU7UUFDckIsR0FBRyxHQUFHLEtBQUssQ0FBQztRQUNaLEtBQUssR0FBRyxDQUFDLENBQUM7S0FDWDtJQUVELE1BQU0sS0FBSyxHQUFVLEVBQUUsQ0FBQztJQUN4QixLQUFLLElBQUksQ0FBQyxHQUFHLEtBQUssRUFBRSxDQUFDLEdBQUcsR0FBRyxFQUFFLENBQUMsRUFBRSxFQUFFO1FBQ2hDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7S0FDZjtJQUVELE9BQU8sS0FBSyxDQUFDO0FBQ2YsQ0FBQztBQUVEOzs7R0FHRztBQUNILE1BQU0sVUFBVSx1QkFBdUIsQ0FDckMsR0FBWSxFQUNaLG9CQUE0QjtJQUU1QixJQUFJLG9CQUFvQixLQUFLLEVBQUUsRUFBRTtRQUMvQixvQkFBb0IsSUFBSSxPQUFPLENBQUM7S0FDakM7SUFFRCxvQkFBb0IsSUFBSSxRQUFRLENBQUMsR0FBRyxDQUFDLENBQUM7SUFFdEMsT0FBTyxvQkFBb0IsQ0FBQztBQUM5QixDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSxXQUFXLENBQUMsU0FBaUIsRUFBRSxLQUFZO0lBQ3pELFNBQVMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFFLENBQUMsQ0FBQztJQUN2QyxJQUFJLFNBQVMsQ0FBQyxNQUFNLEtBQUssaUJBQWlCLEVBQUU7UUFDMUMsS0FBSyxDQUFDLGlDQUFpQyxpQkFBaUIsR0FBRyxDQUFDLENBQUM7S0FDOUQ7SUFFRCxNQUFNLE9BQU8sR0FBRyxTQUFTLENBQUMsTUFBTSxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztJQUN2QyxNQUFNLENBQUMsR0FBRyxRQUFRLENBQUMsS0FBSyxPQUFPLEVBQUUsQ0FBQyxDQUFDO0lBQ25DLElBQUksQ0FBQyxLQUFLLFNBQVMsRUFBRTtRQUNuQixLQUFLLENBQUMseUJBQXlCLE9BQU8saUJBQWlCLENBQUMsQ0FBQztLQUMxRDtJQUVELE1BQU0sT0FBTyxHQUFHLFNBQVMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDO0lBQ3ZDLE1BQU0sQ0FBQyxHQUFHLFFBQVEsQ0FBQyxLQUFLLE9BQU8sRUFBRSxDQUFDLENBQUM7SUFDbkMsSUFBSSxDQUFDLEtBQUssU0FBUyxFQUFFO1FBQ25CLEtBQUssQ0FBQyx5QkFBeUIsT0FBTyxpQkFBaUIsQ0FBQyxDQUFDO0tBQzFEO0lBRUQsTUFBTSxPQUFPLEdBQUcsU0FBUyxDQUFDLE1BQU0sQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUM7SUFDdkMsTUFBTSxDQUFDLEdBQUcsUUFBUSxDQUFDLEtBQUssT0FBTyxFQUFFLENBQUMsQ0FBQztJQUNuQyxJQUFJLENBQUMsS0FBSyxTQUFTLEVBQUU7UUFDbkIsS0FBSyxDQUFDLHlCQUF5QixPQUFPLGlCQUFpQixDQUFDLENBQUM7S0FDMUQ7SUFFRCwyQ0FBMkM7SUFDM0MsTUFBTSxJQUFJLEdBQUcsR0FBRyxDQUFDO0lBQ2pCLE9BQU8sTUFBTSxDQUFDLENBQUMsR0FBRyxJQUFJLEVBQUUsQ0FBQyxHQUFHLElBQUksRUFBRSxDQUFDLEdBQUcsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO0FBQ3JELENBQUM7QUFFRDs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sVUFBVSxNQUFNLENBQUMsS0FBVSxFQUFFLEdBQVM7SUFDMUMsSUFBSSxHQUFHLEtBQUssU0FBUyxFQUFFO1FBQ3JCLEdBQUcsR0FBRyxLQUFLLENBQUM7UUFDWixLQUFLLEdBQUcsQ0FBQyxDQUFDO0tBQ1g7SUFFRCxNQUFNLEtBQUssR0FBVSxFQUFFLENBQUM7SUFDeEIsS0FBSyxJQUFJLENBQUMsR0FBRyxLQUFLLEVBQUUsQ0FBQyxJQUFJLEdBQUcsRUFBRSxDQUFDLEVBQUUsRUFBRTtRQUNqQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO0tBQ2Y7SUFFRCxPQUFPLEtBQUssQ0FBQztBQUNmLENBQUM7QUFFRDs7O0dBR0c7QUFDSCxNQUFNLFVBQVUsa0JBQWtCO0lBQ2hDLE1BQU0sSUFBSSxHQUFHLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUM1QixNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsYUFBYSxFQUFFLENBQUM7SUFDeEMsT0FBTyxVQUFVLEtBQUssVUFBVSxDQUFDLGFBQWEsQ0FBQztBQUNqRCxDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLHVCQUF1QixDQUFDLFdBQW1CO0lBQ3pELE9BQU8sb0JBQW9CLENBQUMsR0FBRyxDQUFDLFdBQVcsQ0FBQyxDQUFDO0FBQy9DLENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLFlBQVksQ0FBQyxHQUFXO0lBQ3RDLEtBQUssQ0FBQyxhQUFhLENBQUMsR0FBRyxHQUFHLElBQUksQ0FBQyxDQUFDO0FBQ2xDLENBQUM7QUFFRCxpR0FBaUc7QUFDakcsTUFBTSxVQUFVLFlBQVksQ0FBQyxPQUFnQixFQUFFLFdBQW1CO0lBQ2hFLE1BQU0sV0FBVyxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxVQUFVLENBQUM7SUFDckQsWUFBWSxDQUFDLEdBQUcsV0FBVyxJQUFJLFdBQVcsR0FBRyxDQUFDLENBQUM7QUFDakQsQ0FBQztBQUVEOzs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBbUJHO0FBQ0gsTUFBTSxVQUFVLE1BQU0sQ0FBQyxDQUFNLEVBQUUsSUFBc0I7SUFDbkQsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEVBQUUsRUFBRTtRQUMxQixJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7S0FDVDtBQUNILENBQUM7QUFFRDs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFNLFVBQVUsSUFBSSxLQUFVLENBQUM7QUFFL0I7Ozs7Ozs7Ozs7OztHQVlHO0FBQ0gsTUFBTSxVQUFVLGtCQUFrQixDQUFJLENBQU0sRUFBRSxDQUFNO0lBQ2xELElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLFNBQVMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssU0FBUyxFQUFFO1FBQzVDLEtBQUssQ0FDSCxvRkFBb0YsQ0FDckYsQ0FBQztLQUNIO0lBRUQsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUFFO1FBQ2pCLE9BQU8sQ0FBQyxDQUFDO0tBQ1Y7SUFFRCxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDOUIsQ0FBQyJ9