WildStar:UI Event: Difference between revisions

Created page with "{{../uievent}} :''Were you looking for the list of [[../API events/]]?'' This is the main WS event reference. Events are a basic message passing system which are received by ..."
(Created page with "{{uievent}} Events are a basic and important message passing system for WildStar client and its UI. The Event API and the WS UI are built around these messages being recei...")
 
(Created page with "{{../uievent}} :''Were you looking for the list of [[../API events/]]?'' This is the main WS event reference. Events are a basic message passing system which are received by ...")
Line 1: Line 1:
{{uievent}}
{{--|uievent}}
:''Were you looking for the list of [[API events]]?''
:''Were you looking for the list of [[../API events/]]?''


This is the main WS event reference. Events are a basic message passing system which are received by ''event handlers'' as Lua table and function. Many require registration in Lua.
This is the main WS event reference. Events are a basic message passing system which are received by ''event handlers'' as Lua table and function. Many require registration in Lua.
Line 8: Line 8:


== Registration ==
== Registration ==
You can register any other table and function to receive an event using the {{api||Apollo|RegisterEventHandler}}(sEventName, sFuncName, tHandler) function. When the events occur they will be delivered to that script handler.
You can register any other table and function to receive an event using the {{--|api||Apollo|RegisterEventHandler}}(sEventName, sFuncName, tHandler) function. When the events occur they will be delivered to that script handler.


== Removal ==  
== Removal ==  
To unregister an event handler, use {{api||Apollo|RemoveEventHandler}}(sEventName, tHandler).
To unregister an event handler, use {{--|api||Apollo|RemoveEventHandler}}(sEventName, tHandler).


== Performance ==
== Performance ==
Line 17: Line 17:


== See also ==
== See also ==
* [[Handling events]] - setting up event handling for an AddOn
* [[../Handling events/]] - setting up event handling for an AddOn
* [[Registering events]] - how to create new events for use by AddOns
* [[../Registering events/]] - how to create new events for use by AddOns
* [[Parsing event messages]] - extracting information from event's parameters
* [[../Parsing event messages/]] - extracting information from event's parameters
* [[UI AddOn]]
* [[../UI AddOn/]]