Skip to main content
Version: 15.x (API 15) [Legacy]

Interface ICharacter

Interface representing a character.

Assembly: Dalamud.dll​
Declaration
public interface ICharacter : IGameObject, IEquatable<IGameObject>

Properties​

CurrentHp​

Gets the current HP of this character.

Declaration
uint CurrentHp { get; }

MaxHp​

Gets the maximum HP of this character.

Declaration
uint MaxHp { get; }

CurrentMp​

Gets the current MP of this character.

Declaration
uint CurrentMp { get; }

MaxMp​

Gets the maximum MP of this character.

Declaration
uint MaxMp { get; }

CurrentGp​

Gets the current GP of this character.

Declaration
uint CurrentGp { get; }

MaxGp​

Gets the maximum GP of this character.

Declaration
uint MaxGp { get; }

CurrentCp​

Gets the current CP of this character.

Declaration
uint CurrentCp { get; }

MaxCp​

Gets the maximum CP of this character.

Declaration
uint MaxCp { get; }

ShieldPercentage​

Gets the shield percentage of this character.

Declaration
byte ShieldPercentage { get; }

ClassJob​

Gets the ClassJob of this character.

Declaration
RowRef<ClassJob> ClassJob { get; }

Level​

Gets the level of this character.

Declaration
byte Level { get; }

Customize​

Gets a byte array describing the visual appearance of this character. Indexed by Dalamud.Game.ClientState.Objects.Enums.CustomizeIndex.

Declaration
Span<byte> Customize { get; }

CustomizeData​

Gets the underlying CustomizeData struct for this character.

Declaration
ICustomizeData CustomizeData { get; }

CompanyTag​

Gets the Free Company tag of this character.

Declaration
string CompanyTag { get; }

NameId​

Gets the name ID of the character.

Declaration
uint NameId { get; }

OnlineStatus​

Gets the current online status of the character.

Declaration
RowRef<OnlineStatus> OnlineStatus { get; }

StatusFlags​

Gets the status flags.

Declaration
StatusFlags StatusFlags { get; }

CurrentMount​

Gets the current mount for this character. Will be null if the character doesn't have a mount.

Declaration
RowRef<Mount>? CurrentMount { get; }

CurrentMinion​

Gets the current minion summoned for this character. Will be null if the character doesn't have a minion. This method will return information about a spawned (but invisible) minion, e.g. if the character is riding a mount.

Declaration
RowRef<Companion>? CurrentMinion { get; }