Characters
Functions
canCharacterHaveRedHearts
▸ canCharacterHaveRedHearts(character): boolean
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.
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/characters.ts:34
canCharacterHaveSoulHearts
▸ canCharacterHaveSoulHearts(character): 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.
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/characters.ts:43
canCharacterTakeFreeDevilDeals
▸ canCharacterTakeFreeDevilDeals(character): boolean
Helper function for determining whether the given character can take free Devil Deals. (e.g. The Lost, Tainted Lost, etc.)
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/characters.ts:51
doesCharacterGetBlackHeartFromEternalHeart
▸ doesCharacterGetBlackHeartFromEternalHeart(character): 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.
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/characters.ts:60
doesCharacterStartWithActiveItem
▸ doesCharacterStartWithActiveItem(character): 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).
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/characters.ts:72
getCharacterDamageMultiplier
▸ getCharacterDamageMultiplier(character, hasWhoreOfBabylon?): float
Helper function to get the numerical damage multiplier for a character.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
character | PlayerType | undefined | The character to get. |
hasWhoreOfBabylon | boolean | false | Optional. Whether the character has the Whore of Babylon effect currently active. Defaults to false. This is necessary because Eve's damage multiplier changes from 0.75 to 1 when she has Whore of Babylon active. |
Returns
float
Defined in
packages/isaacscript-common/src/functions/characters.ts:87
getCharacterDeathAnimationName
▸ getCharacterDeathAnimationName(character): string
- 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).
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
string
Defined in
packages/isaacscript-common/src/functions/characters.ts:103
getCharacterMaxHeartContainers
▸ getCharacterMaxHeartContainers(character): int
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.
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
int
Defined in
packages/isaacscript-common/src/functions/characters.ts:120
getCharacterName
▸ getCharacterName(character): string
Helper function to get the name of a character. Returns "Unknown" for modded characters.
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
string
Defined in
packages/isaacscript-common/src/functions/characters.ts:145
getCharacterSpritePNGFilePath
▸ getCharacterSpritePNGFilePath(character): string
Helper function to get the path to the sprite for a particular character.
For example, the file path for PlayerType.ISAAC is
"characters/costumes/character_001_isaac.png".
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
string
Defined in
packages/isaacscript-common/src/functions/characters.ts:159
getCharacterStartingCollectibleTypes
▸ getCharacterStartingCollectibleTypes(character): readonly CollectibleType[]
Helper function to get the collectibles that are granted to a particular character at the beginning of a run.
Note that this will return an empty array for Eden and Tainted Eden.
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
readonly CollectibleType[]
Defined in
packages/isaacscript-common/src/functions/characters.ts:170
getCharacterStartingTrinketType
▸ getCharacterStartingTrinketType(character): TrinketType | undefined
Helper function to get the trinket that is granted to a particular character at the beginning of a run. Returns undefined if the character does not start with a trinket.
Note that this will return undefined for Eden and Tainted Eden.
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
TrinketType | undefined
Defined in
packages/isaacscript-common/src/functions/characters.ts:182
getMainCharacter
▸ getMainCharacter(character): PlayerType
Helper function to get the "main" version of the character. In other words, this is the character that selectable from the main menu (and has achievements related to completing the various bosses and so on).
For example, the main character for PlayerType.MAGDALENE (1) is also PlayerType.MAGDALENE
(1), but the main character for PlayerType.LAZARUS_2 (11) would be PlayerType.LAZARUS (8).
For PlayerType.POSSESSOR (-1) and modded characters, the same character will be returned.
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
PlayerType
Defined in
packages/isaacscript-common/src/functions/characters.ts:198
isFlyingCharacter
▸ isFlyingCharacter(character): boolean
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/characters.ts:246
isMainCharacter
▸ isMainCharacter(character): character is ISAAC | MAGDALENE | CAIN | JUDAS | BLUE_BABY | EVE | SAMSON | AZAZEL | LAZARUS | EDEN | LOST | LILITH | KEEPER | APOLLYON | FORGOTTEN | BETHANY | JACOB | ISAAC_B | MAGDALENE_B | CAIN_B | JUDAS_B | BLUE_BABY_B | EVE_B | SAMSON_B | AZAZEL_B | LAZARUS_B | EDEN_B | LOST_B | LILITH_B | KEEPER_B | APOLLYON_B | FORGOTTEN_B | BETHANY_B | JACOB_B
Helper function to check if the provided character is one of the characters that are selectable from the main menu (and have achievements related to completing the various bosses and so on).
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
character is ISAAC | MAGDALENE | CAIN | JUDAS | BLUE_BABY | EVE | SAMSON | AZAZEL | LAZARUS | EDEN | LOST | LILITH | KEEPER | APOLLYON | FORGOTTEN | BETHANY | JACOB | ISAAC_B | MAGDALENE_B | CAIN_B | JUDAS_B | BLUE_BABY_B | EVE_B | SAMSON_B | AZAZEL_B | LAZARUS_B | EDEN_B | LOST_B | LILITH_B | KEEPER_B | APOLLYON_B | FORGOTTEN_B | BETHANY_B | JACOB_B
Defined in
packages/isaacscript-common/src/functions/characters.ts:254
isModdedCharacter
▸ isModdedCharacter(character): boolean
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
boolean
Defined in
packages/isaacscript-common/src/functions/characters.ts:260
isVanillaCharacter
▸ isVanillaCharacter(character): boolean
Parameters
| Name | Type |
|---|---|
character | PlayerType |
Returns
boolean