isaacscript-common 8.9.0 → 9.0.1

package/dist/index.d.ts

@@ -10,7 +10,7 @@ import { BombVariant } from 'isaac-typescript-definitions';
 import { BossID } from 'isaac-typescript-definitions';
 import { ButtonAction } from 'isaac-typescript-definitions';
 import { CacheFlag } from 'isaac-typescript-definitions';
-import { Card } from 'isaac-typescript-definitions';
+import { CardType } from 'isaac-typescript-definitions';
 import { Challenge } from 'isaac-typescript-definitions';
 import { CoinSubType } from 'isaac-typescript-definitions';
 import { CollectiblePedestalType } from 'isaac-typescript-definitions';
@@ -454,12 +454,12 @@ export declare function arrayToBitFlags<T extends BitFlag | BitFlag128>(array: T
 export declare function arrayToString<T>(array: T[] | readonly T[]): string;
 
 /**
- * Helper function to safely cast a `number` to a `Card`. (This is better than using the `as`
+ * Helper function to safely cast a `number` to a `CardType`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
  * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
  */
-export declare function asCard(num: number): Card;
+export declare function asCardType(num: number): CardType;
 
 /**
  * Helper function to safely cast a `number` to a `CollectibleType`. (This is better than using the
@@ -605,7 +605,7 @@ export declare function canRunUnlockAchievements(): boolean;
 export declare function capitalizeFirstLetter(string: string): string;
 
 /** Maps card names to card sub-types. */
-export declare const CARD_MAP: ReadonlyMap<string, Card>;
+export declare const CARD_MAP: ReadonlyMap<string, CardType>;
 
 /**
  * Helper function for quickly switching to a new room without playing a particular animation. Use
@@ -2120,7 +2120,7 @@ export declare function fireProjectiles(npc: EntityNPC | undefined, position: Ve
 export declare function fireProjectilesInCircle(npc: EntityNPC | undefined, position: Vector, speed: float, numProjectiles: int): EntityProjectile[];
 
 /** Equal to `Card.FOOL`. */
-export declare const FIRST_CARD = Card.FOOL;
+export declare const FIRST_CARD_TYPE = CardType.FOOL;
 
 /** Equal to `PlayerType.ISAAC`. */
 export declare const FIRST_CHARACTER = PlayerType.ISAAC;
@@ -2309,7 +2309,7 @@ export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlyS
  * This function can only be called if at least one callback has been executed. This is because not
  * all cards will necessarily be present when a mod first loads (due to mod load order).
  */
-export declare function getAllCards(): Card[];
+export declare function getAllCardTypes(): CardType[];
 
 /**
  * Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
@@ -2468,44 +2468,32 @@ export declare function getBossSet(stage: int, stageType: StageType): ReadonlySe
 /**
  * Helper function to get a card description from a Card enum value.
  *
- * For example:
- *
- * ```ts
- * const card = Card.FOOL;
- * const cardDescription = getCardDescription(card); // cardDescription is "Where journey begins"
- * ```
+ * For example, `getCardDescription(card)` returns "Where journey begins".
  */
-export declare function getCardDescription(card: Card): string;
+export declare function getCardDescription(cardType: CardType): string;
 
 /**
  * Helper function to get a card name from a Card.
  *
- * For example:
- *
- * ```ts
- * const card = Card.FOOL;
- * const cardName = getCardName(card); // cardName is "0 - The Fool"
- * ```
+ * For example, `getCardName(Card.FOOL)` would return "0 - The Fool".
  */
-export declare function getCardName(card: Card): string;
+export declare function getCardName(cardType: CardType): string;
 
 /**
  * Helper function to get all of the card entities in the room.
  *
- * @param card Optional. If specified, will only get the cards that match the sub-type. Default is
- *             -1, which matches every sub-type.
+ * @param cardType Optional. If specified, will only get the cards that match the sub-type. Default
+ *                 is -1, which matches every sub-type.
  */
-export declare function getCards(card?: Card): EntityPickupCard[];
+export declare function getCards(cardType?: CardType): EntityPickupCard[];
 
 /**
- * Helper function to get a set of cards matching the type. Also see the `CardType` enum.
+ * Helper function to get a set of card types matching the `ItemConfigCardType`.
  *
  * This function is variadic, meaning that you can you can specify N card types to get a set
  * containing cards that match any of the specified types.
  */
-export declare function getCardsOfType(...cardTypes: ItemConfigCardType[]): Set<Card>;
-
-export declare function getCardType(card: Card): ItemConfigCardType;
+export declare function getCardTypesOfType(...itemConfigCardTypes: ItemConfigCardType[]): Set<CardType>;
 
 /** Get the proper name for a `Challenge` enum. This will only work for vanilla challenges. */
 export declare function getChallengeName(challenge: Challenge): string;
@@ -2698,12 +2686,7 @@ export declare function getCollectibleMaxCharges(collectibleType: CollectibleTyp
  * 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"
- * ```
+ * For example, `getCollectibleName(CollectibleType.SAD_ONION)` would return "Sad Onion".
  */
 export declare function getCollectibleName(collectibleType: CollectibleType): string;
 
@@ -3135,7 +3118,7 @@ export declare function getFirstCardOrPill(player: EntityPlayer): PocketItemDesc
  * This function can only be called if at least one callback has been executed. This is because not
  * all cards will necessarily be present when a mod first loads (due to mod load order).
  */
-export declare function getFirstModdedCard(): Card | undefined;
+export declare function getFirstModdedCardType(): CardType | undefined;
 
 /**
  * Returns the first modded collectible type, or undefined if there are no modded collectibles.
@@ -3327,6 +3310,8 @@ export declare function getHUDOffsetVector(): Vector;
  */
 export declare function getIsaacAPIClassName(object: unknown): string | undefined;
 
+export declare function getItemConfigCardType(cardType: CardType): ItemConfigCardType;
+
 /**
  * Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
  * given JSON room.
@@ -3417,7 +3402,7 @@ export declare function getLasers(laserVariant?: LaserVariant, subType?: number)
  * This function can only be called if at least one callback has been executed. This is because not
  * all cards will necessarily be present when a mod first loads (due to mod load order).
  */
-export declare function getLastCard(): Card;
+export declare function getLastCardType(): CardType;
 
 /**
  * Will change depending on how many modded collectibles there are.
@@ -3470,7 +3455,7 @@ export declare function getLastFrameOfAnimation(sprite: Sprite, animation?: stri
 export declare function getLastPillEffect(): PillEffect;
 
 /**
- * Will change depending on how many modded cards there are.
+ * Will change depending on how many modded trinkets there are.
  *
  * This is equal to the number of trinket types, since all trinket types are contiguous (unlike
  * collectibles).
@@ -3525,7 +3510,7 @@ export declare function getMatchingGridEntities(gridEntityType: GridEntityType,
  * This function can only be called if at least one callback has been executed. This is because not
  * all cards will necessarily be present when a mod first loads (due to mod load order).
  */
-export declare function getModdedCards(): Card[];
+export declare function getModdedCardTypes(): CardType[];
 
 /**
  * Returns an array containing every modded collectible type in the game.
@@ -3724,7 +3709,7 @@ export declare function getNumBitsOfN(n: int): int;
  * This function can only be called if at least one callback has been executed. This is because not
  * all cards will necessarily be present when a mod first loads (due to mod load order).
  */
-export declare function getNumCards(): int;
+export declare function getNumCardTypes(): int;
 
 /**
  * This function can only be called if at least one callback has been executed. This is because not
@@ -3736,7 +3721,7 @@ export declare function getNumCollectibleTypes(): int;
  * This function can only be called if at least one callback has been executed. This is because not
  * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
-export declare function getNumModdedCards(): int;
+export declare function getNumModdedCardTypes(): int;
 
 /**
  * Unlike vanilla collectible types, modded collectible types are always contiguous.
@@ -3776,7 +3761,7 @@ export declare function getNumPillEffects(): int;
 export declare function getNumRooms(): int;
 
 /**
- * Will change depending on how many modded cards there are.
+ * Will change depending on how many modded trinkets there are.
  *
  * Equal to `itemConfig.GetTrinkets().Size - 1`. (We subtract one to account for
  * `TrinketType.NULL`.)
@@ -3882,12 +3867,7 @@ export declare function getPillEffectClass(pillEffect: PillEffect): ItemConfigPi
 /**
  * Helper function to get a pill effect name from a PillEffect enum value.
  *
- * For example:
- *
- * ```ts
- * const pillEffect = PillEffect.BAD_GAS;
- * const pillEffectName = getPillEffectName(pillEffect); // trinketName is "Bad Gas"
- * ```
+ * For example, `getPillEffectName(PillEffect.BAD_GAS)` would return "Bad Gas".
  */
 export declare function getPillEffectName(pillEffect: PillEffect): string;
 
@@ -3946,18 +3926,22 @@ export declare function getPlayerCloserThan(position: Vector, distance: float):
  * collectible type(s) provided.
  *
  * This function is variadic, meaning that you can specify N collectible types.
+ *
+ * Note that this will filter out non-real collectibles like Lilith's Incubus.
  */
 export declare function getPlayerCollectibleCount(player: EntityPlayer, ...collectibleTypes: CollectibleType[]): int;
 
 /**
  * Iterates over every item in the game and returns a map containing the number of each item that
  * the player has.
+ *
+ * Note that this will filter out non-real collectibles like Lilith's Incubus.
  */
 export declare function getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType, int>;
 
 /**
  * Returns an array containing every collectible type that the player has that matches the provided
- * CacheFlag.
+ * `CacheFlag`.
  *
  * For example, if the cache flag is `CacheFlag.FLYING`, and the player has one Lord of the Pit and
  * two Dead Doves, then this function would return:
@@ -3970,6 +3954,9 @@ export declare function getPlayerCollectibleMap(player: EntityPlayer): Map<Colle
  * ]
  * ```
  *
+ * Note that this array will not include collectibles that the player does not really have, like
+ * Lilith's Incubus.
+ *
  * This function can only be called if at least one callback has been executed. This is because not
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
@@ -4287,15 +4274,16 @@ export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seedOr
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param exceptions Optional. An array of cards to not select.
  */
-export declare function getRandomCard(seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
+export declare function getRandomCard(seedOrRNG?: Seed | RNG, exceptions?: CardType[]): CardType;
 
 /**
- * @param cardType The card type that represents the pool of cards to select from.
+ * @param itemConfigCardType The item config card type that represents the pool of cards to select
+ *                           from.
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param exceptions Optional. An array of cards to not select.
  */
-export declare function getRandomCardOfType(cardType: ItemConfigCardType, seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
+export declare function getRandomCardTypeOfType(itemConfigCardType: ItemConfigCardType, seedOrRNG?: Seed | RNG, exceptions?: CardType[]): CardType;
 
 /**
  * Helper function to get a random color.
@@ -4389,7 +4377,7 @@ export declare function getRandomKColor(seedOrRNG?: Seed | RNG, alpha?: number):
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param exceptions Optional. An array of runes to not select.
  */
-export declare function getRandomRune(seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
+export declare function getRandomRune(seedOrRNG?: Seed | RNG, exceptions?: CardType[]): CardType;
 
 /**
  * Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
@@ -5002,6 +4990,8 @@ export declare function getTotalCharge(player: EntityPlayer, activeSlot: ActiveS
 /**
  * Returns the total number of collectibles amongst all players. For example, if player 1 has 1 Sad
  * Onion and player 2 has 2 Sad Onions, then this function would return 3.
+ *
+ * Note that this will filter out non-real collectibles like Lilith's Incubus.
  */
 export declare function getTotalPlayerCollectibles(collectibleType: CollectibleType): int;
 
@@ -5070,12 +5060,7 @@ export declare function getTrinketGfxFilename(trinketType: TrinketType): string;
  * Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
  * not valid.
  *
- * For example:
- *
- * ```ts
- * const trinketType = TrinketType.SWALLOWED_PENNY;
- * const trinketName = getTrinketName(trinketType); // trinketName is "Swallowed Penny"
- * ```
+ * For example, `getTrinketName(TrinketType.SWALLOWED_PENNY)` would return "Swallowed Penny".
  */
 export declare function getTrinketName(trinketType: TrinketType): string;
 
@@ -5130,7 +5115,7 @@ export declare function getTSTLClassName(object: unknown): string | undefined;
 export declare function getUnusedDoorSlots(): DoorSlot[];
 
 /** Helper function to get an array with every valid vanilla card sub-type. */
-export declare function getVanillaCards(): Card[];
+export declare function getVanillaCardTypes(): CardType[];
 
 /**
  * Returns an array containing every valid vanilla collectible type in the game.
@@ -5604,13 +5589,13 @@ export declare function isBoolean(variable: unknown): variable is boolean;
  * - CardType.SPECIAL
  * - CardType.TAROT_REVERSE
  */
-export declare function isCard(card: Card): boolean;
+export declare function isCard(cardType: CardType): boolean;
 
 /** For `PickupVariant.TAROT_CARD` (300) */
 export declare function isCardPickup(pickup: EntityPickup): pickup is EntityPickupCard;
 
-/** Returns whether or not the given card matches the specified card type. */
-export declare function isCardType(card: Card, cardType: ItemConfigCardType): boolean;
+/** Returns whether or not the given card type matches the specified item config card type. */
+export declare function isCardType(cardType: CardType, itemConfigCardType: ItemConfigCardType): boolean;
 
 /**
  * Helper function to check if a player is a specific character (i.e. `PlayerType`).
@@ -5941,7 +5926,7 @@ export declare function isLRoom(roomShape: RoomShape): boolean;
 export declare function isLuaDebugEnabled(): boolean;
 
 /** Returns true for any card or rune added by a mod. */
-export declare function isModdedCard(card: Card): boolean;
+export declare function isModdedCardType(cardType: CardType): boolean;
 
 export declare function isModdedCharacter(character: PlayerType): boolean;
 
@@ -6008,8 +5993,8 @@ export declare function isPlayer(variable: unknown): variable is EntityPlayer;
  */
 export declare function isPlayerUsingPony(player: EntityPlayer): boolean;
 
-/** Returns true for cards that have `CardType.SPECIAL_OBJECT`. */
-export declare function isPocketItemObject(card: Card): boolean;
+/** Returns true for cards that have `ItemConfigCardType.SPECIAL_OBJECT`. */
+export declare function isPocketItemObject(cardType: CardType): boolean;
 
 /** Helper function to detect if a variable is of type `GridEntityPoop`. */
 export declare function isPoop(variable: unknown): variable is GridEntityPoop;
@@ -6066,8 +6051,8 @@ export declare function isRepentanceDoor(door: GridEntityDoor): boolean;
 
 export declare function isRepentanceStage(stageType: StageType): boolean;
 
-/** Returns true for cards that have `CardType.TAROT_REVERSE`. */
-export declare function isReverseTarotCard(card: Card): boolean;
+/** Returns true for cards that have `ItemConfigCardType.TAROT_REVERSE`. */
+export declare function isReverseTarotCard(cardType: CardType): boolean;
 
 /** Helper function to check if something is an instantiated `RNG` object. */
 export declare function isRNG(object: unknown): object is RNG;
@@ -6093,7 +6078,7 @@ export declare function isRoomInsideGrid(roomGridIndex?: int): boolean;
 export declare function isRoomShapeDoubleCharge(roomShape: RoomShape): boolean;
 
 /** Returns true for cards that have `CardType.RUNE`. */
-export declare function isRune(card: Card): boolean;
+export declare function isRune(cardType: CardType): boolean;
 
 /** For `PickupVariant.SACK` (69) */
 export declare function isSack(pickup: EntityPickup): pickup is EntityPickupSack;
@@ -6170,7 +6155,7 @@ export declare function isSingleUseCollectible(collectibleType: CollectibleType)
 export declare function isSlot(entity: Entity): entity is EntitySlot;
 
 /** Returns true for cards that have `CardType.SPECIAL`. */
-export declare function isSpecialCard(card: Card): boolean;
+export declare function isSpecialCard(cardType: CardType): boolean;
 
 /** Helper function to detect if a variable is of type `GridEntitySpikes`. */
 export declare function isSpikes(variable: unknown): variable is GridEntitySpikes;
@@ -6185,7 +6170,7 @@ export declare function isStoryBoss(entityType: EntityType): boolean;
 export declare function isString(variable: unknown): variable is string;
 
 /** Returns true for cards that have `CardType.SUIT`. */
-export declare function isSuitCard(card: Card): boolean;
+export declare function isSuitCard(cardType: CardType): boolean;
 
 export declare function isTable(variable: unknown): variable is LuaMap<AnyNotNil, unknown>;
 
@@ -6196,7 +6181,7 @@ export declare function isTainted(player: EntityPlayer): boolean;
 export declare function isTaintedLazarus(player: EntityPlayer): boolean;
 
 /** Returns true for cards that have `CardType.TAROT`. */
-export declare function isTarotCard(card: Card): boolean;
+export declare function isTarotCard(cardType: CardType): boolean;
 
 /** Helper function to detect if a variable is of type `EntityTear`. */
 export declare function isTear(variable: unknown): variable is EntityTear;
@@ -6240,7 +6225,7 @@ 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 isVanillaCard(card: Card): boolean;
+export declare function isVanillaCardType(cardType: CardType): boolean;
 
 export declare function isVanillaCharacter(character: PlayerType): boolean;
 
@@ -6440,7 +6425,7 @@ export declare const LAST_ROOM_TYPE: RoomType;
 export declare const LAST_STAGE: LevelStage;
 
 /** Calculated from the `Card` enum. */
-export declare const LAST_VANILLA_CARD: Card;
+export declare const LAST_VANILLA_CARD_TYPE: CardType;
 
 /** Calculated from the `PlayerType` enum. */
 export declare const LAST_VANILLA_CHARACTER: PlayerType;
@@ -8231,7 +8216,7 @@ export declare const NUM_NORMAL_PILL_COLORS: number;
 export declare const NUM_PILLS_IN_POOL: number;
 
 /** Calculated from the `Card` enum. `Card.NULL` is not included. */
-export declare const NUM_VANILLA_CARDS: number;
+export declare const NUM_VANILLA_CARD_TYPES: number;
 
 /** Calculated from the `CollectibleType` enum. (`CollectibleType.NULL` is not included.) */
 export declare const NUM_VANILLA_COLLECTIBLE_TYPES: number;
@@ -9082,12 +9067,12 @@ export declare function removeAllBombs(bombVariant?: BombVariant, subType?: numb
 /**
  * Helper function to remove all of the cards in the room.
  *
- * @param card Optional. If specified, will only remove cards that match this sub-type. Default is
- *             -1, which matches every sub-type.
+ * @param cardType Optional. If specified, will only remove cards that match this sub-type. Default
+ *                 is -1, which matches every sub-type.
  * @param cap Optional. If specified, will only remove the given amount of cards.
  * @returns The cards that were removed.
  */
-export declare function removeAllCards(card?: Card, cap?: int): EntityPickupCard[];
+export declare function removeAllCards(cardType?: CardType, cap?: int): EntityPickupCard[];
 
 export declare function removeAllCharacters(string: string, character: string): string;
 
@@ -10764,13 +10749,13 @@ export declare function spawnBossWithSeed(entityType: EntityType, variant: int,
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300).
  */
-export declare function spawnCard(card: Card, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupCard;
+export declare function spawnCard(cardType: CardType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupCard;
 
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300)
  * and a specific seed.
  */
-export declare function spawnCardWithSeed(card: Card, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupCard;
+export declare function spawnCardWithSeed(cardType: CardType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupCard;
 
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20). */
 export declare function spawnCoin(coinSubType: CoinSubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupCoin;

package/dist/maps/cardMap.d.ts

@@ -1,4 +1,4 @@
-import { Card } from "isaac-typescript-definitions";
+import { CardType } from "isaac-typescript-definitions";
 /** Maps card names to card sub-types. */
-export declare const CARD_MAP: ReadonlyMap<string, Card>;
+export declare const CARD_MAP: ReadonlyMap<string, CardType>;
 //# sourceMappingURL=cardMap.d.ts.map

package/dist/maps/cardMap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cardMap.d.ts","sourceRoot":"","sources":["../../src/maps/cardMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AAIpD,yCAAyC;AACzC,eAAO,MAAM,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,IAAI,CA2M7C,CAAC"}
+{"version":3,"file":"cardMap.d.ts","sourceRoot":"","sources":["../../src/maps/cardMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAIxD,yCAAyC;AACzC,eAAO,MAAM,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,QAAQ,CA2MjD,CAAC"}