WoW:API Frame RegisterEvent: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Changing Aerobrain to Omnigrok (user switched handles))
({{widgetmethod}})
Line 1: Line 1:
{{widgetmethod}}
  <center>'''RegisterEvent''' ''-Documentation by [[User:Omnigrok|Omnigrok]]-''</center>
  <center>'''RegisterEvent''' ''-Documentation by [[User:Omnigrok|Omnigrok]]-''</center>


Line 26: Line 28:


: Registers which events an object is monitoring.
: Registers which events an object is monitoring.
----
{{WoW API}}

Revision as of 11:58, 10 June 2006

Widget API ← Frame < RegisterEvent

RegisterEvent -Documentation by Omnigrok-

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);

Arguments
event
The name of the event to register the object as monitoring. See Events

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.