Scaleform Studio Lua API Reference: scaleform.Event table reference
scaleform.Event table reference
scaleform.AccelerometerEventThe event parameters for AccelerometerUpdate event.
{ accelerationX : number, accelerationY : number, accelerationZ : number, timestamp : number, }
scaleform.AppLifecycleEventThe event parameters for AppLifecycle event.
{ status : string, }
scaleform.CharEventThe event parameters for Char event.
{ keyboardIndex : integer, wcharCode : integer, }
scaleform.ContactEventThe event parameters for Contact events.
{ childIndexA : integer, childIndexB : integer, fixtureA : scaleform.physics.Fixture, fixtureB : scaleform.physics.Fixture, friction : number, isEnabled : boolean, isTouching : boolean, restitution : number, }
scaleform.ContactPostEventThe event parameters for ContactPostSolve event.
{ count : integer, normalImpulse1 : number, normalImpulse2 : number, }
scaleform.CustomEventThe event parameters for Custom event.
{ data : table, name : string, }
scaleform.GamePadAnalogChangeEventThe event parameters for GamePadAnalogChange event.
{ analogControl : scaleform.AnalogControls, analogX : number, analogY : number, controllerIndex : integer, }
scaleform.GamePadButtonChangeEventThe event parameters for GamePadButtonChange event.
{ button : scaleform.Buttons, controllerIndex : integer, pressed : boolean, }
scaleform.GeolocationEventThe event parameters for GeolocationUpdate event.
{ altitude : number, hAccuracy : number, heading : number, latitude : number, longitude : number, speed : number, timeStamp : number, vAccuracy : number, }
scaleform.GestureEventThe event parameters for GestureBegin, GestureEnd, GestureUpdate, GestureAll event.
{ gesture : string, offsetX : number, offsetY : number, rotation : number, scaleX : number, scaleY : number, x : number, y : number, }
scaleform.KeyEventThe event parameters for KeyDown and KeyUp events.
{ asciiCode : integer, key : string, keyboardIndex : integer, keyCode : scaleform.Keys, keyState : integer, }
scaleform.MouseEventThe event parameters for MouseDown, MouseUp, MouseMove, MouseWheel, MouseOut, MouseOver, MouseUpOutside, Click, DoubleClick,RollOut and RollOver events.
{ buttonId : integer, buttonsMask : integer, keyMods : integer, localX : number, localY : number, mouseIndex : integer, relatedActor : scaleform.Actor, rollOverCount : integer, stageX : number, stageY : number, wheelDelta : number, }
scaleform.OrientationEventThe event parameters for OrientationChange event.
{ orientation : string, }
scaleform.PropertyChangeEvent{ property : string, value : any, }
scaleform.SoundCompleteEventThe event parameters for SoundComplete event.
{ playingId : integer, sound : scaleform.Sound, }
scaleform.StatusEventThe event parameters for StatusUpdate event.
{ code : string, level : string, }
scaleform.TimelineTriggerEventThe event parameters for TimelineTrigger event.
{ intParam : integer, name : string, }
scaleform.TimerEvent{ timer : scaleform.Timer, }
scaleform.TouchEventThe event parameters for TouchBegin, TouchEnd, TouchMove, TouchTap, TouchOver, TouchOut, TouchRollOver, TouchRollOut event.
{ contactHeight : number, contactWidth : number, localX : number, localY : number, mouseIndex : integer, pressure : number, primaryPoint : boolean, stageX : number, stageY : number, touchID : integer, }
scaleform.EventDispatcher.dispatch_event (self, event) : booleanDispatches an event to registered listeners.
scaleform.Stage.dispatch_event (event) : booleanDispatches an event to all loaded scenes.
scaleform.Event.currentTarget : scaleform.Actor?The actor receiving the event.
scaleform.ActorGeneric objects located in a scene.
scaleform.Event.eventId : scaleform.EventTypesThe event type.
scaleform.EventTypesThe list of events.
scaleform.Event.phase : stringThe event phase. A string of characters.
scaleform.Event.target : scaleform.Actor?The target actor of the event was generated on. A numeric value.A strictly integral numeric value, with no decimal component.
scaleform.physics.FixtureAn interface to attach shapes to the fixtures. true or false.A Lua table consisting of paired keys and values.
scaleform.AnalogControlsThe possible analog or touchpad controls which generate 2 axis input.
scaleform.ButtonsThe possible game pad buttons that generate press events.
scaleform.KeysThe possible keyboard keys. This value may be an instance of any type.
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.TimerRepresents a timer.
self : scaleform.EventDispatcherThe dispatcher whose event is dispatched for.
event : scaleform.EventThe event to dispatch.
boolean event : scaleform.EventThe event to dispatch.
boolean scaleform.EventDispatcherThe base object for managing event listeners and dispatching events to the listeners.
scaleform.Event{ currentTarget : scaleform.Actor?, eventId : scaleform.EventTypes, phase : string, target : scaleform.Actor?, }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.