API reference

TeleportInteractable Class

Makes an object a teleport hotspot.

Properties

bool AllowTeleport[Get]
Indicates if the interactable is valid for teleport.
Setting it to false can be convenient to block the arc.
float EqualDistanceToBlockerOverride[Get]
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.
ISurface Surface[Get]
IBounds 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.

Protected Functions

virtual override void Awake ( )
virtual override void Start ( )

Member Functions

bool IsInRange
( Pose origin,
float maxSqrDistance )
Determines if a <cref="TeleportInteractor" /> is close enough to target this interactable.
bool DetectHit
( Vector3 from,
Vector3 to,
out TeleportHit hit )
Detects a hit from the teleport raycast on the object.
Pose 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 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.
Meta
English (US)
© 2026 Meta