Interface IClientState
This class represents the state of the game client at the time of access.
Assembly: Dalamud.dll​
public interface IClientState : IDalamudService
Properties​
ClientLanguage​
Gets the language of the client.
ClientLanguage ClientLanguage { get; }
TerritoryType​
Gets the current Territory the player resides in.
RowRef<TerritoryType> TerritoryType { get; }
Map​
Gets the current Map the player resides in.
RowRef<Map> Map { get; }
Instance​
Gets the instance number of the current zone, used when multiple copies of an area are active.
uint Instance { get; }
IsLoggedIn​
Gets a value indicating whether a character is logged in.
bool IsLoggedIn { get; }
IsPvP​
Gets a value indicating whether the user is playing PvP.
bool IsPvP { get; }
IsPvPExcludingDen​
Gets a value indicating whether the user is playing PvP, excluding the Wolves' Den.
bool IsPvPExcludingDen { get; }
IsGPosing​
Gets a value indicating whether the client is currently in Group Pose (GPose) mode.
bool IsGPosing { get; }
Methods​
IsClientIdle(out ConditionFlag)​
Opinionated check whether the client is currently "idle". This means a player is not logged in, or is not actively in combat or doing anything that we may not want to disrupt.
bool IsClientIdle(out ConditionFlag blockingFlag)
Returns​
System.Boolean: Returns true if the client is idle, false otherwise.
Parameters​
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.ClientState.Conditions.ConditionFlag | blockingFlag | An outvar containing the first observed condition blocking the "idle" state. 0 if idle. |
IsClientIdle()​
Opinionated check whether the client is currently "idle". This means a player is not logged in, or is not actively in combat or doing anything that we may not want to disrupt.
bool IsClientIdle()
Returns​
System.Boolean: Returns true if the client is idle, false otherwise.
Events​
ZoneInit​
Event that gets fired when the game initializes a zone.
event Action<ZoneInitEventArgs> ZoneInit
Event Type​
System.Action<Dalamud.Game.ClientState.ZoneInitEventArgs>
TerritoryChanged​
Event that gets fired when the current Territory changes.
event Action<RowRef<TerritoryType>> TerritoryChanged
Event Type​
System.Action<Lumina.Excel.RowRef<Dalamud.Excel.Sheets.TerritoryType>>
MapChanged​
Event that gets fired when the current Map changes.
event Action<RowRef<Map>> MapChanged
Event Type​
System.Action<Lumina.Excel.RowRef<Dalamud.Excel.Sheets.Map>>
InstanceChanged​
Event that gets fired when the current zone Instance changes.
event Action<uint> InstanceChanged
Event Type​
System.Action<System.UInt32>
ClassJobChanged​
Event that fires when a characters ClassJob changed.
event IClientState.ClassJobChangeDelegate? ClassJobChanged
Event Type​
Dalamud.Plugin.Services.IClientState.ClassJobChangeDelegate
LevelChanged​
Event that fires when any character level changes, including levels for a not-currently-active ClassJob (e.g. PvP matches, DoH/DoL).
event IClientState.LevelChangeDelegate? LevelChanged
Event Type​
Dalamud.Plugin.Services.IClientState.LevelChangeDelegate
Login​
Event that fires when a character is logging in, and the local character object is available.
event Action Login
Event Type​
System.Action
Logout​
Event that fires when a character is logging out.
event IClientState.LogoutDelegate Logout
Event Type​
Dalamud.Plugin.Services.IClientState.LogoutDelegate
EnterPvP​
Event that fires when a character is entering PvP.
event Action EnterPvP
Event Type​
System.Action
LeavePvP​
Event that fires when a character is leaving PvP.
event Action LeavePvP
Event Type​
System.Action
CfPop​
Event that gets fired when a duty is ready.
event Action<RowRef<ContentFinderCondition>> CfPop
Event Type​
System.Action<Lumina.Excel.RowRef<Dalamud.Excel.Sheets.ContentFinderCondition>>