Class LocationServices
Location Services
Inherited Members
Namespace: UE4.LocationServicesBPLibrary
Assembly: UE4DotNet.dll
Syntax
public class LocationServices : BlueprintFunctionLibrary
Properties
| Improve this Doc View SourceDefaultObject
Get UE4 Default Object for this Class
Declaration
public static LocationServices DefaultObject { get; }
Property Value
| Type | Description |
|---|---|
| LocationServices |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }
Property Value
| Type | Description |
|---|---|
| Class |
Methods
| Improve this Doc View SourceAreLocationServicesEnabled()
Checks if the Location Services on the mobile device are enabled for this application @
Declaration
public static bool AreLocationServicesEnabled()
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
return - true if the mobile device has enabled the appropriate service for the app
GetLastKnownLocation()
Returns the last location information returned by the location service.
Declaration
public static LocationServicesData GetLastKnownLocation()
Returns
| Type | Description |
|---|---|
| LocationServicesData |
Remarks
If no location update has been made, will return a default-value-filled struct. @return - the last known location from updates
GetLocationServicesImpl()
- Returns the Location Services implementation object.
Declaration
public static LocationServicesImpl GetLocationServicesImpl()
Returns
| Type | Description |
|---|---|
| LocationServicesImpl |
Remarks
Intended to be used to set up the FLocationServicesData_OnLocationChanged
- delegate in Blueprints.
- @return - the Android or IOS impl object
InitLocationServices(ELocationAccuracy, Single, Single)
Called to set up the Location Service before use @
Declaration
public static bool InitLocationServices(ELocationAccuracy Accuracy, float UpdateFrequency, float MinDistanceFilter)
Parameters
| Type | Name | Description |
|---|---|---|
| ELocationAccuracy | Accuracy | |
| System.Single | UpdateFrequency | |
| System.Single | MinDistanceFilter |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
param Accuracy - as seen in the enum above @param UpdateFrequency - in milliseconds. (Android only) @param MinDistance - minDistance before a location update, in meters. 0 here means "update asap" @return - true if Initialization was succesful
IsLocationAccuracyAvailable(ELocationAccuracy)
Checks if the supplied Accuracy is available on the current device.
Declaration
public static bool IsLocationAccuracyAvailable(ELocationAccuracy Accuracy)
Parameters
| Type | Name | Description |
|---|---|---|
| ELocationAccuracy | Accuracy |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
@param Accuracy - the accuracy to check @return - true if the mobile device can support the Accuracy, false if it will use a different accuracy
New(UObject, Name)
Spawn an object of this class
Declaration
public static LocationServices New(UObject obj = null, Name name = default(Name))
Parameters
| Type | Name | Description |
|---|---|---|
| UObject | obj | |
| Name | name |
Returns
| Type | Description |
|---|---|
| LocationServices |
StartLocationServices()
Starts requesting location updates from the appropriate Location Service @
Declaration
public static bool StartLocationServices()
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
return - true if startup successful
StopLocationServices()
Stops the updates of location from the Location Service that was started with StartLocationService @
Declaration
public static bool StopLocationServices()
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
return - true if stop is successful
Operators
| Improve this Doc View SourceImplicit(IntPtr to LocationServices)
Convert from IntPtr to UObject
Declaration
public static implicit operator LocationServices(IntPtr p)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IntPtr | p |
Returns
| Type | Description |
|---|---|
| LocationServices |