diff --git a/Dalamud/Plugin/Services/IClientState.cs b/Dalamud/Plugin/Services/IClientState.cs index de0c5dad8..36bf2e296 100644 --- a/Dalamud/Plugin/Services/IClientState.cs +++ b/Dalamud/Plugin/Services/IClientState.cs @@ -109,7 +109,7 @@ public interface IClientState /// /// Gets the local player character, if one is present. /// - [Obsolete($"Use {nameof(IPlayerState)} or {nameof(IObjectTable)}.{nameof(IObjectTable.LocalPlayer)} if you need to.")] + [Obsolete($"Use {nameof(IPlayerState)} or {nameof(IObjectTable)}.{nameof(IObjectTable.LocalPlayer)} if necessary.")] public IPlayerCharacter? LocalPlayer { get; } /// diff --git a/Dalamud/Plugin/Services/IPlayerState.cs b/Dalamud/Plugin/Services/IPlayerState.cs index dc507e461..a119f231b 100644 --- a/Dalamud/Plugin/Services/IPlayerState.cs +++ b/Dalamud/Plugin/Services/IPlayerState.cs @@ -8,15 +8,16 @@ namespace Dalamud.Plugin.Services; #pragma warning disable SA1400 // Access modifier should be declared: Interface members are public by default /// -/// Interface for determining unlock state of various content in the game. +/// Interface for determining the players state. /// public interface IPlayerState { /// - /// Gets a value indicating whether the local character is loaded. + /// Gets a value indicating whether the local players data is loaded. /// /// - /// The actual GameObject will not immediately exist when this changes to true. + /// PlayerState is separate from , + /// and as such the game object might not exist when it's loaded. /// bool IsLoaded { get; } @@ -141,37 +142,37 @@ public interface IPlayerState RowRef GrandCompany { get; } /// - /// Gets the Aetheryte row for the local character's home aetheryte. + /// Gets the Aetheryte row for the local player's home aetheryte. /// RowRef HomeAetheryte { get; } /// - /// Gets a span of Aetheryte rows for the local character's favourite aetherytes. + /// Gets a span of Aetheryte rows for the local player's favourite aetherytes. /// ReadOnlySpan> FavouriteAetherytes { get; } /// - /// Gets the Aetheryte row for the local character's free aetheryte. + /// Gets the Aetheryte row for the local player's free aetheryte. /// RowRef FreeAetheryte { get; } /// - /// Gets the amount of received player commendations of the local character. + /// Gets the amount of received player commendations of the local player. /// uint BaseRestedExperience { get; } /// - /// Gets the amount of received player commendations of the local character. + /// Gets the amount of received player commendations of the local player. /// short PlayerCommendations { get; } /// - /// Gets the Carrier Level of Delivery Moogle Quests of the local character. + /// Gets the Carrier Level of Delivery Moogle Quests of the local player. /// byte DeliveryLevel { get; } /// - /// Gets the mentor version of the local character. + /// Gets the mentor version of the local player. /// MentorVersion MentorVersion { get; }