Class RouteTraveller

Controls the movement of the GameObject along the route.

Inheritance

object

RouteTraveller

Namespace: Holoride.ElasticSDK

Assembly: Holoride.ElasticSDK.Runtime.dll

Syntax

[AddComponentMenu("holoride/Route Traveller")]
[HelpURL("http://localhost:8080/api/Holoride.ElasticSDK.RouteTraveller.html")]
public class RouteTraveller : MonoBehaviour

Fields

Distance

Distance on the spline where the GameObject is currently located.

Declaration

[Tooltip("Distance on the spline where the GameObject is currently located.")]
public double Distance

Field Value

Type	Description
double

GameObject

The GameObject to travel along the route.

Declaration

[Tooltip("The GameObject to travel along the route.")]
public GameObject GameObject

Field Value

Type	Description
GameObject

MoveGameObject

States whether to travel or to pause.

Declaration

[Tooltip("States whether to travel or to pause.")]
public bool MoveGameObject

Field Value

Type	Description
bool

Offset

Offset for the GameObject relative to its path on the spline.

Declaration

[Tooltip("Offset for the GameObject relative to its path on the spline.")]
public Vector3 Offset

Field Value

Type	Description
Vector3

Route

The Route to travel along.

Declaration

[Tooltip("The Route to travel along.")]
public Route Route

Field Value

Type	Description
Route

SnapTo

States whether to snap the travelling object to the ground.

Declaration

[Tooltip("Which layer to snap the travelling object to, usually the terrain.")]
public LayerMask SnapTo

Field Value

Type	Description
LayerMask

Speed

The GameObject's travelling speed in meters per second.

Declaration

[Tooltip("The GameObject's travelling speed in meters per second.")]
public float Speed

Field Value

Type	Description
float

Methods

OnEnable()

Implements the OnEnable method of the MonoBehaviour life-cycle. Initializes the GameObject flight.

Declaration

public void OnEnable()

Update()

Implements the Update method of the MonoBehaviour life-cycle.

Declaration

public void Update()