Struct AtkUnitBasePtr

A readonly wrapper for AtkUnitBase.

Assembly: Dalamud.dll

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.

Declaration

public bool IsNull { get; }

IsReady

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

Declaration

public bool IsReady { get; }

IsVisible

Gets a value indicating whether the AtkUnitBase is visible.

Declaration

public bool IsVisible { get; }

Name

Gets the name.

Declaration

public string Name { get; }

NameSpan

Gets the name as System.ReadOnlySpan1`.

Declaration

public ReadOnlySpan<byte> NameSpan { get; }

Id

Gets the id.

Declaration

public ushort Id { get; }

ParentId

Gets the parent id.

Declaration

public ushort ParentId { get; }

HostId

Gets the host id.

Declaration

public ushort HostId { get; }

Scale

Gets the scale.

Declaration

public float Scale { get; }

X

Gets the x-position.

Declaration

public short X { get; }

Y

Gets the y-position.

Declaration

public short Y { get; }

Width

Gets the width.

Declaration

public float Width { get; }

Height

Gets the height.

Declaration

public float Height { get; }

ScaledWidth

Gets the scaled width.

Declaration

public float ScaledWidth { get; }

ScaledHeight

Gets the scaled height.

Declaration

public float ScaledHeight { get; }

Position

Gets the position.

Declaration

public Vector2 Position { get; }

Size

Gets the size.

Declaration

public Vector2 Size { get; }

ScaledSize

Gets the scaled size.

Declaration

public Vector2 ScaledSize { get; }

AtkValuesCount

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

Declaration

public int AtkValuesCount { get; }

AtkValues

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

Declaration

public IEnumerable<AtkValuePtr> AtkValues { get; }

Fields

Address

The address to the AtkUnitBase.

Declaration

public readonly nint Address

Methods

Focus()

Focuses the AtkUnitBase.

Declaration

public void Focus()

Equals(AtkUnitBasePtr)

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

Declaration

public bool Equals(AtkUnitBasePtr other)

Returns

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

Parameters

Type	Name	Description
Dalamud.Game.NativeWrapper.AtkUnitBasePtr	other	The AtkUnitBasePtr to compare with the current AtkUnitBasePtr.

Equals(object)

Declaration

public override bool Equals(object obj)

Returns

System.Boolean

Parameters

Type	Name
System.Object	obj

GetHashCode()

Declaration

public override int GetHashCode()

Returns

System.Int32

Implements

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