isaacscript-common 2.3.0 → 3.0.0

package/functions/table.lua

@@ -0,0 +1,98 @@
+local ____lualib = require("lualib_bundle")
+local __TS__TypeOf = ____lualib.__TS__TypeOf
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
+local ____exports = {}
+--- In a Map, you can use the `clear` method to delete every element. However, in a LuaTable, the
+-- `clear` method does not exist. Use this helper function as a drop-in replacement for this.
+function ____exports.clearTable(self, ____table)
+    for key in pairs(____table) do
+        ____table[key] = nil
+    end
+end
+--- Helper function to copy specific values from a object to a table.
+function ____exports.copyValuesToTable(self, object, keys, ____table)
+    local otherTable = object
+    for ____, key in ipairs(keys) do
+        local value = otherTable[key]
+        ____table[key] = value
+    end
+end
+--- Helper function to safely get boolean values from a Lua table. Will throw an error if the
+-- specific value does not exist on the table.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to get N values.
+function ____exports.getBooleansFromTable(self, ____table, objectName, ...)
+    local keys = {...}
+    local booleans = {}
+    for ____, key in ipairs(keys) do
+        local value = ____table[key]
+        if value == nil then
+            error(((("Failed to find a value for \"" .. key) .. "\" in a table representing a \"") .. objectName) .. "\" object.")
+        end
+        if type(value) == "boolean" then
+            booleans[#booleans + 1] = value
+        else
+            error((((("Failed to get the boolean for the \"" .. key) .. "\" value of a table representing a \"") .. objectName) .. "\" object because the type was: ") .. __TS__TypeOf(value))
+        end
+    end
+    return booleans
+end
+--- Helper function to safely get number values from a Lua table. Will throw an error if the specific
+-- value does not exist on the table or if it cannot be converted to a number.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to get N values.
+function ____exports.getNumbersFromTable(self, ____table, objectName, ...)
+    local keys = {...}
+    local numbers = {}
+    for ____, key in ipairs(keys) do
+        local value = ____table[key]
+        if value == nil then
+            error(((("Failed to find a value for \"" .. key) .. "\" in a table representing a \"") .. objectName) .. "\" object.")
+        end
+        if type(value) == "number" then
+            numbers[#numbers + 1] = value
+        elseif type(value) == "string" then
+            local number = tonumber(value)
+            if number == nil then
+                error((((("Failed to convert the \"" .. key) .. "\" value of a table representing a \"") .. objectName) .. "\" object to a number: ") .. value)
+            end
+            numbers[#numbers + 1] = number
+        else
+            error((((("Failed to get the number for the \"" .. key) .. "\" value of a table representing a \"") .. objectName) .. "\" object because the type was: ") .. __TS__TypeOf(value))
+        end
+    end
+    return numbers
+end
+--- Helper function to safely get string values from a Lua table. Will throw an error if the specific
+-- value does not exist on the table.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to get N values.
+function ____exports.getStringsFromTable(self, ____table, objectName, ...)
+    local keys = {...}
+    local strings = {}
+    for ____, key in ipairs(keys) do
+        local value = ____table[key]
+        if value == nil then
+            error(((("Failed to find a value for \"" .. key) .. "\" in a table representing a \"") .. objectName) .. "\" object.")
+        end
+        if type(value) == "string" then
+            strings[#strings + 1] = value
+        else
+            local ____string = tostring(value)
+            strings[#strings + 1] = ____string
+        end
+    end
+    return strings
+end
+--- Helper function to check if a Lua table has all of the provided keys.
+-- 
+-- This function is variadic, meaning that you can specify as many arguments as you want to check
+-- for.
+function ____exports.tableHasKeys(self, ____table, ...)
+    local keys = {...}
+    return __TS__ArrayEvery(
+        keys,
+        function(____, key) return ____table[key] ~= nil end
+    )
+end
+return ____exports

package/functions/tears.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * - Converts the specified amount of tears stat into MaxFireDelay and adds it to the player.
+ * - This function should only be used inside the EvaluateCache callback.
+ * - In this context, the "tears stat" represents what is shown on the in-game stat UI.
+ */
+export declare function addTearsStat(player: EntityPlayer, tearsStat: float): void;
+/**
+ * - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+ *   equivalent to how many tears the player can shoot per frame.
+ * - If you already have a "tears" stat and you want to convert it back to MaxFireDelay, then use
+ *   this function.
+ * - In this context, the "tears stat" represents what is shown on the in-game stat UI.
+ */
+export declare function getFireDelay(tearsStat: float): float;
+/**
+ * - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+ *   equivalent to how many tears the player can shoot per frame.
+ * - If you want to convert this to the "tears" stat that is shown on the in-game stat UI, then use
+ *   this function.
+ */
+export declare function getTearsStat(fireDelay: float): float;

package/functions/tears.lua

@@ -0,0 +1,26 @@
+local ____exports = {}
+--- - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+--   equivalent to how many tears the player can shoot per frame.
+-- - If you already have a "tears" stat and you want to convert it back to MaxFireDelay, then use
+--   this function.
+-- - In this context, the "tears stat" represents what is shown on the in-game stat UI.
+function ____exports.getFireDelay(self, tearsStat)
+    return math.max(30 / tearsStat - 1, -0.9999)
+end
+--- - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+--   equivalent to how many tears the player can shoot per frame.
+-- - If you want to convert this to the "tears" stat that is shown on the in-game stat UI, then use
+--   this function.
+function ____exports.getTearsStat(self, fireDelay)
+    return 30 / (fireDelay + 1)
+end
+--- - Converts the specified amount of tears stat into MaxFireDelay and adds it to the player.
+-- - This function should only be used inside the EvaluateCache callback.
+-- - In this context, the "tears stat" represents what is shown on the in-game stat UI.
+function ____exports.addTearsStat(self, player, tearsStat)
+    local existingTearsStat = ____exports.getTearsStat(nil, player.MaxFireDelay)
+    local newTearsStat = existingTearsStat + tearsStat
+    local newMaxFireDelay = ____exports.getFireDelay(nil, newTearsStat)
+    player.MaxFireDelay = newMaxFireDelay
+end
+return ____exports

package/functions/transformations.d.ts

@@ -0,0 +1,30 @@
+import { CollectibleType, PlayerForm } from "isaac-typescript-definitions";
+/**
+ * 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);
+ * ```
+ */
+export declare function getCollectibleTypesForTransformation(playerForm: PlayerForm): Set<CollectibleType>;
+/** Returns the number of items that a player has towards a particular transformation. */
+export declare function getPlayerNumCollectiblesForTransformation(player: EntityPlayer, playerForm: PlayerForm): int;
+/** Returns a set of the player's current transformations. */
+export declare function getPlayerTransformations(player: EntityPlayer): Set<PlayerForm>;
+/**
+ * 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"
+ * ```
+ */
+export declare function getTransformationName(playerForm: PlayerForm): string;
+export declare function getTransformationsForCollectibleType(collectibleType: CollectibleType): Set<PlayerForm>;
+export declare function hasFlyingTransformation(player: EntityPlayer): boolean;
+export declare function isTransformationFlying(playerForm: PlayerForm): boolean;

package/functions/transformations.lua

@@ -0,0 +1,114 @@
+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 DEFAULT_TRANSFORMATION_NAME = ____transformationNames.DEFAULT_TRANSFORMATION_NAME
+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)
+    local transformationName = TRANSFORMATION_NAMES[playerForm]
+    return transformationName == nil and DEFAULT_TRANSFORMATION_NAME or transformationName
+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/functions/trinketCacheFlag.d.ts

@@ -0,0 +1,10 @@
+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>;

package/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/functions/trinketGive.d.ts

@@ -0,0 +1,38 @@
+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;

package/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/functions/trinkets.d.ts

@@ -0,0 +1,73 @@
+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;