diff --git a/Dalamud/Game/ClientState/Aetherytes/AetheryteEntry.cs b/Dalamud/Game/ClientState/Aetherytes/AetheryteEntry.cs
index 59e78831f..3020c6ba0 100644
--- a/Dalamud/Game/ClientState/Aetherytes/AetheryteEntry.cs
+++ b/Dalamud/Game/ClientState/Aetherytes/AetheryteEntry.cs
@@ -3,33 +3,70 @@ using FFXIVClientStructs.FFXIV.Client.Game.UI;
namespace Dalamud.Game.ClientState.Aetherytes
{
- public class AetheryteEntry
+ ///
+ /// This class represents an entry in the Aetheryte list.
+ ///
+ public sealed class AetheryteEntry
{
private readonly TeleportInfo data;
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// Data read from the Aetheryte List.
internal AetheryteEntry(TeleportInfo data)
{
this.data = data;
}
+ ///
+ ///Gets the Aetheryte ID.
+ ///
public uint AetheryteId => this.data.AetheryteId;
+ ///
+ ///Gets the Territory ID.
+ ///
public uint TerritoryId => this.data.TerritoryId;
+ ///
+ ///Gets the SubIndex used when there can be multiple Aetherytes with the same ID (Private/Shared Estates etc.).
+ ///
public byte SubIndex => this.data.SubIndex;
+ ///
+ ///Gets the Ward. Zero if not a Shared Estate.
+ ///
public byte Ward => this.data.Ward;
+ ///
+ ///Gets the Plot. Zero if not a Shared Estate.
+ ///
public byte Plot => this.data.Plot;
+ ///
+ ///Gets the Cost in Gil to Teleport to this location.
+ ///
public uint GilCost => this.data.GilCost;
+ ///
+ ///Gets if the LocalPlayer has set this Aetheryte as Favorite.
+ ///
public bool IsFavourite => this.data.IsFavourite != 0;
-
+
+ ///
+ ///Gets if this Aetheryte is a Shared Estate.
+ ///
public bool IsSharedHouse => this.data.IsSharedHouse;
+ ///
+ ///Gets if this Aetheryte is an Appartment.
+ ///
public bool IsAppartment => this.data.IsAppartment;
+ ///
+ /// Gets the Aetheryte data related to this aetheryte.
+ ///
public ExcelResolver AetheryteData => new(this.AetheryteId);
}
}