isaacscript-common 6.6.1-dev.2 → 6.6.1

package/functions/collectibleSet.lua

@@ -1,104 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
-local __TS__ArraySort = ____lualib.__TS__ArraySort
-local ____exports = {}
-local ____cachedClasses = require("cachedClasses")
-local itemConfig = ____cachedClasses.itemConfig
-local ____constantsFirstLast = require("constantsFirstLast")
-local FIRST_COLLECTIBLE_TYPE = ____constantsFirstLast.FIRST_COLLECTIBLE_TYPE
-local LAST_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_COLLECTIBLE_TYPE
-local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_VANILLA_COLLECTIBLE_TYPE
-local ____utils = require("functions.utils")
-local irange = ____utils.irange
-local ALL_COLLECTIBLES_ARRAY = {}
-local VANILLA_COLLECTIBLES_ARRAY = {}
-local MODDED_COLLECTIBLES_ARRAY = {}
-local ALL_COLLECTIBLES_SET = __TS__New(Set)
-local VANILLA_COLLECTIBLES_SET = __TS__New(Set)
-local MODDED_COLLECTIBLES_SET = __TS__New(Set)
-local function initCollectibleArraysAndSets(self)
-    if #ALL_COLLECTIBLES_ARRAY ~= 0 then
-        return
-    end
-    local collectibleTypeRange = irange(nil, FIRST_COLLECTIBLE_TYPE, LAST_COLLECTIBLE_TYPE)
-    for ____, collectibleType in ipairs(collectibleTypeRange) do
-        do
-            local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-            if itemConfigItem == nil then
-                goto __continue4
-            end
-            ALL_COLLECTIBLES_ARRAY[#ALL_COLLECTIBLES_ARRAY + 1] = collectibleType
-            if collectibleType <= LAST_VANILLA_COLLECTIBLE_TYPE then
-                VANILLA_COLLECTIBLES_ARRAY[#VANILLA_COLLECTIBLES_ARRAY + 1] = collectibleType
-            else
-                MODDED_COLLECTIBLES_ARRAY[#MODDED_COLLECTIBLES_ARRAY + 1] = collectibleType
-            end
-        end
-        ::__continue4::
-    end
-    __TS__ArraySort(ALL_COLLECTIBLES_ARRAY)
-    __TS__ArraySort(VANILLA_COLLECTIBLES_ARRAY)
-    __TS__ArraySort(MODDED_COLLECTIBLES_ARRAY)
-    for ____, collectibleType in ipairs(ALL_COLLECTIBLES_ARRAY) do
-        ALL_COLLECTIBLES_SET:add(collectibleType)
-    end
-    for ____, collectibleType in ipairs(VANILLA_COLLECTIBLES_ARRAY) do
-        VANILLA_COLLECTIBLES_SET:add(collectibleType)
-    end
-    for ____, collectibleType in ipairs(MODDED_COLLECTIBLES_ARRAY) do
-        MODDED_COLLECTIBLES_SET:add(collectibleType)
-    end
-end
---- 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 `getCollectibleArray` helper function instead.
-function ____exports.getCollectibleArray(self)
-    initCollectibleArraysAndSets(nil)
-    return ALL_COLLECTIBLES_ARRAY
-end
---- 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.
-function ____exports.getCollectibleSet(self)
-    initCollectibleArraysAndSets(nil)
-    return ALL_COLLECTIBLES_SET
-end
---- 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.
-function ____exports.getModdedCollectibleArray(self)
-    initCollectibleArraysAndSets(nil)
-    return MODDED_COLLECTIBLES_ARRAY
-end
---- 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.
-function ____exports.getModdedCollectibleSet(self)
-    initCollectibleArraysAndSets(nil)
-    return MODDED_COLLECTIBLES_SET
-end
---- 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.
-function ____exports.getVanillaCollectibleArray(self)
-    initCollectibleArraysAndSets(nil)
-    return VANILLA_COLLECTIBLES_ARRAY
-end
---- 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.
-function ____exports.getVanillaCollectibleSet(self)
-    initCollectibleArraysAndSets(nil)
-    return VANILLA_COLLECTIBLES_SET
-end
-return ____exports
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZnVuY3Rpb25zL2NvbGxlY3RpYmxlU2V0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQ0EsMEJBQTJCO0FBQWxCO0FBQ1QsK0JBSU87QUFITDtBQUNBO0FBQ0E7QUFFRixrQkFBdUI7QUFBZDtBQUVILCtCQUE0QztBQUM1QyxtQ0FBZ0Q7QUFDaEQsa0NBQStDO0FBRS9DLDZCQUF1QixVQUFJO0FBQzNCLGlDQUEyQixVQUFJO0FBQy9CLGdDQUEwQixVQUFJO0FBRXBDLGVBQVM7T0FDSCwyQkFBa0M7QUFDcEM7O0FBR0ksaUNBQXVCLFlBQzNCLHdCQUNBO0FBRUYsY0FBVywwQkFBbUI7O0FBQ3RCLG1DQUFpQixXQUFXLGVBQWU7ZUFDN0M7QUFDRjs7QUFHRixrRUFBNEI7ZUFDeEIsbUJBQW1CO0FBQ3JCLDhFQUFnQzs7QUFFaEMsNEVBQStCOzs7OztJQUluQztJQUNBO0lBQ0E7QUFFQSxjQUFXLDBCQUFtQjtRQUM1QixxQkFBcUIsSUFBSTs7QUFFM0IsY0FBVywwQkFBbUI7UUFDNUIseUJBQXlCLElBQUk7O0FBRS9CLGNBQVcsMEJBQW1CO1FBQzVCLHdCQUF3QixJQUFJOztBQWxDaEM7Ozs7OztBQTZDQTtJQUVFO0FBRUEsV0FBTztBQUpUOzs7OztBQWFBO0lBRUU7QUFFQSxXQUFPO0FBSlQ7Ozs7O0FBYUE7SUFFRTtBQUVBLFdBQU87QUFKVDs7Ozs7QUFhQTtJQUVFO0FBRUEsV0FBTztBQUpUOzs7OztBQWFBO0lBRUU7QUFFQSxXQUFPO0FBSlQ7Ozs7O0FBYUE7SUFFRTtBQUVBLFdBQU87QUFKVCIsImZpbGUiOiJjb2xsZWN0aWJsZVNldC5sdWEiLCJzb3VyY2VSb290IjoiIn0=

package/functions/collectibleTag.d.ts

@@ -1,16 +0,0 @@
-import { CollectibleType, ItemConfigTag } from "isaac-typescript-definitions";
-export declare function collectibleHasTag(collectibleType: CollectibleType, tag: ItemConfigTag): boolean;
-/**
- * Helper function to get all of the collectible types in the game that have a certain 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);
- * ```
- */
-export declare function getCollectibleTypesWithTag(itemConfigTag: ItemConfigTag): Set<CollectibleType>;
-/** Returns the number of items that a player has towards a particular transformation. */
-export declare function getPlayerNumCollectiblesWithTag(player: EntityPlayer, itemConfigTag: ItemConfigTag): int;
-export declare function isQuestCollectible(collectibleType: CollectibleType): boolean;

package/functions/collectibleTag.js

@@ -1,65 +0,0 @@
-import { ItemConfigTag } from "isaac-typescript-definitions";
-import { itemConfig } from "../cachedClasses";
-import { getCollectibleArray } from "./collectibleSet";
-import { getEnumValues } from "./enums";
-import { getFlagName } from "./flag";
-import { getPlayerCollectibleCount } from "./player";
-import { copySet } from "./set";
-const TAG_TO_COLLECTIBLE_TYPES_MAP = new Map();
-function initTagMap() {
-    // The tag to collectible types map should be valid for every tag, so we initialize it with empty
-    // sets.
-    for (const itemConfigTag of getEnumValues(ItemConfigTag)) {
-        TAG_TO_COLLECTIBLE_TYPES_MAP.set(itemConfigTag, new Set());
-    }
-    for (const collectibleType of getCollectibleArray()) {
-        for (const itemConfigTag of getEnumValues(ItemConfigTag)) {
-            if (!collectibleHasTag(collectibleType, itemConfigTag)) {
-                continue;
-            }
-            const collectibleTypesSet = TAG_TO_COLLECTIBLE_TYPES_MAP.get(itemConfigTag);
-            if (collectibleTypesSet === undefined) {
-                const flagName = getFlagName(itemConfigTag, ItemConfigTag);
-                error(`Failed to get the collectible types for item tag: ${flagName}`);
-            }
-            collectibleTypesSet.add(collectibleType);
-        }
-    }
-}
-export function collectibleHasTag(collectibleType, tag) {
-    const itemConfigItem = itemConfig.GetCollectible(collectibleType);
-    if (itemConfigItem === undefined) {
-        return false;
-    }
-    return itemConfigItem.HasTags(tag);
-}
-/**
- * Helper function to get all of the collectible types in the game that have a certain 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);
- * ```
- */
-export function getCollectibleTypesWithTag(itemConfigTag) {
-    // Lazy initialize the map.
-    if (TAG_TO_COLLECTIBLE_TYPES_MAP.size === 0) {
-        initTagMap();
-    }
-    const collectibleTypes = TAG_TO_COLLECTIBLE_TYPES_MAP.get(itemConfigTag);
-    if (collectibleTypes === undefined) {
-        error(`The item config tag of ${itemConfigTag} is not a valid value of the ItemConfigTag enum.`);
-    }
-    return copySet(collectibleTypes);
-}
-/** Returns the number of items that a player has towards a particular transformation. */
-export function getPlayerNumCollectiblesWithTag(player, itemConfigTag) {
-    const collectibleTypesSet = getCollectibleTypesWithTag(itemConfigTag);
-    return getPlayerCollectibleCount(player, ...collectibleTypesSet.values());
-}
-export function isQuestCollectible(collectibleType) {
-    return collectibleHasTag(collectibleType, ItemConfigTag.QUEST);
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29sbGVjdGlibGVUYWcuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9pc2FhY3NjcmlwdC1jb21tb24vc3JjL2Z1bmN0aW9ucy9jb2xsZWN0aWJsZVRhZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQW1CLGFBQWEsRUFBRSxNQUFNLDhCQUE4QixDQUFDO0FBQzlFLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUM5QyxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUN2RCxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sU0FBUyxDQUFDO0FBQ3hDLE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSxRQUFRLENBQUM7QUFDckMsT0FBTyxFQUFFLHlCQUF5QixFQUFFLE1BQU0sVUFBVSxDQUFDO0FBQ3JELE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxPQUFPLENBQUM7QUFFaEMsTUFBTSw0QkFBNEIsR0FBRyxJQUFJLEdBQUcsRUFHekMsQ0FBQztBQUVKLFNBQVMsVUFBVTtJQUNqQixpR0FBaUc7SUFDakcsUUFBUTtJQUNSLEtBQUssTUFBTSxhQUFhLElBQUksYUFBYSxDQUFDLGFBQWEsQ0FBQyxFQUFFO1FBQ3hELDRCQUE0QixDQUFDLEdBQUcsQ0FBQyxhQUFhLEVBQUUsSUFBSSxHQUFHLEVBQUUsQ0FBQyxDQUFDO0tBQzVEO0lBRUQsS0FBSyxNQUFNLGVBQWUsSUFBSSxtQkFBbUIsRUFBRSxFQUFFO1FBQ25ELEtBQUssTUFBTSxhQUFhLElBQUksYUFBYSxDQUFDLGFBQWEsQ0FBQyxFQUFFO1lBQ3hELElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxlQUFlLEVBQUUsYUFBYSxDQUFDLEVBQUU7Z0JBQ3RELFNBQVM7YUFDVjtZQUVELE1BQU0sbUJBQW1CLEdBQ3ZCLDRCQUE0QixDQUFDLEdBQUcsQ0FBQyxhQUFhLENBQUMsQ0FBQztZQUNsRCxJQUFJLG1CQUFtQixLQUFLLFNBQVMsRUFBRTtnQkFDckMsTUFBTSxRQUFRLEdBQUcsV0FBVyxDQUFDLGFBQWEsRUFBRSxhQUFhLENBQUMsQ0FBQztnQkFDM0QsS0FBSyxDQUFDLHFEQUFxRCxRQUFRLEVBQUUsQ0FBQyxDQUFDO2FBQ3hFO1lBQ0QsbUJBQW1CLENBQUMsR0FBRyxDQUFDLGVBQWUsQ0FBQyxDQUFDO1NBQzFDO0tBQ0Y7QUFDSCxDQUFDO0FBRUQsTUFBTSxVQUFVLGlCQUFpQixDQUMvQixlQUFnQyxFQUNoQyxHQUFrQjtJQUVsQixNQUFNLGNBQWMsR0FBRyxVQUFVLENBQUMsY0FBYyxDQUFDLGVBQWUsQ0FBQyxDQUFDO0lBQ2xFLElBQUksY0FBYyxLQUFLLFNBQVMsRUFBRTtRQUNoQyxPQUFPLEtBQUssQ0FBQztLQUNkO0lBRUQsT0FBTyxjQUFjLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0FBQ3JDLENBQUM7QUFFRDs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFNLFVBQVUsMEJBQTBCLENBQ3hDLGFBQTRCO0lBRTVCLDJCQUEyQjtJQUMzQixJQUFJLDRCQUE0QixDQUFDLElBQUksS0FBSyxDQUFDLEVBQUU7UUFDM0MsVUFBVSxFQUFFLENBQUM7S0FDZDtJQUVELE1BQU0sZ0JBQWdCLEdBQUcsNEJBQTRCLENBQUMsR0FBRyxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQ3pFLElBQUksZ0JBQWdCLEtBQUssU0FBUyxFQUFFO1FBQ2xDLEtBQUssQ0FDSCwwQkFBMEIsYUFBYSxrREFBa0QsQ0FDMUYsQ0FBQztLQUNIO0lBRUQsT0FBTyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztBQUNuQyxDQUFDO0FBRUQseUZBQXlGO0FBQ3pGLE1BQU0sVUFBVSwrQkFBK0IsQ0FDN0MsTUFBb0IsRUFDcEIsYUFBNEI7SUFFNUIsTUFBTSxtQkFBbUIsR0FBRywwQkFBMEIsQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUN0RSxPQUFPLHlCQUF5QixDQUFDLE1BQU0sRUFBRSxHQUFHLG1CQUFtQixDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUM7QUFDNUUsQ0FBQztBQUVELE1BQU0sVUFBVSxrQkFBa0IsQ0FBQyxlQUFnQztJQUNqRSxPQUFPLGlCQUFpQixDQUFDLGVBQWUsRUFBRSxhQUFhLENBQUMsS0FBSyxDQUFDLENBQUM7QUFDakUsQ0FBQyJ9

package/functions/collectibleTag.lua

@@ -1,85 +0,0 @@
-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 ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local ItemConfigTag = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTag
-local ____cachedClasses = require("cachedClasses")
-local itemConfig = ____cachedClasses.itemConfig
-local ____collectibleSet = require("functions.collectibleSet")
-local getCollectibleArray = ____collectibleSet.getCollectibleArray
-local ____enums = require("functions.enums")
-local getEnumValues = ____enums.getEnumValues
-local ____flag = require("functions.flag")
-local getFlagName = ____flag.getFlagName
-local ____player = require("functions.player")
-local getPlayerCollectibleCount = ____player.getPlayerCollectibleCount
-local ____set = require("functions.set")
-local copySet = ____set.copySet
-function ____exports.collectibleHasTag(self, collectibleType, tag)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return false
-    end
-    return itemConfigItem:HasTags(tag)
-end
-local TAG_TO_COLLECTIBLE_TYPES_MAP = __TS__New(Map)
-local function initTagMap(self)
-    for ____, itemConfigTag in ipairs(getEnumValues(nil, ItemConfigTag)) do
-        TAG_TO_COLLECTIBLE_TYPES_MAP:set(
-            itemConfigTag,
-            __TS__New(Set)
-        )
-    end
-    for ____, collectibleType in ipairs(getCollectibleArray(nil)) do
-        for ____, itemConfigTag in ipairs(getEnumValues(nil, ItemConfigTag)) do
-            do
-                if not ____exports.collectibleHasTag(nil, collectibleType, itemConfigTag) then
-                    goto __continue6
-                end
-                local collectibleTypesSet = TAG_TO_COLLECTIBLE_TYPES_MAP:get(itemConfigTag)
-                if collectibleTypesSet == nil then
-                    local flagName = getFlagName(nil, itemConfigTag, ItemConfigTag)
-                    error("Failed to get the collectible types for item tag: " .. tostring(flagName))
-                end
-                collectibleTypesSet:add(collectibleType)
-            end
-            ::__continue6::
-        end
-    end
-end
---- Helper function to get all of the collectible types in the game that have a certain 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);
--- ```
-function ____exports.getCollectibleTypesWithTag(self, itemConfigTag)
-    if TAG_TO_COLLECTIBLE_TYPES_MAP.size == 0 then
-        initTagMap(nil)
-    end
-    local collectibleTypes = TAG_TO_COLLECTIBLE_TYPES_MAP:get(itemConfigTag)
-    if collectibleTypes == nil then
-        error(("The item config tag of " .. tostring(itemConfigTag)) .. " is not a valid value of the ItemConfigTag enum.")
-    end
-    return copySet(nil, collectibleTypes)
-end
---- Returns the number of items that a player has towards a particular transformation.
-function ____exports.getPlayerNumCollectiblesWithTag(self, player, itemConfigTag)
-    local collectibleTypesSet = ____exports.getCollectibleTypesWithTag(nil, itemConfigTag)
-    return getPlayerCollectibleCount(
-        nil,
-        player,
-        __TS__Spread(collectibleTypesSet:values())
-    )
-end
-function ____exports.isQuestCollectible(self, collectibleType)
-    return ____exports.collectibleHasTag(nil, collectibleType, ItemConfigTag.QUEST)
-end
-return ____exports
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZnVuY3Rpb25zL2NvbGxlY3RpYmxlVGFnLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7OztBQUFBLDZDQUErQztBQUFyQjtBQUMxQiwwQkFBMkI7QUFBbEI7QUFDVCwyQkFBb0M7QUFBM0I7QUFDVCxrQkFBOEI7QUFBckI7QUFDVCxpQkFBNEI7QUFBbkI7QUFDVCxtQkFBMEM7QUFBakM7QUFDVCxnQkFBd0I7QUFBZjtBQStCVCw2Q0FDRSxpQkFDQTtBQUVNLDJCQUFpQixXQUFXLGVBQWU7T0FDN0M7QUFDRixlQUFPOztBQUdULFdBQU8sZUFBZSxRQUFRO0FBVGhDO0FBN0JNLHFDQUErQixVQUFJO0FBS3pDLGVBQVM7QUFHUCxjQUFXLHdCQUFpQixtQkFBYztRQUN4Qyw2QkFBNkI7WUFBSTtZQUFlLFVBQUk7OztBQUd0RCxjQUFXLDBCQUFtQjtBQUM1QixrQkFBVyx3QkFBaUIsbUJBQWM7O3VCQUNuQyxtQ0FBa0IsaUJBQWlCO0FBQ3RDOztBQUdJLDRDQUNKLDZCQUE2QixJQUFJO21CQUMvQjtBQUNJLHFDQUFXLGlCQUFZLGVBQWU7b0JBQzVDLE1BQU0saUVBQXFEOztnQkFFN0Qsb0JBQW9CLElBQUk7Ozs7O0FBbkI5Qjs7Ozs7Ozs7O0FBOENBLHNEQUNFO09BR0kscUNBQXNDO1FBQ3hDOztBQUdJLDZCQUFtQiw2QkFBNkIsSUFBSTtPQUN0RDtRQUNGLE9BQ0Usc0NBQTBCLG1CQUFhOztBQUkzQyxXQUFPLGFBQVE7QUFmakI7O0FBbUJBLDJEQUNFLFFBQ0E7QUFFTSxnQ0FBc0IsNENBQTJCO0FBQ3ZELFdBQU87O1FBQTBCO1FBQVEsYUFBRyxvQkFBb0I7O0FBTGxFO0FBUUEsOENBQW1DO0FBQ2pDLFdBQU8sbUNBQWtCLGlCQUFpQjtBQUQ1QyIsImZpbGUiOiJjb2xsZWN0aWJsZVRhZy5sdWEiLCJzb3VyY2VSb290IjoiIn0=

package/functions/collectibles.d.ts

@@ -1,212 +0,0 @@
-import { CollectiblePedestalType, CollectibleType, ItemConfigTag, ItemType, PickupPrice } from "isaac-typescript-definitions";
-import { CollectibleIndex } from "../types/CollectibleIndex";
-export declare function clearCollectibleSprite(collectible: EntityPickup): void;
-/** Helper function to check if two collectible sprites have the same sprite sheet loaded. */
-export declare function collectibleSpriteEquals(sprite1: Sprite, sprite2: Sprite): boolean;
-/**
- * Helper function to get the in-game description for a collectible. Returns "Unknown" if the
- * provided collectible type was not valid.
- */
-export declare function getCollectibleDescription(collectibleType: CollectibleType): string;
-/**
- * Helper function to get the coin cost that a collectible item would be if it were being offered in
- * a Devil Room deal. Returns 0 if passed `CollectibleType.NULL`.
- */
-export declare function getCollectibleDevilCoinPrice(collectibleType: CollectibleType): int;
-/**
- * Helper function to get the heart cost that a collectible item would be if it were being offered
- * in a Devil Room deal. Returns 0 if passed `CollectibleType.NULL`.
- */
-export declare function getCollectibleDevilHeartPrice(collectibleType: CollectibleType, player: EntityPlayer): PickupPrice;
-/**
- * Helper function to get the path to a collectible's sprite. Returns the path to the question mark
- * sprite (i.e. from Curse of the Blind) if the provided collectible type was not valid.
- */
-export declare function getCollectibleGfxFilename(collectibleType: CollectibleType): string;
-/**
- * Mods often have to track variables relating to a collectible. Finding an index for these kinds of
- * data structures is difficult, since collectibles are respawned every time a player re-enters a
- * room, so the `PtrHash` will change. Instead, we use a 4-tuple of the room list index, the grid
- * index of the collectible in the room, the collectible's SubType, and the collectible's InitSeed.
- *
- * Collectibles that are shifted by Tainted Isaac's mechanic will have unique collectible indexes
- * because the SubType is different. (The collectible entities share the same InitSeed.)
- *
- * Collectibles that are rolled (with e.g. a D6) will have unique collectible indexes because the
- * SubType and InitSeed are different. If you want to track collectibles independently of any
- * rerolls, then you can use the `PtrHash` as an index instead. (The `PtrHash` will not persist
- * between rooms, however.)
- *
- * Note that:
- * - The grid index is a necessary part of the collectible index because Diplopia and Crooked Penny
- *   can cause two or more collectibles with the same SubType and InitSeed to exist in the same
- *   room.
- * - This index will fail in the case where the player uses Diplopia or a successful Crooked Penny
- *   seven or more times in the same room, since that will cause two or more collectibles with the
- *   same grid index, SubType, and InitSeed to exist.
- * - The SubType is a necessary part of the collectible index because Tainted Isaac will
- *   continuously cause collectibles to morph into new sub-types with the same InitSeed.
- * - Using a collectible's position as part of the index is problematic, since players can push a
- *   pedestal. (Even using the grid index does not solve this problem, since it is possible in
- *   certain cases for collectibles to be spawned at a position that is not aligned with the grid,
- *   and the pedestal pushed to an adjacent tile, but this case should be extremely rare.)
- * - Mega Chests spawn two collectibles on the exact same position. However, both of them will have
- *   different InitSeeds, so this is not a problem for this indexing scheme.
- * - The indexing scheme used is different for collectibles that are inside of a Treasure Room or
- *   Boss Room, in order to handle the case of the player seeing the same collectible again in a
- *   post-Ascent Treasure Room or Boss Room. A 5-tuple of stage, stage type, grid index, SubType,
- *   and InitSeed is used in this case. (Using the room list index or the room grid index is not
- *   suitable for this purpose, since both of these values can change in the post-Ascent rooms.)
- *   Even though Treasure Rooms and Boss Rooms are grouped together in this scheme, there probably
- *   will not be collectibles with the same grid index, SubType, and InitSeed.
- */
-export declare function getCollectibleIndex(collectible: EntityPickup): CollectibleIndex;
-/**
- * Helper function to get the initial amount of charges that a collectible has. Returns 0 if the
- * provided collectible type was not valid.
- */
-export declare function getCollectibleInitCharge(collectibleType: CollectibleType): int;
-/**
- * Helper function to get the `ItemType` of a collectible. Returns `ItemType.ITEM_NULL` if the
- * provided collectible type was not valid.
- */
-export declare function getCollectibleItemType(collectibleType: CollectibleType): ItemType;
-/**
- * Helper function to get the maximum amount of charges that a collectible has. Returns 0 if the
- * provided collectible type was not valid.
- */
-export declare function getCollectibleMaxCharges(collectibleType: CollectibleType): int;
-/**
- * Helper function to get the name of a collectible. Returns "Unknown" if the provided collectible
- * type is not valid.
- *
- * For example:
- *
- * ```ts
- * const collectibleType = CollectibleType.SAD_ONION;
- * const collectibleName = getCollectibleName(collectibleType); // collectibleName is "Sad Onion"
- * ```
- */
-export declare function getCollectibleName(collectibleType: CollectibleType): string;
-export declare function getCollectiblePedestalType(collectible: EntityPickup): CollectiblePedestalType;
-/**
- * Helper function to get the path to a collectible's quality. Returns 0 if the provided collectible
- * type was not valid.
- */
-export declare function getCollectibleQuality(collectibleType: CollectibleType): int;
-/**
- * Helper function to get the tags of a collectible (which is the composition of zero or more
- * `ItemConfigTag`). Returns 0 if the provided collectible type is not valid.
- *
- * For example:
- *
- * ```ts
- * const collectibleType = CollectibleType.SAD_ONION;
- * const itemConfigTags = getCollectibleTags(collectibleType); // itemConfigTags is "18350080"
- * ```
- */
-export declare function getCollectibleTags(collectibleType: CollectibleType): BitFlags<ItemConfigTag>;
-/**
- * Helper function to get an array that represents the all modded collectible types.
- *
- * This function is only useful when building collectible type objects. For most purposes, you
- * should use the `getModdedCollectibleSet` helper function instead.
- *
- * Returns an empty array if there are no modded collectible types.
- *
- * (This function is named differently from the `getVanillaCollectibleTypeRange` function because
- * all modded collectible types are contiguous. Thus, each value represents a real
- * `CollectibleType`.)
- */
-export declare function getModdedCollectibleTypes(): CollectibleType[];
-/**
- * Helper function to get an array that represents the range from the first collectible type to the
- * last vanilla collectible type. This will include integers that do not represent any valid
- * collectible types.
- *
- * This function is only useful when building collectible type objects. For most purposes, you
- * should use the `getVanillaCollectibleSet` helper function instead.
- */
-export declare function getVanillaCollectibleTypeRange(): CollectibleType[];
-/** Returns true if the item type in the item config is equal to `ItemType.ITEM_ACTIVE`. */
-export declare function isActiveCollectible(collectibleType: CollectibleType): boolean;
-/** Returns true if the collectible has a red question mark sprite. */
-export declare function isBlindCollectible(collectible: EntityPickup): boolean;
-/**
- * Returns whether or not the given collectible is a "glitched" item. All items are replaced by
- * glitched items once a player has TMTRAINER. However, glitched items can also "naturally" appear
- * in secret rooms and I AM ERROR rooms if the "Corrupted Data" achievement is unlocked.
- */
-export declare function isGlitchedCollectible(pickup: EntityPickup): boolean;
-/**
- * Returns true if the collectible has the "Hidden" attribute in the item config.
- *
- * Hidden collectibles will not show up in any pools and Eden will not start with them.
- */
-export declare function isHiddenCollectible(collectibleType: CollectibleType): boolean;
-/**
- * Returns true if the item type in the item config is equal to `ItemType.ITEM_PASSIVE` or
- * `ItemType.ITEM_FAMILIAR`.
- */
-export declare function isPassiveCollectible(collectibleType: CollectibleType): boolean;
-/**
- * Helper function to determine if a particular collectible will disappear from the player's
- * inventory upon use. Note that this will not work will modded items, as there is no way to
- * dynamically know if a modded item will disappear.
- */
-export declare function isSingleUseCollectible(collectibleType: CollectibleType): boolean;
-export declare function isValidCollectibleType(collectibleType: CollectibleType): boolean;
-/**
- * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that it
- * should remove an item.
- *
- * The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
- * Python program located at: https://github.com/Rchardon/RebirthItemTracker
- */
-export declare function removeCollectibleFromItemTracker(collectibleType: CollectibleType): void;
-/**
- * Helper function to remove all pickup delay on a collectible. By default, collectibles have a 20
- * frame delay before they can be picked up by a player.
- */
-export declare function removeCollectiblePickupDelay(collectible: EntityPickup): void;
-/**
- * Helper function to set a collectible sprite to a question mark (i.e. how collectibles look when
- * the player has Curse of the Blind).
- */
-export declare function setCollectibleBlind(collectible: EntityPickup): void;
-/**
- * Helper function to remove the collectible from a collectible pedestal and make it appear as if a
- * player has already taken the item. This is accomplished by changing the sub-type to
- * `CollectibleType.NULL` and then setting the sprite to an empty/missing PNG file.
- *
- * For more information, see the documentation for the "clearSprite" helper function.
- */
-export declare function setCollectibleEmpty(collectible: EntityPickup): void;
-/**
- * Helper function to change a collectible into a "glitched" item (like the ones that appear when
- * the player has TMTRAINER).
- */
-export declare function setCollectibleGlitched(collectible: EntityPickup): void;
-/**
- * Helper function to change the sprite of a collectible pedestal entity.
- *
- * For more information about removing the collectible sprite, see the documentation for the
- * "clearSprite" helper function.
- *
- * @param collectible The collectible whose sprite you want to modify.
- * @param pngPath Equal to either the spritesheet path to load (e.g.
- *                "gfx/items/collectibles/collectibles_001_thesadonion.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 setCollectibleSprite(collectible: EntityPickup, pngPath: string | undefined): void;
-/**
- * Helper function to change the collectible on a pedestal. Simply updating the `SubType` property
- * is not sufficient because the sprite will not change.
- */
-export declare function setCollectibleSubType(collectible: EntityPickup, newCollectibleType: CollectibleType): void;
-/**
- * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that
- * the build has been rerolled.
- */
-export declare function setCollectiblesRerolledForItemTracker(): void;