Skip to main content

Struct AgentInterfacePtr

A readonly wrapper for AgentInterface.

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

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

Properties​

IsNull​

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

View Source​
Declaration
public bool IsNull { get; }

Addon​

Gets a value indicating whether the agents addon is visible.

View Source​
Declaration
public AtkUnitBasePtr Addon { get; }

AddonId​

Gets a value indicating whether the agent is active.

View Source​
Declaration
public ushort AddonId { get; }

IsAgentActive​

Gets a value indicating whether the agent is active.

View Source​
Declaration
public bool IsAgentActive { get; }

IsAddonReady​

Gets a value indicating whether the agents addon is ready.

View Source​
Declaration
public bool IsAddonReady { get; }

IsAddonShown​

Gets a value indicating whether the agents addon is visible.

View Source​
Declaration
public bool IsAddonShown { get; }

Fields​

Address​

The address to the AgentInterface.

View Source​
Declaration
public readonly nint Address

Methods​

FocusAddon()​

Focuses the AtkUnitBase.

View Source​
Declaration
public bool FocusAddon()
Returns​

System.Boolean: true when the addon was focused, false otherwise.

Equals(AgentInterfacePtr)​

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

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

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

Parameters​
TypeNameDescription
Dalamud.Game.NativeWrapper.AgentInterfacePtrotherThe AgentInterfacePtr to compare with the current AgentInterfacePtr.

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.AgentInterfacePtr>