isaacscript-common 2.0.34 → 2.3.0

package/functions/charge.lua

@@ -1,123 +0,0 @@
-local ____exports = {}
-local getNumChargesToAdd, getNumChargesWithAAAModifier, shouldPlayFullRechargeSound
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
-local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
-local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
-local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
-local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-local sfxManager = ____cachedClasses.sfxManager
-local ____collectibles = require("functions.collectibles")
-local getCollectibleMaxCharges = ____collectibles.getCollectibleMaxCharges
-local ____playerIndex = require("functions.playerIndex")
-local getPlayers = ____playerIndex.getPlayers
-function ____exports.addRoomClearChargeToSlot(self, player, activeSlot, ignoreBigRoomDoubleCharge)
-    if ignoreBigRoomDoubleCharge == nil then
-        ignoreBigRoomDoubleCharge = false
-    end
-    if not player:NeedsCharge(activeSlot) then
-        return
-    end
-    local hud = game:GetHUD()
-    local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
-    local chargesToAdd = getNumChargesToAdd(nil, player, activeSlot, ignoreBigRoomDoubleCharge)
-    local modifiedChargesToAdd = getNumChargesWithAAAModifier(nil, player, activeSlot, chargesToAdd)
-    local newCharge = totalCharge + modifiedChargesToAdd
-    player:SetActiveCharge(newCharge, activeSlot)
-    hud:FlashChargeBar(player, activeSlot)
-    ____exports.playChargeSoundEffect(nil, player, activeSlot)
-end
-function getNumChargesToAdd(self, player, activeSlot, ignoreBigRoomDoubleCharge)
-    if ignoreBigRoomDoubleCharge == nil then
-        ignoreBigRoomDoubleCharge = false
-    end
-    local room = game:GetRoom()
-    local roomShape = room:GetRoomShape()
-    local activeItem = player:GetActiveItem(activeSlot)
-    local activeCharge = player:GetActiveCharge(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
-    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
-    if not hasBattery and activeCharge == maxCharges then
-        return 0
-    end
-    if hasBattery and batteryCharge == maxCharges then
-        return 0
-    end
-    if not hasBattery and activeCharge + 1 == maxCharges then
-        return 1
-    end
-    if hasBattery and batteryCharge + 1 == maxCharges then
-        return 1
-    end
-    if roomShape >= RoomShape.SHAPE_2x2 and not ignoreBigRoomDoubleCharge then
-        return 2
-    end
-    return 1
-end
-function getNumChargesWithAAAModifier(self, player, activeSlot, chargesToAdd)
-    local activeItem = player:GetActiveItem(activeSlot)
-    local activeCharge = player:GetActiveCharge(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
-    local hasAAABattery = player:HasTrinket(TrinketType.AAA_BATTERY)
-    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
-    if not hasAAABattery then
-        return chargesToAdd
-    end
-    if not hasBattery and activeCharge + chargesToAdd == maxCharges - 1 then
-        return maxCharges + 1
-    end
-    if hasBattery and batteryCharge + chargesToAdd == maxCharges - 1 then
-        return maxCharges + 1
-    end
-    return chargesToAdd
-end
-function ____exports.getTotalCharge(self, player, activeSlot)
-    local activeCharge = player:GetActiveCharge(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    return activeCharge + batteryCharge
-end
-function ____exports.playChargeSoundEffect(self, player, activeSlot)
-    for ____, soundEffect in ipairs({SoundEffect.BATTERY_CHARGE, SoundEffect.BEEP}) do
-        sfxManager:Stop(soundEffect)
-    end
-    local chargeSoundEffect = shouldPlayFullRechargeSound(nil, player, activeSlot) and SoundEffect.BATTERY_CHARGE or SoundEffect.BEEP
-    sfxManager:Play(chargeSoundEffect)
-end
-function shouldPlayFullRechargeSound(self, player, activeSlot)
-    local activeItem = player:GetActiveItem(activeSlot)
-    local activeCharge = player:GetActiveCharge(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
-    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
-    if not hasBattery then
-        return not player:NeedsCharge(activeSlot)
-    end
-    return not player:NeedsCharge(activeSlot) or activeCharge == maxCharges and batteryCharge == 0
-end
-function ____exports.addRoomClearCharge(self, player, ignoreBigRoomDoubleCharge)
-    if ignoreBigRoomDoubleCharge == nil then
-        ignoreBigRoomDoubleCharge = false
-    end
-    for ____, activeSlot in ipairs({ActiveSlot.PRIMARY, ActiveSlot.SECONDARY, ActiveSlot.POCKET}) do
-        ____exports.addRoomClearChargeToSlot(nil, player, activeSlot, ignoreBigRoomDoubleCharge)
-    end
-end
-function ____exports.addRoomClearCharges(self, ignoreBigRoomDoubleCharge)
-    if ignoreBigRoomDoubleCharge == nil then
-        ignoreBigRoomDoubleCharge = false
-    end
-    for ____, player in ipairs(getPlayers(nil)) do
-        ____exports.addRoomClearCharge(nil, player, ignoreBigRoomDoubleCharge)
-    end
-end
-function ____exports.isActiveSlotDoubleCharged(self, player, activeSlot)
-    local collectibleType = player:GetActiveItem(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    local maxCharges = getCollectibleMaxCharges(nil, collectibleType)
-    return batteryCharge >= maxCharges
-end
-return ____exports

package/functions/chargeBar.d.ts

@@ -1,19 +0,0 @@
-/// <reference types="isaac-typescript-definitions" />
-/** A collection of the four sprites necessary in order to render a charge bar. */
-export interface ChargeBarSprites {
-    back: Sprite;
-    meter: Sprite;
-    meterBattery: Sprite;
-    lines: Sprite;
-    maxCharges: int;
-}
-/**
- * Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`
- * helper function.
- */
-export declare function newChargeBarSprites(maxCharges: int): ChargeBarSprites;
-/**
- * Helper function to render a charge bar on the screen. First, call the `newChargeBarSprites`
- * function to initialize the sprites, and then call this function on every render frame.
- */
-export declare function renderChargeBar(sprites: ChargeBarSprites, position: Vector, normalCharges: int, batteryCharges: int): void;

package/functions/chargeBar.lua

@@ -1,43 +0,0 @@
-local ____exports = {}
-local getChargeBarClamp
-local ____constants = require("constants")
-local VectorZero = ____constants.VectorZero
-function getChargeBarClamp(self, charges, maxCharges)
-    local meterMultiplier = 24 / maxCharges
-    local meterClip = 26 - charges * meterMultiplier
-    return Vector(0, meterClip)
-end
-local CHARGE_BAR_ANM2 = "gfx/ui/ui_chargebar.anm2"
-function ____exports.newChargeBarSprites(self, maxCharges)
-    local back = Sprite()
-    back:Load(CHARGE_BAR_ANM2, true)
-    back:Play("BarEmpty", true)
-    local meter = Sprite()
-    meter:Load(CHARGE_BAR_ANM2, true)
-    meter:Play("BarFull", true)
-    local meterBattery = Sprite()
-    meterBattery:Load(CHARGE_BAR_ANM2, true)
-    meterBattery:Play("BarFull", true)
-    local lines = Sprite()
-    lines:Load(CHARGE_BAR_ANM2, true)
-    lines:Play(
-        "BarOverlay" .. tostring(maxCharges),
-        true
-    )
-    return {
-        back = back,
-        meter = meter,
-        meterBattery = meterBattery,
-        lines = lines,
-        maxCharges = maxCharges
-    }
-end
-function ____exports.renderChargeBar(self, sprites, position, normalCharges, batteryCharges)
-    sprites.back:Render(position, VectorZero, VectorZero)
-    local normalChargesClamp = getChargeBarClamp(nil, normalCharges, sprites.maxCharges)
-    sprites.meter:Render(position, normalChargesClamp, VectorZero)
-    local batteryChargesClamp = getChargeBarClamp(nil, batteryCharges, sprites.maxCharges)
-    sprites.meterBattery:Render(position, batteryChargesClamp, VectorZero)
-    sprites.lines:Render(position, VectorZero, VectorZero)
-end
-return ____exports

package/functions/collectibleCacheFlag.d.ts

@@ -1,23 +0,0 @@
-import { CacheFlag, CollectibleType } from "isaac-typescript-definitions";
-export declare function collectibleHasCacheFlag(collectibleType: CollectibleType, cacheFlag: CacheFlag): boolean;
-/**
- * Returns a set containing every collectible type with the given cache flag, including modded
- * collectibles.
- */
-export declare function getCollectiblesForCacheFlag(cacheFlag: CacheFlag): Set<CollectibleType>;
-/**
- * Returns an array containing every collectible type that the player has that matches the provided
- * CacheFlag.
- *
- * For example, if a player has one Lord of the Pit and two Transcendences, then this function would
- * return:
- *
- * ```ts
- * [
- *   CollectibleType.LORD_OF_THE_PIT,
- *   CollectibleType.TRANSCENDENCE,
- *   CollectibleType.TRANSCENDENCE,
- * ]
- * ```
- */
-export declare function getPlayerCollectiblesForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): CollectibleType[];

package/functions/collectibleCacheFlag.lua

@@ -1,65 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__New = ____lualib.__TS__New
-local Set = ____lualib.Set
-local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
-local ____cachedClasses = require("cachedClasses")
-local itemConfig = ____cachedClasses.itemConfig
-local ____collectibles = require("functions.collectibles")
-local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
-local ____enums = require("functions.enums")
-local getEnumValues = ____enums.getEnumValues
-local ____flag = require("functions.flag")
-local hasFlag = ____flag.hasFlag
-local ____set = require("functions.set")
-local copySet = ____set.copySet
-local getSortedSetValues = ____set.getSortedSetValues
-local ____utils = require("functions.utils")
-local ____repeat = ____utils["repeat"]
-function ____exports.collectibleHasCacheFlag(self, collectibleType, cacheFlag)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return false
-    end
-    return hasFlag(nil, itemConfigItem.CacheFlags, cacheFlag)
-end
-local CACHE_FLAG_TO_COLLECTIBLES_MAP = __TS__New(Map)
-local function initCacheFlagMap(self)
-    for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
-        local collectiblesSet = __TS__New(Set)
-        for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
-            if ____exports.collectibleHasCacheFlag(nil, collectibleType, cacheFlag) then
-                collectiblesSet:add(collectibleType)
-            end
-        end
-        CACHE_FLAG_TO_COLLECTIBLES_MAP:set(cacheFlag, collectiblesSet)
-    end
-end
-function ____exports.getCollectiblesForCacheFlag(self, cacheFlag)
-    if CACHE_FLAG_TO_COLLECTIBLES_MAP.size == 0 then
-        initCacheFlagMap(nil)
-    end
-    local collectiblesSet = CACHE_FLAG_TO_COLLECTIBLES_MAP:get(cacheFlag)
-    if collectiblesSet == nil then
-        return __TS__New(Set)
-    end
-    return copySet(nil, collectiblesSet)
-end
-function ____exports.getPlayerCollectiblesForCacheFlag(self, player, cacheFlag)
-    local collectiblesForCacheFlag = ____exports.getCollectiblesForCacheFlag(nil, cacheFlag)
-    local playerCollectibles = {}
-    for ____, collectibleType in ipairs(getSortedSetValues(nil, collectiblesForCacheFlag)) do
-        local numCollectibles = player:GetCollectibleNum(collectibleType)
-        ____repeat(
-            nil,
-            numCollectibles,
-            function()
-                playerCollectibles[#playerCollectibles + 1] = collectibleType
-            end
-        )
-    end
-    return playerCollectibles
-end
-return ____exports

package/functions/collectibleSet.d.ts

@@ -1,9 +0,0 @@
-import { CollectibleType } from "isaac-typescript-definitions";
-/**
- * Returns a set containing every valid collectible type in the game, including modded collectibles.
- */
-export declare function getCollectibleSet(): Set<CollectibleType>;
-/** Returns a set containing every modded collectible type in the game. */
-export declare function getModdedCollectibleSet(): Set<CollectibleType>;
-/** Returns a set containing every valid vanilla collectible type in the game. */
-export declare function getVanillaCollectibleSet(): Set<CollectibleType>;

package/functions/collectibleSet.lua

@@ -1,51 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
-local ____exports = {}
-local ____cachedClasses = require("cachedClasses")
-local itemConfig = ____cachedClasses.itemConfig
-local ____constantsMax = require("constantsMax")
-local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsMax.LAST_VANILLA_COLLECTIBLE_TYPE
-local ____collectibles = require("functions.collectibles")
-local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
-local ____set = require("functions.set")
-local copySet = ____set.copySet
-local ALL_COLLECTIBLES_SET = __TS__New(Set)
-local VANILLA_COLLECTIBLES_SET = __TS__New(Set)
-local MODDED_COLLECTIBLES_SET = __TS__New(Set)
-local function initCollectibleSets(self)
-    for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
-        do
-            local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-            if itemConfigItem == nil then
-                goto __continue3
-            end
-            ALL_COLLECTIBLES_SET:add(collectibleType)
-            if collectibleType <= LAST_VANILLA_COLLECTIBLE_TYPE then
-                VANILLA_COLLECTIBLES_SET:add(collectibleType)
-            else
-                MODDED_COLLECTIBLES_SET:add(collectibleType)
-            end
-        end
-        ::__continue3::
-    end
-end
-function ____exports.getCollectibleSet(self)
-    if ALL_COLLECTIBLES_SET.size == 0 then
-        initCollectibleSets(nil)
-    end
-    return copySet(nil, ALL_COLLECTIBLES_SET)
-end
-function ____exports.getModdedCollectibleSet(self)
-    if ALL_COLLECTIBLES_SET.size == 0 then
-        initCollectibleSets(nil)
-    end
-    return copySet(nil, MODDED_COLLECTIBLES_SET)
-end
-function ____exports.getVanillaCollectibleSet(self)
-    if ALL_COLLECTIBLES_SET.size == 0 then
-        initCollectibleSets(nil)
-    end
-    return copySet(nil, VANILLA_COLLECTIBLES_SET)
-end
-return ____exports

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.lua

@@ -1,74 +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 ____collectibles = require("functions.collectibles")
-local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
-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(getCollectibleTypeRange(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
-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
-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

package/functions/collectibles.d.ts

@@ -1,211 +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 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, in
- *   order to handle the case of the player seeing the same collectible again in a post-Ascent
- *   Treasure 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 Treasure Room.) Even though there can
- *   be two Treasure Rooms on an XL floor, both Treasure Rooms should not have 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 range from the first collectible type to the
- * last 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 `getCollectibleSet` helper function instead.
- */
-export declare function getCollectibleTypeRange(): CollectibleType[];
-/**
- * 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 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;