API reference
API reference
Select your platform
No SDKs available
No versions available

TeleportInteractable Class

Makes an object a teleport hotspot.

Properties

AllowTeleport : bool
[Get][Set]
Indicates if the interactable is valid for teleport.
Setting it to false can be convenient to block the arc.
Signature
bool AllowTeleport
EqualDistanceToBlockerOverride : float
[Get][Set]
An override for the Interactor EqualDistanceThreshold used when comparing the interactable against other interactables that does not allow teleport.
Signature
float EqualDistanceToBlockerOverride
EyeLevel : bool
[Get][Set]
When true, instead of aligning the players feet to the TargetPoint it will align the head.
Signature
bool EyeLevel
FaceTargetDirection : bool
[Get][Set]
When true, the player will also face the direction specified by the target point.
Signature
bool FaceTargetDirection
Surface : ISurface
[Get]
Signature
ISurface Surface
SurfaceBounds : IBounds
[Get]
Signature
IBounds SurfaceBounds
TieBreakerScore : int
[Get][Set]
Establishes the priority when several interactables are hit at the same time (EqualDistanceThreshold) by the arc.
Signature
int TieBreakerScore

Protected Methods

Awake ()
Signature
override void Awake()
Returns
override void
Start ()
Signature
override void Start()
Returns
override void

Methods

DetectHit ( from , to , hit )
Detects a hit from the teleport raycast on the object.
Signature
bool DetectHit(Vector3 from, Vector3 to, out TeleportHit hit)
Parameters
from: Vector3
to: Vector3
hit: out TeleportHit
Returns
bool
InjectAllTeleportInteractable ( surface )
Sets all required values for a <cref="TeleportInteractable" /> for a dynamically instantiated GameObject.
Signature
void InjectAllTeleportInteractable(ISurface surface)
Parameters
surface: ISurface
Returns
void
InjectOptionalTargetPoint ( targetPoint )
Sets a target point for a dynamically instantiated GameObject.
Signature
void InjectOptionalTargetPoint(Transform targetPoint)
Parameters
targetPoint: Transform
Returns
void
InjectSurface ( surface )
Sets an <cref="ISurface" /> for a dynamically instantiated GameObject.
Signature
void InjectSurface(ISurface surface)
Parameters
surface: ISurface
Returns
void
IsInRange ( origin , maxSqrDistance )
Determines if a <cref="TeleportInteractor" /> is close enough to target this interactable.
Signature
bool IsInRange(Pose origin, float maxSqrDistance)
Parameters
origin: Pose
maxSqrDistance: float
Returns
bool
TargetPose ( 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.
Signature
Pose TargetPose(Pose hitPose)
Parameters
hitPose: Pose
Returns
Pose