Interface IAddonEventManager
Service provider for addon event management.
Assembly: Dalamud.dll
View Source
Declaration
public interface IAddonEventManager
Methods
AddEvent(nint, nint, AddonEventType, AddonEventHandler)
Registers an event handler for the specified addon, node, and type.
View Source
Declaration
[Obsolete("Use AddEvent with AddonEventDelegate instead of AddonEventHandler")]
IAddonEventHandle? AddEvent(nint atkUnitBase, nint atkResNode, AddonEventType eventType, IAddonEventManager.AddonEventHandler eventHandler)
Returns
Dalamud.Game.Addon.Events.IAddonEventHandle: IAddonEventHandle used to remove the event. Null if no event was added.
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | atkUnitBase | The parent addon for this event. |
System.IntPtr | atkResNode | The node that will trigger this event. |
Dalamud.Game.Addon.Events.AddonEventType | eventType | The event type for this event. |
Dalamud.Plugin.Services.IAddonEventManager.AddonEventHandler | eventHandler | The handler to call when event is triggered. |
AddEvent(nint, nint, AddonEventType, AddonEventDelegate)
Registers an event handler for the specified addon, node, and type.
View Source
Declaration
IAddonEventHandle? AddEvent(nint atkUnitBase, nint atkResNode, AddonEventType eventType, IAddonEventManager.AddonEventDelegate eventDelegate)
Returns
Dalamud.Game.Addon.Events.IAddonEventHandle: IAddonEventHandle used to remove the event. Null if no event was added.
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | atkUnitBase | The parent addon for this event. |
System.IntPtr | atkResNode | The node that will trigger this event. |
Dalamud.Game.Addon.Events.AddonEventType | eventType | The event type for this event. |
Dalamud.Plugin.Services.IAddonEventManager.AddonEventDelegate | eventDelegate | The handler to call when event is triggered. |
RemoveEvent(IAddonEventHandle)
Unregisters an event handler with the specified event id and event type.
View Source
Declaration
void RemoveEvent(IAddonEventHandle eventHandle)
Parameters
Type | Name | Description |
---|---|---|
Dalamud.Game.Addon.Events.IAddonEventHandle | eventHandle | Unique handle identifying this event. |
SetCursor(AddonCursorType)
Force the game cursor to be the specified cursor.
View Source
Declaration
void SetCursor(AddonCursorType cursor)
Parameters
Type | Name | Description |
---|---|---|
Dalamud.Game.Addon.Events.AddonCursorType | cursor | Which cursor to use. |
ResetCursor()
Un-forces the game cursor.
View Source
Declaration
void ResetCursor()