mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
7947b896ea
* Add interfaces to non public/sealed classes referenced in public interfaces * Fixed inheritdocs + made most classes internal * Add missing properties to IFate and Fate, fix documentation --------- Co-authored-by: goat <16760685+goaaats@users.noreply.github.com>
108 lines
2.8 KiB
C#
108 lines
2.8 KiB
C#
using Dalamud.Game.ClientState.Resolvers;
|
|
using FFXIVClientStructs.FFXIV.Client.Game.UI;
|
|
|
|
namespace Dalamud.Game.ClientState.Aetherytes;
|
|
|
|
/// <summary>
|
|
/// Class representing an aetheryte entry available to the game.
|
|
/// </summary>
|
|
internal sealed class AetheryteEntry : IAetheryteEntry
|
|
{
|
|
private readonly TeleportInfo data;
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="AetheryteEntry"/> class.
|
|
/// </summary>
|
|
/// <param name="data">Data read from the Aetheryte List.</param>
|
|
internal AetheryteEntry(TeleportInfo data)
|
|
{
|
|
this.data = data;
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public uint AetheryteId => this.data.AetheryteId;
|
|
|
|
/// <inheritdoc />
|
|
public uint TerritoryId => this.data.TerritoryId;
|
|
|
|
/// <inheritdoc />
|
|
public byte SubIndex => this.data.SubIndex;
|
|
|
|
/// <inheritdoc />
|
|
public byte Ward => this.data.Ward;
|
|
|
|
/// <inheritdoc />
|
|
public byte Plot => this.data.Plot;
|
|
|
|
/// <inheritdoc />
|
|
public uint GilCost => this.data.GilCost;
|
|
|
|
/// <inheritdoc />
|
|
public bool IsFavourite => this.data.IsFavourite != 0;
|
|
|
|
/// <inheritdoc />
|
|
public bool IsSharedHouse => this.data.IsSharedHouse;
|
|
|
|
/// <inheritdoc />
|
|
public bool IsApartment => this.data.IsApartment;
|
|
|
|
/// <inheritdoc />
|
|
public ExcelResolver<Lumina.Excel.GeneratedSheets.Aetheryte> AetheryteData => new(this.AetheryteId);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Interface representing an aetheryte entry available to the game.
|
|
/// </summary>
|
|
public interface IAetheryteEntry
|
|
{
|
|
/// <summary>
|
|
/// Gets the Aetheryte ID.
|
|
/// </summary>
|
|
uint AetheryteId { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the Territory ID.
|
|
/// </summary>
|
|
uint TerritoryId { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the SubIndex used when there can be multiple Aetherytes with the same ID (Private/Shared Estates etc.).
|
|
/// </summary>
|
|
byte SubIndex { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the Ward. Zero if not a Shared Estate.
|
|
/// </summary>
|
|
byte Ward { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the Plot. Zero if not a Shared Estate.
|
|
/// </summary>
|
|
byte Plot { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the Cost in Gil to Teleport to this location.
|
|
/// </summary>
|
|
uint GilCost { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the LocalPlayer has set this Aetheryte as Favorite or not.
|
|
/// </summary>
|
|
bool IsFavourite { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether this Aetheryte is a Shared Estate or not.
|
|
/// </summary>
|
|
bool IsSharedHouse { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether this Aetheryte is an Apartment or not.
|
|
/// </summary>
|
|
bool IsApartment { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the Aetheryte data related to this aetheryte.
|
|
/// </summary>
|
|
ExcelResolver<Lumina.Excel.GeneratedSheets.Aetheryte> AetheryteData { get; }
|
|
}
|
|
|