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

Enum AddonEvent

Enumeration for available AddonLifecycle events.

Assembly: Dalamud.dll​
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,FFXIVClientStructs.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.

Declaration
PreSetup = 0
See Also​

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.

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.

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.

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.

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.

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.

Declaration
PreFinalize = 6
Remarks​

This event is NOT fired when the addon is being hidden, but tends to be fired when it's being properly closed.

As this is part of the destruction process for an addon, this event does not have an associated Post event.

PreRequestedUpdate​

An event that is fired before a call to FFXIVClientStructs.FFXIV.Component.GUI.AtkUnitBase.OnRequestedUpdate(FFXIVClientStructs.FFXIV.Component.GUI.NumberArrayData**,FFXIVClientStructs.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 client-driven interactions.

Declaration
PreRequestedUpdate = 7
Examples​

A developer would use this event to intercept free company information after it's received from the server, but before it's displayed to the user. This would allow the developer to add user-driven notes or other information to the Free Company's overview.

See Also​

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.

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*,System.UInt32,FFXIVClientStructs.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.

Declaration
PreRefresh = 9
See Also​

PostRefresh​

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

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,System.Int32,FFXIVClientStructs.FFXIV.Component.GUI.AtkEvent*,FFXIVClientStructs.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.

Declaration
PreReceiveEvent = 11
See Also​

PostReceiveEvent​

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

Declaration
PostReceiveEvent = 12

PreOpen​

An event that is fired before an addon processes its open method.

Declaration
PreOpen = 13

PostOpen​

An event that is fired after an addon has processed its open method.

Declaration
PostOpen = 14

PreClose​

An even that is fired before an addon processes its Close method.

Declaration
PreClose = 15

PostClose​

An event that is fired after an addon has processed its Close method.

Declaration
PostClose = 16

PreShow​

An event that is fired before an addon processes its Show method.

Declaration
PreShow = 17

PostShow​

An event that is fired after an addon has processed its Show method.

Declaration
PostShow = 18

PreHide​

An event that is fired before an addon processes its Hide method.

Declaration
PreHide = 19

PostHide​

An event that is fired after an addon has processed its Hide method.

Declaration
PostHide = 20

PreMove​

An event that is fired before an addon processes its OnMove method. OnMove is triggered only when a move is completed.

Declaration
PreMove = 21

PostMove​

An event that is fired after an addon has processed its OnMove method. OnMove is triggered only when a move is completed.

Declaration
PostMove = 22

PreMouseOver​

An event that is fired before an addon processes its MouseOver method.

Declaration
PreMouseOver = 23

PostMouseOver​

An event that is fired after an addon has processed its MouseOver method.

Declaration
PostMouseOver = 24

PreMouseOut​

An event that is fired before an addon processes its MouseOut method.

Declaration
PreMouseOut = 25

PostMouseOut​

An event that is fired after an addon has processed its MouseOut method.

Declaration
PostMouseOut = 26

PreFocus​

An event that is fired before an addon processes its Focus method.

Declaration
PreFocus = 27
Remarks​

Be aware this is only called for certain popup windows, it is not triggered when clicking on windows.

PostFocus​

An event that is fired after an addon has processed its Focus method.

Declaration
PostFocus = 28
Remarks​

Be aware this is only called for certain popup windows, it is not triggered when clicking on windows.

PreFocusChanged​

An event that is fired before an addon processes its FocusChanged method.

Declaration
PreFocusChanged = 29

PostFocusChanged​

An event that is fired after a addon processes its FocusChanged method.

Declaration
PostFocusChanged = 30

Extension Methods​