Skip to main content
Version: 14.x (API 14) [Legacy]

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​

AddonName​

Gets the name of the addon this args referrers to.

Declaration
public string AddonName { 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​

InvalidAddon​

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

Declaration
public const string InvalidAddon = "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()