Class LocalizationEvents

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

LocalizationEvents

Namespace: Holoride.ElasticSDK

Assembly: Holoride.ElasticSDK.Runtime.dll

Syntax

public class LocalizationEvents : MonoBehaviour

Fields

DistanceToStreetUntilOffRoad

The distance in meters from the street until the player is considered to be too far away from the road and the OnOffRoadMode event is triggered.

Declaration

[Tooltip("The distance in meters from the street until the player is considered to be too far away from the road and the OnOffRoadMode event is triggered.")]
public float DistanceToStreetUntilOffRoad

Field Value

Type	Description
float

OnLocalizationInitialized

This event is fired when the localization becomes available and the pivot is set.

Declaration

[Tooltip("This is fired when the localization becomes available and the pivot is set.")]
public UnityEvent OnLocalizationInitialized

Field Value

Type	Description
UnityEvent

OnLocalizationNormalMode

This event is fired when the localization is available and we are on the street (up to the configured DistanceToStreetUntilOffRoad).

Declaration

[Tooltip("This event is fired when the localization is available and we are on the street (up to the road distance threshold).")]
public UnityEvent OnLocalizationNormalMode

Field Value

Type	Description
UnityEvent

OnLocalizationUnavailableMode

This event is fired when the localization is unavailable and thus the player won't move even though the vehicle in the real world might.

Declaration

[Tooltip("This event is fired when the localization is unavailable and thus the player won't move even though the vehicle in the real world might.")]
public UnityEvent OnLocalizationUnavailableMode

Field Value

Type	Description
UnityEvent

OnOffRoadMode

This event is fired when the localization is available but we are not on the road and the distance to the road is larger than the threshold configured in DistanceToStreetUntilOffRoad.

Declaration

[Tooltip("This event is fired when the localization is available but we are not on the road and the distance to the road is larger than the threshold configured in <c>DistanceToStreetUntilOffRoad</c>.")]
public UnityEvent OnOffRoadMode

Field Value

Type	Description
UnityEvent

Properties

CurrentMode

Gets the current LocalizationMode. Note that this is initialized correctly after Unity's Start method was called.

Declaration

public LocalizationMode CurrentMode { get; }

Property Value

Type	Description
LocalizationMode