ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Improve wording

Browse source
This commit is contained in:
Haselnussbomber 2025-10-05 14:37:11 +02:00
parent 8cac486249
commit c2fc04c3a8
No known key found for this signature in database
GPG key ID: BB905BB49E7295D1
2 changed files with 12 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Dalamud/Plugin/Services/IClientState.cs
View file

@ -109,7 +109,7 @@ public interface IClientState
/// <summary>
/// Gets the local player character, if one is present.
/// </summary>
[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; }
/// <summary>

21
Dalamud/Plugin/Services/IPlayerState.cs
View file

@ -8,15 +8,16 @@ namespace Dalamud.Plugin.Services;
#pragma warning disable SA1400 // Access modifier should be declared: Interface members are public by default
/// <summary>
/// Interface for determining unlock state of various content in the game.
/// Interface for determining the players state.
/// </summary>
public interface IPlayerState
{
/// <summary>
/// Gets a value indicating whether the local character is loaded.
/// Gets a value indicating whether the local players data is loaded.
/// </summary>
/// <remarks>
/// The actual GameObject will not immediately exist when this changes to true.
/// PlayerState is separate from <see cref="IObjectTable.LocalPlayer"/>,
/// and as such the game object might not exist when it's loaded.
/// </remarks>
bool IsLoaded { get; }
@ -141,37 +142,37 @@ public interface IPlayerState
RowRef<GrandCompany> GrandCompany { get; }
/// <summary>
/// Gets the Aetheryte row for the local character's home aetheryte.
/// Gets the Aetheryte row for the local player's home aetheryte.
/// </summary>
RowRef<Aetheryte> HomeAetheryte { get; }
/// <summary>
/// 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.
/// </summary>
ReadOnlySpan<RowRef<Aetheryte>> FavouriteAetherytes { get; }
/// <summary>
/// Gets the Aetheryte row for the local character's free aetheryte.
/// Gets the Aetheryte row for the local player's free aetheryte.
/// </summary>
RowRef<Aetheryte> FreeAetheryte { get; }
/// <summary>
/// Gets the amount of received player commendations of the local character.
/// Gets the amount of received player commendations of the local player.
/// </summary>
uint BaseRestedExperience { get; }
/// <summary>
/// Gets the amount of received player commendations of the local character.
/// Gets the amount of received player commendations of the local player.
/// </summary>
short PlayerCommendations { get; }
/// <summary>
/// Gets the Carrier Level of Delivery Moogle Quests of the local character.
/// Gets the Carrier Level of Delivery Moogle Quests of the local player.
/// </summary>
byte DeliveryLevel { get; }
/// <summary>
/// Gets the mentor version of the local character.
/// Gets the mentor version of the local player.
/// </summary>
MentorVersion MentorVersion { get; }