Scaleform Studio Lua API Reference: scaleform.EventDispatcher object reference
scaleform.EventDispatcher object reference
Description
The base object for managing event listeners and dispatching events to the listeners.
Inheritance 
Other related reference items
Related help topics
Functions
Parameters
Returns
self : |
The dispatcher whose event is considered. | |
eventType : |
The Id of the event. | |
listener : |
The event listener added for the event. |
boolean |
Returns true if the event listener is added and false otherwise. |
Parameters
Returns
self : |
The dispatcher whose event is dispatched for. | |
event : |
The event to dispatch. |
boolean |
Returns true if the event was handled and false otherwise. |
Parameters
Returns
self : |
The dispatcher to disconnect all event listeners connected to. |
| This function does not return any values. |
Parameters
Returns
self : |
The dispatcher the listener is connected to. | |
eventType : |
The Id of the event. | |
listener : |
The listener that is to be removed. |
boolean |
Returns true if the event listener is removed and false otherwise. |
scaleform.AccelerometerDispatches events based on activity detected by the device's motion sensor.
scaleform.ActorGeneric objects located in a scene.
scaleform.FMODSoundA Sound object for audio.
scaleform.GeolocationDispatches events in response to the device's location sensor.
scaleform.physics.WorldManages all physics entities, dynamic simulation, and asynchronous queries.
scaleform.SoundA Sound object for playing audio through Wwise Wwise is only available if Scaleform Studio is compiled with it enabled (by default it is enabled).
scaleform.TimerBaseAn interface to timer objects.
scaleform.TimerRepresents a timer.
scaleform.TweenerA Lua interface to Tweener.
scaleform.EventListener.connect (listener, dispatcher, event) : booleanConnects the event listener to stage events of the input type.
scaleform.EventListener.disconnect (listener, dispatcher) : booleanDisconnects all connections from the dispatcher type that listener has.
scaleform.EventListener.disconnect (listener, dispatcher, event) : booleanDisconnects a single connection of a given event type to a dispatcher the listener has.
scaleform.EventDispatcher.add_event_listener (self, eventType, listener) : booleanAdd event listener for the dispatcher.
self : scaleform.EventDispatcherThe dispatcher whose event is considered.
eventType : scaleform.EventTypesThe Id of the event.
listener : scaleform.EventListenerThe event listener added for the event.
boolean scaleform.EventDispatcherThe base object for managing event listeners and dispatching events to the listeners.
scaleform.EventTypesThe list of events.
scaleform.EventListenerThe EventListener type. true or false.
scaleform.EventDispatcher.dispatch_event (self, event) : booleanDispatches an event to registered listeners.
self : scaleform.EventDispatcherThe dispatcher whose event is dispatched for.
event : scaleform.EventThe event to dispatch.
boolean
scaleform.Event{ currentTarget : scaleform.Actor?, eventId : scaleform.EventTypes, phase : string, target : scaleform.Actor?, }
scaleform.EventDispatcher.remove_all_event_listeners (self) Removes the event listener of the dispatcher.
self : scaleform.EventDispatcherThe dispatcher to disconnect all event listeners connected to.
scaleform.EventDispatcher.remove_event_listener (self, eventType, listener) : booleanRemoves the event listener of the dispatcher.
self : scaleform.EventDispatcherThe dispatcher the listener is connected to.
eventType : scaleform.EventTypesThe Id of the event.
listener : scaleform.EventListenerThe listener that is to be removed.
boolean scaleform.EventDispatcher.remove_event_listener_all_events (self, listener) : booleanRemoves the event listener of the dispatcher for all event types
self : scaleform.EventDispatcherThe dispatcher the listener is connected to.
listener : scaleform.EventListenerThe listener that is to be removed.
boolean listener : scaleform.EventListenerThe listener to connect
dispatcher : scaleform.EventDispatcherThe dispatcher for the particular event, different objects dispatch different events.
event : scaleform.EventTypesThe event type to receive.
boolean listener : scaleform.EventListenerThe listener to disconnect.
dispatcher : scaleform.EventDispatcherThe dispatcher the listener is connected to.
boolean listener : scaleform.EventListenerThe listener to disconnect.
dispatcher : scaleform.EventDispatcherThe dispatcher the listener is connected to.
event : scaleform.EventTypesThe type of event to stop listening for.
booleanA string of characters.Indicates a table. This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.