Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Start(desiredAccuracyInMeters: float = 10f, updateDistanceInMeters: float = 10f): void;
void Start(float desiredAccuracyInMeters = 10f, float updateDistanceInMeters = 10f);
def Start(desiredAccuracyInMeters as float = 10f, updateDistanceInMeters as float = 10f) as void

Description

Starts location service updates. Last location coordinates could be.

Retrieved via Input.location.lastData. Service does not start to send location data immediately. Code should check Input.location.status for current service status. desiredAccuracyInMeters - desired service accuracy in meters. Using higher value like 500 usually does not require to turn GPS chip on and thus saves battery power. Values like 5-10 could be used for getting best accuracy. Default value is 10 meters. updateDistanceInMeters - the minimum distance (measured in meters) a device must move laterally before Input.location property is updated. Higher values like 500 imply less overhead. Default is 10 meters.

function Start () {
        // First, check if user has location service enabled
        if (!Input.location.isEnabledByUser)
            return;
        // Start service before querying location
        Input.location.Start ();
        // Wait until service initializes
        var maxWait : int = 20;
        while (Input.location.status
               == LocationServiceStatus.Initializing && maxWait > 0) {
            yield WaitForSeconds (1);
            maxWait--;
        }
        // Service didn't initialize in 20 seconds
        if (maxWait < 1) {
            print ("Timed out");
            return;
        }
        // Connection has failed
        if (Input.location.status == LocationServiceStatus.Failed) {
            print ("Unable to determine device location");
            return;
        }
        // Access granted and location value could be retrieved
        else {
            print ("Location: " + Input.location.lastData.latitude + " " +
                   Input.location.lastData.longitude + " " +
                   Input.location.lastData.altitude + " " +
                   Input.location.lastData.horizontalAccuracy + " " +
                   Input.location.lastData.timestamp);
        }
        // Stop service if there is no need to query location updates continuously
        Input.location.Stop ();
    }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    IEnumerator Start() {
        if (!Input.location.isEnabledByUser)
            return;
        
        Input.location.Start();
        int maxWait = 20;
        while (Input.location.status == LocationServiceStatus.Initializing && maxWait > 0) {
            yield return new WaitForSeconds(1);
            maxWait--;
        }
        if (maxWait < 1) {
            print("Timed out");
            return;
        }
        if (Input.location.status == LocationServiceStatus.Failed) {
            print("Unable to determine device location");
            return;
        } else
            print("Location: " + Input.location.lastData.latitude + " " + Input.location.lastData.longitude + " " + Input.location.lastData.altitude + " " + Input.location.lastData.horizontalAccuracy + " " + Input.location.lastData.timestamp);
        Input.location.Stop();
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Start() as IEnumerator:
		if not Input.location.isEnabledByUser:
			return
		Input.location.Start()
		maxWait as int = 20
		while (Input.location.status == LocationServiceStatus.Initializing) and (maxWait > 0):
			yield WaitForSeconds(1)
			maxWait--
		if maxWait < 1:
			print('Timed out')
			return
		if Input.location.status == LocationServiceStatus.Failed:
			print('Unable to determine device location')
			return
		else:
			print(((((((((('Location: ' + Input.location.lastData.latitude) + ' ') + Input.location.lastData.longitude) + ' ') + Input.location.lastData.altitude) + ' ') + Input.location.lastData.horizontalAccuracy) + ' ') + Input.location.lastData.timestamp))
		Input.location.Stop()