WoW:API Frame RegisterEvent: Difference between revisions
Jump to navigation
Jump to search
(remove handler argument (it doesn't exist)) |
m (Move page script moved page API Frame RegisterEvent to API Frame RegisterEvent without leaving a redirect) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{widgetmethod}} | {{widgetmethod}} | ||
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. The last frame to register for an event is the last one to receive it. | ||
obj:RegisterEvent(''event''); | obj:RegisterEvent(''event''); | ||
| Line 8: | Line 8: | ||
;''Arguments'' | ;''Arguments'' | ||
; 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 (API)]] | ||
---- | ---- | ||
| Line 26: | Line 26: | ||
: Registers which events an object is monitoring. | : Registers which events an object is monitoring. | ||
: See also: [[API Frame UnregisterEvent|obj:UnregisterEvent]] | |||
Latest revision as of 04:45, 15 August 2023
← 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. The last frame to register for an event is the last one to receive it.
obj:RegisterEvent(event);
- Arguments
- event
- The name of the event to register the object as monitoring. See Events (API)
- 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.
- See also: obj:UnregisterEvent