Class TeleportationProvider
The TeleportationProvider is responsible for moving the XR Origin to the desired location on the user's request.
Inheritance
Inherited Members
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.0/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Teleportation.TeleportationProvider.html")]
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public class TeleportationProvider : LocomotionProviderProperties
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
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
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
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()