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

Interface IPlayerState

Interface for determining the players state.

Assembly: Dalamud.dll​
Declaration
public interface IPlayerState : IDalamudService

Properties​

IsLoaded​

Gets a value indicating whether the local players data is loaded.

Declaration
bool IsLoaded { get; }
Remarks​

PlayerState is separate from Dalamud.Plugin.Services.IObjectTable.LocalPlayer, and as such the game object might not exist when it's loaded.

CharacterName​

Gets the name of the local character.

Declaration
string CharacterName { get; }

EntityId​

Gets the entity ID of the local character.

Declaration
uint EntityId { get; }

ContentId​

Gets the content ID of the local character.

Declaration
ulong ContentId { get; }

CurrentWorld​

Gets the World row for the local character's current world.

Declaration
RowRef<World> CurrentWorld { get; }

HomeWorld​

Gets the World row for the local character's home world.

Declaration
RowRef<World> HomeWorld { get; }

Sex​

Gets the sex of the local character.

Declaration
Sex Sex { get; }

Race​

Gets the Race row for the local character.

Declaration
RowRef<Race> Race { get; }

Tribe​

Gets the Tribe row for the local character.

Declaration
RowRef<Tribe> Tribe { get; }

ClassJob​

Gets the ClassJob row for the local character's current class/job.

Declaration
RowRef<ClassJob> ClassJob { get; }

Level​

Gets the current class/job's level of the local character.

Declaration
short Level { get; }

IsLevelSynced​

Gets a value indicating whether the local character's level is synced.

Declaration
bool IsLevelSynced { get; }

EffectiveLevel​

Gets the effective level of the local character, taking level sync into account.

Declaration
short EffectiveLevel { get; }

GuardianDeity​

Gets the GuardianDeity row for the local character.

Declaration
RowRef<GuardianDeity> GuardianDeity { get; }

BirthMonth​

Gets the birth month of the local character.

Declaration
byte BirthMonth { get; }

BirthDay​

Gets the birth day of the local character.

Declaration
byte BirthDay { get; }

FirstClass​

Gets the ClassJob row for the local character's starting class.

Declaration
RowRef<ClassJob> FirstClass { get; }

StartTown​

Gets the Town row for the local character's starting town.

Declaration
RowRef<Town> StartTown { get; }

BaseStrength​

Gets the base strength of the local character.

Declaration
int BaseStrength { get; }

BaseDexterity​

Gets the base dexterity of the local character.

Declaration
int BaseDexterity { get; }

BaseVitality​

Gets the base vitality of the local character.

Declaration
int BaseVitality { get; }

BaseIntelligence​

Gets the base intelligence of the local character.

Declaration
int BaseIntelligence { get; }

BaseMind​

Gets the base mind of the local character.

Declaration
int BaseMind { get; }

BasePiety​

Gets the piety mind of the local character.

Declaration
int BasePiety { get; }

GrandCompany​

Gets the GrandCompany row for the local character's current Grand Company affiliation.

Declaration
RowRef<GrandCompany> GrandCompany { get; }

HomeAetheryte​

Gets the Aetheryte row for the local player's home aetheryte.

Declaration
RowRef<Aetheryte> HomeAetheryte { get; }

FavoriteAetherytes​

Gets an array of Aetheryte rows for the local player's favourite aetherytes.

Declaration
IReadOnlyList<RowRef<Aetheryte>> FavoriteAetherytes { get; }

FreeAetheryte​

Gets the Aetheryte row for the local player's free aetheryte.

Declaration
RowRef<Aetheryte> FreeAetheryte { get; }

BaseRestedExperience​

Gets the amount of rested experience available to the local player.

Declaration
uint BaseRestedExperience { get; }

PlayerCommendations​

Gets the amount of received player commendations of the local player.

Declaration
short PlayerCommendations { get; }

DeliveryLevel​

Gets the Carrier Level of Delivery Moogle Quests of the local player.

Declaration
byte DeliveryLevel { get; }

MentorVersion​

Gets the mentor version of the local player.

Declaration
MentorVersion MentorVersion { get; }

IsMentor​

Gets a value indicating whether the local player is any kind of Mentor (Battle or Trade Mentor).

Declaration
bool IsMentor { get; }

IsBattleMentor​

Gets a value indicating whether the local player is a Battle Mentor.

Declaration
bool IsBattleMentor { get; }

IsTradeMentor​

Gets a value indicating whether the local player is a Trade Mentor.

Declaration
bool IsTradeMentor { get; }

IsNovice​

Gets a value indicating whether the local player is a novice (aka. Sprout or New Adventurer).

Declaration
bool IsNovice { get; }
Remarks​

Can be false if /nastatus was used to deactivate it.

IsReturner​

Gets a value indicating whether the local player is a returner.

Declaration
bool IsReturner { get; }

IsAwayFromKeyboard​

Gets a value indicating whether the Away from Keyboard status is currently active for the local player.

Declaration
bool IsAwayFromKeyboard { get; }

Methods​

GetAttribute(PlayerAttribute)​

Gets the value of an attribute of the local character.

Declaration
int GetAttribute(PlayerAttribute attribute)
Returns​

System.Int32: The value of the specific attribute.

Parameters​
TypeNameDescription
Dalamud.Game.Player.PlayerAttributeattributeThe attribute to check.

GetGrandCompanyRank(GrandCompany)​

Gets the Grand Company rank of the local character.

Declaration
byte GetGrandCompanyRank(GrandCompany grandCompany)
Returns​

System.Byte: The Grand Company rank of the local character.

Parameters​
TypeNameDescription
Lumina.Excel.Sheets.GrandCompanygrandCompanyThe Grand Company to check.

GetClassJobLevel(ClassJob)​

Gets the level of the local character's class/job.

Declaration
short GetClassJobLevel(ClassJob classJob)
Returns​

System.Int16: The level of the requested class/job.

Parameters​
TypeNameDescription
Lumina.Excel.Sheets.ClassJobclassJobThe ClassJob row to check.

GetClassJobExperience(ClassJob)​

Gets the experience of the local character's class/job.

Declaration
int GetClassJobExperience(ClassJob classJob)
Returns​

System.Int32: The experience of the requested class/job.

Parameters​
TypeNameDescription
Lumina.Excel.Sheets.ClassJobclassJobThe ClassJob row to check.

GetDesynthesisLevel(ClassJob)​

Gets the desynthesis level of the local character's crafter job.

Declaration
float GetDesynthesisLevel(ClassJob classJob)
Returns​

System.Single: The desynthesis level of the requested crafter job.

Parameters​
TypeNameDescription
Lumina.Excel.Sheets.ClassJobclassJobThe ClassJob row to check.