Interface IPlayerState
Interface for determining the players state.
Assembly: Dalamud.dll
View Source
public interface IPlayerState : IDalamudService
Properties
IsLoaded
Gets a value indicating whether the local players data is loaded.
View Source
bool IsLoaded { get; }
CharacterName
Gets the name of the local character.
View Source
string CharacterName { get; }
EntityId
Gets the entity ID of the local character.
View Source
uint EntityId { get; }
ContentId
Gets the content ID of the local character.
View Source
ulong ContentId { get; }
CurrentWorld
Gets the World row for the local character's current world.
View Source
RowRef<World> CurrentWorld { get; }
HomeWorld
Gets the World row for the local character's home world.
View Source
RowRef<World> HomeWorld { get; }
Sex
Gets the sex of the local character.
View Source
Sex Sex { get; }
Race
Gets the Race row for the local character.
View Source
RowRef<Race> Race { get; }
Tribe
Gets the Tribe row for the local character.
View Source
RowRef<Tribe> Tribe { get; }
ClassJob
Gets the ClassJob row for the local character's current class/job.
View Source
RowRef<ClassJob> ClassJob { get; }
Level
Gets the current class/job's level of the local character.
View Source
short Level { get; }
IsLevelSynced
Gets a value indicating whether the local character's level is synced.
View Source
bool IsLevelSynced { get; }
EffectiveLevel
Gets the effective level of the local character.
View Source
short EffectiveLevel { get; }
GuardianDeity
Gets the GuardianDeity row for the local character.
View Source
RowRef<GuardianDeity> GuardianDeity { get; }
BirthMonth
Gets the birth month of the local character.
View Source
byte BirthMonth { get; }
BirthDay
Gets the birth day of the local character.
View Source
byte BirthDay { get; }
FirstClass
Gets the ClassJob row for the local character's starting class.
View Source
RowRef<ClassJob> FirstClass { get; }
StartTown
Gets the Town row for the local character's starting town.
View Source
RowRef<Town> StartTown { get; }
BaseStrength
Gets the base strength of the local character.
View Source
int BaseStrength { get; }
BaseDexterity
Gets the base dexterity of the local character.
View Source
int BaseDexterity { get; }
BaseVitality
Gets the base vitality of the local character.
View Source
int BaseVitality { get; }
BaseIntelligence
Gets the base intelligence of the local character.
View Source
int BaseIntelligence { get; }
BaseMind
Gets the base mind of the local character.
View Source
int BaseMind { get; }
BasePiety
Gets the piety mind of the local character.
View Source
int BasePiety { get; }
GrandCompany
Gets the GrandCompany row for the local character's current Grand Company affiliation.
View Source
RowRef<GrandCompany> GrandCompany { get; }
HomeAetheryte
Gets the Aetheryte row for the local player's home aetheryte.
View Source
RowRef<Aetheryte> HomeAetheryte { get; }
FavoriteAetherytes
Gets an array of Aetheryte rows for the local player's favourite aetherytes.
View Source
IReadOnlyList<RowRef<Aetheryte>> FavoriteAetherytes { get; }
FreeAetheryte
Gets the Aetheryte row for the local player's free aetheryte.
View Source
RowRef<Aetheryte> FreeAetheryte { get; }
BaseRestedExperience
Gets the amount of received player commendations of the local player.
View Source
uint BaseRestedExperience { get; }
PlayerCommendations
Gets the amount of received player commendations of the local player.
View Source
short PlayerCommendations { get; }
DeliveryLevel
Gets the Carrier Level of Delivery Moogle Quests of the local player.
View Source
byte DeliveryLevel { get; }
MentorVersion
Gets the mentor version of the local player.
View Source
MentorVersion MentorVersion { get; }
IsMentor
Gets a value indicating whether the local player is any kind of Mentor (Battle or Trade Mentor).
View Source
bool IsMentor { get; }
IsBattleMentor
Gets a value indicating whether the local player is a Battle Mentor.
View Source
bool IsBattleMentor { get; }
IsTradeMentor
Gets a value indicating whether the local player is a Trade Mentor.
View Source
bool IsTradeMentor { get; }
IsNovice
Gets a value indicating whether the local player is a novice (aka. Sprout or New Adventurer).
View Source
bool IsNovice { get; }
IsReturner
Gets a value indicating whether the local player is a returner.
View Source
bool IsReturner { get; }
Methods
GetAttribute(PlayerAttribute)
Gets the value of an attribute of the local character.
View Source
int GetAttribute(PlayerAttribute attribute)
Returns
System.Int32: The value of the specific attribute.
Parameters
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.Player.PlayerAttribute | attribute | The attribute to check. |
GetGrandCompanyRank(GrandCompany)
Gets the Grand Company rank of the local character.
View Source
byte GetGrandCompanyRank(GrandCompany grandCompany)
Returns
System.Byte: The Grand Company rank of the local character.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Excel.Sheets.GrandCompany | grandCompany | The Grand Company to check. |
GetClassJobLevel(ClassJob)
Gets the level of the local character's class/job.
View Source
short GetClassJobLevel(ClassJob classJob)
Returns
System.Int16: The level of the requested class/job.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Excel.Sheets.ClassJob | classJob | The ClassJob row to check. |
GetClassJobExperience(ClassJob)
Gets the experience of the local character's class/job.
View Source
int GetClassJobExperience(ClassJob classJob)
Returns
System.Int32: The experience of the requested class/job.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Excel.Sheets.ClassJob | classJob | The ClassJob row to check. |
GetDesynthesisLevel(ClassJob)
Gets the desynthesis level of the local character's crafter job.
View Source
float GetDesynthesisLevel(ClassJob classJob)
Returns
System.Single: The desynthesis level of the requested crafter job.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Excel.Sheets.ClassJob | classJob | The ClassJob row to check. |