Scaleform Studio Lua API Reference: scaleform.TouchEvent table reference

scaleform.TouchEvent table reference

Description

The event parameters for TouchBegin, TouchEnd, TouchMove, TouchTap, TouchOver, TouchOut, TouchRollOver, TouchRollOut event.

Data Members

contactHeight : number
Touch contact rectangle height
contactWidth : number
Touch contact rectangle width.
localX : number
Touch local x-position.
localY : number
Touch local y-position.
mouseIndex : integer
Mouse index.
pressure : number
Touch pressure.
primaryPoint : boolean
Whether this is first point of contact.
stageX : number
Touch x-position on stage.
stageY : number
Touch y-position on stage.
touchID : integer
Touch Id.
 scaleform.Event

{ currentTarget : scaleform.Actor?, eventId : scaleform.EventTypes, phase : string, target : scaleform.Actor?, }
 scaleform.EventTypes.TouchBegin
The touch begin event, scaleform.TouchEvent.
 scaleform.EventTypes.TouchEnd
The touch end event, scaleform.TouchEvent.
 scaleform.EventTypes.TouchMove
The touch move event, scaleform.TouchEvent.
 scaleform.EventTypes.TouchOut
The touch out event, scaleform.TouchEvent.
 scaleform.EventTypes.TouchOver
The touch over event, scaleform.TouchEvent.
 scaleform.EventTypes.TouchRollOut
The touch roll out event, scaleform.TouchEvent.
 scaleform.EventTypes.TouchRollOver
The touch roll over event, scaleform.TouchEvent.
 scaleform.EventTypes.TouchTap
The touch tap event, scaleform.TouchEvent.
 scaleform.TouchEvent.contactHeight : number
Touch contact rectangle height
A numeric value.  scaleform.TouchEvent.contactWidth : number
Touch contact rectangle width.
 scaleform.TouchEvent.localX : number
Touch local x-position.
 scaleform.TouchEvent.localY : number
Touch local y-position.
 scaleform.TouchEvent.mouseIndex : integer
Mouse index.
A strictly integral numeric value, with no decimal component.  scaleform.TouchEvent.pressure : number
Touch pressure.
 scaleform.TouchEvent.primaryPoint : boolean
Whether this is first point of contact.
true or false.  scaleform.TouchEvent.stageX : number
Touch x-position on stage.
 scaleform.TouchEvent.stageY : number
Touch y-position on stage.
 scaleform.TouchEvent.touchID : integer
Touch Id.
 scaleform.Actor
Generic objects located in a scene.
 scaleform.EventTypes
The list of events.
A string of characters.  scaleform.TouchEvent
The 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, }
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.