Dalamud/Dalamud/Game/ClientState/Statuses/Status.cs

using Dalamud.Data;
using Dalamud.Game.ClientState.Objects;
using Dalamud.Game.ClientState.Objects.Types;

using Lumina.Excel;

namespace Dalamud.Game.ClientState.Statuses;

/// <summary>
/// This class represents a status effect an actor is afflicted by.
/// </summary>
public unsafe class Status
{
    /// <summary>
    /// Initializes a new instance of the <see cref="Status"/> class.
    /// </summary>
    /// <param name="address">Status address.</param>
    internal Status(IntPtr address)
    {
        this.Address = address;
    }

    /// <summary>
    /// Gets the address of the status in memory.
    /// </summary>
    public IntPtr Address { get; }

    /// <summary>
    /// Gets the status ID of this status.
    /// </summary>
    public uint StatusId => this.Struct->StatusId;

    /// <summary>
    /// Gets the GameData associated with this status.
    /// </summary>
    public RowRef<Lumina.Excel.Sheets.Status> GameData => LuminaUtils.CreateRef<Lumina.Excel.Sheets.Status>(this.Struct->StatusId);

    /// <summary>
    /// Gets the parameter value of the status.
    /// </summary>
    public ushort Param => this.Struct->Param;

    /// <summary>
    /// Gets the stack count of this status.
    /// Only valid if this is a non-food status.
    /// </summary>
    [Obsolete($"Replaced with {nameof(Param)}", true)]
    public byte StackCount => (byte)this.Struct->Param;

    /// <summary>
    /// Gets the time remaining of this status.
    /// </summary>
    public float RemainingTime => this.Struct->RemainingTime;

    /// <summary>
    /// Gets the source ID of this status.
    /// </summary>
    public uint SourceId => this.Struct->SourceObject.ObjectId;

    /// <summary>
    /// Gets the source actor associated with this status.
    /// </summary>
    /// <remarks>
    /// This iterates the actor table, it should be used with care.
    /// </remarks>
    public IGameObject? SourceObject => Service<ObjectTable>.Get().SearchById(this.SourceId);

    private FFXIVClientStructs.FFXIV.Client.Game.Status* Struct => (FFXIVClientStructs.FFXIV.Client.Game.Status*)this.Address;
}