openspace.event
Functions overview
Name |
Documentation |
---|---|
Disables the event with the provided identifier |
|
Enables the event with the provided identifier |
|
Returns the list of registered events |
|
Registers an action to be executed whenever an event is encountered |
|
Unregisters a specific combination of event, action, and potentially a filter |
Functions
disableEvent
Disables the event with the provided identifier.
identifier
Integer
Return type: void
openspace.event.disableEvent(identifier)
enableEvent
Enables the event with the provided identifier.
identifier
Integer
Return type: void
openspace.event.enableEvent(identifier)
registeredEvents
Returns the list of registered events.
Return type: Table[]
openspace.event.registeredEvents()
registerEventAction
Registers an action to be executed whenever an event is encountered. If the optional third parameter is provided, it describes a filter that the event is being checked against and only if it passes the filter, the action is triggered.
event
String
action
String
filter
Table?
Return type: void
openspace.event.registerEventAction(event, action, filter)
unregisterEventAction
Unregisters a specific combination of event, action, and potentially a filter.
event
String
action
String
filter
Table?
Return type: void
openspace.event.unregisterEventAction(event, action, filter)