Guides
Guides
These docs are for v3.1.0. Click to read the latest docs for v3.3.0.

Destination Point

extends VRTK_DestinationMarker

Overview

The Destination Point allows for a specific scene marker that can be teleported to.

The destination points can provide a useful way of having specific teleport locations in a scene.

The destination points can also have a locked state if the Enable Teleport flag is disabled.

Inspector Parameters

  • Default Cursor Object: The GameObject to use to represent the default cursor state.
  • Hover Cursor Object: The GameObject to use to represent the hover cursor state.
  • Locked Cursor Object: The GameObject to use to represent the locked cursor state.
  • Snap To Point: If this is checked then after teleporting, the play area will be snapped to the origin of the destination point. If this is false then it's possible to teleport to anywhere within the destination point collider.
  • Hide Pointer Cursor On Hover: If this is checked, then the pointer cursor will be hidden when a valid destination point is hovered over.

Class Methods

ResetDestinationPoint/0

public virtual void ResetDestinationPoint()

  • Parameters
  • none
  • Returns
  • none

The ResetDestinationPoint resets the destination point back to the default state.

Example

044_CameraRig_RestrictedTeleportZones uses the VRTK_DestinationPoint prefab to set up a collection of pre-defined teleport locations.