isaacscript-common 20.16.0 → 20.18.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;
 
@@ -3269,6 +3269,16 @@ declare class DisableInputs extends Feature {
 /** This is also the distance that a player spawns from the door that they enter a room from. */
 export declare const DISTANCE_OF_GRID_TILE = 40;
 
+/**
+ * Helper function to check if one or more matching entities exist in the current room. It uses the
+ * `doesEntityExist` helper function to determine this.
+ *
+ * @param entityTypes An array or set of the entity types that you want to check for. Will return
+ *                    true if any of the provided entity types exist.
+ * @param ignoreFriendly Optional. Default is false.
+ */
+export declare function doesAnyEntityExist(entityTypes: EntityType[] | readonly EntityType[] | Set<EntityType> | ReadonlySet<EntityType>, ignoreFriendly?: boolean): boolean;
+
 /**
  * Helper function to check if one or more of a specific kind of entity is present in the current
  * room. It uses the `countEntities` helper function to determine this.
@@ -4356,7 +4366,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 +4374,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 +4396,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 +4454,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 +4476,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 +4488,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 +4509,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 +7627,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 +7664,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 +7776,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 +7832,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 +7979,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 +14017,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.
  *