Class "EntityConfigPlayer"

Info

You can get this class by using the following functions:

• EntityConfig.GetPlayer()

Example Code

local cainConfig = EntityConfig.GetPlayer(PlayerType.PLAYER_CAIN)

Functions

CanShoot ()

boolean CanShoot ( )

---

GetAchievementID ()

Achievement GetAchievementID ( )

Returns -1 if the character is not locked behind a vanilla achievement (or -2 for "hidden" vanilla characters).

---

GetBirthrightDescription ()

string GetBirthrightDescription ( )

---

GetBlackHearts ()

int GetBlackHearts ( )

---

GetBombs ()

int GetBombs ( )

---

GetBrokenHearts ()

int GetBrokenHearts ( )

---

GetCard ()

Card GetCard ( )

Returns 0 if the character does not start with any vanilla card.

Does not include starting cards obtained via unlocks.

Does not include cards added by mods.

---

GetCoins ()

int GetCoins ( )

---

GetCollectibles ()

CollectibleType[] GetCollectibles ( )

Returns a table of CollectibleTypes for the character's starting items.

---

GetCostumeID ()

int GetCostumeID ( )

Returns -1 if the character does not have any XML-defined starting costume (like Maggy's hair).

---

GetCostumeSuffix ()

string GetCostumeSuffix ( )

Directory suffix used for character-specific costume sprites.

---

GetExtraPortraitPath ()

string GetExtraPortraitPath ( )

Path to a .anm2 file displayed on top of the character's level transition and boss VS screen portrait.

---

GetKeys ()

int GetKeys ( )

---

GetModdedControlsSprite ()

Sprite GetModdedControlsSprite ( )

Returns the Sprite used for a modded character's starting room controls.

Note that this Sprite is shared by other characters from the same mod - there is an animation with the same name as this character.

Returns nil for vanilla characters, or characters with no corresponding animation.

---

GetModdedCoopMenuSprite ()

Sprite GetModdedCoopMenuSprite ( )

Returns the Sprite used for a modded character's icon in the co-op character select wheel.

Note that this Sprite is shared by other characters from the same mod - there is an animation with the same name as this character.

Returns nil for vanilla characters, or characters with no corresponding animation.

---

GetModdedGameOverSprite ()

Sprite GetModdedGameOverSprite ( )

Returns the Sprite used for a modded character's game over screen (ie, their name).

Note that this Sprite is shared by other characters from the same mod - there is an animation with the same name as this character.

Returns nil for vanilla characters, or characters with no corresponding animation.

---

GetModdedMenuBackgroundSprite ()

Sprite GetModdedMenuBackgroundSprite ( )

Returns the Sprite used for a modded character's character select screen.

Note that this Sprite is shared by other characters from the same mod - there is an animation with the same name as this character.

Returns nil for vanilla characters, or characters with no corresponding animation.

---

GetModdedMenuPortraitSprite ()

Sprite GetModdedMenuPortraitSprite ( )

Returns the Sprite used for a modded character's character select portrait.

Note that this Sprite is shared by other characters from the same mod - there is an animation with the same name as this character.

Returns nil for vanilla characters, or characters with no corresponding animation.

---

GetName ()

string GetName ( )

---

GetNameImagePath ()

string GetNameImagePath ( )

Path to the PNG file used for the character's name on the boss VS screen.

---

GetPill ()

PillColor GetPill ( )

Does not include starting pills obtained via unlocks.

---

GetPlayerType ()

int GetPlayerType ( )

---

GetPocketActive ()

CollectibleType GetPocketActive ( )

Does not include items added by mods.

---

GetPortraitPath ()

string GetPortraitPath ( )

Path to the PNG file used for the character's main level transition and boss VS screen portrait.

---

GetRedHearts ()

int GetRedHearts ( )

---

GetSkinColor ()

SkinColor GetSkinColor ( )

---

GetSkinPath ()

string GetSkinPath ( )

Path to the PNG file used for the character's primary sprite sheet.

---

GetSoulHearts ()

int GetSoulHearts ( )

---

GetTaintedCounterpart ()

EntityConfigPlayer GetTaintedCounterpart ( )

For non-tainted characters, returns their tainted counterpart, or returns nil if there is none.

For tainted characters, returns their non-tainted counterpart.

---

GetTrinket ()

TrinketType GetTrinket ( )

Does not include starting trinkets obtained via unlocks.

Does not include trinkets added by mods.

---

IsHidden ()

boolean IsHidden ( )

Returns true if the character is not visible/selectable from the character select screen.

Doesn't include characters who are only hidden until unlocked.

---

IsTainted ()

boolean IsTainted ( )

---