API reference
TeleportInteractable Class
Makes an object a teleport hotspot.
Oculus::Interaction::Locomotion::TeleportInteractable extends Oculus.Interaction.Interactable< TeleportInteractor, TeleportInteractable >.
Overview
Properties
bool | AllowTeleport[Get] Indicates if the interactable is valid for teleport. |
float | An override for the Interactor EqualDistanceThreshold used when comparing the interactable against other interactables that does not allow teleport. |
int | TieBreakerScore[Get] Establishes the priority when several interactables are hit at the same time (EqualDistanceThreshold) by the arc. |
Surface[Get] | |
SurfaceBounds[Get] | |
bool | FaceTargetDirection[Get] When true, the player will also face the direction specified by the target point. |
bool | EyeLevel[Get] When true, instead of aligning the players feet to the TargetPoint it will align the head. |
Public Member Functions
bool | Determines if a <cref="TeleportInteractor" /> is close enough to target this interactable. |
bool | Detects a hit from the teleport raycast on the object. |
Pose | TargetPose ( Pose hitPose ) Used when the interactor is looking for a teleport target. |
void | InjectAllTeleportInteractable ( ISurface surface ) Sets all required values for a <cref="TeleportInteractable" /> for a dynamically instantiated GameObject. |
void | InjectSurface ( ISurface surface ) Sets an <cref="ISurface" /> for a dynamically instantiated GameObject. |
void | InjectOptionalTargetPoint ( Transform targetPoint ) Sets a target point for a dynamically instantiated GameObject. |
Details
Properties
| bool Oculus.Interaction.Locomotion.TeleportInteractable.AllowTeleport |
|---|
Indicates if the interactable is valid for teleport. Setting it to false can be convenient to block the arc. |
| float Oculus.Interaction.Locomotion.TeleportInteractable.EqualDistanceToBlockerOverride |
|---|
An override for the Interactor EqualDistanceThreshold used when comparing the interactable against other interactables that does not allow teleport. |
| int Oculus.Interaction.Locomotion.TeleportInteractable.TieBreakerScore |
|---|
Establishes the priority when several interactables are hit at the same time (EqualDistanceThreshold) by the arc. |
| ISurface Oculus.Interaction.Locomotion.TeleportInteractable.Surface |
|---|
No description available.
|
| IBounds Oculus.Interaction.Locomotion.TeleportInteractable.SurfaceBounds |
|---|
No description available.
|
| bool Oculus.Interaction.Locomotion.TeleportInteractable.FaceTargetDirection |
|---|
When true, the player will also face the direction specified by the target point. |
| bool Oculus.Interaction.Locomotion.TeleportInteractable.EyeLevel |
|---|
When true, instead of aligning the players feet to the TargetPoint it will align the head. |
Object Data
| override void Oculus.Interaction.Locomotion.TeleportInteractable.Awake ( ) |
|---|
No description available.
|
| override void Oculus.Interaction.Locomotion.TeleportInteractable.Start ( ) |
|---|
No description available.
|
Member Functions
| bool Oculus.Interaction.Locomotion.TeleportInteractable.IsInRange ( Pose origin, float maxSqrDistance ) |
|---|
Determines if a <cref="TeleportInteractor" /> is close enough to target this interactable. |
| bool Oculus.Interaction.Locomotion.TeleportInteractable.DetectHit ( Vector3 from, Vector3 to, out TeleportHit hit ) |
|---|
Detects a hit from the teleport raycast on the object. |
| Pose Oculus.Interaction.Locomotion.TeleportInteractable.TargetPose ( Pose hitPose ) |
|---|
Used when the interactor is looking for a teleport target. If you specify a target point, it'll use that. Otherwise it uses wherever the teleport arc is pointing. |
| void Oculus.Interaction.Locomotion.TeleportInteractable.InjectAllTeleportInteractable ( ISurface surface ) |
|---|
Sets all required values for a <cref="TeleportInteractable" /> for a dynamically instantiated GameObject. |
| void Oculus.Interaction.Locomotion.TeleportInteractable.InjectSurface ( ISurface surface ) |
|---|
Sets an <cref="ISurface" /> for a dynamically instantiated GameObject. |
| void Oculus.Interaction.Locomotion.TeleportInteractable.InjectOptionalTargetPoint ( Transform targetPoint ) |
|---|
Sets a target point 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