Class LocomotionProvider

The LocomotionProvider is the base class for various locomotion implementations. This class provides simple ways to interrogate the LocomotionSystem for whether a locomotion can begin and simple events for hooking into a start/end locomotion.

Inheritance

Object

Object

Component

Behaviour

MonoBehaviour

LocomotionProvider

ContinuousMoveProviderBase

ContinuousTurnProviderBase

SnapTurnProviderBase

TeleportationProvider

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(String, Single)

MonoBehaviour.InvokeRepeating(String, Single, Single)

MonoBehaviour.CancelInvoke(String)

MonoBehaviour.IsInvoking(String)

MonoBehaviour.StartCoroutine(String)

MonoBehaviour.StartCoroutine(String, Object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(String)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(Object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, Component)

Component.TryGetComponent<T>(T)

Component.GetComponent(String)

Component.GetComponentInChildren(Type, Boolean)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(Boolean)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, Boolean)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(Boolean)

Component.GetComponentsInChildren<T>(Boolean, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, Boolean)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(Boolean)

Component.GetComponentsInParent<T>(Boolean, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(String)

Component.SendMessageUpwards(String, Object, SendMessageOptions)

Component.SendMessageUpwards(String, Object)

Component.SendMessageUpwards(String)

Component.SendMessageUpwards(String, SendMessageOptions)

Component.SendMessage(String, Object)

Component.SendMessage(String)

Component.SendMessage(String, Object, SendMessageOptions)

Component.SendMessage(String, SendMessageOptions)

Component.BroadcastMessage(String, Object, SendMessageOptions)

Component.BroadcastMessage(String, Object)

Component.BroadcastMessage(String)

Component.BroadcastMessage(String, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Component.rigidbody

Component.rigidbody2D

Component.camera

Component.light

Component.animation

Component.constantForce

Component.renderer

Component.audio

Component.networkView

Component.collider

Component.collider2D

Component.hingeJoint

Component.particleSystem

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(Object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEngine.XR.Interaction.Toolkit

Syntax

[DefaultExecutionOrder(-210)]
public abstract class LocomotionProvider : MonoBehaviour

Properties

locomotionPhase

The LocomotionPhase of this LocomotionProvider.

Declaration

public LocomotionPhase locomotionPhase { get; protected set; }

Property Value

Type	Description
LocomotionPhase

Remarks

Each LocomotionProvider instance can implement LocomotionPhase options based on their own logic related to locomotion, such as input actions and frames during the animation.

See Also

LocomotionPhase

TunnelingVignetteController

system

The LocomotionSystem that this LocomotionProvider communicates with for exclusive access to an XR Origin. If one is not provided, the behavior will attempt to locate one during its Awake call.

Declaration

public LocomotionSystem system { get; set; }

Property Value

Type	Description
LocomotionSystem

Methods

Awake()

See MonoBehaviour.

Declaration

protected virtual void Awake()

BeginLocomotion()

Invokes begin locomotion events.

Declaration

protected bool BeginLocomotion()

Returns

Type	Description
Boolean	Returns true if successful. Otherwise, returns false.

CanBeginLocomotion()

Checks if locomotion can begin.

Declaration

protected bool CanBeginLocomotion()

Returns

Type	Description
Boolean	Returns true if locomotion can start. Otherwise, returns false.

EndLocomotion()

Invokes end locomotion events.

Declaration

protected bool EndLocomotion()

Returns

Type	Description
Boolean	Returns true if successful. Otherwise, returns false.

Events

beginLocomotion

Unity calls the beginLocomotion action when a LocomotionProvider successfully begins a locomotion event.

Declaration

public event Action<LocomotionSystem> beginLocomotion

Event Type

Type	Description
Action<LocomotionSystem>

endLocomotion

Unity calls the endLocomotion action when a LocomotionProvider successfully ends a locomotion event.

Declaration

public event Action<LocomotionSystem> endLocomotion

Event Type

Type	Description
Action<LocomotionSystem>

startLocomotion

(Deprecated) The startLocomotion action will be called when a LocomotionProvider successfully begins a locomotion event.

Declaration

[Obsolete("startLocomotion has been deprecated. Use beginLocomotion instead. (UnityUpgradable) -> beginLocomotion", true)]
public event Action<LocomotionSystem> startLocomotion

Event Type

Type	Description
Action<LocomotionSystem>

Remarks

startLocomotion has been deprecated. Use beginLocomotion instead.

See Also

beginLocomotion