API reference
TeleportInteractor Class
TeleportInteractor uses a provided ITeleportArc and an external Selector to find the best interactable and emit the event requesting a teleport to it.
By itself it does not define the shape of the arc or even moves the player, instead it is the core class that brings these pieces together.
Properties
IHmd Hmd[Get]
When provided, the Interactor will perform an extra check to ensure nothing is blocking the line between the Hmd (head of the player) and the teleport origin (hand).
Making it impossible to teleport if the user is placing their hands behind a virtual wall.
IPolyline TeleportArc[Get]
Specifies the shape of the arc used for detecting available interactables.
If none is provided TeleportArcGravity will be used.
float EqualDistanceThreshold[Get]
(Meters, World) The threshold below which distances to a interactable are treated as equal for the purposes of ranking.
Pose ArcOrigin[Get]
The starting point of the teleport arc.
TeleportHit ArcEnd[Get]
Pose TeleportTarget[Get]
The location to teleport to.
If the interactor has an interactable, then that's the teleport location. Otherwise it just projects the end of the arc onto the ground and uses that as the target.
Action< LocomotionEvent > WhenLocomotionPerformed
Protected Functions
virtual override void Awake ( )
virtual override void Start ( )
override void InteractableSelected
( TeleportInteractable interactable )
virtual override TeleportInteractable ComputeCandidate ( )
override int ComputeCandidateTiebreaker
( TeleportInteractable a,
Member Functions
override bool CanSelect
( TeleportInteractable interactable )
void InjectAllTeleportInteractor
( ISelector selector )
Sets all required values for a dynamically instantiated GameObject.
void InjectSelector
( ISelector selector )
Sets the selection mechanism for a dynamically instantiated GameObject.
void InjectOptionalHmd
( IHmd hmd )
Sets the HMD (Head Mounted Display) for a dynamically instantiated GameObject.
void InjectOptionalTeleportArc
( IPolyline teleportArc )
Sets the teleport arc for a dynamically instantiated GameObject.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta