Ace3

API / AceEvent-3.0

AceEvent-3.0 provides event registration and secure dispatching.
All dispatching is done using CallbackHandler-1.0. AceEvent is a simple wrapper around CallbackHandler, and dispatches all game events or addon message to the registrees.

AceEvent-3.0 can be embeded into your addon, either explicitly by calling AceEvent:Embed(MyAddon) or by specifying it as an embeded library in your AceAddon. All functions will be available on your addon object and can be accessed directly, without having to explicitly call AceEvent itself.
It is recommended to embed AceEvent, otherwise you'll have to specify a custom `self` on all calls you make into AceEvent.


AceEvent:RegisterEvent(event[, callback [, arg]])

Register for a Blizzard Event.
The callback will be called with the optional `arg` as the first argument (if supplied), and the event name as the second (or first, if no arg was supplied) Any arguments to the event will be passed on after that.

Parameters

event
The event to register for
callback
The callback function to call when the event is triggered (funcref or method, defaults to a method with the event name)
arg
An optional argument to pass to the callback function


AceEvent:RegisterMessage(message[, callback [, arg]])

Register for a custom AceEvent-internal message.
The callback will be called with the optional `arg` as the first argument (if supplied), and the event name as the second (or first, if no arg was supplied) Any arguments to the event will be passed on after that.

Parameters

message
The message to register for
callback
The callback function to call when the message is triggered (funcref or method, defaults to a method with the event name)
arg
An optional argument to pass to the callback function


AceEvent:SendMessage(message, ...)

Send a message over the AceEvent-3.0 internal message system to other addons registered for this message.

Parameters

message
The message to send
...
Any arguments to the message


AceEvent:UnregisterEvent(event)

Unregister an event.

Parameters

event
The event to unregister


AceEvent:UnregisterMessage(message)

Unregister a message

Parameters

message
The message to unregister


You must login to post a comment. Don't have an account? Register to get one!

  • 1 comment
  • Avatar of zaide_chris zaide_chris Jun 02, 2011 at 03:12 UTC - 0 likes

    Is there any way a AceEvent:UnregisterAllEvents() and AceEvent:UnregisterAllMessages() Could be added?

  • 1 comment