Skip to main content
Version: 13.x (API 13) [Current]

Enum AddonEvent

Enumeration for available AddonLifecycle events.

Assembly: Dalamud.dll​
View Source​
Declaration
public enum AddonEvent

Fields​

PreSetup​

An event that is fired prior to an addon being setup with its implementation of FFXIVClientStructs.FFXIV.Component.GUI.AtkUnitBase.OnSetup(System.UInt32%2cFFXIVClientStructs.FFXIV.Component.GUI.AtkValue*). This event is useful for modifying the initial data contained within Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonSetupArgs.AtkValueSpan prior to the addon being created.

View Source​
Declaration
PreSetup = 0

PostSetup​

An event that is fired after an addon has finished its initial setup. This event is particularly useful for developers seeking to add custom elements to now-initialized and populated node lists, as well as reading data placed in the AtkValues by the game during the setup process. See Dalamud.Game.Addon.Lifecycle.AddonEvent.PreSetup for more information.

View Source​
Declaration
PostSetup = 1

PreUpdate​

An event that is fired before an addon begins its update cycle via FFXIVClientStructs.FFXIV.Component.GUI.AtkUnitBase.Update(System.Single). This event is fired every frame that an addon is loaded, regardless of visibility.

View Source​
Declaration
PreUpdate = 2

PostUpdate​

An event that is fired after an addon has finished its update. See Dalamud.Game.Addon.Lifecycle.AddonEvent.PreUpdate for more information.

View Source​
Declaration
PostUpdate = 3

PreDraw​

An event that is fired before an addon begins drawing to screen via FFXIVClientStructs.FFXIV.Component.GUI.AtkUnitBase.Draw. Unlike Dalamud.Game.Addon.Lifecycle.AddonEvent.PreUpdate, this event is only fired if an addon is visible or otherwise drawing to screen.

View Source​
Declaration
PreDraw = 4

PostDraw​

An event that is fired after an addon has finished its draw to screen. See Dalamud.Game.Addon.Lifecycle.AddonEvent.PreDraw for more information.

View Source​
Declaration
PostDraw = 5

PreFinalize​

An event that is fired immediately before an addon is finalized via FFXIVClientStructs.FFXIV.Component.GUI.AtkUnitBase.Finalizer and destroyed. After this event, the addon will destruct its UI node data as well as free any allocated memory. This event can be used for cleanup and tracking tasks.

View Source​
Declaration
PreFinalize = 6

PreRequestedUpdate​

An event that is fired before a call to FFXIVClientStructs.FFXIV.Component.GUI.AtkUnitBase.OnRequestedUpdate(FFXIVClientStructs.FFXIV.Component.GUI.NumberArrayData**%2cFFXIVClientStructs.FFXIV.Component.GUI.StringArrayData**) is made in response to a change in the subscribed Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonRequestedUpdateArgs.NumberArrayData or Dalamud.Game.Addon.Lifecycle.AddonArgTypes.AddonRequestedUpdateArgs.StringArrayData backing this addon. This generally occurs in response to receiving data from the game server, but can happen in other cases as well. This event is useful for modifying the data received before it's passed to the UI for display. Contrast to Dalamud.Game.Addon.Lifecycle.AddonEvent.PreRefresh which tends to be in response to <em>client-driven</em> interactions.

View Source​
Declaration
PreRequestedUpdate = 7

PostRequestedUpdate​

An event that is fired after an addon has finished processing an ArrayData update. See Dalamud.Game.Addon.Lifecycle.AddonEvent.PreRequestedUpdate for more information.

View Source​
Declaration
PostRequestedUpdate = 8

PreRefresh​

An event that is fired before an addon calls its FFXIVClientStructs.FFXIV.Component.GUI.AtkUnitManager.RefreshAddon(FFXIVClientStructs.FFXIV.Component.GUI.AtkUnitBase*%2cSystem.UInt32%2cFFXIVClientStructs.FFXIV.Component.GUI.AtkValue*) method. Refreshes are generally triggered in response to certain user interactions such as changing tabs, and are primarily used to update the AtkValues present in this addon. Contrast to Dalamud.Game.Addon.Lifecycle.AddonEvent.PreRequestedUpdate which is called in response to ArrayData updates.

View Source​
Declaration
PreRefresh = 9

PostRefresh​

An event that is fired after an addon has finished its refresh. See Dalamud.Game.Addon.Lifecycle.AddonEvent.PreRefresh for more information.

View Source​
Declaration
PostRefresh = 10

PreReceiveEvent​

An event that is fired before an addon begins processing a user-driven event via FFXIVClientStructs.FFXIV.Component.GUI.AtkEventListener.ReceiveEvent(FFXIVClientStructs.FFXIV.Component.GUI.AtkEventType%2cSystem.Int32%2cFFXIVClientStructs.FFXIV.Component.GUI.AtkEvent*%2cFFXIVClientStructs.FFXIV.Component.GUI.AtkEventData*), such as mousing over an element or clicking a button. This event is only valid for addons that actually override the ReceiveEvent method of the underlying AtkEventListener.

View Source​
Declaration
PreReceiveEvent = 11

PostReceiveEvent​

An event that is fired after an addon finishes calling its FFXIVClientStructs.FFXIV.Component.GUI.AtkEventListener.ReceiveEvent(FFXIVClientStructs.FFXIV.Component.GUI.AtkEventType%2cSystem.Int32%2cFFXIVClientStructs.FFXIV.Component.GUI.AtkEvent*%2cFFXIVClientStructs.FFXIV.Component.GUI.AtkEventData*) method. See Dalamud.Game.Addon.Lifecycle.AddonEvent.PreReceiveEvent for more information.

View Source​
Declaration
PostReceiveEvent = 12

Extension Methods​