Class TeleportationProvider
The TeleportationProvider is responsible for moving the XR Origin to the desired location on the user's request.
Inheritance
TeleportationProvider
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
[AddComponentMenu("XR/Locomotion/Teleportation Provider", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.0/api/UnityEngine.XR.Interaction.Toolkit.TeleportationProvider.html")]
public class TeleportationProvider : LocomotionProvider
Properties
currentRequest
The current teleportation request.
Declaration
protected TeleportRequest currentRequest { get; set; }
Property Value
Type | Description |
---|---|
TeleportRequest |
validRequest
Whether the current teleportation request is valid.
Declaration
protected bool validRequest { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
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 |
---|---|
Boolean | Returns true if successfully queued. Otherwise, returns false. |
Update()
See MonoBehaviour.
Declaration
protected virtual void Update()