isaacscript-common 14.1.3 → 15.0.0

package/dist/src/classes/features/other/ModdedElementDetection.lua

@@ -0,0 +1,249 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____cachedClasses = require("src.core.cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
+local ____constantsFirstLast = require("src.core.constantsFirstLast")
+local FIRST_CARD_TYPE = ____constantsFirstLast.FIRST_CARD_TYPE
+local FIRST_PILL_EFFECT = ____constantsFirstLast.FIRST_PILL_EFFECT
+local FIRST_TRINKET_TYPE = ____constantsFirstLast.FIRST_TRINKET_TYPE
+local LAST_VANILLA_CARD_TYPE = ____constantsFirstLast.LAST_VANILLA_CARD_TYPE
+local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_VANILLA_COLLECTIBLE_TYPE
+local LAST_VANILLA_PILL_EFFECT = ____constantsFirstLast.LAST_VANILLA_PILL_EFFECT
+local LAST_VANILLA_TRINKET_TYPE = ____constantsFirstLast.LAST_VANILLA_TRINKET_TYPE
+local NUM_VANILLA_CARD_TYPES = ____constantsFirstLast.NUM_VANILLA_CARD_TYPES
+local NUM_VANILLA_COLLECTIBLE_TYPES = ____constantsFirstLast.NUM_VANILLA_COLLECTIBLE_TYPES
+local NUM_VANILLA_PILL_EFFECTS = ____constantsFirstLast.NUM_VANILLA_PILL_EFFECTS
+local NUM_VANILLA_TRINKET_TYPES = ____constantsFirstLast.NUM_VANILLA_TRINKET_TYPES
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____types = require("src.functions.types")
+local asCardType = ____types.asCardType
+local asCollectibleType = ____types.asCollectibleType
+local asNumber = ____types.asNumber
+local asPillEffect = ____types.asPillEffect
+local asTrinketType = ____types.asTrinketType
+local ____utils = require("src.functions.utils")
+local iRange = ____utils.iRange
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+--- Mods can add extra things to the game (e.g. collectibles, trinkets, and so on). Since mods load
+-- in alphabetical order, the total number of things can't be properly be known until at least one
+-- callback fires (which indicates that all mods have been loaded).
+-- 
+-- This feature gates all such functions behind a callback check. Subsequently, these functions will
+-- throw a runtime error if they are called in the menu, before any callbacks have occurred. This
+-- ensures that the proper values are always returned and allows you to get immediate feedback if
+-- you accidentally access them from the menu.
+____exports.ModdedElementDetection = __TS__Class()
+local ModdedElementDetection = ____exports.ModdedElementDetection
+ModdedElementDetection.name = "ModdedElementDetection"
+__TS__ClassExtends(ModdedElementDetection, Feature)
+function ModdedElementDetection.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.atLeastOneCallbackFired = false
+    self.postPlayerInit = function(____, _player)
+        self.atLeastOneCallbackFired = true
+    end
+    self.callbacksUsed = {{ModCallback.POST_PLAYER_INIT, {self.postPlayerInit}}}
+end
+function ModdedElementDetection.prototype.errorIfNoCallbacksFired(self, constantType)
+    if not self.atLeastOneCallbackFired then
+        error(("Failed to retrieve a " .. constantType) .. " constant. Since not all mods have been loaded yet, any constants of this type will be inaccurate. Thus, you must wait until at least one callback fires before retrieving these types of constants.")
+    end
+end
+function ModdedElementDetection.prototype.getFirstModdedCollectibleType(self)
+    self:errorIfNoCallbacksFired("collectible")
+    local firstModdedCollectibleType = asCollectibleType(
+        nil,
+        asNumber(nil, LAST_VANILLA_COLLECTIBLE_TYPE) + 1
+    )
+    local itemConfigItem = itemConfig:GetCollectible(firstModdedCollectibleType)
+    local ____temp_0
+    if itemConfigItem == nil then
+        ____temp_0 = nil
+    else
+        ____temp_0 = firstModdedCollectibleType
+    end
+    return ____temp_0
+end
+function ModdedElementDetection.prototype.getLastCollectibleType(self)
+    self:errorIfNoCallbacksFired("collectible")
+    return itemConfig:GetCollectibles().Size - 1
+end
+function ModdedElementDetection.prototype.getModdedCollectibleTypes(self)
+    self:errorIfNoCallbacksFired("collectible")
+    local firstModdedCollectibleType = self:getFirstModdedCollectibleType()
+    if firstModdedCollectibleType == nil then
+        return {}
+    end
+    local lastCollectibleType = self:getLastCollectibleType()
+    return iRange(nil, firstModdedCollectibleType, lastCollectibleType)
+end
+function ModdedElementDetection.prototype.getNumCollectibleTypes(self)
+    self:errorIfNoCallbacksFired("collectible")
+    local numModdedCollectibleTypes = self:getNumModdedCollectibleTypes()
+    return NUM_VANILLA_COLLECTIBLE_TYPES + numModdedCollectibleTypes
+end
+function ModdedElementDetection.prototype.getNumModdedCollectibleTypes(self)
+    self:errorIfNoCallbacksFired("collectible")
+    local lastCollectibleType = self:getLastCollectibleType()
+    return lastCollectibleType - LAST_VANILLA_COLLECTIBLE_TYPE
+end
+function ModdedElementDetection.prototype.getFirstModdedTrinketType(self)
+    self:errorIfNoCallbacksFired("trinket")
+    local firstModdedTrinketType = asTrinketType(
+        nil,
+        asNumber(nil, LAST_VANILLA_TRINKET_TYPE) + 1
+    )
+    local itemConfigItem = itemConfig:GetTrinket(firstModdedTrinketType)
+    local ____temp_1
+    if itemConfigItem == nil then
+        ____temp_1 = nil
+    else
+        ____temp_1 = firstModdedTrinketType
+    end
+    return ____temp_1
+end
+function ModdedElementDetection.prototype.getLastTrinketType(self)
+    self:errorIfNoCallbacksFired("trinket")
+    local numTrinketTypes = self:getNumTrinketTypes()
+    return asTrinketType(nil, numTrinketTypes)
+end
+function ModdedElementDetection.prototype.getModdedTrinketTypes(self)
+    self:errorIfNoCallbacksFired("trinket")
+    local firstModdedTrinketType = self:getFirstModdedTrinketType()
+    if firstModdedTrinketType == nil then
+        return {}
+    end
+    local lastTrinketType = self:getLastTrinketType()
+    return iRange(nil, firstModdedTrinketType, lastTrinketType)
+end
+function ModdedElementDetection.prototype.getNumTrinketTypes(self)
+    self:errorIfNoCallbacksFired("trinket")
+    return itemConfig:GetTrinkets().Size - 1
+end
+function ModdedElementDetection.prototype.getNumModdedTrinketTypes(self)
+    self:errorIfNoCallbacksFired("trinket")
+    local numTrinketTypes = self:getNumTrinketTypes()
+    return numTrinketTypes - NUM_VANILLA_TRINKET_TYPES
+end
+function ModdedElementDetection.prototype.getTrinketTypes(self)
+    self:errorIfNoCallbacksFired("trinket")
+    local lastTrinketType = self:getLastTrinketType()
+    return iRange(nil, FIRST_TRINKET_TYPE, lastTrinketType)
+end
+function ModdedElementDetection.prototype.getAllCardTypes(self)
+    self:errorIfNoCallbacksFired("card")
+    local lastCardType = self:getLastCardType()
+    return iRange(nil, FIRST_CARD_TYPE, lastCardType)
+end
+function ModdedElementDetection.prototype.getFirstModdedCardType(self)
+    self:errorIfNoCallbacksFired("card")
+    local firstModdedCardType = asCardType(
+        nil,
+        asNumber(nil, LAST_VANILLA_CARD_TYPE) + 1
+    )
+    local itemConfigCard = itemConfig:GetCard(firstModdedCardType)
+    local ____temp_2
+    if itemConfigCard == nil then
+        ____temp_2 = nil
+    else
+        ____temp_2 = firstModdedCardType
+    end
+    return ____temp_2
+end
+function ModdedElementDetection.prototype.getLastCardType(self)
+    self:errorIfNoCallbacksFired("card")
+    local numCards = self:getNumCardTypes()
+    return asCardType(nil, numCards)
+end
+function ModdedElementDetection.prototype.getModdedCardTypes(self)
+    self:errorIfNoCallbacksFired("card")
+    local firstModdedCardType = self:getFirstModdedCardType()
+    if firstModdedCardType == nil then
+        return {}
+    end
+    local lastCardType = self:getLastCardType()
+    return iRange(nil, firstModdedCardType, lastCardType)
+end
+function ModdedElementDetection.prototype.getNumCardTypes(self)
+    self:errorIfNoCallbacksFired("card")
+    return itemConfig:GetCards().Size - 1
+end
+function ModdedElementDetection.prototype.getNumModdedCardTypes(self)
+    self:errorIfNoCallbacksFired("card")
+    local numCardTypes = self:getNumCardTypes()
+    return numCardTypes - NUM_VANILLA_CARD_TYPES
+end
+function ModdedElementDetection.prototype.getAllPillEffects(self)
+    self:errorIfNoCallbacksFired("pill")
+    local lastPillEffect = self:getLastPillEffect()
+    return iRange(nil, FIRST_PILL_EFFECT, lastPillEffect)
+end
+function ModdedElementDetection.prototype.getFirstModdedPillEffect(self)
+    self:errorIfNoCallbacksFired("pill")
+    local firstModdedPillEffect = asPillEffect(
+        nil,
+        asNumber(nil, LAST_VANILLA_PILL_EFFECT) + 1
+    )
+    local itemConfigPillEffect = itemConfig:GetPillEffect(firstModdedPillEffect)
+    local ____temp_3
+    if itemConfigPillEffect == nil then
+        ____temp_3 = nil
+    else
+        ____temp_3 = firstModdedPillEffect
+    end
+    return ____temp_3
+end
+function ModdedElementDetection.prototype.getLastPillEffect(self)
+    self:errorIfNoCallbacksFired("pill")
+    local numPillEffects = self:getNumPillEffects()
+    return asPillEffect(nil, numPillEffects)
+end
+function ModdedElementDetection.prototype.getModdedPillEffects(self)
+    self:errorIfNoCallbacksFired("pill")
+    local firstModdedPillEffect = self:getFirstModdedPillEffect()
+    if firstModdedPillEffect == nil then
+        return {}
+    end
+    local lastPillEffect = self:getLastPillEffect()
+    return iRange(nil, firstModdedPillEffect, lastPillEffect)
+end
+function ModdedElementDetection.prototype.getNumPillEffects(self)
+    self:errorIfNoCallbacksFired("pill")
+    return itemConfig:GetPillEffects().Size
+end
+function ModdedElementDetection.prototype.getNumModdedPillEffects(self)
+    self:errorIfNoCallbacksFired("pill")
+    local numPillEffects = self:getNumPillEffects()
+    return numPillEffects - NUM_VANILLA_PILL_EFFECTS
+end
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getFirstModdedCollectibleType", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getLastCollectibleType", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getModdedCollectibleTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getNumCollectibleTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getNumModdedCollectibleTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getFirstModdedTrinketType", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getLastTrinketType", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getModdedTrinketTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getNumTrinketTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getNumModdedTrinketTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getTrinketTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getAllCardTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getFirstModdedCardType", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getLastCardType", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getModdedCardTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getNumCardTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getNumModdedCardTypes", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getAllPillEffects", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getFirstModdedPillEffect", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getLastPillEffect", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getModdedPillEffects", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getNumPillEffects", true)
+__TS__Decorate({Exported}, ModdedElementDetection.prototype, "getNumModdedPillEffects", true)
+return ____exports

package/dist/src/classes/features/other/ModdedElementSets.d.ts

@@ -0,0 +1,261 @@
+import { CacheFlag, CollectibleType, ItemConfigTag, PlayerForm, TrinketType } from "isaac-typescript-definitions";
+import { Feature } from "../../private/Feature";
+export declare class ModdedElementSets extends Feature {
+    private allCollectibleTypesArray;
+    private allCollectibleTypesSet;
+    private vanillaCollectibleTypesArray;
+    private vanillaCollectibleTypesSet;
+    private moddedCollectibleTypesArray;
+    private moddedCollectibleTypesSet;
+    private allTrinketTypesArray;
+    private allTrinketTypesSet;
+    private vanillaTrinketTypesArray;
+    private vanillaTrinketTypesSet;
+    private moddedTrinketTypesArray;
+    private moddedTrinketTypesSet;
+    private tagToCollectibleTypesMap;
+    private cacheFlagToCollectibleTypesMap;
+    private cacheFlagToTrinketTypesMap;
+    private flyingCollectibleTypesSet;
+    private permanentFlyingCollectibleTypesSet;
+    private flyingTrinketTypesSet;
+    private edenActiveCollectibleTypesSet;
+    private edenPassiveCollectibleTypesSet;
+    private moddedElementDetection;
+    private lazyInitVanillaCollectibleTypes;
+    private lazyInitModdedCollectibleTypes;
+    private lazyInitVanillaTrinketTypes;
+    private lazyInitModdedTrinketTypes;
+    private lazyInitTagToCollectibleTypesMap;
+    private lazyInitCacheFlagToCollectibleTypesMap;
+    private lazyInitCacheFlagToTrinketTypesMap;
+    private lazyInitFlyingCollectibleTypesSet;
+    private lazyInitFlyingTrinketTypesSet;
+    private lazyInitEdenCollectibleTypesSet;
+    /**
+     * Returns an array containing every valid collectible type in the game, including modded
+     * collectibles.
+     *
+     * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+     * then use the `getCollectibleSet` helper function instead.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all collectibles will necessarily be present when a mod first loads (due to mod load
+     * order).
+     */
+    getCollectibleArray(): readonly CollectibleType[];
+    /**
+     * Returns a set containing every valid collectible type in the game, including modded
+     * collectibles.
+     *
+     * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+     * then use the `getCollectibleArray` helper function instead.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all collectibles will necessarily be present when a mod first loads (due to mod load
+     * order).
+     */
+    getCollectibleSet(): ReadonlySet<CollectibleType>;
+    /**
+     * 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 = getCollectiblesForTransformation(PlayerForm.GUPPY);
+     * ```
+     */
+    getCollectiblesForTransformation(playerForm: PlayerForm): ReadonlySet<CollectibleType>;
+    /**
+     * Returns a set containing every collectible type with the given cache flag, including modded
+     * collectibles.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all collectibles will necessarily be present when a mod first loads (due to mod load
+     * order).
+     */
+    getCollectiblesWithCacheFlag(cacheFlag: CacheFlag): ReadonlySet<CollectibleType>;
+    /**
+     * Returns a set containing every collectible type with the given tag.
+     *
+     * For example, to get all of the collectible types that count as offensive for the purposes of
+     * Tainted Lost:
+     *
+     * ```ts
+     * const offensiveCollectibleTypes = getCollectibleTypesWithTag(ItemConfigTag.OFFENSIVE);
+     * ```
+     */
+    getCollectiblesWithTag(itemConfigTag: ItemConfigTag): ReadonlySet<CollectibleType>;
+    /**
+     * Returns a set containing every valid passive item that can be randomly granted to Eden as a
+     * starting item.
+     */
+    getEdenActiveCollectibles(): ReadonlySet<CollectibleType>;
+    /**
+     * Returns a set containing every valid passive item that can be randomly granted to Eden as a
+     * starting item.
+     */
+    getEdenPassiveCollectibles(): ReadonlySet<CollectibleType>;
+    /**
+     * Returns a set of all of the collectibles that grant flight. This is derived from collectibles
+     * that have `CacheFlag.FLYING` set in the "items.xml" file.
+     *
+     * Collectibles that only grant flight conditionally are manually pruned. Collectibles such as
+     * Empty Vessel should be checked for via the `hasFlyingTemporaryEffect` function.
+     *
+     * @param pruneConditionalItems Whether or not collectibles that only grant flight conditionally
+     *                              should be included in the set (like Empty Vessel).
+     */
+    getFlyingCollectibles(pruneConditionalItems: boolean): ReadonlySet<CollectibleType>;
+    /**
+     * Returns a set of all of the trinkets that grant flight. (All trinkets that grant flight do so
+     * conditionally, like Bat Wing and Azazel's Stump.)
+     */
+    getFlyingTrinkets(): ReadonlySet<TrinketType>;
+    /**
+     * Returns an array containing every modded collectible type in the game.
+     *
+     * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+     * then use the `getModdedCollectibleSet` helper function instead.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all collectibles will necessarily be present when a mod first loads (due to mod load
+     * order).
+     */
+    getModdedCollectibleArray(): readonly CollectibleType[];
+    /**
+     * Returns a set containing every modded collectible type in the game.
+     *
+     * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+     * then use the `getModdedCollectibleArray` helper function instead.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all collectibles will necessarily be present when a mod first loads (due to mod load
+     * order).
+     */
+    getModdedCollectibleSet(): ReadonlySet<CollectibleType>;
+    /**
+     * Returns an array containing every valid trinket type in the game, including modded trinkets.
+     *
+     * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups,
+     * then use the `getTrinketSet` helper function instead.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     */
+    getModdedTrinketArray(): readonly TrinketType[];
+    /**
+     * Returns a set containing every valid trinket type in the game, including modded trinkets.
+     *
+     * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order,
+     * then use the `getTrinketArray` helper function instead.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     */
+    getModdedTrinketSet(): ReadonlySet<TrinketType>;
+    /**
+     * Iterates over every item in the game and returns a map containing the number of each item that
+     * the player has.
+     *
+     * Note that this will filter out non-real collectibles like Lilith's Incubus.
+     */
+    getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType, int>;
+    /**
+     * Returns an array containing every collectible type that the player has that matches the
+     * provided `CacheFlag`.
+     *
+     * For example, if the cache flag is `CacheFlag.FLYING`, and the player has one Lord of the Pit
+     * and two Dead Doves, then this function would return:
+     *
+     * ```ts
+     * [
+     *   CollectibleType.LORD_OF_THE_PIT,
+     *   CollectibleType.DEAD_DOVE,
+     *   CollectibleType.DEAD_DOVE,
+     * ]
+     * ```
+     *
+     * Note that this array will not include collectibles that the player does not really have, like
+     * Lilith's Incubus.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all collectibles will necessarily be present when a mod first loads (due to mod load
+     * order).
+     */
+    getPlayerCollectiblesWithCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): CollectibleType[];
+    /** Returns the number of items that a player has towards a particular transformation. */
+    getPlayerCollectiblesWithTag(player: EntityPlayer, itemConfigTag: ItemConfigTag): CollectibleType[];
+    /** Returns the number of items that a player has towards a particular transformation. */
+    getPlayerCollectiblesForTransformation(player: EntityPlayer, playerForm: PlayerForm): CollectibleType[];
+    /**
+     * 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.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     */
+    getPlayerTrinketsWithCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): Map<TrinketType, int>;
+    /** Returns a random active collectible type that that is a valid starting item for Eden. */
+    getRandomEdenActiveCollectible(seedOrRNG?: Seed | RNG, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
+    /** Returns a random passive collectible type that that is a valid starting item for Eden. */
+    getRandomEdenPassiveCollectible(seedOrRNG?: Seed | RNG, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
+    /**
+     * Returns an array containing every modded trinket type in the game.
+     *
+     * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups,
+     * then use the `getModdedTrinketSet` helper function instead.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     */
+    getTrinketArray(): readonly TrinketType[];
+    /**
+     * Returns a set containing every modded trinket type in the game.
+     *
+     * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order,
+     * then use the `getModdedTrinketArray` helper function instead.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     */
+    getTrinketSet(): ReadonlySet<TrinketType>;
+    /**
+     * Returns a set containing every trinket type with the given cache flag, including modded
+     * trinkets.
+     *
+     * This function can only be called if at least one callback has been executed. This is because
+     * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
+     */
+    getTrinketsWithCacheFlag(cacheFlag: CacheFlag): ReadonlySet<TrinketType>;
+    /**
+     * Returns an array containing every valid vanilla collectible type in the game.
+     *
+     * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+     * then use the `getVanillaCollectibleSet` helper function instead.
+     */
+    getVanillaCollectibleArray(): readonly CollectibleType[];
+    /**
+     * Returns a set containing every valid vanilla collectible type in the game.
+     *
+     * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+     * then use the `getVanillaCollectibleArray` helper function instead.
+     */
+    getVanillaCollectibleSet(): ReadonlySet<CollectibleType>;
+    /**
+     * Returns an array containing every valid vanilla trinket type in the game.
+     *
+     * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups,
+     * then use the `getVanillaTrinketSet` helper function instead.
+     */
+    getVanillaTrinketArray(): readonly TrinketType[];
+    /**
+     * Returns a set containing every valid vanilla trinket type in the game.
+     *
+     * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order,
+     * then use the `getVanillaTrinketArray` helper function instead.
+     */
+    getVanillaTrinketSet(): ReadonlySet<TrinketType>;
+}
+//# sourceMappingURL=ModdedElementSets.d.ts.map

package/dist/src/classes/features/other/ModdedElementSets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModdedElementSets.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/ModdedElementSets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,eAAe,EACf,aAAa,EACb,UAAU,EACV,WAAW,EACZ,MAAM,8BAA8B,CAAC;AA0BtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AA4BhD,qBAAa,iBAAkB,SAAQ,OAAO;IAC5C,OAAO,CAAC,wBAAwB,CAAyB;IACzD,OAAO,CAAC,sBAAsB,CAA8B;IAE5D,OAAO,CAAC,4BAA4B,CAAyB;IAC7D,OAAO,CAAC,0BAA0B,CAA8B;IAEhE,OAAO,CAAC,2BAA2B,CAAyB;IAC5D,OAAO,CAAC,yBAAyB,CAA8B;IAE/D,OAAO,CAAC,oBAAoB,CAAqB;IACjD,OAAO,CAAC,kBAAkB,CAA0B;IAEpD,OAAO,CAAC,wBAAwB,CAAqB;IACrD,OAAO,CAAC,sBAAsB,CAA0B;IAExD,OAAO,CAAC,uBAAuB,CAAqB;IACpD,OAAO,CAAC,qBAAqB,CAA0B;IAEvD,OAAO,CAAC,wBAAwB,CAG5B;IAEJ,OAAO,CAAC,8BAA8B,CAGlC;IAEJ,OAAO,CAAC,0BAA0B,CAA0C;IAE5E,OAAO,CAAC,yBAAyB,CAA8B;IAC/D,OAAO,CAAC,kCAAkC,CAA8B;IACxE,OAAO,CAAC,qBAAqB,CAA0B;IAEvD,OAAO,CAAC,6BAA6B,CAA8B;IACnE,OAAO,CAAC,8BAA8B,CAA8B;IAEpE,OAAO,CAAC,sBAAsB,CAAyB;IAWvD,OAAO,CAAC,+BAA+B;IAgBvC,OAAO,CAAC,8BAA8B;IA2BtC,OAAO,CAAC,2BAA2B;IAgBnC,OAAO,CAAC,0BAA0B;IA2BlC,OAAO,CAAC,gCAAgC;IA8BxC,OAAO,CAAC,sCAAsC;IAkB9C,OAAO,CAAC,kCAAkC;IAkB1C,OAAO,CAAC,iCAAiC;IAgCzC,OAAO,CAAC,6BAA6B;IAoBrC,OAAO,CAAC,+BAA+B;IAuBvC;;;;;;;;;;OAUG;IAEI,mBAAmB,IAAI,SAAS,eAAe,EAAE;IAKxD;;;;;;;;;;OAUG;IAEI,iBAAiB,IAAI,WAAW,CAAC,eAAe,CAAC;IAKxD;;;;;;;;;OASG;IAEI,gCAAgC,CACrC,UAAU,EAAE,UAAU,GACrB,WAAW,CAAC,eAAe,CAAC;IAW/B;;;;;;;OAOG;IAEI,4BAA4B,CACjC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,eAAe,CAAC;IAW/B;;;;;;;;;OASG;IAEI,sBAAsB,CAC3B,aAAa,EAAE,aAAa,GAC3B,WAAW,CAAC,eAAe,CAAC;IAa/B;;;OAGG;IAEI,yBAAyB,IAAI,WAAW,CAAC,eAAe,CAAC;IAKhE;;;OAGG;IAEI,0BAA0B,IAAI,WAAW,CAAC,eAAe,CAAC;IAKjE;;;;;;;;;OASG;IAEI,qBAAqB,CAC1B,qBAAqB,EAAE,OAAO,GAC7B,WAAW,CAAC,eAAe,CAAC;IAQ/B;;;OAGG;IAEI,iBAAiB,IAAI,WAAW,CAAC,WAAW,CAAC;IAMpD;;;;;;;;;OASG;IAEI,yBAAyB,IAAI,SAAS,eAAe,EAAE;IAK9D;;;;;;;;;OASG;IAEI,uBAAuB,IAAI,WAAW,CAAC,eAAe,CAAC;IAK9D;;;;;;;;OAQG;IAEI,qBAAqB,IAAI,SAAS,WAAW,EAAE;IAKtD;;;;;;;;OAQG;IAEI,mBAAmB,IAAI,WAAW,CAAC,WAAW,CAAC;IAKtD;;;;;OAKG;IAEI,uBAAuB,CAC5B,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;IAe5B;;;;;;;;;;;;;;;;;;;;;OAqBG;IAEI,kCAAkC,CACvC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,eAAe,EAAE;IAkBpB,yFAAyF;IAElF,4BAA4B,CACjC,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,aAAa,GAC3B,eAAe,EAAE;IAepB,yFAAyF;IAElF,sCAAsC,CAC3C,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,eAAe,EAAE;IAkBpB;;;;;;OAMG;IAEI,8BAA8B,CACnC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC;IAcxB,4FAA4F;IAErF,8BAA8B,CACnC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IASlB,6FAA6F;IAEtF,+BAA+B,CACpC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IASlB;;;;;;;;OAQG;IAEI,eAAe,IAAI,SAAS,WAAW,EAAE;IAKhD;;;;;;;;OAQG;IAEI,aAAa,IAAI,WAAW,CAAC,WAAW,CAAC;IAKhD;;;;;;OAMG;IAEI,wBAAwB,CAC7B,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,WAAW,CAAC;IAW3B;;;;;OAKG;IAEI,0BAA0B,IAAI,SAAS,eAAe,EAAE;IAK/D;;;;;OAKG;IAEI,wBAAwB,IAAI,WAAW,CAAC,eAAe,CAAC;IAK/D;;;;;OAKG;IAEI,sBAAsB,IAAI,SAAS,WAAW,EAAE;IAKvD;;;;;OAKG;IAEI,oBAAoB,IAAI,WAAW,CAAC,WAAW,CAAC;CAIxD"}