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

package/dist/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=trinkets.js.map

package/dist/functions/trinkets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trinkets.js","sourceRoot":"../src/","sources":["functions/trinkets.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,WAAW,EACX,WAAW,GACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,iBAAiB,EACjB,yBAAyB,GAC1B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC;;;;;;GAMG;AACH,MAAM,yBAAyB,GAAG,KAAK,CAAC;AAExC,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAE/B;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,WAAwB;IAC3D,OAAO,WAAW,GAAG,yBAAyB,CAAC,CAAC,+CAA+C;AACjG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB;IACnC,IAAI,yBAAyB,KAAK,iBAAiB,EAAE;QACnD,OAAO,EAAE,CAAC;KACX;IAED,OAAO,MAAM,CAAC,yBAAyB,EAAE,iBAAiB,CAAkB,CAAC;AAC/E,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAoB;IACrD,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;IAC5C,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3D,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAE3D,IAAI,WAAW,KAAK,CAAC,EAAE;QACrB,OAAO,YAAY,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;KAC1D;IAED,IAAI,WAAW,KAAK,CAAC,EAAE;QACrB,IAAI,YAAY,KAAK,WAAW,CAAC,IAAI,EAAE;YACrC,OAAO,CAAC,CAAC;SACV;QAED,OAAO,YAAY,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;KAC1D;IAED,KAAK,CAAC,sDAAsD,WAAW,EAAE,CAAC,CAAC;AAC7E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,WAAwB;IAC5D,yFAAyF;IACzF,kCAAkC;IAClC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACpE,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACpC,OAAO,kBAAkB,CAAC;KAC3B;IAED,MAAM,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAC1D,IAAI,cAAc,KAAK,SAAS,EAAE;QAChC,OAAO,cAAc,CAAC,WAAW,CAAC;KACnC;IAED,OAAO,2BAA2B,CAAC;AACrC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,cAAc,CAAC,WAAwB;IACrD,iGAAiG;IACjG,mBAAmB;IACnB,MAAM,WAAW,GAAG,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACtD,IAAI,WAAW,KAAK,SAAS,EAAE;QAC7B,OAAO,WAAW,CAAC;KACpB;IAED,MAAM,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAC1D,IAAI,cAAc,KAAK,SAAS,EAAE;QAChC,OAAO,cAAc,CAAC,IAAI,CAAC;KAC5B;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,eAAe;IAC7B,OAAO,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,CAAkB,CAAC;AACxE,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,sBAAsB;IACpC,OAAO,MAAM,CAAC,kBAAkB,EAAE,yBAAyB,CAAkB,CAAC;AAChF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAoB;IACrD,IAAI,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,EAAE;QAC9C,OAAO,KAAK,CAAC;KACd;IAED,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACnD,OAAO,eAAe,KAAK,SAAS,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,WAAwB;IACtD,OAAO,WAAW,GAAI,yBAAyC,CAAC;AAClE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAqB,EACrB,OAA2B;IAE3B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;QACvB,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;QACtC,KAAK,CACH,4DAA4D,QAAQ,EAAE,CACvE,CAAC;KACH;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IACnC,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,WAAW,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;KAC3C;SAAM;QACL,MAAM,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QACzD,MAAM,CAAC,YAAY,EAAE,CAAC;KACvB;AACH,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,WAAwB,EACxB,SAAoB;IAEpB,MAAM,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAC1D,IAAI,cAAc,KAAK,SAAS,EAAE;QAChC,OAAO,KAAK,CAAC;KACd;IAED,OAAO,OAAO,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AACvD,CAAC"}

package/dist/functions/trinkets.lua

@@ -0,0 +1,167 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local TrinketSlot = ____isaac_2Dtypescript_2Ddefinitions.TrinketSlot
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____cachedClasses = require("cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
+local ____constantsFirstLast = require("constantsFirstLast")
+local FIRST_MODDED_TRINKET_TYPE = ____constantsFirstLast.FIRST_MODDED_TRINKET_TYPE
+local FIRST_TRINKET_TYPE = ____constantsFirstLast.FIRST_TRINKET_TYPE
+local LAST_TRINKET_TYPE = ____constantsFirstLast.LAST_TRINKET_TYPE
+local LAST_VANILLA_TRINKET_TYPE = ____constantsFirstLast.LAST_VANILLA_TRINKET_TYPE
+local ____trinketDescriptionMap = require("maps.trinketDescriptionMap")
+local DEFAULT_TRINKET_DESCRIPTION = ____trinketDescriptionMap.DEFAULT_TRINKET_DESCRIPTION
+local TRINKET_DESCRIPTION_MAP = ____trinketDescriptionMap.TRINKET_DESCRIPTION_MAP
+local ____trinketNameMap = require("maps.trinketNameMap")
+local DEFAULT_TRINKET_NAME = ____trinketNameMap.DEFAULT_TRINKET_NAME
+local TRINKET_NAME_MAP = ____trinketNameMap.TRINKET_NAME_MAP
+local ____entity = require("functions.entity")
+local getEntityID = ____entity.getEntityID
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____pickupVariants = require("functions.pickupVariants")
+local isTrinket = ____pickupVariants.isTrinket
+local ____player = require("functions.player")
+local isCharacter = ____player.isCharacter
+local ____sprite = require("functions.sprite")
+local clearSprite = ____sprite.clearSprite
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
+--- Add this to a `TrinketType` to get the corresponding golden trinket type.
+-- 
+-- Corresponds to the vanilla `PillColor.TRINKET_GOLDEN_FLAG` value.
+-- 
+-- 1 << 15
+local GOLDEN_TRINKET_ADJUSTMENT = 32768
+local 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.
+function ____exports.getGoldenTrinketType(self, trinketType)
+    return trinketType + GOLDEN_TRINKET_ADJUSTMENT
+end
+--- Helper function to get an array that represents every modded trinket type.
+-- 
+-- Returns an empty array if there are no modded trinket types.
+function ____exports.getModdedTrinketTypes(self)
+    if LAST_VANILLA_TRINKET_TYPE == LAST_TRINKET_TYPE then
+        return {}
+    end
+    return irange(nil, FIRST_MODDED_TRINKET_TYPE, LAST_TRINKET_TYPE)
+end
+--- 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);
+-- }
+-- ```
+function ____exports.getOpenTrinketSlot(self, player)
+    local maxTrinkets = player:GetMaxTrinkets()
+    local trinketType1 = player:GetTrinket(TrinketSlot.SLOT_1)
+    local trinketType2 = player:GetTrinket(TrinketSlot.SLOT_2)
+    if maxTrinkets == 1 then
+        return trinketType1 == TrinketType.NULL and 0 or nil
+    end
+    if maxTrinkets == 2 then
+        if trinketType1 == TrinketType.NULL then
+            return 0
+        end
+        return trinketType2 == TrinketType.NULL and 1 or nil
+    end
+    error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
+end
+--- Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
+-- trinket type was not valid.
+function ____exports.getTrinketDescription(self, trinketType)
+    local trinketDescription = TRINKET_DESCRIPTION_MAP:get(trinketType)
+    if trinketDescription ~= nil then
+        return trinketDescription
+    end
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
+    if itemConfigItem ~= nil then
+        return itemConfigItem.Description
+    end
+    return DEFAULT_TRINKET_DESCRIPTION
+end
+--- 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"
+-- ```
+function ____exports.getTrinketName(self, trinketType)
+    local trinketName = TRINKET_NAME_MAP:get(trinketType)
+    if trinketName ~= nil then
+        return trinketName
+    end
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
+    if itemConfigItem ~= nil then
+        return itemConfigItem.Name
+    end
+    return DEFAULT_TRINKET_NAME
+end
+--- Helper function to get an array that contains every trinket type.
+function ____exports.getTrinketTypes(self)
+    return irange(nil, FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE)
+end
+--- Helper function to get an array that represents every vanilla trinket type.
+function ____exports.getVanillaTrinketTypes(self)
+    return irange(nil, FIRST_TRINKET_TYPE, LAST_VANILLA_TRINKET_TYPE)
+end
+--- 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.)
+function ____exports.hasOpenTrinketSlot(self, player)
+    if isCharacter(nil, player, PlayerType.THE_SOUL_B) then
+        return false
+    end
+    local openTrinketSlot = ____exports.getOpenTrinketSlot(nil, player)
+    return openTrinketSlot ~= nil
+end
+function ____exports.isGoldenTrinket(self, trinketType)
+    return trinketType > GOLDEN_TRINKET_ADJUSTMENT
+end
+--- 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.
+function ____exports.setTrinketSprite(self, trinket, pngPath)
+    if not isTrinket(nil, trinket) then
+        local entityID = getEntityID(nil, trinket)
+        error("The \"setTrinketSprite\" function was given a non-trinket: " .. entityID)
+    end
+    local sprite = trinket:GetSprite()
+    if pngPath == nil then
+        clearSprite(nil, sprite, TRINKET_SPRITE_LAYER)
+    else
+        sprite:ReplaceSpritesheet(TRINKET_SPRITE_LAYER, pngPath)
+        sprite:LoadGraphics()
+    end
+end
+function ____exports.trinketHasCacheFlag(self, trinketType, cacheFlag)
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
+    if itemConfigItem == nil then
+        return false
+    end
+    return hasFlag(nil, itemConfigItem.CacheFlags, cacheFlag)
+end
+return ____exports

package/dist/functions/trinkets.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/trinkets.ts"],"names":[],"mappings":";AAAA,6CAKO;AAHL;AACA;AACA;AAEF,0BAA2B;AAAlB;AACT,+BAKO;AAJL;AACA;AACA;AACA;AAEF,kCAGO;AAFL;AACA;AAEF,2BAAuD;AAA9C;AAAsB;AAC/B,mBAA4B;AAAnB;AACT,iBAAwB;AAAf;AACT,2BAA0B;AAAjB;AACT,mBAA4B;AAAnB;AACT,mBAA4B;AAAnB;AACT,kBAAuB;AAAd;;;;;;AASH,kCAA4B;AAE5B,6BAAuB;;;;;AAQ7B,gDAAqC;AACnC,WAAO,cAAc;AADvB;;;;AASA;OACM,6BAA8B;AAChC,eAAO;;AAGT,WAAO,YAAO,2BAA2B;AAL3C;;;;;;;;;;;;;AAsBA,8CAAmC;AAC3B,wBAAc,OAAO;AACrB,yBAAe,OAAO,WAAW;AACjC,yBAAe,OAAO,WAAW;OAEnC,eAAgB;AAClB,eAAO,gBAAiB,qBAAmB;;OAGzC,eAAgB;WACd,gBAAiB;AACnB,mBAAO;;AAGT,eAAO,gBAAiB,qBAAmB;;IAG7C,MAAM,kEAAsD;AAjB9D;;;AAwBA,iDAAsC;AAG9B,+BAAqB,wBAAwB,IAAI;OACnD;AACF,eAAO;;AAGH,2BAAiB,WAAW,WAAW;OACzC;AACF,eAAO;;AAGT,WAAO;AAbT;;;;;;;;;;AA2BA,0CAA+B;AAGvB,wBAAc,iBAAiB,IAAI;OACrC;AACF,eAAO;;AAGH,2BAAiB,WAAW,WAAW;OACzC;AACF,eAAO;;AAGT,WAAO;AAbT;;AAiBA;AACE,WAAO,YAAO,oBAAoB;AADpC;;AAKA;AACE,WAAO,YAAO,oBAAoB;AADpC;;;;;;AAWA,8CAAmC;OAC7B,iBAAY,QAAQ;AACtB,eAAO;;AAGH,4BAAkB,oCAAmB;AAC3C,WAAO;AANT;AASA,2CAAgC;AAC9B,WAAO,cAAe;AADxB;;;;;;;;;;;AAgBA,4CACE,SACA;WAEK,eAAU;AACP,yBAAW,iBAAY;QAC7B,MACE,iEAA4D;;AAI1D,mBAAS,QAAQ;OACnB;QACF,iBAAY,QAAQ;;QAEpB,OAAO,mBAAmB,sBAAsB;QAChD,OAAO;;AAhBX;AAoBA,+CACE,aACA;AAEM,2BAAiB,WAAW,WAAW;OACzC;AACF,eAAO;;AAGT,WAAO,aAAQ,2BAA2B;AAT5C","file":"trinkets.lua","sourceRoot":"../src/"}

package/dist/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=tstlClass.js.map

package/dist/functions/tstlClass.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tstlClass.js","sourceRoot":"../src/","sources":["functions/tstlClass.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5C,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAE3E,MAAM,yBAAyB,GAAwB,IAAI,GAAG,CAAC;IAC7D,iBAAiB;IACjB,SAAS;IACT,aAAa;CACd,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAe;IAC9C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACpB,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC;IAClC,uEAAuE;IACvE,IAAI,WAAW,KAAK,SAAS,EAAE;QAC7B,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,WAAW,CAAC,IAAI,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAe;IAEf,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO,SAAS,KAAK,YAAY,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAAe;IACtD,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,MAAe;IACvC,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO,SAAS,KAAK,KAAK,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,MAAe;IACvC,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO,SAAS,KAAK,KAAK,CAAC;AAC7B,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,sBAAsB,CAAC,MAAe;IACpD,IAAI,kBAAkB,CAAC,MAAM,CAAC,IAAI,wBAAwB,CAAC,MAAM,CAAC,EAAE;QAClE,OAAO,KAAK,CAAC;KACd;IAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACpB,OAAO,KAAK,CAAC;KACd;IAED,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,OAAO,KAAK,CAAC;KACd;IAED,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,EAAE;QACpC,OAAO,IAAI,CAAC,CAAC;QAEb,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAClB,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACvC,OAAO,KAAK,CAAC;SACd;KACF;IAED,OAAO,OAAO,KAAK,yBAAyB,CAAC,IAAI,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAe;IAChD,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3C,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,OAAO,KAAK,CAAC;KACd;IAED,OAAO,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,QAAmB;IAC9C,MAAM,SAAS,GAAG,YAAY,CAAC,QAAQ,CAAmC,CAAC;IAC3E,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,KAAK,CACH,2GAA2G,CAC5G,CAAC;KACH;IAED,OAAO,yBAAyB,CAAC,SAAS,CAAC,CAAC;AAC9C,CAAC;AAED,0EAA0E;AAC1E,SAAS,yBAAyB,CAAC,SAA6B;IAC9D,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAsB,CAAC;IACpD,MAAM,iBAAiB,GAAG,YAAY,CACpC,QAAQ,EACR,SAAS,CAAC,WAAW,CAAC,SAAS,CACC,CAAC;IACnC,iBAAiB,CAAC,eAAe,EAAE,CAAC,CAAC,2CAA2C;IAEhF,OAAO,QAAgC,CAAC;AAC1C,CAAC"}

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/tstlClass.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/tstlClass.ts"],"names":[],"mappings":";;;;MAmJS,2BA9IH;AAFN,kBAAkC;AAAzB;AAAU;;;;;;;;;AAoBnB,4CAAiC;WAC1B,aAAQ;AACX;;AAGI,sBAAY,aAAa;OAC3B;AACF;;UAGM,cAAgB;OAEpB;AACF;;AAGF,WAAO;AAhBT;;;AAiGA,8CAAmC;AAC3B,sBAAY,kCAAiB;OAC/B;AACF,eAAO;;AAGT,WAAO,qBAAqB,IAAI;AANlC;AA2BA,SAAS,gCAA0B;AAC3B,qBAAW;AACX,8BAAoB,aACxB,UACA;IAEF,kBAAkB;AAElB,WAAO;;AAtJH,uBAAuB,UAAI,KAAI,CAAC,OAAO,OAAO,WAAW;AAEzD,kCAAiD,UAAI,KAAI,CAC7D,mBACA,WACA;;;;;AAsCF,wCACE;AAEM,sBAAY,kCAAiB;AACnC,WAAO,aAAc;AAJvB;;;AAWA,oDAAyC;AACvC,WAAO,8BAAa;AADtB;;;;;AAUA,qCAA0B;AAClB,sBAAY,kCAAiB;AACnC,WAAO,aAAc;AAFvB;;;;;AAWA,qCAA0B;AAClB,sBAAY,kCAAiB;AACnC,WAAO,aAAc;AAFvB;;AAMA,kDAAuC;OACjC,oCAAmB,WAAW,0CAAyB;AACzD,eAAO;;WAGJ,aAAQ;AACX,eAAO;;AAGH,sBAAY,aAAa;OAC3B;AACF,eAAO;;AAGL,oBAAU;AACd,QAAY,OAAQ,MAAM;AACxB,4BAAW;eAEN,cAAS;AACZ,mBAAO;;eAGJ,0BAA0B,IAAI;AACjC,mBAAO;;;AAIX,WAAO,WAAY;AA3BrB;;;;;AAiDA,wCAA6B;AACrB,sBAAY,aAAa;OAC3B;QACF,MACE;;AAIJ,WAAO,+BAA0B;AARnC","file":"tstlClass.lua","sourceRoot":"../src/"}

package/dist/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=types.js.map

package/dist/functions/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"../src/","sources":["functions/types.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,SAAS,CAAC,QAAiB;IACzC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC;AACtC,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,UAAU,CAAC,QAAiB;IAC1C,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,UAAU,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,QAAiB;IACxC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC;AACrC,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,WAAW,CACzB,QAAiB;IAEjB,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpC,OAAO,CACL,YAAY,KAAK,SAAS;QAC1B,YAAY,KAAK,QAAQ;QACzB,YAAY,KAAK,QAAQ,CAC1B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,QAAiB;IACxC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,QAAiB;IACvC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,QAAiB;IAC1C,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,UAAU,CAAC;AACvC,CAAC"}

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/types.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/types.ts"],"names":[],"mappings":";AAAA,qCAA0B;AACxB,WAAO,KAAK,aAAc;AAD5B;AAKA,sCAA2B;AACzB,WAAO,KAAK,aAAc;AAD5B;AAIA,oCAAyB;AACvB,WAAO,KAAK,aAAc;AAD5B;;AAKA,uCACE;AAEM,yBAAe,KAAK;AAC1B,WACE,gBAAiB,aACjB,gBAAiB,YACjB,gBAAiB;AAPrB;AAWA,oCAAyB;AACvB,WAAO,KAAK,aAAc;AAD5B;AAIA,mCAAwB;AACtB,WAAO,KAAK,aAAc;AAD5B;AAIA,sCAA2B;AACzB,WAAO,KAAK,aAAc;AAD5B","file":"types.lua","sourceRoot":"../src/"}