openspace.event

Functions overview

Name

Documentation

disableEvent

Disables the event with the provided identifier

enableEvent

Enables the event with the provided identifier

registeredEvents

Returns the list of registered events

registerEventAction

Registers an action to be executed whenever an event is encountered

unregisterEventAction

Unregisters a specific combination of event, action, and potentially a filter

Functions

disableEvent

Disables the event with the provided identifier.

Parameters
  • identifier Integer

Return type: void

Signature
openspace.event.disableEvent(identifier)

enableEvent

Enables the event with the provided identifier.

Parameters
  • identifier Integer

Return type: void

Signature
openspace.event.enableEvent(identifier)

registeredEvents

Returns the list of registered events.

Return type: Table[]

Signature
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.

Parameters
  • event String

  • action String

  • filter Table?

Return type: void

Signature
openspace.event.registerEventAction(event, action, filter)

unregisterEventAction

Unregisters a specific combination of event, action, and potentially a filter.

Parameters
  • event String

  • action String

  • filter Table?

Return type: void

Signature
openspace.event.unregisterEventAction(event, action, filter)