Scaleform Studio Lua API Reference: scaleform.Geolocation object reference
scaleform.Geolocation object reference
Description
Dispatches events in response to the device's location sensor.
Inheritance 
Constructors and accessors
Functions
Parameters
Returns
| This function does not accept any parameters. |
|
The newly created Geolocation |
Parameters
Returns
self : |
The geolocation that is currently in use. |
boolean |
Whether the geolocation is muted or not. |
scaleform.EventDispatcherThe base object for managing event listeners and dispatching events to the listeners.
scaleform.Geolocation.create () : scaleform.GeolocationCreates a new Geolocation.
scaleform.GeolocationThe newly created Geolocation
scaleform.GeolocationDispatches events in response to the device's location sensor.
scaleform.Geolocation.muted (self) : booleanReturns whether the geolocation is muted by platform or not.
self : scaleform.GeolocationThe geolocation that is currently in use.
booleantrue or false. scaleform.Geolocation.set_requested_update_interval (self, interval) Sets update interval for geolocation events.
self : scaleform.GeolocationThe geolocation currently in use.
interval : integerThe requested update interval.A strictly integral numeric value, with no decimal component.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.