WoW:API Frame RegisterEvent: Difference between revisions
Jump to navigation
Jump to search
RegisterEvent -Documentation by Omnigrok-
({{widgetmethod}}) |
(Added optional argument info) |
||
| Line 5: | Line 5: | ||
Registers which events the object would like to monitor. This ensures the code placed in the <OnEvent> section is not called for any unneccessary events such as an incoming chat message when your addon is only looking to perform actions based upon the start of casting a spell. | Registers which events the object would like to monitor. This ensures the code placed in the <OnEvent> section is not called for any unneccessary events such as an incoming chat message when your addon is only looking to perform actions based upon the start of casting a spell. | ||
obj:RegisterEvent(''event''); | obj:RegisterEvent(''event''[, ''handler'']); | ||
---- | ---- | ||
| Line 11: | Line 11: | ||
; event : The name of the event to register the object as monitoring. See [[Events]] | ; event : The name of the event to register the object as monitoring. See [[Events]] | ||
; handler : Optional. The name of the function to call when the event fires. If this argument is provided, the code in the <OnEvent> tag will not be called, and this function will be called instead. Event arguments, if they exist, will be passed to the function as parameters. | |||
---- | ---- | ||
Revision as of 00:48, 5 July 2006
← Widget API ← Frame < RegisterEvent
Registers which events the object would like to monitor. This ensures the code placed in the <OnEvent> section is not called for any unneccessary events such as an incoming chat message when your addon is only looking to perform actions based upon the start of casting a spell.
obj:RegisterEvent(event[, handler]);
- Arguments
- event
- The name of the event to register the object as monitoring. See Events
- handler
- Optional. The name of the function to call when the event fires. If this argument is provided, the code in the <OnEvent> tag will not be called, and this function will be called instead. Event arguments, if they exist, will be passed to the function as parameters.
- Returns
- nil
- Example
myChatAddon:RegisterEvent("CHAT_MSG");
- Result
- You could now add code to the <OnEvent> section of your addon, and anytime a chat message was received it would execute your code.
- Description
- Registers which events an object is monitoring.