isaacscript-common 20.16.0 → 20.17.0

package/dist/index.d.ts

@@ -1318,7 +1318,7 @@ export declare function closeDoorFast(door: GridEntityDoor): void;
 export declare const COLLECTIBLE_INITIAL_WAIT = 20;
 
 /** Helper function to check in the item config if a given collectible has a given cache flag. */
-export declare function collectibleHasCacheFlag(collectibleType: CollectibleType, cacheFlag: CacheFlag): boolean;
+export declare function collectibleHasCacheFlag(collectibleOrCollectibleType: EntityPickup | CollectibleType, cacheFlag: CacheFlag): boolean;
 
 export declare function collectibleHasTag(collectibleType: CollectibleType, tag: ItemConfigTag): boolean;
 
@@ -4356,7 +4356,7 @@ export declare function getCoinValue(coinSubType: CoinSubType): int;
  * Helper function to get the charge type that a collectible has. Returns
  * `ItemConfigChargeType.NORMAL` if the provided collectible type was not valid.
  */
-export declare function getCollectibleChargeType(collectibleType: CollectibleType): ItemConfigChargeType;
+export declare function getCollectibleChargeType(collectibleOrCollectibleType: EntityPickup | CollectibleType): ItemConfigChargeType;
 
 /**
  * Helper function to get the in-game description for a collectible. Returns "Unknown" if the
@@ -4364,19 +4364,19 @@ export declare function getCollectibleChargeType(collectibleType: CollectibleTyp
  *
  * This function works for both vanilla and modded collectibles.
  */
-export declare function getCollectibleDescription(collectibleType: CollectibleType): string;
+export declare function getCollectibleDescription(collectibleOrCollectibleType: EntityPickup | 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;
+export declare function getCollectibleDevilCoinPrice(collectibleOrCollectibleType: EntityPickup | 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;
+export declare function getCollectibleDevilHeartPrice(collectibleOrCollectibleType: EntityPickup | CollectibleType, player: EntityPlayer): PickupPrice;
 
 /**
  * Helper function to get the path to a collectible PNG file. Returns the path to the question mark
@@ -4386,7 +4386,7 @@ export declare function getCollectibleDevilHeartPrice(collectibleType: Collectib
  * The function is named "GfxFilename" to correspond to the associated `ItemConfigItem.GfxFileName`
  * field.
  */
-export declare function getCollectibleGfxFilename(collectibleType: CollectibleType): string;
+export declare function getCollectibleGfxFilename(collectibleOrCollectibleType: EntityPickup | CollectibleType): string;
 
 /**
  * Mods may have to keep track of data relating to a collectible. Finding an index for these kinds
@@ -4444,19 +4444,19 @@ export declare function getCollectibleIndex(collectible: EntityPickup): Collecti
  * 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;
+export declare function getCollectibleInitCharge(collectibleOrCollectibleType: EntityPickup | 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;
+export declare function getCollectibleItemType(collectibleOrCollectibleType: EntityPickup | 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;
+export declare function getCollectibleMaxCharges(collectibleOrCollectibleType: EntityPickup | CollectibleType): int;
 
 /**
  * Helper function to get the name of a collectible. Returns "Unknown" if the provided collectible
@@ -4466,7 +4466,7 @@ export declare function getCollectibleMaxCharges(collectibleType: CollectibleTyp
  *
  * This function works for both vanilla and modded collectibles.
  */
-export declare function getCollectibleName(collectibleType: CollectibleType): string;
+export declare function getCollectibleName(collectibleOrCollectibleType: EntityPickup | CollectibleType): string;
 
 /**
  * Helper function to get the "pedestal type" of a collectible. For example, it might be sitting on
@@ -4478,7 +4478,7 @@ export declare function getCollectiblePedestalType(collectible: EntityPickup): C
  * Helper function to get a collectible's quality. For example, Mom's Knife has a quality of 4.
  * Returns 0 if the provided collectible type was not valid.
  */
-export declare function getCollectibleQuality(collectibleType: CollectibleType): int;
+export declare function getCollectibleQuality(collectibleOrCollectibleType: EntityPickup | CollectibleType): int;
 
 /**
  * Helper function to get all of the collectible entities in the room.
@@ -4499,7 +4499,7 @@ export declare function getCollectibles(collectibleType?: CollectibleType): Enti
  * const itemConfigTags = getCollectibleTags(collectibleType); // itemConfigTags is "18350080"
  * ```
  */
-export declare function getCollectibleTags(collectibleType: CollectibleType): BitFlags<ItemConfigTag>;
+export declare function getCollectibleTags(collectibleOrCollectibleType: EntityPickup | CollectibleType): BitFlags<ItemConfigTag>;
 
 /**
  * Gets the entities that have a hitbox that overlaps with any part of the square that the grid
@@ -7617,7 +7617,7 @@ export declare function isFunction(variable: unknown): variable is Function;
  * 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;
+export declare function isGlitchedCollectible(collectible: EntityPickup): boolean;
 
 export declare function isGoldenTrinketType(trinketType: TrinketType): boolean;
 
@@ -7654,7 +7654,7 @@ export declare function isHeart(pickup: EntityPickup): pickup is EntityPickupHea
  *
  * Hidden collectibles will not show up in any pools and Eden will not start with them.
  */
-export declare function isHiddenCollectible(collectibleType: CollectibleType): boolean;
+export declare function isHiddenCollectible(collectibleOrCollectibleType: EntityPickup | CollectibleType): boolean;
 
 export declare function isHiddenSecretRoomDoor(door: GridEntityDoor): boolean;
 
@@ -7766,7 +7766,7 @@ export declare function isOdd(num: int): 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;
+export declare function isPassiveCollectible(collectibleOrCollectibleType: EntityPickup | CollectibleType): boolean;
 
 /** Helper function to narrow the type of `PickingUpItem`. */
 export declare function isPickingUpItemCollectible(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemCollectible;
@@ -7822,7 +7822,7 @@ export declare function isPrimitive(variable: unknown): variable is boolean | nu
 export declare function isProjectile(variable: unknown): variable is EntityProjectile;
 
 /** Helper function to check if a collectible type is a particular quality. */
-export declare function isQuality(collectibleType: CollectibleType, quality: int): boolean;
+export declare function isQuality(collectibleOrCollectibleType: EntityPickup | CollectibleType, quality: int): boolean;
 
 export declare function isQuestCollectible(collectibleType: CollectibleType): boolean;
 
@@ -7969,8 +7969,8 @@ export declare function isSin(npc: EntityNPC): 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.
+ * inventory upon use. Note that this will not work will modded collectibles, as there is no way to
+ * dynamically know if a modded collectible will disappear.
  */
 export declare function isSingleUseCollectible(collectibleType: CollectibleType): boolean;
 
@@ -14007,6 +14007,13 @@ export declare function setCollectibleEmpty(collectible: EntityPickup): void;
  */
 export declare function setCollectibleGlitched(collectible: EntityPickup): void;
 
+/**
+ * Helper function to set the "pedestal type" of a collectible. For example, it might be sitting on
+ * top of a broken Blood Donation Machine and you want to change it to be sitting on top of an
+ * opened Spiked Chest.
+ */
+export declare function setCollectiblePedestalType(collectible: EntityPickup, collectiblePedestalType: CollectiblePedestalType): void;
+
 /**
  * Helper function to change the sprite of a collectible pedestal entity.
  *

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 20.16.0
+isaacscript-common 20.17.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -20112,39 +20112,40 @@ return ____exports
 ["src.functions.pickupVariants"] = function(...) 
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
 function ____exports.isHeart(self, pickup)
-    return pickup.Variant == PickupVariant.HEART
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.HEART
 end
 function ____exports.isCoin(self, pickup)
-    return pickup.Variant == PickupVariant.COIN
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.COIN
 end
 function ____exports.isKey(self, pickup)
-    return pickup.Variant == PickupVariant.KEY
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.KEY
 end
 function ____exports.isBombPickup(self, pickup)
-    return pickup.Variant == PickupVariant.BOMB
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.BOMB
 end
 function ____exports.isPoopPickup(self, pickup)
-    return pickup.Variant == PickupVariant.POOP
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.POOP
 end
 function ____exports.isSack(self, pickup)
-    return pickup.Variant == PickupVariant.SACK
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.SACK
 end
 function ____exports.isPill(self, pickup)
-    return pickup.Variant == PickupVariant.PILL
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.PILL
 end
 function ____exports.isBattery(self, pickup)
-    return pickup.Variant == PickupVariant.LIL_BATTERY
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.LIL_BATTERY
 end
 function ____exports.isCollectible(self, pickup)
-    return pickup.Variant == PickupVariant.COLLECTIBLE
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.COLLECTIBLE
 end
 function ____exports.isCardPickup(self, pickup)
-    return pickup.Variant == PickupVariant.TAROT_CARD
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.TAROT_CARD
 end
 function ____exports.isTrinket(self, pickup)
-    return pickup.Variant == PickupVariant.TRINKET
+    return pickup.Type == EntityType.PICKUP and pickup.Variant == PickupVariant.TRINKET
 end
 return ____exports
  end,
@@ -20985,7 +20986,7 @@ return ____exports
  end,
 ["src.functions.collectibles"] = function(...) 
 local ____exports = {}
-local initQuestionMarkSprite
+local initQuestionMarkSprite, getCollectibleTypeFromArg
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local CollectibleSpriteLayer = ____isaac_2Dtypescript_2Ddefinitions.CollectibleSpriteLayer
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
@@ -21025,6 +21026,8 @@ local getRoomListIndex = ____roomData.getRoomListIndex
 local ____sprites = require("src.functions.sprites")
 local clearSprite = ____sprites.clearSprite
 local spriteEquals = ____sprites.spriteEquals
+local ____types = require("src.functions.types")
+local isNumber = ____types.isNumber
 local ____utils = require("src.functions.utils")
 local iRange = ____utils.iRange
 function initQuestionMarkSprite(self)
@@ -21035,6 +21038,10 @@ function initQuestionMarkSprite(self)
     return sprite
 end
 function ____exports.clearCollectibleSprite(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"clearCollectibleSprite\" function was given a non-collectible: " .. entityID)
+    end
     ____exports.setCollectibleSprite(nil, collectible, nil)
 end
 function ____exports.isVanillaCollectibleType(self, collectibleType)
@@ -21079,10 +21086,24 @@ function ____exports.setCollectibleSubType(self, collectible, newCollectibleType
         true
     )
 end
+function getCollectibleTypeFromArg(self, collectibleOrCollectibleType, functionName)
+    if isNumber(nil, collectibleOrCollectibleType) then
+        local collectibleType = collectibleOrCollectibleType
+        return collectibleType
+    end
+    local collectible = collectibleOrCollectibleType
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error((("The \"" .. functionName) .. "\" function was given a non-collectible: ") .. entityID)
+    end
+    return collectible.SubType
+end
 local COLLECTIBLE_ANM2_PATH = "gfx/005.100_collectible.anm2"
+local DEFAULT_COLLECTIBLE_PRICE = 15
 local GLITCHED_ITEM_THRESHOLD = 4000000000
 local questionMarkSprite = initQuestionMarkSprite(nil)
-function ____exports.collectibleHasCacheFlag(self, collectibleType, cacheFlag)
+function ____exports.collectibleHasCacheFlag(self, collectibleOrCollectibleType, cacheFlag)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "collectibleHasCacheFlag")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
         return false
@@ -21109,14 +21130,16 @@ function ____exports.collectibleSpriteEquals(self, sprite1, sprite2)
         yIncrement
     )
 end
-function ____exports.getCollectibleChargeType(self, collectibleType)
+function ____exports.getCollectibleChargeType(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleChargeType")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
         return ItemConfigChargeType.NORMAL
     end
     return itemConfigItem.ChargeType
 end
-function ____exports.getCollectibleDescription(self, collectibleType)
+function ____exports.getCollectibleDescription(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleDescription")
     local collectibleDescription = COLLECTIBLE_DESCRIPTION_MAP:get(collectibleType)
     if collectibleDescription ~= nil then
         return collectibleDescription
@@ -21127,18 +21150,19 @@ function ____exports.getCollectibleDescription(self, collectibleType)
     end
     return DEFAULT_COLLECTIBLE_DESCRIPTION
 end
-function ____exports.getCollectibleDevilCoinPrice(self, collectibleType)
+function ____exports.getCollectibleDevilCoinPrice(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleDescription")
     if collectibleType == CollectibleType.NULL then
         return 0
     end
-    local defaultCollectiblePrice = 15
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
-        return defaultCollectiblePrice
+        return DEFAULT_COLLECTIBLE_PRICE
     end
-    return itemConfigItem.DevilPrice * defaultCollectiblePrice
+    return itemConfigItem.DevilPrice * DEFAULT_COLLECTIBLE_PRICE
 end
-function ____exports.getCollectibleDevilHeartPrice(self, collectibleType, player)
+function ____exports.getCollectibleDevilHeartPrice(self, collectibleOrCollectibleType, player)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleDevilHeartPrice")
     local maxHearts = player:GetMaxHearts()
     if collectibleType == CollectibleType.NULL then
         return 0
@@ -21154,7 +21178,8 @@ function ____exports.getCollectibleDevilHeartPrice(self, collectibleType, player
     local twoHeartPrice = maxHearts == 2 and PickupPrice.ONE_HEART_AND_TWO_SOUL_HEARTS or PickupPrice.TWO_HEARTS
     return itemConfigItem.DevilPrice == 2 and twoHeartPrice or PickupPrice.ONE_HEART
 end
-function ____exports.getCollectibleGfxFilename(self, collectibleType)
+function ____exports.getCollectibleGfxFilename(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleGfxFilename")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
         return BLIND_ITEM_PNG_PATH
@@ -21178,28 +21203,32 @@ function ____exports.getCollectibleIndex(self, collectible)
     end
     return (((((tostring(roomListIndex) .. ",") .. tostring(gridIndex)) .. ",") .. tostring(collectible.SubType)) .. ",") .. tostring(collectible.InitSeed)
 end
-function ____exports.getCollectibleInitCharge(self, collectibleType)
+function ____exports.getCollectibleInitCharge(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleInitCharge")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
         return 0
     end
     return itemConfigItem.InitCharge
 end
-function ____exports.getCollectibleItemType(self, collectibleType)
+function ____exports.getCollectibleItemType(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleItemType")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
         return ItemType.NULL
     end
     return itemConfigItem.Type
 end
-function ____exports.getCollectibleMaxCharges(self, collectibleType)
+function ____exports.getCollectibleMaxCharges(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleMaxCharges")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
         return 0
     end
     return itemConfigItem.MaxCharges
 end
-function ____exports.getCollectibleName(self, collectibleType)
+function ____exports.getCollectibleName(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleName")
     local collectibleName = COLLECTIBLE_TYPE_TO_NAME_MAP:get(collectibleType)
     if collectibleName ~= nil then
         return collectibleName
@@ -21218,14 +21247,16 @@ function ____exports.getCollectiblePedestalType(self, collectible)
     local sprite = collectible:GetSprite()
     return sprite:GetOverlayFrame()
 end
-function ____exports.getCollectibleQuality(self, collectibleType)
+function ____exports.getCollectibleQuality(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleQuality")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
         return 0
     end
     return itemConfigItem.Quality
 end
-function ____exports.getCollectibleTags(self, collectibleType)
+function ____exports.getCollectibleTags(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleTags")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     return itemConfigItem == nil and ItemConfigTagZero or itemConfigItem.Tags
 end
@@ -21252,22 +21283,24 @@ function ____exports.isBlindCollectible(self, collectible)
     questionMarkSprite:SetFrame(animation, frame)
     return ____exports.collectibleSpriteEquals(nil, sprite, questionMarkSprite)
 end
-function ____exports.isGlitchedCollectible(self, pickup)
-    return pickup.Variant == PickupVariant.COLLECTIBLE and pickup.SubType > GLITCHED_ITEM_THRESHOLD
+function ____exports.isGlitchedCollectible(self, collectible)
+    return collectible.Variant == PickupVariant.COLLECTIBLE and collectible.SubType > GLITCHED_ITEM_THRESHOLD
 end
-function ____exports.isHiddenCollectible(self, collectibleType)
+function ____exports.isHiddenCollectible(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "isHiddenCollectible")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     return itemConfigItem ~= nil and itemConfigItem.Hidden
 end
 function ____exports.isModdedCollectibleType(self, collectibleType)
     return not ____exports.isVanillaCollectibleType(nil, collectibleType)
 end
-function ____exports.isPassiveCollectible(self, collectibleType)
+function ____exports.isPassiveCollectible(self, collectibleOrCollectibleType)
+    local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "isPassiveCollectible")
     local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
     return itemType == ItemType.PASSIVE or itemType == ItemType.FAMILIAR
 end
-function ____exports.isQuality(self, collectibleType, quality)
-    local actualQuality = ____exports.getCollectibleQuality(nil, collectibleType)
+function ____exports.isQuality(self, collectibleOrCollectibleType, quality)
+    local actualQuality = ____exports.getCollectibleQuality(nil, collectibleOrCollectibleType)
     return quality == actualQuality
 end
 function ____exports.isSingleUseCollectible(self, collectibleType)
@@ -21323,6 +21356,15 @@ function ____exports.setCollectibleGlitched(self, collectible)
         player:RemoveCollectible(CollectibleType.TMTRAINER)
     end
 end
+function ____exports.setCollectiblePedestalType(self, collectible, collectiblePedestalType)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectiblePedestalType\" function was given a non-collectible: " .. entityID)
+    end
+    local sprite = collectible:GetSprite()
+    local overlayAnimation = sprite:GetOverlayAnimation()
+    sprite:SetOverlayFrame(overlayAnimation, collectiblePedestalType)
+end
 function ____exports.setCollectiblesRerolledForItemTracker(self)
     Isaac.DebugString("Added 3 Collectibles")
 end

package/dist/src/functions/collectibles.d.ts

@@ -2,31 +2,31 @@ import { CacheFlag, CollectiblePedestalType, CollectibleType, ItemConfigChargeTy
 import { CollectibleIndex } from "../types/CollectibleIndex";
 export declare function clearCollectibleSprite(collectible: EntityPickup): void;
 /** Helper function to check in the item config if a given collectible has a given cache flag. */
-export declare function collectibleHasCacheFlag(collectibleType: CollectibleType, cacheFlag: CacheFlag): boolean;
+export declare function collectibleHasCacheFlag(collectibleOrCollectibleType: EntityPickup | CollectibleType, cacheFlag: CacheFlag): boolean;
 /** 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 charge type that a collectible has. Returns
  * `ItemConfigChargeType.NORMAL` if the provided collectible type was not valid.
  */
-export declare function getCollectibleChargeType(collectibleType: CollectibleType): ItemConfigChargeType;
+export declare function getCollectibleChargeType(collectibleOrCollectibleType: EntityPickup | CollectibleType): ItemConfigChargeType;
 /**
  * Helper function to get the in-game description for a collectible. Returns "Unknown" if the
  * provided collectible type was not valid.
  *
  * This function works for both vanilla and modded collectibles.
  */
-export declare function getCollectibleDescription(collectibleType: CollectibleType): string;
+export declare function getCollectibleDescription(collectibleOrCollectibleType: EntityPickup | 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;
+export declare function getCollectibleDevilCoinPrice(collectibleOrCollectibleType: EntityPickup | 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;
+export declare function getCollectibleDevilHeartPrice(collectibleOrCollectibleType: EntityPickup | CollectibleType, player: EntityPlayer): PickupPrice;
 /**
  * Helper function to get the path to a collectible PNG file. Returns the path to the question mark
  * sprite (i.e. from Curse of the Blind) if the provided collectible type was not valid.
@@ -35,7 +35,7 @@ export declare function getCollectibleDevilHeartPrice(collectibleType: Collectib
  * The function is named "GfxFilename" to correspond to the associated `ItemConfigItem.GfxFileName`
  * field.
  */
-export declare function getCollectibleGfxFilename(collectibleType: CollectibleType): string;
+export declare function getCollectibleGfxFilename(collectibleOrCollectibleType: EntityPickup | CollectibleType): string;
 /**
  * Mods may have to keep track of data 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
@@ -91,17 +91,17 @@ export declare function getCollectibleIndex(collectible: EntityPickup): Collecti
  * 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;
+export declare function getCollectibleInitCharge(collectibleOrCollectibleType: EntityPickup | 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;
+export declare function getCollectibleItemType(collectibleOrCollectibleType: EntityPickup | 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;
+export declare function getCollectibleMaxCharges(collectibleOrCollectibleType: EntityPickup | CollectibleType): int;
 /**
  * Helper function to get the name of a collectible. Returns "Unknown" if the provided collectible
  * type is not valid.
@@ -110,7 +110,7 @@ export declare function getCollectibleMaxCharges(collectibleType: CollectibleTyp
  *
  * This function works for both vanilla and modded collectibles.
  */
-export declare function getCollectibleName(collectibleType: CollectibleType): string;
+export declare function getCollectibleName(collectibleOrCollectibleType: EntityPickup | CollectibleType): string;
 /**
  * Helper function to get the "pedestal type" of a collectible. For example, it might be sitting on
  * top of a broken Blood Donation Machine, or it might be sitting on top of an opened Spiked Chest.
@@ -120,7 +120,7 @@ export declare function getCollectiblePedestalType(collectible: EntityPickup): C
  * Helper function to get a collectible's quality. For example, Mom's Knife has a quality of 4.
  * Returns 0 if the provided collectible type was not valid.
  */
-export declare function getCollectibleQuality(collectibleType: CollectibleType): int;
+export declare function getCollectibleQuality(collectibleOrCollectibleType: EntityPickup | 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.
@@ -132,7 +132,7 @@ export declare function getCollectibleQuality(collectibleType: CollectibleType):
  * const itemConfigTags = getCollectibleTags(collectibleType); // itemConfigTags is "18350080"
  * ```
  */
-export declare function getCollectibleTags(collectibleType: CollectibleType): BitFlags<ItemConfigTag>;
+export declare function getCollectibleTags(collectibleOrCollectibleType: EntityPickup | CollectibleType): BitFlags<ItemConfigTag>;
 /**
  * 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
@@ -157,25 +157,25 @@ export declare function isBlindCollectible(collectible: EntityPickup): boolean;
  * 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;
+export declare function isGlitchedCollectible(collectible: 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;
+export declare function isHiddenCollectible(collectibleOrCollectibleType: EntityPickup | CollectibleType): boolean;
 export declare function isModdedCollectibleType(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;
+export declare function isPassiveCollectible(collectibleOrCollectibleType: EntityPickup | CollectibleType): boolean;
 /** Helper function to check if a collectible type is a particular quality. */
-export declare function isQuality(collectibleType: CollectibleType, quality: int): boolean;
+export declare function isQuality(collectibleOrCollectibleType: EntityPickup | CollectibleType, quality: int): 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.
+ * inventory upon use. Note that this will not work will modded collectibles, as there is no way to
+ * dynamically know if a modded collectible will disappear.
  */
 export declare function isSingleUseCollectible(collectibleType: CollectibleType): boolean;
 export declare function isValidCollectibleType(collectibleType: CollectibleType): boolean;
@@ -221,6 +221,12 @@ export declare function setCollectibleEmpty(collectible: EntityPickup): void;
  * the player has TMTRAINER).
  */
 export declare function setCollectibleGlitched(collectible: EntityPickup): void;
+/**
+ * Helper function to set the "pedestal type" of a collectible. For example, it might be sitting on
+ * top of a broken Blood Donation Machine and you want to change it to be sitting on top of an
+ * opened Spiked Chest.
+ */
+export declare function setCollectiblePedestalType(collectible: EntityPickup, collectiblePedestalType: CollectiblePedestalType): void;
 /**
  * Helper function to change the sprite of a collectible pedestal entity.
  *

package/dist/src/functions/collectibles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collectibles.d.ts","sourceRoot":"","sources":["../../../src/functions/collectibles.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,uBAAuB,EAEvB,eAAe,EAEf,oBAAoB,EACpB,aAAa,EAEb,QAAQ,EACR,WAAW,EAIZ,MAAM,8BAA8B,CAAC;AAgBtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAyB7D,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAEtE;AAED,iGAAiG;AACjG,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,EAChC,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED,6FAA6F;AAC7F,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAsBT;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,oBAAoB,CAOtB;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,eAAe,EAAE,eAAe,GAC/B,MAAM,CAeR;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,eAAe,EAAE,eAAe,GAC/B,GAAG,CAYL;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAC3C,eAAe,EAAE,eAAe,EAChC,MAAM,EAAE,YAAY,GACnB,WAAW,CAyBb;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,eAAe,EAAE,eAAe,GAC/B,MAAM,CAOR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GACxB,gBAAgB,CAsBlB;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,GAAG,CAOL;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAOV;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,GAAG,CAOL;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,CAc3E;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,GACxB,uBAAuB,CAUzB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,eAAe,EAAE,eAAe,GAAG,GAAG,CAO3E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,aAAa,CAAC,CAGzB;AAED;;;;;;;;GAQG;AACH,wBAAgB,8BAA8B,IAAI,eAAe,EAAE,CAElE;AAED,2FAA2F;AAC3F,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAG7E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAsBrE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAKnE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAG7E;AAED,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED,8EAA8E;AAC9E,wBAAgB,SAAS,CACvB,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,GAAG,GACX,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,CAiB7E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gCAAgC,CAC9C,eAAe,EAAE,eAAe,GAC/B,IAAI,CAQN;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAS5E;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CASnE;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAUnE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAuBtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,YAAY,EACzB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAqBN;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,YAAY,EACzB,kBAAkB,EAAE,eAAe,GAClC,IAAI,CA2BN;AAED;;;GAGG;AACH,wBAAgB,qCAAqC,IAAI,IAAI,CAK5D"}
+{"version":3,"file":"collectibles.d.ts","sourceRoot":"","sources":["../../../src/functions/collectibles.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,uBAAuB,EAEvB,eAAe,EAEf,oBAAoB,EACpB,aAAa,EAEb,QAAQ,EACR,WAAW,EAIZ,MAAM,8BAA8B,CAAC;AAgBtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AA4B7D,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAStE;AAED,iGAAiG;AACjG,wBAAgB,uBAAuB,CACrC,4BAA4B,EAAE,YAAY,GAAG,eAAe,EAC5D,SAAS,EAAE,SAAS,GACnB,OAAO,CAYT;AAED,6FAA6F;AAC7F,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAsBT;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,oBAAoB,CAYtB;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,MAAM,CAoBR;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAgBL;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAC3C,4BAA4B,EAAE,YAAY,GAAG,eAAe,EAC5D,MAAM,EAAE,YAAY,GACnB,WAAW,CA6Bb;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,MAAM,CAYR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GACxB,gBAAgB,CAsBlB;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAYL;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,QAAQ,CAYV;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAYL;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,MAAM,CAmBR;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,GACxB,uBAAuB,CAUzB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAYL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,QAAQ,CAAC,aAAa,CAAC,CAQzB;AAED;;;;;;;;GAQG;AACH,wBAAgB,8BAA8B,IAAI,eAAe,EAAE,CAElE;AAED,2FAA2F;AAC3F,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAG7E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAsBrE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAKxE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,OAAO,CAQT;AAED,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,OAAO,CAQT;AAED,8EAA8E;AAC9E,wBAAgB,SAAS,CACvB,4BAA4B,EAAE,YAAY,GAAG,eAAe,EAC5D,OAAO,EAAE,GAAG,GACX,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,CAiB7E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gCAAgC,CAC9C,eAAe,EAAE,eAAe,GAC/B,IAAI,CAQN;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAS5E;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CASnE;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAUnE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAuBtE;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,EACzB,uBAAuB,EAAE,uBAAuB,GAC/C,IAAI,CAWN;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,YAAY,EACzB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAqBN;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,YAAY,EACzB,kBAAkB,EAAE,eAAe,GAClC,IAAI,CA2BN;AAED;;;GAGG;AACH,wBAAgB,qCAAqC,IAAI,IAAI,CAK5D"}