Scaleform Studio Lua API Reference: scaleform.GeolocationEvent table reference

scaleform.GeolocationEvent table reference
Data Members
expand all | collapse all

Description

The event parameters for GeolocationUpdate event.

Data Members

altitude : number
The altitude in meters.
hAccuracy : number
The horizontal accuracy in meters.
heading : number
The direction of movement (with respect to true north) in integer degrees.
latitude : number
The latitude in degrees.
longitude : number
The longitude in degrees.
speed : number
The speed in meters/second.
timeStamp : number
The number of milliseconds at the time of the event since the runtime was initialized.
vAccuracy : number
The vertical accuracy in meters.
 scaleform.Event

{ currentTarget : scaleform.Actor?, eventId : scaleform.EventTypes, phase : string, target : scaleform.Actor?, }  scaleform.EventTypes.GeolocationUpdate
The geolocation update event, scaleform.GeolocationEvent.  scaleform.GeolocationEvent.altitude : number
The altitude in meters. A numeric value.  scaleform.GeolocationEvent.hAccuracy : number
The horizontal accuracy in meters.  scaleform.GeolocationEvent.heading : number
The direction of movement (with respect to true north) in integer degrees.  scaleform.GeolocationEvent.latitude : number
The latitude in degrees.  scaleform.GeolocationEvent.longitude : number
The longitude in degrees.  scaleform.GeolocationEvent.speed : number
The speed in meters/second.  scaleform.GeolocationEvent.timeStamp : number
The number of milliseconds at the time of the event since the runtime was initialized.  scaleform.GeolocationEvent.vAccuracy : number
The vertical accuracy in meters.  scaleform.Actor
Generic objects located in a scene.  scaleform.EventTypes
The list of events. A string of characters.  scaleform.GeolocationEvent
The event parameters for GeolocationUpdate event.
{ altitude : number, hAccuracy : number, heading : number, latitude : number, longitude : number, speed : number, timeStamp : number, vAccuracy : number, }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.
Please send us your comment about this page