isaacscript-common 6.6.1-dev.2 → 6.6.1

package/dist/functions/transformations.lua

@@ -0,0 +1,112 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local Set = ____lualib.Set
+local __TS__Spread = ____lualib.__TS__Spread
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ItemConfigTag = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTag
+local PlayerForm = ____isaac_2Dtypescript_2Ddefinitions.PlayerForm
+local ____transformationNames = require("objects.transformationNames")
+local TRANSFORMATION_NAMES = ____transformationNames.TRANSFORMATION_NAMES
+local ____collectibles = require("functions.collectibles")
+local getCollectibleTags = ____collectibles.getCollectibleTags
+local ____collectibleTag = require("functions.collectibleTag")
+local getCollectibleTypesWithTag = ____collectibleTag.getCollectibleTypesWithTag
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____player = require("functions.player")
+local getPlayerCollectibleCount = ____player.getPlayerCollectibleCount
+local TRANSFORMATION_TO_TAG_MAP = __TS__New(Map, {
+    {PlayerForm.GUPPY, ItemConfigTag.GUPPY},
+    {PlayerForm.BEELZEBUB, ItemConfigTag.FLY},
+    {PlayerForm.FUN_GUY, ItemConfigTag.MUSHROOM},
+    {PlayerForm.SERAPHIM, ItemConfigTag.ANGEL},
+    {PlayerForm.BOB, ItemConfigTag.BOB},
+    {PlayerForm.SPUN, ItemConfigTag.SYRINGE},
+    {PlayerForm.YES_MOTHER, ItemConfigTag.MOM},
+    {PlayerForm.CONJOINED, ItemConfigTag.BABY},
+    {PlayerForm.LEVIATHAN, ItemConfigTag.DEVIL},
+    {PlayerForm.OH_CRAP, ItemConfigTag.POOP},
+    {PlayerForm.BOOKWORM, ItemConfigTag.BOOK},
+    {PlayerForm.SPIDER_BABY, ItemConfigTag.SPIDER}
+})
+local TRANSFORMATIONS_THAT_GRANT_FLYING = __TS__New(Set, {PlayerForm.GUPPY, PlayerForm.BEELZEBUB, PlayerForm.SERAPHIM, PlayerForm.LEVIATHAN})
+--- Helper function to get all of the collectible types in the game that count towards a particular
+-- transformation.
+-- 
+-- For example, to get all of the collectible types that count towards Guppy:
+-- 
+-- ```ts
+-- const guppyCollectibleTypes = getCollectibleTypesForTransformation(PlayerForm.GUPPY);
+-- ```
+function ____exports.getCollectibleTypesForTransformation(self, playerForm)
+    local itemConfigTag = TRANSFORMATION_TO_TAG_MAP:get(playerForm)
+    if itemConfigTag == nil then
+        error(("Failed to get the collectible types for the transformation of " .. tostring(playerForm)) .. " because that transformation is not based on collectibles.")
+    end
+    return getCollectibleTypesWithTag(nil, itemConfigTag)
+end
+--- Returns the number of items that a player has towards a particular transformation.
+function ____exports.getPlayerNumCollectiblesForTransformation(self, player, playerForm)
+    local collectibleTypes = ____exports.getCollectibleTypesForTransformation(nil, playerForm)
+    return getPlayerCollectibleCount(
+        nil,
+        player,
+        __TS__Spread(collectibleTypes:values())
+    )
+end
+--- Returns a set of the player's current transformations.
+function ____exports.getPlayerTransformations(self, player)
+    local transformations = __TS__New(Set)
+    for ____, playerForm in ipairs(getEnumValues(nil, PlayerForm)) do
+        if player:HasPlayerForm(playerForm) then
+            transformations:add(playerForm)
+        end
+    end
+    return transformations
+end
+--- Helper function to get a transformation name from a PlayerForm enum.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const transformationName = getTransformationName(PlayerForm.LORD_OF_THE_FLIES);
+-- // transformationName is "Beelzebub"
+-- ```
+function ____exports.getTransformationName(self, playerForm)
+    return TRANSFORMATION_NAMES[playerForm]
+end
+function ____exports.getTransformationsForCollectibleType(self, collectibleType)
+    local itemConfigTags = getCollectibleTags(nil, collectibleType)
+    local playerForms = getEnumValues(nil, PlayerForm)
+    local transformationSet = __TS__New(Set)
+    for ____, playerForm in ipairs(playerForms) do
+        do
+            local itemConfigTag = TRANSFORMATION_TO_TAG_MAP:get(playerForm)
+            if itemConfigTag == nil then
+                goto __continue11
+            end
+            if hasFlag(nil, itemConfigTags, itemConfigTag) then
+                transformationSet:add(playerForm)
+            end
+        end
+        ::__continue11::
+    end
+    return transformationSet
+end
+function ____exports.hasFlyingTransformation(self, player)
+    for ____, playerForm in __TS__Iterator(TRANSFORMATIONS_THAT_GRANT_FLYING:values()) do
+        if player:HasPlayerForm(playerForm) then
+            return true
+        end
+    end
+    return false
+end
+function ____exports.isTransformationFlying(self, playerForm)
+    return TRANSFORMATIONS_THAT_GRANT_FLYING:has(playerForm)
+end
+return ____exports

package/dist/functions/trinketCacheFlag.d.ts

@@ -0,0 +1,11 @@
+import { CacheFlag, TrinketType } from "isaac-typescript-definitions";
+/**
+ * Returns a map containing every trinket type that the player has that matches the provided
+ * CacheFlag. The values of the map correspond to the multiplier for that trinket.
+ */
+export declare function getPlayerTrinketsForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): Map<TrinketType, int>;
+/**
+ * Returns a set containing every trinket type with the given cache flag, including modded trinkets.
+ */
+export declare function getTrinketsForCacheFlag(cacheFlag: CacheFlag): Set<TrinketType>;
+//# sourceMappingURL=trinketCacheFlag.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trinketCacheFlag.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/trinketCacheFlag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAqBtE;;;GAGG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAYvB;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,CAAC,CAYlB"}

package/dist/functions/trinketCacheFlag.lua

@@ -0,0 +1,53 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local Set = ____lualib.Set
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local initCacheFlagMap, CACHE_FLAG_TO_TRINKETS_MAP
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____set = require("functions.set")
+local copySet = ____set.copySet
+local ____trinkets = require("functions.trinkets")
+local getTrinketTypes = ____trinkets.getTrinketTypes
+local trinketHasCacheFlag = ____trinkets.trinketHasCacheFlag
+function initCacheFlagMap(self)
+    for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
+        local trinketsSet = __TS__New(Set)
+        for ____, trinketType in ipairs(getTrinketTypes(nil)) do
+            if trinketHasCacheFlag(nil, trinketType, cacheFlag) then
+                trinketsSet:add(trinketType)
+            end
+        end
+        CACHE_FLAG_TO_TRINKETS_MAP:set(cacheFlag, trinketsSet)
+    end
+end
+--- Returns a set containing every trinket type with the given cache flag, including modded trinkets.
+function ____exports.getTrinketsForCacheFlag(self, cacheFlag)
+    if CACHE_FLAG_TO_TRINKETS_MAP.size == 0 then
+        initCacheFlagMap(nil)
+    end
+    local trinketsSet = CACHE_FLAG_TO_TRINKETS_MAP:get(cacheFlag)
+    if trinketsSet == nil then
+        return __TS__New(Set)
+    end
+    return copySet(nil, trinketsSet)
+end
+CACHE_FLAG_TO_TRINKETS_MAP = __TS__New(Map)
+--- Returns a map containing every trinket type that the player has that matches the provided
+-- CacheFlag. The values of the map correspond to the multiplier for that trinket.
+function ____exports.getPlayerTrinketsForCacheFlag(self, player, cacheFlag)
+    local trinketsForCacheFlag = ____exports.getTrinketsForCacheFlag(nil, cacheFlag)
+    local playerTrinkets = __TS__New(Map)
+    for ____, trinketType in __TS__Iterator(trinketsForCacheFlag:values()) do
+        local trinketMultiplier = player:GetTrinketMultiplier(trinketType)
+        if trinketMultiplier > 0 then
+            playerTrinkets:set(trinketType, trinketMultiplier)
+        end
+    end
+    return playerTrinkets
+end
+return ____exports

package/dist/functions/trinketGive.d.ts

@@ -0,0 +1,39 @@
+import { TrinketType } from "isaac-typescript-definitions";
+import { TrinketSituation } from "../interfaces/TrinketSituation";
+/**
+ * Helper function to restore the player's trinkets back to the way they were before the
+ * `temporarilyRemoveTrinket` function was used. It will re-smelt any smelted trinkets that were
+ * removed.
+ */
+export declare function giveTrinketsBack(player: EntityPlayer, trinketSituation: TrinketSituation | undefined): void;
+/**
+ * Helper function to smelt a trinket. Before smelting, this function will automatically remove the
+ * trinkets that the player is holding, if any, and then give them back after the new trinket is
+ * smelted.
+ *
+ * @param player The player to smelt the trinkets to.
+ * @param trinketType The trinket type to smelt.
+ * @param numTrinkets Optional. If specified, will smelt the given number of trinkets. Use this to
+ *                    avoid calling this function multiple times. Default is 1.
+ */
+export declare function smeltTrinket(player: EntityPlayer, trinketType: TrinketType, numTrinkets?: number): void;
+/**
+ * Helper function to temporarily remove a specific kind of trinket from the player. Use this in
+ * combination with the `giveTrinketsBack` function to take away and give back a trinket on the same
+ * frame. This function correctly handles multiple trinket slots and ensures that all copies of the
+ * trinket are removed, including smelted trinkets.
+ *
+ * Note that one smelted golden trinket is the same as two smelted normal trinkets.
+ *
+ * @returns Undefined if the player does not have the trinket, or TrinketSituation if they do.
+ */
+export declare function temporarilyRemoveTrinket(player: EntityPlayer, trinketType: TrinketType): TrinketSituation | undefined;
+/**
+ * Helper function to temporarily removes a player's held trinkets, if any. This will not remove any
+ * smelted trinkets. Use this in combination with the `giveTrinketsBack` function to take away and
+ * give back trinkets on the same frame.
+ *
+ * @returns Undefined if the player does not have any trinkets, or TrinketSituation if they do.
+ */
+export declare function temporarilyRemoveTrinkets(player: EntityPlayer): TrinketSituation | undefined;
+//# sourceMappingURL=trinketGive.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trinketGive.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/trinketGive.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,WAAW,EACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAKlE;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,YAAY,EACpB,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,GAC7C,IAAI,CA+BN;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,EACxB,WAAW,SAAI,GACd,IAAI,CASN;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,gBAAgB,GAAG,SAAS,CAkC9B;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,GACnB,gBAAgB,GAAG,SAAS,CAsB9B"}

package/dist/functions/trinketGive.lua

@@ -0,0 +1,114 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local TrinketSlot = ____isaac_2Dtypescript_2Ddefinitions.TrinketSlot
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____player = require("functions.player")
+local useActiveItemTemp = ____player.useActiveItemTemp
+local ____trinkets = require("functions.trinkets")
+local getGoldenTrinketType = ____trinkets.getGoldenTrinketType
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
+--- Helper function to temporarily removes a player's held trinkets, if any. This will not remove any
+-- smelted trinkets. Use this in combination with the `giveTrinketsBack` function to take away and
+-- give back trinkets on the same frame.
+-- 
+-- @returns Undefined if the player does not have any trinkets, or TrinketSituation if they do.
+function ____exports.temporarilyRemoveTrinkets(self, player)
+    local trinketType1 = player:GetTrinket(TrinketSlot.SLOT_1)
+    local trinketType2 = player:GetTrinket(TrinketSlot.SLOT_2)
+    if trinketType1 == TrinketType.NULL and trinketType2 == TrinketType.NULL then
+        return nil
+    end
+    if trinketType1 ~= TrinketType.NULL then
+        player:TryRemoveTrinket(trinketType1)
+    end
+    if trinketType2 ~= TrinketType.NULL then
+        player:TryRemoveTrinket(trinketType2)
+    end
+    return {trinketTypeRemoved = TrinketType.NULL, trinketType1 = trinketType1, trinketType2 = trinketType2, numSmeltedTrinkets = 0}
+end
+--- Helper function to restore the player's trinkets back to the way they were before the
+-- `temporarilyRemoveTrinket` function was used. It will re-smelt any smelted trinkets that were
+-- removed.
+function ____exports.giveTrinketsBack(self, player, trinketSituation)
+    if trinketSituation == nil then
+        return
+    end
+    local trinketType1 = player:GetTrinket(TrinketSlot.SLOT_1)
+    local trinketType2 = player:GetTrinket(TrinketSlot.SLOT_2)
+    if trinketType1 ~= TrinketType.NULL then
+        player:TryRemoveTrinket(trinketType1)
+    end
+    if trinketType2 ~= TrinketType.NULL then
+        player:TryRemoveTrinket(trinketType2)
+    end
+    ____repeat(
+        nil,
+        trinketSituation.numSmeltedTrinkets,
+        function()
+            player:AddTrinket(trinketSituation.trinketTypeRemoved, false)
+            useActiveItemTemp(nil, player, CollectibleType.SMELTER)
+        end
+    )
+    if trinketSituation.trinketType1 ~= TrinketType.NULL then
+        player:AddTrinket(trinketSituation.trinketType1, false)
+    end
+    if trinketSituation.trinketType2 ~= TrinketType.NULL then
+        player:AddTrinket(trinketSituation.trinketType2, false)
+    end
+end
+--- Helper function to smelt a trinket. Before smelting, this function will automatically remove the
+-- trinkets that the player is holding, if any, and then give them back after the new trinket is
+-- smelted.
+-- 
+-- @param player The player to smelt the trinkets to.
+-- @param trinketType The trinket type to smelt.
+-- @param numTrinkets Optional. If specified, will smelt the given number of trinkets. Use this to
+-- avoid calling this function multiple times. Default is 1.
+function ____exports.smeltTrinket(self, player, trinketType, numTrinkets)
+    if numTrinkets == nil then
+        numTrinkets = 1
+    end
+    local trinketSituation = ____exports.temporarilyRemoveTrinkets(nil, player)
+    ____repeat(
+        nil,
+        numTrinkets,
+        function()
+            player:AddTrinket(trinketType)
+            useActiveItemTemp(nil, player, CollectibleType.SMELTER)
+        end
+    )
+    ____exports.giveTrinketsBack(nil, player, trinketSituation)
+end
+--- Helper function to temporarily remove a specific kind of trinket from the player. Use this in
+-- combination with the `giveTrinketsBack` function to take away and give back a trinket on the same
+-- frame. This function correctly handles multiple trinket slots and ensures that all copies of the
+-- trinket are removed, including smelted trinkets.
+-- 
+-- Note that one smelted golden trinket is the same as two smelted normal trinkets.
+-- 
+-- @returns Undefined if the player does not have the trinket, or TrinketSituation if they do.
+function ____exports.temporarilyRemoveTrinket(self, player, trinketType)
+    if not player:HasTrinket(trinketType) then
+        return nil
+    end
+    local trinketType1 = player:GetTrinket(TrinketSlot.SLOT_1)
+    local trinketType2 = player:GetTrinket(TrinketSlot.SLOT_2)
+    local numTrinkets = 0
+    while player:HasTrinket(trinketType) do
+        player:TryRemoveTrinket(trinketType)
+        numTrinkets = numTrinkets + 1
+    end
+    local numSmeltedTrinkets = numTrinkets
+    local trinketWasInSlot1 = trinketType1 == trinketType or trinketType1 == getGoldenTrinketType(nil, trinketType)
+    if trinketWasInSlot1 then
+        numSmeltedTrinkets = numSmeltedTrinkets - 1
+    end
+    local trinketWasInSlot2 = trinketType2 == trinketType or trinketType2 == getGoldenTrinketType(nil, trinketType)
+    if trinketWasInSlot2 then
+        numSmeltedTrinkets = numSmeltedTrinkets - 1
+    end
+    return {trinketTypeRemoved = trinketType, trinketType1 = trinketType1, trinketType2 = trinketType2, numSmeltedTrinkets = numSmeltedTrinkets}
+end
+return ____exports

package/dist/functions/trinkets.d.ts

@@ -0,0 +1,74 @@
+import { CacheFlag, TrinketType } from "isaac-typescript-definitions";
+/**
+ * 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 declare function getGoldenTrinketType(trinketType: TrinketType): TrinketType;
+/**
+ * Helper function to get an array that represents every modded trinket type.
+ *
+ * Returns an empty array if there are no modded trinket types.
+ */
+export declare function getModdedTrinketTypes(): TrinketType[];
+/**
+ * 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 declare function getOpenTrinketSlot(player: EntityPlayer): int | undefined;
+/**
+ * Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
+ * trinket type was not valid.
+ */
+export declare function getTrinketDescription(trinketType: TrinketType): string;
+/**
+ * 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 declare function getTrinketName(trinketType: TrinketType): string;
+/** Helper function to get an array that contains every trinket type. */
+export declare function getTrinketTypes(): TrinketType[];
+/** Helper function to get an array that represents every vanilla trinket type. */
+export declare function getVanillaTrinketTypes(): TrinketType[];
+/**
+ * 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 declare function hasOpenTrinketSlot(player: EntityPlayer): boolean;
+export declare function isGoldenTrinket(trinketType: TrinketType): boolean;
+/**
+ * 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 declare function setTrinketSprite(trinket: EntityPickup, pngPath: string | undefined): void;
+export declare function trinketHasCacheFlag(trinketType: TrinketType, cacheFlag: CacheFlag): boolean;
+//# sourceMappingURL=trinkets.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trinkets.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/trinkets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAGT,WAAW,EACZ,MAAM,8BAA8B,CAAC;AA+BtC;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,CAE1E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,IAAI,WAAW,EAAE,CAMrD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,GAAG,SAAS,CAkBxE;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CActE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAc/D;AAED,wEAAwE;AACxE,wBAAgB,eAAe,IAAI,WAAW,EAAE,CAE/C;AAED,kFAAkF;AAClF,wBAAgB,sBAAsB,IAAI,WAAW,EAAE,CAEtD;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAOhE;AAED,wBAAgB,eAAe,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEjE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAeN;AAED,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT"}

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/tstlClass.d.ts

@@ -0,0 +1,55 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+import { DefaultMap } from "../classes/DefaultMap";
+import { TSTLClass } from "../types/private/TSTLClass";
+/**
+ * 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 declare function getTSTLClassName(object: unknown): string | undefined;
+/**
+ * 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 declare function isDefaultMap(object: unknown): object is DefaultMap<AnyNotNil, unknown>;
+/**
+ * Returns whether or not this is a class that is provided by the `isaacscript-common` library, such
+ * as a `DefaultMap`.
+ */
+export declare function isIsaacScriptCommonClass(object: unknown): boolean;
+/**
+ * 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 declare function isTSTLMap(object: unknown): object is Map<AnyNotNil, unknown>;
+/**
+ * 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 declare function isTSTLSet(object: unknown): object is Set<AnyNotNil>;
+/** TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys. */
+export declare function isUserDefinedTSTLClass(object: unknown): object is TSTLClass;
+/**
+ * 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 declare function isVanillaTSTLClass(object: unknown): boolean;
+/**
+ * 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 declare function newTSTLClass(oldClass: TSTLClass): TSTLClass;
+//# sourceMappingURL=tstlClass.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tstlClass.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/tstlClass.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAWvD;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAiBpE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAG1C;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAEjE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAG5E;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAGnE;AAED,kGAAkG;AAClG,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,SAAS,CA4B3E;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAO3D;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAS3D"}