isaacscript-common 6.6.1-dev.0 → 6.6.1-dev.4

package/dist/functions/boss.js

@@ -0,0 +1,137 @@
+import { EntityType, LokiVariant, } from "isaac-typescript-definitions";
+import { VectorZero } from "../constants";
+import { ALL_BOSSES_SET, STAGE_TO_COMBINED_BOSS_SET_MAP, STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP, } from "../sets/bossSets";
+import { SIN_ENTITY_TYPES_SET } from "../sets/sinEntityTypesSet";
+import { getNPCs, spawnNPC } from "./entitySpecific";
+import { getAliveNPCs } from "./npc";
+import { isRNG } from "./rng";
+import { copySet } from "./set";
+import { repeat } from "./utils";
+const BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS = new Set([
+    EntityType.LARRY_JR,
+    EntityType.CHUB,
+    EntityType.LOKI,
+    EntityType.GURGLING,
+    EntityType.TURDLET, // 918
+]);
+const DEFAULT_BOSS_MULTI_SEGMENTS = 4;
+/**
+ * Helper function to get all of the non-dead bosses in the room.
+ *
+ * This function will not include bosses on an internal blacklist, such as Death's scythes or Big
+ * Horn holes.
+ */
+export function getAliveBosses(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly = false) {
+    const aliveNPCs = getAliveNPCs(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly);
+    return aliveNPCs.filter((aliveNPC) => aliveNPC.IsBoss());
+}
+/**
+ * Helper function to get the set of every boss in the game.
+ *
+ * The set contains strings with the entity type and variant, separated by a period.
+ *
+ * Also see the `getBossSet` and `getCombinedBossSet` functions.
+ */
+export function getAllBossesSet() {
+    return copySet(ALL_BOSSES_SET);
+}
+/**
+ * Helper function to get the set of vanilla bosses for a particular stage and stage type
+ * combination.
+ *
+ * The set contains strings with the entity type and variant, separated by a period.
+ *
+ * Also see the `getAllBossesSet` and `getCombinedBossSet` functions.
+ */
+export function getBossSet(stage, stageType) {
+    const stageTypeMap = STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP.get(stage);
+    if (stageTypeMap === undefined) {
+        return undefined;
+    }
+    const bossSet = stageTypeMap.get(stageType);
+    if (bossSet === undefined) {
+        return undefined;
+    }
+    return copySet(bossSet);
+}
+/** Helper function to get all of the bosses in the room. */
+export function getBosses(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly = false) {
+    const npcs = getNPCs(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly);
+    return npcs.filter((npc) => npc.IsBoss());
+}
+/**
+ * Helper function to get the set of vanilla bosses for a particular stage across all of the stage
+ * types. For example, specifying a stage of 2 will return a set with all of the bosses for
+ * Basement, Cellar, Burning Basement, Downpour, and Dross.
+ *
+ * The set contains strings with the entity type and variant, separated by a period.
+ *
+ * Also see the `getAllBossesSet` and `getBossSet` functions.
+ */
+export function getCombinedBossSet(stage) {
+    const bossSet = STAGE_TO_COMBINED_BOSS_SET_MAP.get(stage);
+    if (bossSet === undefined) {
+        return undefined;
+    }
+    return copySet(bossSet);
+}
+/** Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust. */
+export function isSin(npc) {
+    return SIN_ENTITY_TYPES_SET.has(npc.Type);
+}
+/**
+ * Helper function to spawn a boss.
+ *
+ * Use this function instead of `spawnNPC` since it handles automatically spawning multiple segments
+ * for multi-segment bosses.
+ *
+ * By default, this will spawn Chub (and his variants) with 3 segments, Lokii with 2 copies,
+ * Gurglings/Turdlings with 2 copies, and other multi-segment bosses with 4 segments. You can
+ * customize this via the "numSegments" argument.
+ */
+export function spawnBoss(entityType, variant, subType, position, velocity = VectorZero, spawner = undefined, seedOrRNG = undefined, numSegments) {
+    const seed = isRNG(seedOrRNG) ? seedOrRNG.Next() : seedOrRNG;
+    const npc = spawnNPC(entityType, variant, subType, position, velocity, spawner, seed);
+    if (BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS.has(entityType)) {
+        const numBossSegments = getNumBossSegments(entityType, variant, numSegments);
+        const remainingSegmentsToSpawn = numBossSegments - 1;
+        repeat(remainingSegmentsToSpawn, () => {
+            spawnNPC(entityType, variant, subType, position, velocity, spawner, seed);
+        });
+    }
+    return npc;
+}
+function getNumBossSegments(entityType, variant, numSegments) {
+    if (numSegments !== undefined) {
+        return numSegments;
+    }
+    switch (entityType) {
+        // 28
+        case EntityType.CHUB: {
+            // Chub is always composed of 3 segments.
+            return 3;
+        }
+        // 69
+        case EntityType.LOKI: {
+            return variant === LokiVariant.LOKII ? 2 : 1;
+        }
+        // 237
+        case EntityType.GURGLING: {
+            // Gurglings & Turdlings are always encountered in groups of 2.
+            return 2;
+        }
+        default: {
+            return DEFAULT_BOSS_MULTI_SEGMENTS;
+        }
+    }
+}
+/**
+ * Helper function to spawn a boss with a specific seed.
+ *
+ * For more information, see the documentation for the `spawnBoss` function.
+ */
+export function spawnBossWithSeed(entityType, variant, subType, position, seedOrRNG, velocity = VectorZero, spawner = undefined, numSegments) {
+    const seed = isRNG(seedOrRNG) ? seedOrRNG.Next() : seedOrRNG;
+    return spawnBoss(entityType, variant, subType, position, velocity, spawner, seed, numSegments);
+}
+//# sourceMappingURL=boss.js.map

package/dist/functions/boss.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boss.js","sourceRoot":"../src/","sources":["functions/boss.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,WAAW,GAEZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EACL,cAAc,EACd,8BAA8B,EAC9B,mCAAmC,GACpC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,MAAM,mCAAmC,GAA4B,IAAI,GAAG,CAAC;IAC3E,UAAU,CAAC,QAAQ;IACnB,UAAU,CAAC,IAAI;IACf,UAAU,CAAC,IAAI;IACf,UAAU,CAAC,QAAQ;IACnB,UAAU,CAAC,OAAO,EAAE,MAAM;CAC3B,CAAC,CAAC;AAEH,MAAM,2BAA2B,GAAG,CAAC,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAC5B,kBAA+B,EAC/B,eAAqB,EACrB,eAAqB,EACrB,cAAc,GAAG,KAAK;IAEtB,MAAM,SAAS,GAAG,YAAY,CAC5B,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,CACf,CAAC;IACF,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,OAAO,CAAC,cAAc,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CACxB,KAAU,EACV,SAAoB;IAEpB,MAAM,YAAY,GAAG,mCAAmC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpE,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC5C,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;AAC1B,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,SAAS,CACvB,kBAA+B,EAC/B,eAAqB,EACrB,eAAqB,EACrB,cAAc,GAAG,KAAK;IAEtB,MAAM,IAAI,GAAG,OAAO,CAClB,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,CACf,CAAC;IACF,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAU;IAC3C,MAAM,OAAO,GAAG,8BAA8B,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC1D,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;AAC1B,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,KAAK,CAAC,GAAc;IAClC,OAAO,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CACvB,UAAsB,EACtB,OAAY,EACZ,OAAY,EACZ,QAAgB,EAChB,WAAmB,UAAU,EAC7B,UAA8B,SAAS,EACvC,YAAoC,SAAS,EAC7C,WAAiB;IAEjB,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,MAAM,GAAG,GAAG,QAAQ,CAClB,UAAU,EACV,OAAO,EACP,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,IAAI,CACL,CAAC;IAEF,IAAI,mCAAmC,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;QACvD,MAAM,eAAe,GAAG,kBAAkB,CACxC,UAAU,EACV,OAAO,EACP,WAAW,CACZ,CAAC;QACF,MAAM,wBAAwB,GAAG,eAAe,GAAG,CAAC,CAAC;QACrD,MAAM,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACpC,QAAQ,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;KACJ;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,kBAAkB,CACzB,UAAsB,EACtB,OAAY,EACZ,WAA4B;IAE5B,IAAI,WAAW,KAAK,SAAS,EAAE;QAC7B,OAAO,WAAW,CAAC;KACpB;IAED,QAAQ,UAAU,EAAE;QAClB,KAAK;QACL,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC;YACpB,yCAAyC;YACzC,OAAO,CAAC,CAAC;SACV;QAED,KAAK;QACL,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC;YACpB,OAAQ,OAAuB,KAAK,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/D;QAED,MAAM;QACN,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC;YACxB,+DAA+D;YAC/D,OAAO,CAAC,CAAC;SACV;QAED,OAAO,CAAC,CAAC;YACP,OAAO,2BAA2B,CAAC;SACpC;KACF;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,UAAsB,EACtB,OAAY,EACZ,OAAY,EACZ,QAAgB,EAChB,SAAqB,EACrB,WAAmB,UAAU,EAC7B,UAA8B,SAAS,EACvC,WAAiB;IAEjB,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,OAAO,SAAS,CACd,UAAU,EACV,OAAO,EACP,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,IAAI,EACJ,WAAW,CACZ,CAAC;AACJ,CAAC"}

package/dist/functions/boss.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/boss.ts"],"names":["repeat"],"mappings":";;;;;MA0KS,oBAhJH;AA1BN,6CAIO;AAHL;AACA;AAGF,sBAA2B;AAAlB;AACT,qBAIO;AAHL;AACA;AACA;AAEF,8BAAqC;AAA5B;AACT,2BAAkC;AAAzB;AAAS;AAClB,gBAA6B;AAApB;AACT,gBAAsB;AAAb;AACT,gBAAwB;AAAf;AACT,kBAAuB;AAAd,MAAAA;AA0JT,SAAS,yBACP,YACA,SACA;OAEI;AACF,eAAO;;;6BAGD;2CAED;;;AAEH,uBAAO;;;mDAIJ;;;AACH,uBAAO,WAA6B,sBAAoB,KAAI;;;mDAIzD;;;AAEH,uBAAO;;;;;AAIP,uBAAO;;;;;AApLP,4CAA+D,UAAI,KAAI;IAC3E;IACA;IACA;IACA;IACA;;AAGI,8BAA8B;;;;;AAQpC,0CACE,oBACA,iBACA,iBACA;OAAA;QAAA,iBAAiB;;AAEX,sBAAY;;QAChB;QACA;QACA;QACA;;AAEF,WAAO;QAAA;QAAiB,eAAC,UAAa,gBAAS,QAAvB;;AAZ1B;;;;;;AAsBA;AACE,WAAO,aAAQ;AADjB;;;;;;;AAYA,sCACE,OACA;AAEM,yBAAe,oCAAoC,IAAI;OACzD;AACF;;AAGI,oBAAU,aAAa,IAAI;OAC7B;AACF;;AAGF,WAAO,aAAQ;AAdjB;;AAkBA,qCACE,oBACA,iBACA,iBACA;OAAA;QAAA,iBAAiB;;AAEX,iBAAO;;QACX;QACA;QACA;QACA;;AAEF,WAAO;QAAA;QAAY,eAAC,KAAQ,WAAI,QAAb;;AAZrB;;;;;;;;AAwBA,8CAAmC;AAC3B,oBAAU,+BAA+B,IAAI;OAC/C;AACF;;AAGF,WAAO,aAAQ;AANjB;;AAUA,iCAAsB;AACpB,WAAO,qBAAqB,IAAI;AADlC;;;;;;;;;AAcA,qCACE,YACA,SACA,SACA,UACA,UACA,SACA,WACA;OAHA;QAAA,WAAmB;;OACnB;QAAA;;OACA;QAAA;;AAGM,iBAAO,WAAM,eAAa,UAAU,UAAS;AAC7C,gBAAM;;QACV;QACA;QACA;QACA;QACA;QACA;QACA;;OAGE,oCAAoC,IAAI;AACpC,gCAAkB,wBACtB,YACA,SACA;AAEI,yCAA2B,kBAAkB;QACnD,AAAAA;;YAAO;YAA0B;gBAC/B;;oBAAS;oBAAY;oBAAS;oBAAS;oBAAU;oBAAU;oBAAS;;YADrC;;;AAKnC,WAAO;AAjCT;;;;AA0EA,6CACE,YACA,SACA,SACA,UACA,WACA,UACA,SACA;OAFA;QAAA,WAAmB;;OACnB;QAAA;;AAGM,iBAAO,WAAM,eAAa,UAAU,UAAS;AACnD,WAAO;;QACL;QACA;QACA;QACA;QACA;QACA;QACA;QACA;;AAnBJ","file":"boss.lua","sourceRoot":"../src/"}

package/dist/functions/cacheFlag.js

@@ -0,0 +1,11 @@
+import { DEFAULT_PLAYER_STAT_MAP } from "../maps/defaultPlayerStatMap";
+/**
+ * Returns the starting stat that Isaac (the default character) starts with. For example, if you
+ * pass this function `CacheFlag.DAMAGE`, it will return 3.5.
+ *
+ * Note that the default fire delay is represented in the tear stat, not the `MaxFireDelay` value.
+ */
+export function getDefaultPlayerStat(cacheFlag) {
+    return DEFAULT_PLAYER_STAT_MAP.get(cacheFlag);
+}
+//# sourceMappingURL=cacheFlag.js.map

package/dist/functions/cacheFlag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cacheFlag.js","sourceRoot":"../src/","sources":["functions/cacheFlag.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,SAAoB;IACvD,OAAO,uBAAuB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAChD,CAAC"}

package/dist/functions/cacheFlag.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/cacheFlag.ts"],"names":[],"mappings":";AACA,iCAAwC;AAA/B;;;;;AAQT,gDAAqC;AACnC,WAAO,wBAAwB,IAAI;AADrC","file":"cacheFlag.lua","sourceRoot":"../src/"}

package/dist/functions/cards.js

@@ -0,0 +1,217 @@
+import { Card, ItemConfigCardType } from "isaac-typescript-definitions";
+import { itemConfig } from "../cachedClasses";
+import { FIRST_CARD, FIRST_MODDED_CARD, LAST_CARD, MAX_VANILLA_CARD, } from "../constantsFirstLast";
+import { CARD_DESCRIPTIONS, DEFAULT_CARD_DESCRIPTION, } from "../objects/cardDescriptions";
+import { CARD_NAMES, DEFAULT_CARD_NAME } from "../objects/cardNames";
+import { CARD_TYPES, DEFAULT_CARD_TYPE } from "../objects/cardTypes";
+import { getEnumValues } from "./enums";
+import { getRandomSeed } from "./rng";
+import { addSetsToSet, getRandomSetElement } from "./set";
+import { irange } from "./utils";
+const CARD_TYPE_TO_CARDS_MAP = new Map();
+/**
+ * Contains all of the entries in the `Card` enum with the following types:
+ * - ItemConfigCardType.TAROT
+ * - ItemConfigCardType.SUIT
+ * - ItemConfigCardType.SPECIAL
+ * - ItemConfigCardType.TAROT_REVERSE
+ */
+const CARD_SET = new Set();
+function initCardObjects() {
+    // The card type to cards map should be valid for every card type, so we initialize it with empty
+    // sets.
+    for (const cardType of getEnumValues(ItemConfigCardType)) {
+        CARD_TYPE_TO_CARDS_MAP.set(cardType, new Set());
+    }
+    for (const card of getAllCards()) {
+        const cardType = getCardType(card);
+        const cardTypeSet = CARD_TYPE_TO_CARDS_MAP.get(cardType);
+        if (cardTypeSet === undefined) {
+            error(`Failed to get the card set for card type: ${cardType}`);
+        }
+        cardTypeSet.add(card);
+    }
+    // i.e. everything except for:
+    // - ItemConfigCardType.RUNE
+    // - ItemConfigCardType.SPECIAL_OBJECT
+    // - ItemConfigCardType.MODDED
+    const cards = getCardsOfType(ItemConfigCardType.TAROT, ItemConfigCardType.SUIT, ItemConfigCardType.SPECIAL, ItemConfigCardType.TAROT_REVERSE);
+    addSetsToSet(CARD_SET, cards);
+}
+/** Helper function to get an array with every valid card sub-type. This includes modded cards. */
+export function getAllCards() {
+    return irange(FIRST_CARD, LAST_CARD);
+}
+/**
+ * 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"
+ * ```
+ */
+export function getCardDescription(card) {
+    // "ItemConfigCard.Description" is bugged with vanilla cards on patch v1.7.6, so we use a
+    // hard-coded map as a workaround.
+    const cardDescription = CARD_DESCRIPTIONS[card];
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (cardDescription !== undefined) {
+        return cardDescription;
+    }
+    const itemConfigCard = itemConfig.GetCard(card);
+    if (itemConfigCard !== undefined) {
+        return itemConfigCard.Description;
+    }
+    return DEFAULT_CARD_DESCRIPTION;
+}
+/**
+ * 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"
+ * ```
+ */
+export function getCardName(card) {
+    // "ItemConfigCard.Name" is bugged with vanilla cards on patch v1.7.6, so we use a hard-coded map
+    // as a workaround.
+    const cardName = CARD_NAMES[card];
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (cardName !== undefined) {
+        return cardName;
+    }
+    const itemConfigCard = itemConfig.GetCard(card);
+    if (itemConfigCard !== undefined) {
+        return itemConfigCard.Name;
+    }
+    return DEFAULT_CARD_NAME;
+}
+export function getCardType(card) {
+    const cardType = CARD_TYPES[card];
+    // Handle modded cards.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return cardType === undefined ? DEFAULT_CARD_TYPE : cardType;
+}
+/**
+ * Helper function to get a set of cards matching the type. Also see the `CardType` enum.
+ *
+ * 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 function getCardsOfType(...cardTypes) {
+    if (CARD_TYPE_TO_CARDS_MAP.size === 0) {
+        initCardObjects();
+    }
+    const matchingCards = new Set();
+    for (const cardType of cardTypes) {
+        const cardSet = CARD_TYPE_TO_CARDS_MAP.get(cardType);
+        if (cardSet === undefined) {
+            error(`Failed to get the cards for type: ${cardType}`);
+        }
+        for (const card of cardSet.values()) {
+            matchingCards.add(card);
+        }
+    }
+    return matchingCards;
+}
+/**
+ * Helper function to get an array with every modded card sub-type.
+ *
+ * Returns an empty array if there are no modded cards.
+ */
+export function getModdedCards() {
+    if (MAX_VANILLA_CARD === LAST_CARD) {
+        return [];
+    }
+    return irange(FIRST_MODDED_CARD, LAST_CARD);
+}
+/**
+ * Has an equal chance of returning any card (e.g. Fool, Reverse Fool, Wild Card, etc.).
+ *
+ * This will not return:
+ * - any runes
+ * - any objects like Dice Shard
+ * - any modded cards (since there is not a way to distinguish between modded cards and modded
+ *   runes/objects)
+ *
+ * @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 function getRandomCard(seedOrRNG = getRandomSeed(), exceptions = []) {
+    return getRandomSetElement(CARD_SET, seedOrRNG, exceptions);
+}
+/**
+ * @param cardType The 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 function getRandomCardOfType(cardType, seedOrRNG = getRandomSeed(), exceptions = []) {
+    const cardSet = getCardsOfType(cardType);
+    return getRandomSetElement(cardSet, seedOrRNG, exceptions);
+}
+/**
+ * Has an equal chance of returning any rune (e.g. Rune of Hagalaz, Blank Rune, Black Rune, Soul of
+ * Isaac, etc.). This will never return a Rune Shard.
+ *
+ * @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 runes to not select.
+ */
+export function getRandomRune(seedOrRNG = getRandomSeed(), exceptions = []) {
+    const runesSet = getCardsOfType(ItemConfigCardType.RUNE);
+    runesSet.delete(Card.RUNE_SHARD);
+    return getRandomSetElement(runesSet, seedOrRNG, exceptions);
+}
+/** Helper function to get an array with every valid vanilla card sub-type. */
+export function getVanillaCards() {
+    return irange(FIRST_CARD, MAX_VANILLA_CARD);
+}
+/**
+ * Returns true for cards that have the following card type:
+ * - CardType.TAROT
+ * - CardType.SUIT
+ * - CardType.SPECIAL
+ * - CardType.TAROT_REVERSE
+ */
+export function isCard(card) {
+    return CARD_SET.has(card);
+}
+/** Returns whether or not the given card matches the specified card type. */
+export function isCardType(card, cardType) {
+    return cardType === getCardType(card);
+}
+/** Returns true for cards that have `CardType.MODDED`. */
+export function isModdedCard(card) {
+    return isCardType(card, ItemConfigCardType.MODDED);
+}
+/** Returns true for cards that have `CardType.SPECIAL_OBJECT`. */
+export function isPocketItemObject(card) {
+    return isCardType(card, ItemConfigCardType.SPECIAL_OBJECT);
+}
+/** Returns true for cards that have `CardType.TAROT_REVERSE`. */
+export function isReverseTarotCard(card) {
+    return isCardType(card, ItemConfigCardType.TAROT_REVERSE);
+}
+/** Returns true for cards that have `CardType.RUNE`. */
+export function isRune(card) {
+    return isCardType(card, ItemConfigCardType.RUNE);
+}
+/** Returns true for cards that have `CardType.SPECIAL`. */
+export function isSpecialCard(card) {
+    return isCardType(card, ItemConfigCardType.SPECIAL);
+}
+/** Returns true for cards that have `CardType.SUIT`. */
+export function isSuitCard(card) {
+    return isCardType(card, ItemConfigCardType.SUIT);
+}
+/** Returns true for cards that have `CardType.TAROT`. */
+export function isTarotCard(card) {
+    return isCardType(card, ItemConfigCardType.TAROT);
+}
+//# sourceMappingURL=cards.js.map

package/dist/functions/cards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cards.js","sourceRoot":"../src/","sources":["functions/cards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,SAAS,EACT,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAiC,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAQ,CAAC;AAEjC,SAAS,eAAe;IACtB,iGAAiG;IACjG,QAAQ;IACR,KAAK,MAAM,QAAQ,IAAI,aAAa,CAAC,kBAAkB,CAAC,EAAE;QACxD,sBAAsB,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,GAAG,EAAQ,CAAC,CAAC;KACvD;IAED,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,EAAE;QAChC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,WAAW,GAAG,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzD,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,KAAK,CAAC,6CAA6C,QAAQ,EAAE,CAAC,CAAC;SAChE;QACD,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;KACvB;IAED,8BAA8B;IAC9B,4BAA4B;IAC5B,sCAAsC;IACtC,8BAA8B;IAC9B,MAAM,KAAK,GAAG,cAAc,CAC1B,kBAAkB,CAAC,KAAK,EACxB,kBAAkB,CAAC,IAAI,EACvB,kBAAkB,CAAC,OAAO,EAC1B,kBAAkB,CAAC,aAAa,CACjC,CAAC;IACF,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AAChC,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,WAAW;IACzB,OAAO,MAAM,CAAC,UAAU,EAAE,SAAS,CAAW,CAAC;AACjD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAU;IAC3C,yFAAyF;IACzF,kCAAkC;IAClC,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAChD,uEAAuE;IACvE,IAAI,eAAe,KAAK,SAAS,EAAE;QACjC,OAAO,eAAe,CAAC;KACxB;IAED,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,IAAI,cAAc,KAAK,SAAS,EAAE;QAChC,OAAO,cAAc,CAAC,WAAW,CAAC;KACnC;IAED,OAAO,wBAAwB,CAAC;AAClC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,WAAW,CAAC,IAAU;IACpC,iGAAiG;IACjG,mBAAmB;IACnB,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAClC,uEAAuE;IACvE,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,OAAO,QAAQ,CAAC;KACjB;IAED,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,IAAI,cAAc,KAAK,SAAS,EAAE;QAChC,OAAO,cAAc,CAAC,IAAI,CAAC;KAC5B;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAU;IACpC,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAClC,uBAAuB;IACvB,uEAAuE;IACvE,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC/D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,GAAG,SAA+B;IAC/D,IAAI,sBAAsB,CAAC,IAAI,KAAK,CAAC,EAAE;QACrC,eAAe,EAAE,CAAC;KACnB;IAED,MAAM,aAAa,GAAG,IAAI,GAAG,EAAQ,CAAC;IACtC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,MAAM,OAAO,GAAG,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrD,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,KAAK,CAAC,qCAAqC,QAAQ,EAAE,CAAC,CAAC;SACxD;QAED,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE;YACnC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACzB;KACF;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC5B,IAAI,gBAAgB,KAAK,SAAS,EAAE;QAClC,OAAO,EAAE,CAAC;KACX;IAED,OAAO,MAAM,CAAC,iBAAiB,EAAE,SAAS,CAAW,CAAC;AACxD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAC3B,YAAwB,aAAa,EAAE,EACvC,aAAqB,EAAE;IAEvB,OAAO,mBAAmB,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,QAA4B,EAC5B,YAAwB,aAAa,EAAE,EACvC,aAAqB,EAAE;IAEvB,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IACzC,OAAO,mBAAmB,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAC3B,YAAwB,aAAa,EAAE,EACvC,aAAqB,EAAE;IAEvB,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACzD,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACjC,OAAO,mBAAmB,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AAC9D,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,eAAe;IAC7B,OAAO,MAAM,CAAC,UAAU,EAAE,gBAAgB,CAAW,CAAC;AACxD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,IAAU;IAC/B,OAAO,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,UAAU,CAAC,IAAU,EAAE,QAA4B;IACjE,OAAO,QAAQ,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,YAAY,CAAC,IAAU;IACrC,OAAO,UAAU,CAAC,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;AACrD,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,kBAAkB,CAAC,IAAU;IAC3C,OAAO,UAAU,CAAC,IAAI,EAAE,kBAAkB,CAAC,cAAc,CAAC,CAAC;AAC7D,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,kBAAkB,CAAC,IAAU;IAC3C,OAAO,UAAU,CAAC,IAAI,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAC;AAC5D,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,MAAM,CAAC,IAAU;IAC/B,OAAO,UAAU,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,aAAa,CAAC,IAAU;IACtC,OAAO,UAAU,CAAC,IAAI,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;AACtD,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,OAAO,UAAU,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,WAAW,CAAC,IAAU;IACpC,OAAO,UAAU,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACpD,CAAC"}

package/dist/functions/cards.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/cards.ts"],"names":[],"mappings":";;;;;;MA8BS,iBAXH,wBASA;AA5BN,6CAAyC;AAAhC;AAAM;AACf,0BAA2B;AAAlB;AACT,+BAKO;AAJL;AACA;AACA;AACA;AAEF,6BAGO;AAFL;AACA;AAEF,sBAA8C;AAArC;AAAY;AACrB,sBAA8C;AAArC;AAAY;AACrB,kBAA8B;AAArB;AACT,gBAA8B;AAArB;AACT,gBAAkD;AAAzC;AAAc;AACvB,kBAAuB;AAAd;AAaT,SAAS;AAGP,cAAW,mBAAY,mBAAc;QACnC,uBAAuB;YAAI;YAAU,UAAI;;;AAG3C,cAAW,eAAQ;AACX,yBAAW,6BAAY;AACvB,4BAAc,uBAAuB,IAAI;WAC3C;YACF,MAAM,yDAA6C;;QAErD,YAAY,IAAI;;AAOZ,kBAAQ;;QACZ;QACA;QACA;QACA;;IAEF,kBAAa,UAAU;;;AAIzB;AACE,WAAO,YAAO,YAAY;AAD5B;AA0DA,uCAA4B;AACpB,qBAAW,WAAW;AAG5B,WAAO,oBAAyB,qBAAoB;AAJtD;;;;;AAaA;UAAkC;OAC5B,+BAAgC;QAClC;;AAGI,0BAAgB,UAAI;AAC1B,cAAW,mBAAY;AACf,wBAAU,uBAAuB,IAAI;WACvC;YACF,MAAM,iDAAqC;;AAG7C,kBAAW,QAAQ,uBAAQ;YACzB,cAAc,IAAI;;;AAItB,WAAO;AAjBT;AAhHM,yBAAyB,UAAI;AAS7B,WAAW,UAAI;;;;;;;;;AA8CrB,8CAAmC;AAG3B,4BAAkB,kBAAkB;OAEtC;AACF,eAAO;;AAGH,2BAAiB,WAAW,QAAQ;OACtC;AACF,eAAO;;AAGT,WAAO;AAdT;;;;;;;;;AA2BA,uCAA4B;AAGpB,qBAAW,WAAW;OAExB;AACF,eAAO;;AAGH,2BAAiB,WAAW,QAAQ;OACtC;AACF,eAAO;;AAGT,WAAO;AAdT;;;;AAuDA;OACM,oBAAqB;AACvB,eAAO;;AAGT,WAAO,YAAO,mBAAmB;AALnC;;;;;;;;;;;;AAqBA,yCACE,WACA;OADA;QAAA,YAAwB;;OACxB;QAAA,aAAqB;;AAErB,WAAO,yBAAoB,UAAU,WAAW;AAJlD;;;;;;AAaA,+CACE,UACA,WACA;OADA;QAAA,YAAwB;;OACxB;QAAA,aAAqB;;AAEf,oBAAU,gCAAe;AAC/B,WAAO,yBAAoB,SAAS,WAAW;AANjD;;;;;;;AAiBA,yCACE,WACA;OADA;QAAA,YAAwB;;OACxB;QAAA,aAAqB;;AAEf,qBAAW,gCAAe;IAChC,SAAS,OAAO;AAChB,WAAO,yBAAoB,UAAU,WAAW;AANlD;;AAUA;AACE,WAAO,YAAO,YAAY;AAD5B;;;;;;AAWA,kCAAuB;AACrB,WAAO,SAAS,IAAI;AADtB;;AAKA,sCAA2B,MAAY;AACrC,WAAO,YAAa,6BAAY;AADlC;;AAKA,wCAA6B;AAC3B,WAAO,4BAAW,MAAM;AAD1B;;AAKA,8CAAmC;AACjC,WAAO,4BAAW,MAAM;AAD1B;;AAKA,8CAAmC;AACjC,WAAO,4BAAW,MAAM;AAD1B;;AAKA,kCAAuB;AACrB,WAAO,4BAAW,MAAM;AAD1B;;AAKA,yCAA8B;AAC5B,WAAO,4BAAW,MAAM;AAD1B;;AAKA,sCAA2B;AACzB,WAAO,4BAAW,MAAM;AAD1B;;AAKA,uCAA4B;AAC1B,WAAO,4BAAW,MAAM;AAD1B","file":"cards.lua","sourceRoot":"../src/"}

package/dist/functions/challenges.js

@@ -0,0 +1,9 @@
+import { CHALLENGE_NAMES, DEFAULT_CHALLENGE_NAME, } from "../objects/challengeNames";
+/** Get the proper name for a `Challenge` enum. This will only work for vanilla challenges. */
+export function getChallengeName(challenge) {
+    const challengeName = CHALLENGE_NAMES[challenge];
+    // Handle modded challenges.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return challengeName === undefined ? DEFAULT_CHALLENGE_NAME : challengeName;
+}
+//# sourceMappingURL=challenges.js.map

package/dist/functions/challenges.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"challenges.js","sourceRoot":"../src/","sources":["functions/challenges.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EACf,sBAAsB,GACvB,MAAM,2BAA2B,CAAC;AAEnC,8FAA8F;AAC9F,MAAM,UAAU,gBAAgB,CAAC,SAAoB;IACnD,MAAM,aAAa,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IACjD,4BAA4B;IAC5B,uEAAuE;IACvE,OAAO,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,aAAa,CAAC;AAC9E,CAAC"}

package/dist/functions/challenges.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/challenges.ts"],"names":[],"mappings":";AACA,2BAGO;AAFL;AACA;;AAIF,4CAAiC;AACzB,0BAAgB,gBAAgB;AAGtC,WAAO,yBAA8B,0BAAyB;AAJhE","file":"challenges.lua","sourceRoot":"../src/"}

package/dist/functions/character.js

@@ -0,0 +1,102 @@
+import { PlayerType } from "isaac-typescript-definitions";
+import { LAST_VANILLA_CHARACTER } from "../constantsFirstLast";
+import { CHARACTER_NAMES } from "../objects/characterNames";
+import { CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET } from "../sets/charactersThatStartWithAnActiveItemSet";
+import { CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET } from "../sets/charactersWithBlackHeartFromEternalHeartSet";
+import { CHARACTERS_WITH_FREE_DEVIL_DEALS_SET } from "../sets/charactersWithFreeDevilDealsSet";
+import { CHARACTERS_WITH_NO_RED_HEARTS_SET } from "../sets/charactersWithNoRedHeartsSet";
+import { CHARACTERS_WITH_NO_SOUL_HEARTS_SET } from "../sets/charactersWithNoSoulHeartsSet";
+import { LOST_STYLE_CHARACTERS_SET } from "../sets/lostStyleCharactersSet";
+/**
+ * Helper function to determine if the given character can have red heart containers. Returns true
+ * for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
+ * though coin containers are not technically the same as red heart containers. Returns false for
+ * characters like Blue Baby. Returns false for The Lost and Tainted Lost.
+ */
+export function characterCanHaveRedHearts(character) {
+    return !CHARACTERS_WITH_NO_RED_HEARTS_SET.has(character);
+}
+/**
+ * Helper function to determine if the given character can have soul hearts. Returns true for
+ * characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
+ * false for The Lost and Tainted Lost.
+ */
+export function characterCanHaveSoulHearts(character) {
+    return !CHARACTERS_WITH_NO_SOUL_HEARTS_SET.has(character);
+}
+/**
+ * Helper function for determining whether the given character can take free Devil Deals. (e.g. The
+ * Lost, Tainted Lost, etc.)
+ */
+export function characterCanTakeFreeDevilDeals(character) {
+    return CHARACTERS_WITH_FREE_DEVIL_DEALS_SET.has(character);
+}
+/**
+ * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
+ * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
+ * Otherwise, returns false.
+ */
+export function characterGetsBlackHeartFromEternalHeart(character) {
+    return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET.has(character);
+}
+/**
+ * Helper function to determine if the specified character starts with an active item.
+ *
+ * For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
+ * is considered to starts with the D6, but this is not the case on a brand new save file).
+ */
+export function characterStartsWithActiveItem(character) {
+    return CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET.has(character);
+}
+/**
+ * - Most characters have a 56 frame death animation (i.e. the "Death" animation).
+ * - The Lost and Tainted Lost have a 38 frame death animation (i.e. the "LostDeath" animation).
+ * - Tainted Forgotten have a 20 frame death animation (i.e. the "ForgottenDeath" animation).
+ */
+export function getCharacterDeathAnimationName(character) {
+    if (LOST_STYLE_CHARACTERS_SET.has(character)) {
+        return "LostDeath";
+    }
+    if (character === PlayerType.THE_FORGOTTEN_B) {
+        return "ForgottenDeath";
+    }
+    return "Death";
+}
+/**
+ * Returns the maximum heart containers that the provided character can have. Normally, this is 12,
+ * but with Keeper it is 3, and with Tainted Keeper it is 2. This does not account for Birthright or
+ * Mother's Kiss; use the `getPlayerMaxHeartContainers` helper function for that.
+ */
+export function getCharacterMaxHeartContainers(character) {
+    // 14
+    if (character === PlayerType.KEEPER) {
+        return 3;
+    }
+    // 16
+    if (character === PlayerType.THE_FORGOTTEN) {
+        return 6;
+    }
+    // 17
+    if (character === PlayerType.THE_SOUL) {
+        return 6;
+    }
+    // 33
+    if (character === PlayerType.KEEPER_B) {
+        return 2;
+    }
+    return 12;
+}
+/** Helper function to get the name of a character. Returns "Unknown" for modded characters. */
+export function getCharacterName(character) {
+    if (isModdedCharacter(character)) {
+        return "Unknown";
+    }
+    return CHARACTER_NAMES[character];
+}
+export function isModdedCharacter(character) {
+    return !isVanillaCharacter(character);
+}
+export function isVanillaCharacter(character) {
+    return character <= LAST_VANILLA_CHARACTER;
+}
+//# sourceMappingURL=character.js.map

package/dist/functions/character.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"character.js","sourceRoot":"../src/","sources":["functions/character.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,6CAA6C,EAAE,MAAM,gDAAgD,CAAC;AAC/G,OAAO,EAAE,kDAAkD,EAAE,MAAM,qDAAqD,CAAC;AACzH,OAAO,EAAE,oCAAoC,EAAE,MAAM,yCAAyC,CAAC;AAC/F,OAAO,EAAE,iCAAiC,EAAE,MAAM,sCAAsC,CAAC;AACzF,OAAO,EAAE,kCAAkC,EAAE,MAAM,uCAAuC,CAAC;AAC3F,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,SAAqB;IAC7D,OAAO,CAAC,iCAAiC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,SAAqB;IAC9D,OAAO,CAAC,kCAAkC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAC5D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAAC,SAAqB;IAClE,OAAO,oCAAoC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAC7D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uCAAuC,CACrD,SAAqB;IAErB,OAAO,kDAAkD,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAC,SAAqB;IACjE,OAAO,6CAA6C,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AACtE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,SAAqB;IAClE,IAAI,yBAAyB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;QAC5C,OAAO,WAAW,CAAC;KACpB;IAED,IAAI,SAAS,KAAK,UAAU,CAAC,eAAe,EAAE;QAC5C,OAAO,gBAAgB,CAAC;KACzB;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,SAAqB;IAClE,KAAK;IACL,IAAI,SAAS,KAAK,UAAU,CAAC,MAAM,EAAE;QACnC,OAAO,CAAC,CAAC;KACV;IAED,KAAK;IACL,IAAI,SAAS,KAAK,UAAU,CAAC,aAAa,EAAE;QAC1C,OAAO,CAAC,CAAC;KACV;IAED,KAAK;IACL,IAAI,SAAS,KAAK,UAAU,CAAC,QAAQ,EAAE;QACrC,OAAO,CAAC,CAAC;KACV;IAED,KAAK;IACL,IAAI,SAAS,KAAK,UAAU,CAAC,QAAQ,EAAE;QACrC,OAAO,CAAC,CAAC;KACV;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,gBAAgB,CAAC,SAAqB;IACpD,IAAI,iBAAiB,CAAC,SAAS,CAAC,EAAE;QAChC,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,eAAe,CAAC,SAAS,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,SAAqB;IACrD,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,SAAqB;IACtD,OAAO,SAAS,IAAI,sBAAsB,CAAC;AAC7C,CAAC"}

package/dist/functions/character.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/character.ts"],"names":[],"mappings":";AAAA,6CAA2B;AAAlB;AACT,+BAAuC;AAA9B;AACT,2BAAgC;AAAvB;AACT,mDAA8D;AAArD;AACT,wDAAmE;AAA1D;AACT,4CAAqD;AAA5C;AACT,yCAAkD;AAAzC;AACT,0CAAmD;AAA1C;AACT,mCAA0C;AAAjC;AAyGT,6CAAkC;AAChC,eAAQ,oCAAmB;AAD7B;AAIA,8CAAmC;AACjC,WAAO,aAAa;AADtB;;;;;AArGA,qDAA0C;AACxC,eAAQ,kCAAkC,IAAI;AADhD;;;;AASA,sDAA2C;AACzC,eAAQ,mCAAmC,IAAI;AADjD;;;AAQA,0DAA+C;AAC7C,WAAO,qCAAqC,IAAI;AADlD;;;;AASA,mEACE;AAEA,WAAO,mDAAmD,IAAI;AAHhE;;;;;AAYA,yDAA8C;AAC5C,WAAO,8CAA8C,IAAI;AAD3D;;;;AASA,0DAA+C;OACzC,0BAA0B,IAAI;AAChC,eAAO;;OAGL,aAAc;AAChB,eAAO;;AAGT,WAAO;AATT;;;;AAiBA,0DAA+C;OAEzC,aAAc;AAChB,eAAO;;OAIL,aAAc;AAChB,eAAO;;OAIL,aAAc;AAChB,eAAO;;OAIL,aAAc;AAChB,eAAO;;AAGT,WAAO;AArBT;;AAyBA,4CAAiC;OAC3B,mCAAkB;AACpB,eAAO;;AAGT,WAAO,gBAAgB;AALzB","file":"character.lua","sourceRoot":"../src/"}