Struct AtkValuePtr
A readonly wrapper for AtkValue.
Assembly: Dalamud.dll
View Source
public readonly struct AtkValuePtr : IEquatable<AtkValuePtr>
Implements:
System.IEquatable<Dalamud.Game.NativeWrapper.AtkValuePtr>
Properties
IsNull
Gets a value indicating whether the underlying pointer is a nullptr.
View Source
public bool IsNull { get; }
ValueType
Gets the value type.
View Source
public AtkValueType ValueType { get; }
Fields
Address
The address to the AtkValue.
View Source
public readonly nint Address
Methods
GetValue()
Gets the value of the underlying FFXIVClientStructs.FFXIV.Component.GUI.AtkValue as a boxed object, based on its Dalamud.Game.NativeWrapper.AtkValueType.
View Source
public object? GetValue()
Returns
System.Object: The boxed value represented by this Dalamud.Game.NativeWrapper.AtkValuePtr, or null if the value is null or undefined.
Exceptions
System.NotImplementedException
Thrown if the value type is not currently handled by this implementation.
TryGet<T>(out T?)
Attempts to retrieve the value as a strongly-typed object if the underlying type matches.
View Source
public bool TryGet<T>(out T? result) where T : struct
Returns
System.Boolean: true if the value was successfully extracted and matched <code class="typeparamref">T</code>; otherwise, false.
Parameters
| Type | Name | Description |
|---|---|---|
System.Nullable<<T>> | result | When this method returns true, contains the extracted value of type <code class="typeparamref">T</code>. |
| Otherwise, contains the default value of type <code class="typeparamref">T</code>. |
Type Parameters
| Name | Description |
|---|---|
T | The expected value type to extract. |
Equals(AtkValuePtr)
Determines whether the specified AtkValuePtr is equal to the current AtkValuePtr.
View Source
public bool Equals(AtkValuePtr other)
Returns
System.Boolean: true if the specified AtkValuePtr is equal to the current AtkValuePtr; otherwise, false.
Parameters
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.NativeWrapper.AtkValuePtr | other | The AtkValuePtr to compare with the current AtkValuePtr. |
Equals(object)
Determines whether the specified object is equal to the current object.
View Source
public override bool Equals(object obj)
Returns
System.Boolean: true if the specified object is equal to the current object; otherwise, false.
Parameters
| Type | Name | Description |
|---|---|---|
System.Object | obj | The object to compare with the current object. |
GetHashCode()
Serves as the default hash function.
View Source
public override int GetHashCode()
Returns
System.Int32: A hash code for the current object.
Implements
System.IEquatable<Dalamud.Game.NativeWrapper.AtkValuePtr>