WildStar:UI Event: Difference between revisions
m (Bear moved page //UI Event to UI Event without leaving a redirect) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{ | {{\|uievent}} | ||
:''Were you looking for the list of [[ | :''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 {{ | 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 {{ | 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 | ||
* [[ | * [[\Registering events]] - how to create new events for use by AddOns | ||
* [[ | * [[\Parsing event messages]] - extracting information from event's parameters | ||
* [[ | * [[\UI AddOn]] | ||
Revision as of 17:36, 10 August 2023
- 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.
Startup
During start-up the OnLoad event fires for an AddOn during load, allowing it register for further event and timer messages.
Registration
You can register any other table and function to receive an event using the Apollo.RegisterEventHandler(sEventName, sFuncName, tHandler) function. When the events occur they will be delivered to that script handler.
Removal
To unregister an event handler, use Apollo.RemoveEventHandler(sEventName, tHandler).
Performance
The WildStar interface is nearly entirely event driven, and all interface code is invoked in response to an event. Script execution must be completed before a frame is rendered; therefore, event processing code that takes too long or contains an infinite loop can drastically degrade the client visibly.
See also
- Handling events - setting up event handling for an AddOn
- Registering events - how to create new events for use by AddOns
- Parsing event messages - extracting information from event's parameters
- UI AddOn