Class TeleportationArea
An area is a teleportation destination which teleports the user to their pointed location on a surface.
Inheritance
TeleportationArea
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
[AddComponentMenu("XR/Teleportation Area", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.0/api/UnityEngine.XR.Interaction.Toolkit.TeleportationArea.html")]
public class TeleportationArea : BaseTeleportationInteractable, IXRActivateInteractable, IXRHoverInteractable, IXRSelectInteractable, IXRInteractableMethods
GenerateTeleportRequest(IXRInteractor, RaycastHit, ref TeleportRequest)
Automatically called upon the teleport trigger event occurring to generate the teleport request. The teleportation destination pose should be filled out.
Declaration
protected override bool GenerateTeleportRequest(IXRInteractor interactor, RaycastHit raycastHit, ref TeleportRequest teleportRequest)Parameters
| Type | Name | Description |
|---|---|---|
| IXRInteractor | interactor | The interactor that initiated the teleport trigger. |
| RaycastHit | raycastHit | The ray cast hit information from the interactor. |
| TeleportRequest | teleportRequest | The teleport request that should be filled out during this method call. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if the teleport request was successfully updated and should be queued. Otherwise, returns false. |