isaacscript-common 1.2.174 → 1.2.175

package/dist/featuresInitialized.d.ts

@@ -1 +1 @@
-export declare function errorIfFeaturesNotInitialized(featureName: string): void;
+export {};

package/dist/featuresInitialized.lua

@@ -4,12 +4,12 @@ local featuresInitialized = false
 function ____exports.areFeaturesInitialized(self)
     return featuresInitialized
 end
-function ____exports.setFeaturesInitialized(self)
-    featuresInitialized = true
-end
 function ____exports.errorIfFeaturesNotInitialized(self, featureName)
     if not ____exports.areFeaturesInitialized(nil) then
         error(("The " .. featureName) .. " is not initialized. You must first upgrade your mod object by calling the \"upgradeMod\" function.")
     end
 end
+function ____exports.setFeaturesInitialized(self)
+    featuresInitialized = true
+end
 return ____exports

package/dist/functions/array.d.ts

@@ -4,6 +4,22 @@
  * only performs a shallow comparison.
  */
 export declare function arrayEquals<T>(array1: T[] | readonly T[], array2: T[] | readonly T[]): boolean;
+/**
+ * Shallow copies and removes the specified element(s) from the array. Returns the copied array. If
+ * the specified element(s) are not found in the array, it will simply return a shallow copy of the
+ * array.
+ *
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
+ */
+export declare function arrayRemove<T>(originalArray: T[] | readonly T[], ...elementsToRemove: T[]): T[];
+/**
+ * Removes the specified element(s) from the array. If the specified element(s) are not found in the
+ * array, this function will do nothing. Returns whether or not one or more elements were removed.
+ *
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
+ */
+export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: T[]): boolean;
+export declare function arrayToString<T>(array: T[]): string;
 /**
  * Helper function to combine two or more arrays. Returns a new array that is the composition of all
  * of the specified arrays.
@@ -23,45 +39,6 @@ export declare function copyArray<T>(oldArray: T[] | readonly T[], numElements?:
 export declare function emptyArray<T>(array: T[]): void;
 /** Helper function to return the last element of an array. */
 export declare function getLastElement<T>(array: T[]): T;
-/**
- * Initializes an array with all elements containing the specified default value.
- *
- * Example:
- * ```
- * const playerTransformations = initArray(false, PlayerForm.NUM_PLAYER_FORMS - 1);
- * ```
- */
-export declare function initArray<T>(defaultValue: T, size: int): T[];
-export declare function isArrayInArray<T>(arrayToMatch: T[] | readonly T[], parentArray: Array<T[] | readonly T[]>): boolean;
-/**
- * Shallow copies and shuffles the array using the Fisher-Yates algorithm. Returns the copied array.
- *
- * From: https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
- */
-export declare function shuffleArray<T>(originalArray: T[] | readonly T[], seed?: Seed): T[];
-/**
- * Shuffles the provided array in-place using the Fisher-Yates algorithm.
- *
- * From: https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
- */
-export declare function shuffleArrayInPlace<T>(array: T[], seed?: Seed): void;
-export declare function sumArray(array: number[] | readonly number[]): number;
-export declare function arrayToString<T>(array: T[]): string;
-/**
- * Shallow copies and removes the specified element(s) from the array. Returns the copied array. If
- * the specified element(s) are not found in the array, it will simply return a shallow copy of the
- * array.
- *
- * This function is variadic, meaning that you can specify N arguments to remove N elements.
- */
-export declare function arrayRemove<T>(originalArray: T[] | readonly T[], ...elementsToRemove: T[]): T[];
-/**
- * Removes the specified element(s) from the array. If the specified element(s) are not found in the
- * array, this function will do nothing. Returns whether or not one or more elements were removed.
- *
- * This function is variadic, meaning that you can specify N arguments to remove N elements.
- */
-export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: T[]): boolean;
 /**
  * Helper function to get a random element from the provided array.
  *
@@ -80,6 +57,15 @@ export declare function getRandomArrayElement<T>(array: T[] | readonly T[], seed
  */
 export declare function getRandomArrayElementAndRemove<T>(array: T[], seed?: Seed, exceptions?: T[] | readonly T[]): T;
 export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seed?: Seed): int;
+/**
+ * Initializes an array with all elements containing the specified default value.
+ *
+ * Example:
+ * ```
+ * const playerTransformations = initArray(false, PlayerForm.NUM_PLAYER_FORMS - 1);
+ * ```
+ */
+export declare function initArray<T>(defaultValue: T, size: int): T[];
 /**
  * Since Lua uses tables for every non-primitive data structure, it is non-trivial to determine if a
  * particular table is being used as an array. isArray returns true if:
@@ -88,3 +74,17 @@ export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seed?:
  * - the table has no keys (i.e. an "empty" table)
  */
 export declare function isArray(thing: unknown): boolean;
+export declare function isArrayInArray<T>(arrayToMatch: T[] | readonly T[], parentArray: Array<T[] | readonly T[]>): boolean;
+/**
+ * Shallow copies and shuffles the array using the Fisher-Yates algorithm. Returns the copied array.
+ *
+ * From: https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
+ */
+export declare function shuffleArray<T>(originalArray: T[] | readonly T[], seed?: Seed): T[];
+/**
+ * Shuffles the provided array in-place using the Fisher-Yates algorithm.
+ *
+ * From: https://stackoverflow.com/questions/2450954/how-to-randomize-shuffle-a-javascript-array
+ */
+export declare function shuffleArrayInPlace<T>(array: T[], seed?: Seed): void;
+export declare function sumArray(array: number[] | readonly number[]): number;

package/dist/functions/array.lua

@@ -1,20 +1,29 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
+local __TS__ArrayIndexOf = ____lualib.__TS__ArrayIndexOf
 local __TS__ArraySplice = ____lualib.__TS__ArraySplice
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__ArrayReduce = ____lualib.__TS__ArrayReduce
-local __TS__ArrayMap = ____lualib.__TS__ArrayMap
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
-local __TS__ArrayIndexOf = ____lualib.__TS__ArrayIndexOf
 local ____exports = {}
 local ____random = require("functions.random")
 local getRandomInt = ____random.getRandomInt
 local nextSeed = ____random.nextSeed
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
+function ____exports.getRandomArrayIndex(self, array, seed)
+    if seed == nil then
+        seed = Random()
+    end
+    if #array == 0 then
+        error("Failed to get a random array index since the provided array is empty.")
+    end
+    return getRandomInt(nil, 0, #array - 1, seed)
+end
 function ____exports.shuffleArrayInPlace(self, array, seed)
     if seed == nil then
         seed = Random()
@@ -30,15 +39,6 @@ function ____exports.shuffleArrayInPlace(self, array, seed)
         array[randomIndex + 1] = ____temp_0[2]
     end
 end
-function ____exports.getRandomArrayIndex(self, array, seed)
-    if seed == nil then
-        seed = Random()
-    end
-    if #array == 0 then
-        error("Failed to get a random array index since the provided array is empty.")
-    end
-    return getRandomInt(nil, 0, #array - 1, seed)
-end
 function ____exports.arrayEquals(self, array1, array2)
     if #array1 ~= #array2 then
         return false
@@ -51,6 +51,40 @@ function ____exports.arrayEquals(self, array1, array2)
         end
     )
 end
+function ____exports.arrayRemove(self, originalArray, ...)
+    local elementsToRemove = {...}
+    local elementsToRemoveSet = __TS__New(Set, elementsToRemove)
+    local array = {}
+    for ____, element in ipairs(originalArray) do
+        if not elementsToRemoveSet:has(element) then
+            __TS__ArrayPush(array, element)
+        end
+    end
+    return array
+end
+function ____exports.arrayRemoveInPlace(self, array, ...)
+    local elementsToRemove = {...}
+    local removedOneOrMoreElements = false
+    for ____, element in ipairs(elementsToRemove) do
+        local index = __TS__ArrayIndexOf(array, element)
+        if index > -1 then
+            removedOneOrMoreElements = true
+            __TS__ArraySplice(array, index, 1)
+        end
+    end
+    return removedOneOrMoreElements
+end
+function ____exports.arrayToString(self, array)
+    if #array == 0 then
+        return "[]"
+    end
+    local strings = __TS__ArrayMap(
+        array,
+        function(____, element) return tostring(element) end
+    )
+    local commaSeparatedStrings = table.concat(strings, ", " or ",")
+    return ("[" .. commaSeparatedStrings) .. "]"
+end
 function ____exports.combineArrays(self, ...)
     local arrays = {...}
     local elements = {}
@@ -82,72 +116,6 @@ end
 function ____exports.getLastElement(self, array)
     return array[#array]
 end
-function ____exports.initArray(self, defaultValue, size)
-    local array = {}
-    ____repeat(
-        nil,
-        size,
-        function()
-            __TS__ArrayPush(array, defaultValue)
-        end
-    )
-    return array
-end
-function ____exports.isArrayInArray(self, arrayToMatch, parentArray)
-    return __TS__ArraySome(
-        parentArray,
-        function(____, element) return ____exports.arrayEquals(nil, element, arrayToMatch) end
-    )
-end
-function ____exports.shuffleArray(self, originalArray, seed)
-    if seed == nil then
-        seed = Random()
-    end
-    local array = ____exports.copyArray(nil, originalArray)
-    ____exports.shuffleArrayInPlace(nil, array, seed)
-    return array
-end
-function ____exports.sumArray(self, array)
-    return __TS__ArrayReduce(
-        array,
-        function(____, accumulator, element) return accumulator + element end,
-        0
-    )
-end
-function ____exports.arrayToString(self, array)
-    if #array == 0 then
-        return "[]"
-    end
-    local strings = __TS__ArrayMap(
-        array,
-        function(____, element) return tostring(element) end
-    )
-    local commaSeparatedStrings = table.concat(strings, ", " or ",")
-    return ("[" .. commaSeparatedStrings) .. "]"
-end
-function ____exports.arrayRemove(self, originalArray, ...)
-    local elementsToRemove = {...}
-    local elementsToRemoveSet = __TS__New(Set, elementsToRemove)
-    local array = {}
-    for ____, element in ipairs(originalArray) do
-        if not elementsToRemoveSet:has(element) then
-            __TS__ArrayPush(array, element)
-        end
-    end
-    return array
-end
-function ____exports.arrayRemoveInPlace(self, array, ...)
-    local elementsToRemove = {...}
-    local removedOneOrMoreElements = false
-    for ____, element in ipairs(elementsToRemove) do
-        local index = __TS__ArrayIndexOf(array, element)
-        if index > -1 then
-            removedOneOrMoreElements = true
-            __TS__ArraySplice(array, index, 1)
-        end
-    end
-    return removedOneOrMoreElements
-end
 function ____exports.getRandomArrayElement(self, array, seed, exceptions)
     if seed == nil then
         seed = Random()
@@ -177,6 +145,17 @@ function ____exports.getRandomArrayElementAndRemove(self, array, seed, exception
     ____exports.arrayRemoveInPlace(nil, array, randomArrayElement)
     return randomArrayElement
 end
+function ____exports.initArray(self, defaultValue, size)
+    local array = {}
+    ____repeat(
+        nil,
+        size,
+        function()
+            __TS__ArrayPush(array, defaultValue)
+        end
+    )
+    return array
+end
 function ____exports.isArray(self, thing)
     if type(thing) ~= "table" then
         return false
@@ -208,4 +187,25 @@ function ____exports.isArray(self, thing)
     end
     return true
 end
+function ____exports.isArrayInArray(self, arrayToMatch, parentArray)
+    return __TS__ArraySome(
+        parentArray,
+        function(____, element) return ____exports.arrayEquals(nil, element, arrayToMatch) end
+    )
+end
+function ____exports.shuffleArray(self, originalArray, seed)
+    if seed == nil then
+        seed = Random()
+    end
+    local array = ____exports.copyArray(nil, originalArray)
+    ____exports.shuffleArrayInPlace(nil, array, seed)
+    return array
+end
+function ____exports.sumArray(self, array)
+    return __TS__ArrayReduce(
+        array,
+        function(____, accumulator, element) return accumulator + element end,
+        0
+    )
+end
 return ____exports

package/dist/functions/cards.d.ts

@@ -20,6 +20,7 @@ export declare function getCardDescription(card: Card | int): string;
  * ```
  */
 export declare function getCardName(card: Card | int): string;
+export declare function getCardType(card: Card | int): CardType;
 /**
  * Helper function to get a set of cards matching the type. Also see the [[`CardType`]] enum.
  *
@@ -27,7 +28,6 @@ export declare function getCardName(card: Card | int): string;
  * containing cards that match any of the specified types.
  */
 export declare function getCardsOfType(...cardTypes: CardType[]): Set<Card>;
-export declare function getCardType(card: Card | int): CardType;
 /**
  * Helper function to get the final card sub-type in the game.
  *
@@ -75,8 +75,6 @@ export declare function isCardType(card: Card, cardType: CardType): boolean;
 export declare function isModdedCard(card: Card): boolean;
 /** Returns true for cards that have `CardType.OBJECT`. */
 export declare function isPocketItemObject(card: Card): boolean;
-/** Returns true for cards that have `CardType.TAROT`. */
-export declare function isTarotCard(card: Card): boolean;
 /** Returns true for cards that have `CardType.TAROT_REVERSE`. */
 export declare function isReverseTarotCard(card: Card): boolean;
 /** Returns true for cards that have `CardType.RUNE`. */
@@ -85,3 +83,5 @@ export declare function isRune(card: Card): boolean;
 export declare function isSpecialCard(card: Card): boolean;
 /** Returns true for cards that have `CardType.SUIT`. */
 export declare function isSuitCard(card: Card): boolean;
+/** Returns true for cards that have `CardType.TAROT`. */
+export declare function isTarotCard(card: Card): boolean;

package/dist/functions/cards.lua

@@ -51,6 +51,10 @@ function initCardObjects(self)
     )
     addSetsToSet(nil, CARD_SET, cards)
 end
+function ____exports.getCardType(self, card)
+    local cardType = CARD_TYPES[card]
+    return cardType == nil and DEFAULT_CARD_TYPE or cardType
+end
 function ____exports.getCardsOfType(self, ...)
     local cardTypes = {...}
     if CARD_TYPE_TO_CARDS_MAP.size == 0 then
@@ -68,10 +72,6 @@ function ____exports.getCardsOfType(self, ...)
     end
     return matchingCards
 end
-function ____exports.getCardType(self, card)
-    local cardType = CARD_TYPES[card]
-    return cardType == nil and DEFAULT_CARD_TYPE or cardType
-end
 function ____exports.getMaxCards(self)
     return itemConfig:GetCards().Size - 1
 end
@@ -141,9 +141,6 @@ end
 function ____exports.isPocketItemObject(self, card)
     return ____exports.isCardType(nil, card, CardType.OBJECT)
 end
-function ____exports.isTarotCard(self, card)
-    return ____exports.isCardType(nil, card, CardType.TAROT)
-end
 function ____exports.isReverseTarotCard(self, card)
     return ____exports.isCardType(nil, card, CardType.TAROT_REVERSE)
 end
@@ -156,4 +153,7 @@ end
 function ____exports.isSuitCard(self, card)
     return ____exports.isCardType(nil, card, CardType.SUIT)
 end
+function ____exports.isTarotCard(self, card)
+    return ____exports.isCardType(nil, card, CardType.TAROT)
+end
 return ____exports

package/dist/functions/charge.d.ts

@@ -1,20 +1,21 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Helper function to add a charge to every player's active item, emulating what happens when a room
- * is cleared.
+ * Helper function to add a charge to a player's active item, emulating what happens when a room is
+ * cleared.
  *
  * This function will take the following things into account:
  * - L rooms and 2x2 rooms granting a double charge
  * - The Battery
  * - AAA Battery
  *
+ * @param player The player to grant the charges to.
  * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
  * 1x1 room for the purposes of calculating how much charge to grant. Default is false.
  */
-export declare function addRoomClearCharges(ignoreBigRoomDoubleCharge?: boolean): void;
+export declare function addRoomClearCharge(player: EntityPlayer, ignoreBigRoomDoubleCharge?: boolean): void;
 /**
- * Helper function to add a charge to a player's active item, emulating what happens when a room is
- * cleared.
+ * Helper function to add a charge to one of a player's active items, emulating what happens when a
+ * room is cleared.
  *
  * This function will take the following things into account:
  * - L rooms and 2x2 rooms granting a double charge
@@ -22,25 +23,24 @@ export declare function addRoomClearCharges(ignoreBigRoomDoubleCharge?: boolean)
  * - AAA Battery
  *
  * @param player The player to grant the charges to.
+ * @param activeSlot The active item slot to grant the charges to.
  * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
  * 1x1 room for the purposes of calculating how much charge to grant. Default is false.
  */
-export declare function addRoomClearCharge(player: EntityPlayer, ignoreBigRoomDoubleCharge?: boolean): void;
+export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlot: ActiveSlot, ignoreBigRoomDoubleCharge?: boolean): void;
 /**
- * Helper function to add a charge to one of a player's active items, emulating what happens when a
- * room is cleared.
+ * Helper function to add a charge to every player's active item, emulating what happens when a room
+ * is cleared.
  *
  * This function will take the following things into account:
  * - L rooms and 2x2 rooms granting a double charge
  * - The Battery
  * - AAA Battery
  *
- * @param player The player to grant the charges to.
- * @param activeSlot The active item slot to grant the charges to.
  * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
  * 1x1 room for the purposes of calculating how much charge to grant. Default is false.
  */
-export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlot: ActiveSlot, ignoreBigRoomDoubleCharge?: boolean): void;
+export declare function addRoomClearCharges(ignoreBigRoomDoubleCharge?: boolean): void;
 /**
  * Helper function to get the combined normal charge and the battery charge for the player's active
  * item. This is useful because you have to add these two values together when setting the active

package/dist/functions/charge.lua

@@ -8,14 +8,6 @@ local ____collectibles = require("functions.collectibles")
 local getCollectibleMaxCharges = ____collectibles.getCollectibleMaxCharges
 local ____player = require("functions.player")
 local getPlayers = ____player.getPlayers
-function ____exports.addRoomClearCharge(self, player, ignoreBigRoomDoubleCharge)
-    if ignoreBigRoomDoubleCharge == nil then
-        ignoreBigRoomDoubleCharge = false
-    end
-    for ____, activeSlot in ipairs({ActiveSlot.SLOT_PRIMARY, ActiveSlot.SLOT_SECONDARY, ActiveSlot.SLOT_POCKET}) do
-        ____exports.addRoomClearChargeToSlot(nil, player, activeSlot, ignoreBigRoomDoubleCharge)
-    end
-end
 function ____exports.addRoomClearChargeToSlot(self, player, activeSlot, ignoreBigRoomDoubleCharge)
     if ignoreBigRoomDoubleCharge == nil then
         ignoreBigRoomDoubleCharge = false
@@ -60,11 +52,6 @@ function getNumChargesToAdd(self, player, activeSlot, ignoreBigRoomDoubleCharge)
     end
     return 1
 end
-function ____exports.getTotalCharge(self, player, activeSlot)
-    local activeCharge = player:GetActiveCharge(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    return activeCharge + batteryCharge
-end
 function getNumChargesWithAAAModifier(self, player, activeSlot, chargesToAdd)
     local activeItem = player:GetActiveItem(activeSlot)
     local activeCharge = player:GetActiveCharge(activeSlot)
@@ -83,6 +70,11 @@ function getNumChargesWithAAAModifier(self, player, activeSlot, chargesToAdd)
     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.SOUND_BATTERYCHARGE, SoundEffect.SOUND_BEEP}) do
         sfxManager:Stop(soundEffect)
@@ -101,6 +93,14 @@ function shouldPlayFullRechargeSound(self, player, 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.SLOT_PRIMARY, ActiveSlot.SLOT_SECONDARY, ActiveSlot.SLOT_POCKET}) do
+        ____exports.addRoomClearChargeToSlot(nil, player, activeSlot, ignoreBigRoomDoubleCharge)
+    end
+end
 function ____exports.addRoomClearCharges(self, ignoreBigRoomDoubleCharge)
     if ignoreBigRoomDoubleCharge == nil then
         ignoreBigRoomDoubleCharge = false

package/dist/functions/collectibles.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="isaac-typescript-definitions" />
 import { CollectiblePedestalType } from "../enums/CollectiblePedestalType";
-export declare function collectibleHasTag(collectibleType: CollectibleType | int, tag: ItemConfigTag): boolean;
+import { CollectibleIndex } from "../types/CollectibleIndex";
 export declare function clearCollectibleSprite(collectible: EntityPickup): void;
 export declare function collectibleHasCacheFlag(collectibleType: CollectibleType | int, cacheFlag: CacheFlag): boolean;
+export declare function collectibleHasTag(collectibleType: CollectibleType | int, tag: ItemConfigTag): boolean;
 /**
  * Helper function to get the in-game description for a collectible. Returns "Unknown" if the
  * provided collectible type was not valid.
@@ -18,16 +19,42 @@ export declare function getCollectibleDevilHeartPrice(collectibleType: Collectib
  * "gfx/items/collectibles/questionmark.png" if the provided collectible type was not valid.
  */
 export declare function getCollectibleGfxFilename(collectibleType: CollectibleType | int): 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 3-tuple of the room list index, the grid
+ * index of the collectible in the room, and the collectible's InitSeed.
+ *
+ * When collectibles are rolled (e.g. with a D6), their InitSeed changes. If you want to track
+ * collectibles independently of any rerolls, then 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 sub-type 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 and InitSeed to exist.
+ * - 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. An 4-tuple of stage, stage type, grid index, 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
+ * 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 getCollectibleInitCharges(collectibleType: CollectibleType | int): int;
-/**
- * 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): int;
+export declare function getCollectibleInitCharge(collectibleType: CollectibleType | int): int;
 /**
  * Helper function to get the `ItemType` of a collectible. Returns `ItemType.ITEM_NULL` if the
  * provided collectible type was not valid.
@@ -50,6 +77,11 @@ export declare function getCollectibleMaxCharges(collectibleType: CollectibleTyp
  */
 export declare function getCollectibleName(collectibleType: CollectibleType | int): 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): int;
 /** Helper function to get all of the collectible entities in the room. */
 export declare function getCollectibles(matchingSubType?: number): EntityPickup[];
 /**
@@ -59,6 +91,8 @@ export declare function getCollectibles(matchingSubType?: number): EntityPickup[
  * collectibles.
  */
 export declare function getMaxCollectibleType(): int;
+/** Returns true if the item type in the item config is equal to `ItemType.ITEM_ACTIVE`. */
+export declare function isActiveCollectible(collectibleType: CollectibleType | int): 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
@@ -86,11 +120,6 @@ export declare function isSingleUseCollectible(collectibleType: CollectibleType
  * @returns True if one or more collectibles was removed, false otherwise.
  */
 export declare function removeAllCollectibles(collectibleType?: CollectibleType | int, cap?: int): boolean;
-/**
- * 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 put a message in the log.txt file to let the Rebirth Item Tracker know that it
  * should remove an item.
@@ -100,10 +129,14 @@ export declare function removeCollectiblePickupDelay(collectible: EntityPickup):
  */
 export declare function removeCollectibleFromItemTracker(collectibleType: CollectibleType | int): 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.
+ * 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 setCollectiblesRerolledForItemTracker(): void;
 export declare function setCollectibleBlind(collectible: EntityPickup): void;
 /**
  * Helper function to remove the collectible from a collectible pedestal and make it appear as if a
@@ -130,3 +163,8 @@ export declare function setCollectibleSprite(collectible: EntityPickup, pngPath:
  * not sufficient because the sprite will not change.
  */
 export declare function setCollectibleSubType(collectible: EntityPickup, newCollectibleType: CollectibleType | int): 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;