Class AddonArgs

Base class for AddonLifecycle AddonArgTypes.

Assembly: Dalamud.dll

Declaration

public class AddonArgs

Derived:
Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonCloseArgs, Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonFocusChangedArgs, Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonHideArgs, Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonReceiveEventArgs, Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonRefreshArgs, Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonRequestedUpdateArgs, Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonSetupArgs, Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonShowArgs

Properties

InvalidAddonNameSpan

Gets the string representing the name of an addon that is invalid.

Declaration

[Obsolete("AddonName can never be null or invalid. This check is unnecessary.")]
public static ReadOnlySpan<byte> InvalidAddonNameSpan { get; }

AddonName

Gets the name of the addon this args referrers to.

Declaration

public string AddonName { get; }

AddonNameSpan

Gets the name of the addon this args referrers to.

Declaration

public ReadOnlySpan<byte> AddonNameSpan { get; }

Addon

Gets the pointer to the addons AtkUnitBase.

Declaration

public AtkUnitBasePtr Addon { get; }

Type

Gets the type of these args.

Declaration

public virtual AddonArgsType Type { get; }

PreventOriginalRequested

Gets a value indicating whether original is being requested to be skipped.

Declaration

public bool PreventOriginalRequested { get; }

Fields

InvalidAddonName

Constant string representing the name of an addon that is invalid.

Declaration

[Obsolete("AddonName can never be null or invalid. This check is unnecessary.")]
public const string InvalidAddonName = "NullAddon"

Methods

PreventOriginal()

Request that the call to original is skipped. Only valid to be called from a Pre event listener not a Post event listener.

Declaration

public void PreventOriginal()

GetAddonPointer<T>()

Gets the typed pointer to the addons AtkUnitBase*.

Declaration

public T* GetAddonPointer<T>() where T : unmanaged

Returns

<T>*: Typed pointer to contained addons AtkUnitBase.

Type Parameters

Name	Description
T	AtkUnitBase.