Widget API: Frame:RegisterEvent

From AddOn Studio
Revision as of 01:19, 29 August 2007 by WoWWiki>Syzgyn (fixed disambiguation)
Jump to navigation Jump to search

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

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