Class TeleportationProvider

The TeleportationProvider is responsible for moving the XR Origin to the desired location on the user's request.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

LocomotionProvider

TeleportationProvider

Inherited Members

LocomotionProvider.mediator

LocomotionProvider.transformationPriority

LocomotionProvider.locomotionState

LocomotionProvider.isLocomotionActive

LocomotionProvider.locomotionStarted

LocomotionProvider.locomotionEnded

LocomotionProvider.beforeStepLocomotion

LocomotionProvider.Awake()

LocomotionProvider.TryPrepareLocomotion()

LocomotionProvider.TryStartLocomotionImmediately()

LocomotionProvider.TryEndLocomotion()

LocomotionProvider.OnLocomotionStarting()

LocomotionProvider.OnLocomotionEnding()

LocomotionProvider.TryQueueTransformation(IXRBodyTransformation)

LocomotionProvider.TryQueueTransformation(IXRBodyTransformation, int)

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(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, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

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

Component.GetComponentsInChildren<T>()

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

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, 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

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, bool)

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, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Interaction.Toolkit.Locomotion.Teleportation

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[AddComponentMenu("XR/Locomotion/Teleportation Provider", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.1/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Teleportation.TeleportationProvider.html")]
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public class TeleportationProvider : LocomotionProvider

Properties

canStartMoving

Whether the provider has finished preparing for locomotion and is ready to enter the Moving state. This only applies when locomotionState is Preparing, so there is no need for this implementation to query locomotionState.

Declaration

public override bool canStartMoving { get; }

Property Value

Type	Description
bool

Overrides

LocomotionProvider.canStartMoving

currentRequest

The current teleportation request.

Declaration

protected TeleportRequest currentRequest { get; set; }

Property Value

Type	Description
TeleportRequest

delayTime

The time (in seconds) to delay the teleportation once it is activated. This delay can be used, for example, as time to set a tunneling vignette effect as a VR comfort option.

Declaration

public float delayTime { get; set; }

Property Value

Type	Description
float

forwardTransformation

The transformation that is used by this component to apply forward vector orientation.

Declaration

public XRCameraForwardXZAlignment forwardTransformation { get; set; }

Property Value

Type	Description
XRCameraForwardXZAlignment

See Also

TargetUpAndForward

positionTransformation

The transformation that is used by this component to apply teleport positioning movement.

Declaration

public XRBodyGroundPosition positionTransformation { get; set; }

Property Value

Type	Description
XRBodyGroundPosition

upTransformation

The transformation that is used by this component to apply up vector orientation.

Declaration

public XROriginUpAlignment upTransformation { get; set; }

Property Value

Type	Description
XROriginUpAlignment

See Also

WorldSpaceUp

TargetUp

validRequest

Whether the current teleportation request is valid.

Declaration

protected bool validRequest { get; set; }

Property Value

Type	Description
bool

Methods

QueueTeleportRequest(TeleportRequest)

This function will queue a teleportation request within the provider.

Declaration

public virtual bool QueueTeleportRequest(TeleportRequest teleportRequest)

Parameters

Type	Name	Description
TeleportRequest	teleportRequest	The teleportation request to queue.

Returns

Type	Description
bool	Returns true if successfully queued. Otherwise, returns false.

Update()

See MonoBehaviour.

Declaration

protected virtual void Update()