Skip to main content

Struct AtkUnitBasePtr

A readonly wrapper for AtkUnitBase.

Assembly: Dalamud.dll​
View Source​
Declaration
public readonly struct AtkUnitBasePtr : IEquatable<AtkUnitBasePtr>

Implements:
System.IEquatable<Dalamud.Game.NativeWrapper.AtkUnitBasePtr>

Properties​

IsNull​

Gets a value indicating whether the underlying pointer is a nullptr.

View Source​
Declaration
public bool IsNull { get; }

IsReady​

Gets a value indicating whether the OnSetup function has been called.

View Source​
Declaration
public bool IsReady { get; }

IsVisible​

Gets a value indicating whether the AtkUnitBase is visible.

View Source​
Declaration
public bool IsVisible { get; }

Name​

Gets the name.

View Source​
Declaration
public string Name { get; }

Id​

Gets the id.

View Source​
Declaration
public ushort Id { get; }

ParentId​

Gets the parent id.

View Source​
Declaration
public ushort ParentId { get; }

HostId​

Gets the host id.

View Source​
Declaration
public ushort HostId { get; }

Scale​

Gets the scale.

View Source​
Declaration
public float Scale { get; }

X​

Gets the x-position.

View Source​
Declaration
public short X { get; }

Y​

Gets the y-position.

View Source​
Declaration
public short Y { get; }

Width​

Gets the width.

View Source​
Declaration
public float Width { get; }

Height​

Gets the height.

View Source​
Declaration
public float Height { get; }

ScaledWidth​

Gets the scaled width.

View Source​
Declaration
public float ScaledWidth { get; }

ScaledHeight​

Gets the scaled height.

View Source​
Declaration
public float ScaledHeight { get; }

Position​

Gets the position.

View Source​
Declaration
public Vector2 Position { get; }

Size​

Gets the size.

View Source​
Declaration
public Vector2 Size { get; }

ScaledSize​

Gets the scaled size.

View Source​
Declaration
public Vector2 ScaledSize { get; }

AtkValuesCount​

Gets the number of FFXIVClientStructs.FFXIV.Component.GUI.AtkValue entries.

View Source​
Declaration
public int AtkValuesCount { get; }

AtkValues​

Gets an enumerable collection of Dalamud.Game.NativeWrapper.AtkValuePtr of the addons current AtkValues.

View Source​
Declaration
public IEnumerable<AtkValuePtr> AtkValues { get; }

Fields​

Address​

The address to the AtkUnitBase.

View Source​
Declaration
public readonly nint Address

Methods​

Focus()​

Focuses the AtkUnitBase.

View Source​
Declaration
public void Focus()

Equals(AtkUnitBasePtr)​

Determines whether the specified AtkUnitBasePtr is equal to the current AtkUnitBasePtr.

View Source​
Declaration
public bool Equals(AtkUnitBasePtr other)
Returns​

System.Boolean: true if the specified AtkUnitBasePtr is equal to the current AtkUnitBasePtr; otherwise, false.

Parameters​
TypeNameDescription
Dalamud.Game.NativeWrapper.AtkUnitBasePtrotherThe AtkUnitBasePtr to compare with the current AtkUnitBasePtr.

Equals(object)​

Determines whether the specified object is equal to the current object.

View Source​
Declaration
public override bool Equals(object obj)
Returns​

System.Boolean: true if the specified object is equal to the current object; otherwise, false.

Parameters​
TypeNameDescription
System.ObjectobjThe object to compare with the current object.

GetHashCode()​

Serves as the default hash function.

View Source​
Declaration
public override int GetHashCode()
Returns​

System.Int32: A hash code for the current object.

Implements​

  • System.IEquatable<Dalamud.Game.NativeWrapper.AtkUnitBasePtr>