isaacscript-common 2.3.0 → 2.3.1

package/functions/boss.d.ts

@@ -0,0 +1,56 @@
+import { EntityType, StageType } from "isaac-typescript-definitions";
+/**
+ * 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 declare function getAliveBosses(matchingEntityType?: EntityType, matchingVariant?: int, matchingSubType?: int, ignoreFriendly?: boolean): EntityNPC[];
+/**
+ * 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 declare function getAllBossesSet(): Set<string>;
+/**
+ * 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 declare function getBossSet(stage: int, stageType: StageType): ReadonlySet<string> | undefined;
+/** Helper function to get all of the bosses in the room. */
+export declare function getBosses(matchingEntityType?: EntityType, matchingVariant?: int, matchingSubType?: int, ignoreFriendly?: boolean): EntityNPC[];
+/**
+ * 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 declare function getCombinedBossSet(stage: int): Set<string> | undefined;
+/** Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust. */
+export declare function isSin(npc: EntityNPC): boolean;
+/**
+ * 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 declare function spawnBoss(entityType: EntityType, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined, numSegments?: int): EntityNPC;
+/**
+ * Helper function to spawn a boss with a specific seed.
+ *
+ * For more information, see the documentation for the `spawnBoss` function.
+ */
+export declare function spawnBossWithSeed(entityType: EntityType, variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined, numSegments?: int): EntityNPC;

package/functions/boss.lua

@@ -0,0 +1,183 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local getNumBossSegments, DEFAULT_BOSS_MULTI_SEGMENTS
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local LokiVariant = ____isaac_2Dtypescript_2Ddefinitions.LokiVariant
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
+local ____bossSets = require("sets.bossSets")
+local ALL_BOSSES_SET = ____bossSets.ALL_BOSSES_SET
+local STAGE_TO_COMBINED_BOSS_SET_MAP = ____bossSets.STAGE_TO_COMBINED_BOSS_SET_MAP
+local STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP = ____bossSets.STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP
+local ____sinEntityTypesSet = require("sets.sinEntityTypesSet")
+local SIN_ENTITY_TYPES_SET = ____sinEntityTypesSet.SIN_ENTITY_TYPES_SET
+local ____entitySpecific = require("functions.entitySpecific")
+local getNPCs = ____entitySpecific.getNPCs
+local spawnNPC = ____entitySpecific.spawnNPC
+local ____npc = require("functions.npc")
+local getAliveNPCs = ____npc.getAliveNPCs
+local ____set = require("functions.set")
+local copySet = ____set.copySet
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
+function getNumBossSegments(self, entityType, variant, numSegments)
+    if numSegments ~= nil then
+        return numSegments
+    end
+    repeat
+        local ____switch18 = entityType
+        local ____cond18 = ____switch18 == EntityType.CHUB
+        if ____cond18 then
+            do
+                return 3
+            end
+        end
+        ____cond18 = ____cond18 or ____switch18 == EntityType.LOKI
+        if ____cond18 then
+            do
+                return variant == LokiVariant.LOKII and 2 or 1
+            end
+        end
+        ____cond18 = ____cond18 or ____switch18 == EntityType.GURGLING
+        if ____cond18 then
+            do
+                return 2
+            end
+        end
+        do
+            do
+                return DEFAULT_BOSS_MULTI_SEGMENTS
+            end
+        end
+    until true
+end
+local BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS = __TS__New(Set, {
+    EntityType.LARRY_JR,
+    EntityType.CHUB,
+    EntityType.LOKI,
+    EntityType.GURGLING,
+    EntityType.TURDLET
+})
+DEFAULT_BOSS_MULTI_SEGMENTS = 4
+function ____exports.getAliveBosses(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
+    if ignoreFriendly == nil then
+        ignoreFriendly = false
+    end
+    local aliveNPCs = getAliveNPCs(
+        nil,
+        matchingEntityType,
+        matchingVariant,
+        matchingSubType,
+        ignoreFriendly
+    )
+    return __TS__ArrayFilter(
+        aliveNPCs,
+        function(____, aliveNPC) return aliveNPC:IsBoss() end
+    )
+end
+function ____exports.getAllBossesSet(self)
+    return copySet(nil, ALL_BOSSES_SET)
+end
+function ____exports.getBossSet(self, stage, stageType)
+    local stageTypeMap = STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP:get(stage)
+    if stageTypeMap == nil then
+        return nil
+    end
+    local bossSet = stageTypeMap:get(stageType)
+    if bossSet == nil then
+        return nil
+    end
+    return copySet(nil, bossSet)
+end
+function ____exports.getBosses(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
+    if ignoreFriendly == nil then
+        ignoreFriendly = false
+    end
+    local npcs = getNPCs(
+        nil,
+        matchingEntityType,
+        matchingVariant,
+        matchingSubType,
+        ignoreFriendly
+    )
+    return __TS__ArrayFilter(
+        npcs,
+        function(____, npc) return npc:IsBoss() end
+    )
+end
+function ____exports.getCombinedBossSet(self, stage)
+    local bossSet = STAGE_TO_COMBINED_BOSS_SET_MAP:get(stage)
+    if bossSet == nil then
+        return nil
+    end
+    return copySet(nil, bossSet)
+end
+function ____exports.isSin(self, npc)
+    return SIN_ENTITY_TYPES_SET:has(npc.Type)
+end
+function ____exports.spawnBoss(self, entityType, variant, subType, position, velocity, spawner, seed, numSegments)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    local npc = spawnNPC(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    if BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS:has(entityType) then
+        local numBossSegments = getNumBossSegments(nil, entityType, variant, numSegments)
+        local remainingSegmentsToSpawn = numBossSegments - 1
+        ____repeat(
+            nil,
+            remainingSegmentsToSpawn,
+            function()
+                spawnNPC(
+                    nil,
+                    entityType,
+                    variant,
+                    subType,
+                    position,
+                    velocity,
+                    spawner,
+                    seed
+                )
+            end
+        )
+    end
+    return npc
+end
+function ____exports.spawnBossWithSeed(self, entityType, variant, subType, position, seed, velocity, spawner, numSegments)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnBoss(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed,
+        numSegments
+    )
+end
+return ____exports

package/functions/cacheFlag.d.ts

@@ -0,0 +1,8 @@
+import { CacheFlag } from "isaac-typescript-definitions";
+/**
+ * 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 declare function getDefaultPlayerStat(cacheFlag: CacheFlag): number | undefined;

package/functions/cacheFlag.lua

@@ -0,0 +1,7 @@
+local ____exports = {}
+local ____defaultPlayerStatMap = require("maps.defaultPlayerStatMap")
+local DEFAULT_PLAYER_STAT_MAP = ____defaultPlayerStatMap.DEFAULT_PLAYER_STAT_MAP
+function ____exports.getDefaultPlayerStat(self, cacheFlag)
+    return DEFAULT_PLAYER_STAT_MAP:get(cacheFlag)
+end
+return ____exports

package/functions/cards.d.ts

@@ -0,0 +1,95 @@
+import { Card, ItemConfigCardType } from "isaac-typescript-definitions";
+/** Helper function to get an array with every valid card sub-type. This includes modded cards. */
+export declare function getAllCards(): 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 declare function getCardDescription(card: Card): 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"
+ * ```
+ */
+export declare function getCardName(card: Card): string;
+export declare function getCardType(card: Card): ItemConfigCardType;
+/**
+ * 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 declare function getCardsOfType(...cardTypes: ItemConfigCardType[]): Set<Card>;
+/**
+ * Helper function to get an array with every modded card sub-type.
+ *
+ * Returns an empty array if there are no modded cards.
+ */
+export declare function getModdedCards(): 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 declare function getRandomCard(seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
+/**
+ * @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 declare function getRandomCardOfType(cardType: ItemConfigCardType, seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
+/**
+ * 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 declare function getRandomRune(seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
+/** Helper function to get an array with every valid vanilla card sub-type. */
+export declare function getVanillaCards(): Card[];
+/**
+ * Returns true for cards that have the following card type:
+ * - CardType.TAROT
+ * - CardType.SUIT
+ * - CardType.SPECIAL
+ * - CardType.TAROT_REVERSE
+ */
+export declare function isCard(card: Card): boolean;
+/** Returns whether or not the given card matches the specified card type. */
+export declare function isCardType(card: Card, cardType: ItemConfigCardType): boolean;
+/** Returns true for cards that have `CardType.MODDED`. */
+export declare function isModdedCard(card: Card): boolean;
+/** Returns true for cards that have `CardType.SPECIAL_OBJECT`. */
+export declare function isPocketItemObject(card: Card): boolean;
+/** Returns true for cards that have `CardType.TAROT_REVERSE`. */
+export declare function isReverseTarotCard(card: Card): boolean;
+/** Returns true for cards that have `CardType.RUNE`. */
+export declare function isRune(card: Card): boolean;
+/** Returns true for cards that have `CardType.SPECIAL`. */
+export declare function isSpecialCard(card: Card): boolean;
+/** Returns true for cards that have `CardType.SUIT`. */
+export declare function isSuitCard(card: Card): boolean;
+/** Returns true for cards that have `CardType.TAROT`. */
+export declare function isTarotCard(card: Card): boolean;

package/functions/cards.lua

@@ -0,0 +1,174 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local Set = ____lualib.Set
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local initCardObjects, CARD_TYPE_TO_CARDS_MAP, CARD_SET
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Card = ____isaac_2Dtypescript_2Ddefinitions.Card
+local ItemConfigCardType = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigCardType
+local ____cachedClasses = require("cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
+local ____constantsFirstLast = require("constantsFirstLast")
+local FIRST_CARD = ____constantsFirstLast.FIRST_CARD
+local FIRST_MODDED_CARD = ____constantsFirstLast.FIRST_MODDED_CARD
+local LAST_CARD = ____constantsFirstLast.LAST_CARD
+local MAX_VANILLA_CARD = ____constantsFirstLast.MAX_VANILLA_CARD
+local ____cardDescriptions = require("objects.cardDescriptions")
+local CARD_DESCRIPTIONS = ____cardDescriptions.CARD_DESCRIPTIONS
+local DEFAULT_CARD_DESCRIPTION = ____cardDescriptions.DEFAULT_CARD_DESCRIPTION
+local ____cardNames = require("objects.cardNames")
+local CARD_NAMES = ____cardNames.CARD_NAMES
+local DEFAULT_CARD_NAME = ____cardNames.DEFAULT_CARD_NAME
+local ____cardTypes = require("objects.cardTypes")
+local CARD_TYPES = ____cardTypes.CARD_TYPES
+local DEFAULT_CARD_TYPE = ____cardTypes.DEFAULT_CARD_TYPE
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local ____set = require("functions.set")
+local addSetsToSet = ____set.addSetsToSet
+local getRandomSetElement = ____set.getRandomSetElement
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
+function initCardObjects(self)
+    for ____, cardType in ipairs(getEnumValues(nil, ItemConfigCardType)) do
+        CARD_TYPE_TO_CARDS_MAP:set(
+            cardType,
+            __TS__New(Set)
+        )
+    end
+    for ____, card in ipairs(____exports.getAllCards(nil)) do
+        local cardType = ____exports.getCardType(nil, card)
+        local cardTypeSet = CARD_TYPE_TO_CARDS_MAP:get(cardType)
+        if cardTypeSet == nil then
+            error("Failed to get the card set for card type: " .. tostring(cardType))
+        end
+        cardTypeSet:add(card)
+    end
+    local cards = ____exports.getCardsOfType(
+        nil,
+        ItemConfigCardType.TAROT,
+        ItemConfigCardType.SUIT,
+        ItemConfigCardType.SPECIAL,
+        ItemConfigCardType.TAROT_REVERSE
+    )
+    addSetsToSet(nil, CARD_SET, cards)
+end
+function ____exports.getAllCards(self)
+    return irange(nil, FIRST_CARD, LAST_CARD)
+end
+function ____exports.getCardType(self, card)
+    local cardType = CARD_TYPES[card]
+    return cardType == nil and DEFAULT_CARD_TYPE or cardType
+end
+function ____exports.getCardsOfType(self, ...)
+    local cardTypes = {...}
+    if CARD_TYPE_TO_CARDS_MAP.size == 0 then
+        initCardObjects(nil)
+    end
+    local matchingCards = __TS__New(Set)
+    for ____, cardType in ipairs(cardTypes) do
+        local cardSet = CARD_TYPE_TO_CARDS_MAP:get(cardType)
+        if cardSet == nil then
+            error("Failed to get the cards for type: " .. tostring(cardType))
+        end
+        for ____, card in __TS__Iterator(cardSet:values()) do
+            matchingCards:add(card)
+        end
+    end
+    return matchingCards
+end
+CARD_TYPE_TO_CARDS_MAP = __TS__New(Map)
+CARD_SET = __TS__New(Set)
+function ____exports.getCardDescription(self, card)
+    local cardDescription = CARD_DESCRIPTIONS[card]
+    if cardDescription ~= nil then
+        return cardDescription
+    end
+    local itemConfigCard = itemConfig:GetCard(card)
+    if itemConfigCard ~= nil then
+        return itemConfigCard.Description
+    end
+    return DEFAULT_CARD_DESCRIPTION
+end
+function ____exports.getCardName(self, card)
+    local cardName = CARD_NAMES[card]
+    if cardName ~= nil and cardName ~= DEFAULT_CARD_NAME then
+        return cardName
+    end
+    local itemConfigCard = itemConfig:GetCard(card)
+    if itemConfigCard ~= nil then
+        return itemConfigCard.Name
+    end
+    return DEFAULT_CARD_NAME
+end
+function ____exports.getModdedCards(self)
+    if MAX_VANILLA_CARD == LAST_CARD then
+        return {}
+    end
+    return irange(nil, FIRST_MODDED_CARD, LAST_CARD)
+end
+function ____exports.getRandomCard(self, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    return getRandomSetElement(nil, CARD_SET, seedOrRNG, exceptions)
+end
+function ____exports.getRandomCardOfType(self, cardType, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    local cardSet = ____exports.getCardsOfType(nil, cardType)
+    return getRandomSetElement(nil, cardSet, seedOrRNG, exceptions)
+end
+function ____exports.getRandomRune(self, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    local runesSet = ____exports.getCardsOfType(nil, ItemConfigCardType.RUNE)
+    runesSet:delete(Card.RUNE_SHARD)
+    return getRandomSetElement(nil, runesSet, seedOrRNG, exceptions)
+end
+function ____exports.getVanillaCards(self)
+    return irange(nil, FIRST_CARD, MAX_VANILLA_CARD)
+end
+function ____exports.isCard(self, card)
+    return CARD_SET:has(card)
+end
+function ____exports.isCardType(self, card, cardType)
+    return cardType == ____exports.getCardType(nil, card)
+end
+function ____exports.isModdedCard(self, card)
+    return ____exports.isCardType(nil, card, ItemConfigCardType.MODDED)
+end
+function ____exports.isPocketItemObject(self, card)
+    return ____exports.isCardType(nil, card, ItemConfigCardType.SPECIAL_OBJECT)
+end
+function ____exports.isReverseTarotCard(self, card)
+    return ____exports.isCardType(nil, card, ItemConfigCardType.TAROT_REVERSE)
+end
+function ____exports.isRune(self, card)
+    return ____exports.isCardType(nil, card, ItemConfigCardType.RUNE)
+end
+function ____exports.isSpecialCard(self, card)
+    return ____exports.isCardType(nil, card, ItemConfigCardType.SPECIAL)
+end
+function ____exports.isSuitCard(self, card)
+    return ____exports.isCardType(nil, card, ItemConfigCardType.SUIT)
+end
+function ____exports.isTarotCard(self, card)
+    return ____exports.isCardType(nil, card, ItemConfigCardType.TAROT)
+end
+return ____exports

package/functions/challenges.d.ts

@@ -0,0 +1,3 @@
+import { Challenge } from "isaac-typescript-definitions";
+/** Get the proper name for a `Challenge` enum. This will only work for vanilla challenges. */
+export declare function getChallengeName(challenge: Challenge): string;

package/functions/challenges.lua

@@ -0,0 +1,9 @@
+local ____exports = {}
+local ____challengeNames = require("objects.challengeNames")
+local CHALLENGE_NAMES = ____challengeNames.CHALLENGE_NAMES
+local DEFAULT_CHALLENGE_NAME = ____challengeNames.DEFAULT_CHALLENGE_NAME
+function ____exports.getChallengeName(self, challenge)
+    local challengeName = CHALLENGE_NAMES[challenge]
+    return challengeName == nil and DEFAULT_CHALLENGE_NAME or challengeName
+end
+return ____exports

package/functions/character.d.ts

@@ -0,0 +1,48 @@
+import { PlayerType } from "isaac-typescript-definitions";
+/**
+ * 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 declare function characterCanHaveRedHearts(character: PlayerType): boolean;
+/**
+ * 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 declare function characterCanHaveSoulHearts(character: PlayerType): boolean;
+/**
+ * Helper function for determining whether the given character can take free Devil Deals. (e.g. The
+ * Lost, Tainted Lost, etc.)
+ */
+export declare function characterCanTakeFreeDevilDeals(character: PlayerType): boolean;
+/**
+ * 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 declare function characterGetsBlackHeartFromEternalHeart(character: PlayerType): boolean;
+/**
+ * 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 declare function characterStartsWithActiveItem(character: PlayerType): boolean;
+/**
+ * - 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 declare function getCharacterDeathAnimationName(character: PlayerType): string;
+/**
+ * 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 declare function getCharacterMaxHeartContainers(character: PlayerType): int;
+/** Helper function to get the name of a character. Returns "unknown" for modded characters. */
+export declare function getCharacterName(character: PlayerType): string;
+export declare function isModdedCharacter(character: PlayerType): boolean;
+export declare function isVanillaCharacter(character: PlayerType): boolean;

package/functions/character.lua

@@ -0,0 +1,73 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____constantsFirstLast = require("constantsFirstLast")
+local LAST_VANILLA_CHARACTER = ____constantsFirstLast.LAST_VANILLA_CHARACTER
+local ____characterNames = require("objects.characterNames")
+local CHARACTER_NAMES = ____characterNames.CHARACTER_NAMES
+local DEFAULT_CHARACTER_NAME = ____characterNames.DEFAULT_CHARACTER_NAME
+local ____charactersThatStartWithAnActiveItemSet = require("sets.charactersThatStartWithAnActiveItemSet")
+local CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET = ____charactersThatStartWithAnActiveItemSet.CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET
+local ____charactersWithBlackHeartFromEternalHeartSet = require("sets.charactersWithBlackHeartFromEternalHeartSet")
+local CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET = ____charactersWithBlackHeartFromEternalHeartSet.CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET
+local ____charactersWithFreeDevilDealsSet = require("sets.charactersWithFreeDevilDealsSet")
+local CHARACTERS_WITH_FREE_DEVIL_DEALS_SET = ____charactersWithFreeDevilDealsSet.CHARACTERS_WITH_FREE_DEVIL_DEALS_SET
+local ____charactersWithNoRedHeartsSet = require("sets.charactersWithNoRedHeartsSet")
+local CHARACTERS_WITH_NO_RED_HEARTS_SET = ____charactersWithNoRedHeartsSet.CHARACTERS_WITH_NO_RED_HEARTS_SET
+local ____charactersWithNoSoulHeartsSet = require("sets.charactersWithNoSoulHeartsSet")
+local CHARACTERS_WITH_NO_SOUL_HEARTS_SET = ____charactersWithNoSoulHeartsSet.CHARACTERS_WITH_NO_SOUL_HEARTS_SET
+local ____lostStyleCharactersSet = require("sets.lostStyleCharactersSet")
+local LOST_STYLE_CHARACTERS_SET = ____lostStyleCharactersSet.LOST_STYLE_CHARACTERS_SET
+function ____exports.isVanillaCharacter(self, character)
+    return character <= LAST_VANILLA_CHARACTER
+end
+function ____exports.characterCanHaveRedHearts(self, character)
+    return not CHARACTERS_WITH_NO_RED_HEARTS_SET:has(character)
+end
+function ____exports.characterCanHaveSoulHearts(self, character)
+    return not CHARACTERS_WITH_NO_SOUL_HEARTS_SET:has(character)
+end
+function ____exports.characterCanTakeFreeDevilDeals(self, character)
+    return CHARACTERS_WITH_FREE_DEVIL_DEALS_SET:has(character)
+end
+function ____exports.characterGetsBlackHeartFromEternalHeart(self, character)
+    return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET:has(character)
+end
+function ____exports.characterStartsWithActiveItem(self, character)
+    return CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET:has(character)
+end
+function ____exports.getCharacterDeathAnimationName(self, character)
+    if LOST_STYLE_CHARACTERS_SET:has(character) then
+        return "LostDeath"
+    end
+    if character == PlayerType.THE_FORGOTTEN_B then
+        return "ForgottenDeath"
+    end
+    return "Death"
+end
+function ____exports.getCharacterMaxHeartContainers(self, character)
+    if character == PlayerType.KEEPER then
+        return 3
+    end
+    if character == PlayerType.THE_FORGOTTEN then
+        return 6
+    end
+    if character == PlayerType.THE_SOUL then
+        return 6
+    end
+    if character == PlayerType.KEEPER_B then
+        return 2
+    end
+    return 12
+end
+function ____exports.getCharacterName(self, character)
+    if ____exports.isVanillaCharacter(nil, character) then
+        return "unknown"
+    end
+    local characterName = CHARACTER_NAMES[character]
+    return characterName == nil and DEFAULT_CHARACTER_NAME or characterName
+end
+function ____exports.isModdedCharacter(self, character)
+    return not ____exports.isVanillaCharacter(nil, character)
+end
+return ____exports