isaacscript-common 55.2.0 → 56.1.0

package/dist/index.rollup.d.ts

@@ -4954,6 +4954,12 @@ export declare function getBossID(): BossID | 0;
 
 export declare function getBossIDFromEntityTypeVariant(entityType: EntityType, variant: int): BossID | undefined;
 
+/**
+ * Helper function to get the proper English name for a boss. For example, the name for
+ * `BossID.WRETCHED` (36) is "The Wretched".
+ */
+export declare function getBossName(bossID: BossID): string;
+
 /**
  * Helper function to get the path to the name file that corresponds to the graphic shown on the
  * versus screen for the particular boss.
@@ -4987,9 +4993,12 @@ export declare function getBossRushDoor(): GridEntityDoor | undefined;
 export declare function getBossSet(stage: LevelStage, stageType: StageType): ReadonlySet<BossID> | undefined;
 
 /**
- * Helper function to get a card description from a Card enum value.
+ * Helper function to get a card description from a `CardType` value. Returns "Unknown" if the
+ * provided card type is not valid.
  *
- * For example, `getCardDescription(card)` returns "Where journey begins".
+ * This function works for both vanilla and modded trinkets.
+ *
+ * For example, `getCardDescription(CardType.FOOL)` would return "Where journey begins".
  */
 export declare function getCardDescription(cardType: CardType): string;
 
@@ -8659,11 +8668,12 @@ export declare function isBossRoomOf(roomData: RoomConfig, bossID: BossID): bool
 export declare function isBossRushDoor(door: GridEntityDoor): boolean;
 
 /**
- * Returns true for cards that have the following card type:
- * - CardType.TAROT
- * - CardType.SUIT
- * - CardType.SPECIAL
- * - CardType.TAROT_REVERSE
+ * Returns true for card types that have the following item config card type:
+ *
+ * - `ItemConfigCardType.TAROT` (0)
+ * - `ItemConfigCardType.SUIT` (1)
+ * - `ItemConfigCardType.SPECIAL` (3)
+ * - `ItemConfigCardType.TAROT_REVERSE` (5)
  */
 export declare function isCard(cardType: CardType): boolean;
 
@@ -9277,7 +9287,7 @@ export declare function isMirrorRoom(roomData: RoomConfig): boolean;
  */
 export declare function isMissedTear(tear: EntityTear): boolean;
 
-/** Returns true for any card or rune added by a mod. */
+/** Returns true for any card type added by a mod. */
 export declare function isModdedCardType(cardType: CardType): boolean;
 
 export declare function isModdedCharacter(character: PlayerType): boolean;
@@ -9362,7 +9372,7 @@ export declare function isPlayer(variable: unknown): variable is EntityPlayer;
  */
 export declare function isPlayerAbleToAim(player: EntityPlayer): boolean;
 
-/** Returns true for cards that have `ItemConfigCardType.SPECIAL_OBJECT`. */
+/** Returns true for card types that have `ItemConfigCardType.SPECIAL_OBJECT`. */
 export declare function isPocketItemObject(cardType: CardType): boolean;
 
 /** Helper function to detect if a variable is of type `GridEntityPoop`. */
@@ -9468,7 +9478,7 @@ export declare function isRepentanceDoor(door: GridEntityDoor): boolean;
  */
 export declare function isRepentanceStage(stageType: StageType): boolean;
 
-/** Returns true for cards that have `ItemConfigCardType.TAROT_REVERSE`. */
+/** Returns true for card types that have `ItemConfigCardType.TAROT_REVERSE`. */
 export declare function isReverseTarotCard(cardType: CardType): boolean;
 
 /** Helper function to check if something is an instantiated `RNG` object. */
@@ -9516,7 +9526,7 @@ export declare function isRoomType(roomData: RoomConfig, ...roomTypes: RoomType[
  */
 export declare function isRoomVisible(roomGridIndexOrRoomDescriptor: int | RoomDescriptor, minimapAPI?: boolean): boolean;
 
-/** Returns true for cards that have `ItemConfigCardType.RUNE`. */
+/** Returns true for card types that have `ItemConfigCardType.RUNE`. */
 export declare function isRune(cardType: CardType): boolean;
 
 /** For `PickupVariant.SACK` (69). */
@@ -9625,7 +9635,7 @@ export declare function isSlot(entity: Entity): entity is EntitySlot;
 /** Returns true for the specific variants of `EntityType.SLOT` that are machines. */
 export declare function isSlotMachine(entity: Entity): boolean;
 
-/** Returns true for cards that have `ItemConfigCardType.SPECIAL`. */
+/** Returns true for card types that have `ItemConfigCardType.SPECIAL`. */
 export declare function isSpecialCard(cardType: CardType): boolean;
 
 /** Helper function to detect if a variable is of type `GridEntitySpikes`. */
@@ -9695,7 +9705,7 @@ export declare function isStoryBoss(entityType: EntityType): boolean;
 
 export declare function isString(variable: unknown): variable is string;
 
-/** Returns true for cards that have `ItemConfigCardType.SUIT`. */
+/** Returns true for card types that have `ItemConfigCardType.SUIT`. */
 export declare function isSuitCard(cardType: CardType): boolean;
 
 export declare function isTable(variable: unknown): variable is LuaMap<AnyNotNil, unknown>;
@@ -9709,7 +9719,7 @@ export declare function isTainted(player: EntityPlayer): boolean;
 /** Helper function for detecting when a player is Tainted Lazarus or Dead Tainted Lazarus. */
 export declare function isTaintedLazarus(player: EntityPlayer): boolean;
 
-/** Returns true for cards that have `ItemConfigCardType.TAROT`. */
+/** Returns true for card types that have `ItemConfigCardType.TAROT`. */
 export declare function isTarotCard(cardType: CardType): boolean;
 
 /** Helper function to detect if a variable is of type `EntityTear`. */
@@ -9793,7 +9803,6 @@ export declare function isValidCollectibleType(collectibleType: CollectibleType)
  */
 export declare function isValidGridPosition(gridPosition: Vector, roomShape: RoomShape): boolean;
 
-/** Returns true for any vanilla card or rune. */
 export declare function isVanillaCardType(cardType: CardType): boolean;
 
 export declare function isVanillaCharacter(character: PlayerType): boolean;
@@ -15169,8 +15178,8 @@ export declare function PriorityCallbackCustom<T extends ModCallbackCustom>(modC
 export declare type PublicInterface<T> = Pick<T, keyof T>;
 
 /**
- * An array representing every valid collectible type quality. Specifically, this is `[0, 1, 2, 3,
- * 4]`.
+ * An array representing every valid collectible type quality. Specifically, this is: `[0, 1, 2, 3,
+ * 4]`
  */
 export declare const QUALITIES: readonly Quality[];