Class GeoLocationModule

Inheritance

Object

GeoLocationModule

Namespace: Unity.MARS.Providers

Syntax

public class GeoLocationModule : ScriptableSettings<GeoLocationModule>, IModuleDependency<MARSDatabase>, IModuleDependency<SlowTaskModule>, IModuleBuildCallbacks

Fields

MaxLatitude

Declaration

public const float MaxLatitude = null

Field Value

Type	Description
Single

MaxLongitude

Declaration

public const float MaxLongitude = null

Field Value

Type	Description
Single

Properties

continuousUpdates

When enabled, the location service will continue to poll for updates after acquiring initial location

Declaration

public bool continuousUpdates { get; set; }

Property Value

Type	Description
Boolean

Methods

SetCurrentLocationAndUpdateTrait(GeographicCoordinate)

Given a GeographicCoordinate, immediately update the GeoLocationModule and MARS database with it

Declaration

public void SetCurrentLocationAndUpdateTrait(GeographicCoordinate location)

Parameters

Type	Name	Description
GeographicCoordinate	location

TryGetGeoLocation(out GeographicCoordinate)

Declaration

public bool TryGetGeoLocation(out GeographicCoordinate coordinate)

Parameters

Type	Name	Description
GeographicCoordinate	coordinate

Returns

Type	Description
Boolean

TryStartService()

Declaration

public bool TryStartService()

Returns

Type	Description
Boolean

Events

GeoLocationChanged

Declaration

public event Action<GeographicCoordinate> GeoLocationChanged

Event Type

Type	Description
Action<GeographicCoordinate>