Class HVRTeleporter

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
HVRTeleporter
Inherited Members
UnityEngine.MonoBehaviour.IsInvoking()
UnityEngine.MonoBehaviour.CancelInvoke()
UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)
UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)
UnityEngine.MonoBehaviour.CancelInvoke(System.String)
UnityEngine.MonoBehaviour.IsInvoking(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)
UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)
UnityEngine.MonoBehaviour.StopCoroutine(System.String)
UnityEngine.MonoBehaviour.StopAllCoroutines()
UnityEngine.MonoBehaviour.print(System.Object)
UnityEngine.MonoBehaviour.useGUILayout
UnityEngine.MonoBehaviour.runInEditMode
UnityEngine.Behaviour.enabled
UnityEngine.Behaviour.isActiveAndEnabled
UnityEngine.Component.GetComponent(System.Type)
UnityEngine.Component.GetComponent<T>()
UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)
UnityEngine.Component.TryGetComponent<T>(T)
UnityEngine.Component.GetComponent(System.String)
UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentInChildren(System.Type)
UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentInChildren<T>()
UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInChildren(System.Type)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInChildren<T>()
UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentInParent(System.Type)
UnityEngine.Component.GetComponentInParent<T>()
UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInParent(System.Type)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInParent<T>()
UnityEngine.Component.GetComponents(System.Type)
UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)
UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponents<T>()
UnityEngine.Component.CompareTag(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object)
UnityEngine.Component.SendMessageUpwards(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, System.Object)
UnityEngine.Component.SendMessage(System.String)
UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object)
UnityEngine.Component.BroadcastMessage(System.String)
UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.transform
UnityEngine.Component.gameObject
UnityEngine.Component.tag
UnityEngine.Object.GetInstanceID()
UnityEngine.Object.GetHashCode()
UnityEngine.Object.Equals(System.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Instantiate<T>(T)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
UnityEngine.Object.Destroy(UnityEngine.Object)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
UnityEngine.Object.FindObjectsOfType(System.Type)
UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
UnityEngine.Object.DestroyObject(UnityEngine.Object)
UnityEngine.Object.FindSceneObjectsOfType(System.Type)
UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
UnityEngine.Object.FindObjectsOfType<T>()
UnityEngine.Object.FindObjectOfType<T>()
UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
UnityEngine.Object.FindObjectOfType(System.Type)
UnityEngine.Object.ToString()
UnityEngine.Object.name
UnityEngine.Object.hideFlags
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: HurricaneVR.Framework.Core.Player
Assembly: HurricaneVR.Framework.dll
Syntax
public class HVRTeleporter : MonoBehaviour

Fields

| Improve this Doc View Source

_dummyInvalid

Declaration
protected HVRInvalidTeleport _dummyInvalid
Field Value
Type Description
HVRInvalidTeleport
| Improve this Doc View Source

_previousPlayerRotation

Declaration
protected Quaternion _previousPlayerRotation
Field Value
Type Description
UnityEngine.Quaternion
| Improve this Doc View Source

_timeSinceLastRotation

Declaration
protected float _timeSinceLastRotation
Field Value
Type Description
System.Single
| Improve this Doc View Source

AfterTeleport

Declaration
public UnityEvent AfterTeleport
Field Value
Type Description
UnityEngine.Events.UnityEvent
| Improve this Doc View Source

BeforeTeleport

Declaration
public TeleportPositionUpdate BeforeTeleport
Field Value
Type Description
TeleportPositionUpdate
| Improve this Doc View Source

BezierAngleOffset

Declaration
[Header("Bezier Settings")]
public float BezierAngleOffset
Field Value
Type Description
System.Single
| Improve this Doc View Source

BezierAngleOffsetCurve

Declaration
public AnimationCurve BezierAngleOffsetCurve
Field Value
Type Description
UnityEngine.AnimationCurve
| Improve this Doc View Source

Camera

Declaration
[Header("Transforms / Components")]
public Transform Camera
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

Capsule

Declaration
[Header("Capsule Collider Override")]
public CapsuleCollider Capsule
Field Value
Type Description
UnityEngine.CapsuleCollider
| Improve this Doc View Source

CheckDropDistance

Declaration
[Header("Destination Validation")]
[Tooltip("If true the fall distance from the bottom of the capsule cannot exceed MaxDropDistance")]
public bool CheckDropDistance
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

CheckJumpDistance

Declaration
public bool CheckJumpDistance
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

CollisionBuffer

Declaration
[Tooltip("The hit point is backed from the point of collision by this distance to provide a visual buffer")]
public float CollisionBuffer
Field Value
Type Description
System.Single
| Improve this Doc View Source

CurveType

Declaration
[Header("Teleport Curve")]
public HVRTeleportCurve CurveType
Field Value
Type Description
HVRTeleportCurve
| Improve this Doc View Source

Dash

Declaration
[Header("Dash Teleport")]
public bool Dash
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DashSpeed

Declaration
public float DashSpeed
Field Value
Type Description
System.Single
| Improve this Doc View Source

DestinationHeight

Declaration
[Tooltip("How high above the destination the line of sight check will be performed")]
public float DestinationHeight
Field Value
Type Description
System.Single
| Improve this Doc View Source

DestinationIgnoreLayerMask

Declaration
public LayerMask DestinationIgnoreLayerMask
Field Value
Type Description
UnityEngine.LayerMask
| Improve this Doc View Source

DestinationIntervals

Declaration
[Tooltip("How many ray casts above the teleport point will be used to determine destination line of sight")]
public int DestinationIntervals
Field Value
Type Description
System.Int32
| Improve this Doc View Source

DisableMarkerWhenInvalid

Declaration
public bool DisableMarkerWhenInvalid
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DoesPlayerFit

Declaration
public bool DoesPlayerFit
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DownHitNormal

Declaration
[Header("Debugging")]
public Vector3 DownHitNormal
Field Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

DownLineMaxLength

Declaration
public float DownLineMaxLength
Field Value
Type Description
System.Single
| Improve this Doc View Source

DownLineMinLength

Declaration
public float DownLineMinLength
Field Value
Type Description
System.Single
| Improve this Doc View Source

DownRayIgnoreMask

Declaration
[Tooltip("Layers to ignore along the downwards ray cast")]
public LayerMask DownRayIgnoreMask
Field Value
Type Description
UnityEngine.LayerMask
| Improve this Doc View Source

DownRayLength

Declaration
[Header("Downward Ray cast")]
[Tooltip("Max length of the downwards ray cast")]
public float DownRayLength
Field Value
Type Description
System.Single
| Improve this Doc View Source

DownRenderer

Declaration
public LineRenderer DownRenderer
Field Value
Type Description
UnityEngine.LineRenderer
| Improve this Doc View Source

InvalidColor

Declaration
public Color InvalidColor
Field Value
Type Description
UnityEngine.Color
| Improve this Doc View Source

IsDestinationInLineOfSight

Declaration
public bool IsDestinationInLineOfSight
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsDropDistanceValid

Declaration
public bool IsDropDistanceValid
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsJumpDistanceValid

Declaration
public bool IsJumpDistanceValid
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsOnlyDropDistanceInvalid

Declaration
public bool IsOnlyDropDistanceInvalid
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsOriginInLineOfSight

Declaration
public bool IsOriginInLineOfSight
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsSurfaceAngleValid

Declaration
public bool IsSurfaceAngleValid
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

LayerMask

Declaration
[Tooltip("Teleport curve layer mask")]
public LayerMask LayerMask
Field Value
Type Description
UnityEngine.LayerMask
| Improve this Doc View Source

LayerMaskTriggerInteraction

Declaration
[Tooltip("Trigger setting for ray cast")]
public QueryTriggerInteraction LayerMaskTriggerInteraction
Field Value
Type Description
UnityEngine.QueryTriggerInteraction
| Improve this Doc View Source

LeftHand

Declaration
public HVRHandGrabber LeftHand
Field Value
Type Description
HVRHandGrabber
| Improve this Doc View Source

LineRenderer

Declaration
public LineRenderer LineRenderer
Field Value
Type Description
UnityEngine.LineRenderer
| Improve this Doc View Source

LineSegments

Declaration
public int LineSegments
Field Value
Type Description
System.Int32
| Improve this Doc View Source

MaxAngle

Declaration
[Range(90F, 179F)]
public float MaxAngle
Field Value
Type Description
System.Single
| Improve this Doc View Source

MaxDropDistance

Declaration
[Tooltip("Max fall distance that is calculated from the bottom of the provided Capsule Collider or CharacterController")]
public float MaxDropDistance
Field Value
Type Description
System.Single
| Improve this Doc View Source

MaxJumpDistance

Declaration
public float MaxJumpDistance
Field Value
Type Description
System.Single
| Improve this Doc View Source

MaxSurfaceAngle

Declaration
[Tooltip("Max angle allowed to teleport onto")]
[Range(0F, 90F)]
public float MaxSurfaceAngle
Field Value
Type Description
System.Single
| Improve this Doc View Source

OriginIgnoreLayerMask

Declaration
[Tooltip("Layers ignored when checking line of sight to the teleport origin ")]
public LayerMask OriginIgnoreLayerMask
Field Value
Type Description
UnityEngine.LayerMask
| Improve this Doc View Source

Player

Declaration
public HVRPlayerController Player
Field Value
Type Description
HVRPlayerController
| Improve this Doc View Source

PlayerClimbingCheck

Declaration
[Tooltip("If the player is climbing, should teleport be disabled.")]
public bool PlayerClimbingCheck
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

PlayerFitIgnoreLayerMask

Declaration
[Tooltip("Ignored layers when checking if the player fits in the target destination")]
public LayerMask PlayerFitIgnoreLayerMask
Field Value
Type Description
UnityEngine.LayerMask
| Improve this Doc View Source

PlayerGroundedCheck

Declaration
[Tooltip("If the player is not grounded, should teleport be disabled.")]
public bool PlayerGroundedCheck
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

PlayerRotateCheck

Declaration
[Header("Teleport Disable Checks")]
[Tooltip("Should player rotation disable teleport aiming?")]
public bool PlayerRotateCheck
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

PositionUpdate

Declaration
public TeleportPositionUpdate PositionUpdate
Field Value
Type Description
TeleportPositionUpdate
| Improve this Doc View Source

RequireDestinationLineOfSight

Declaration
[Header("Destination Line Of Sight")]
[Tooltip("If true line of sight from the camera to the teleport destination is required")]
public bool RequireDestinationLineOfSight
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

RequireOriginLineOfSight

Declaration
[Header("Origin Line Of Sight")]
[Tooltip("If true line of sight from the camera to the origin of the teleport line is required")]
public bool RequireOriginLineOfSight
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

RightHand

Declaration
public HVRHandGrabber RightHand
Field Value
Type Description
HVRHandGrabber
| Improve this Doc View Source

RotationTeleportThreshold

Declaration
[Tooltip("If turning how long of a timeout to wait before allowing joystick teleporting to prevent accidental teleporting when turning with the same joystick")]
public float RotationTeleportThreshold
Field Value
Type Description
System.Single
| Improve this Doc View Source

Speed

Declaration
[Header("Ballistic Settings")]
public float Speed
Field Value
Type Description
System.Single
| Improve this Doc View Source

SurfaceAngle

Declaration
public float SurfaceAngle
Field Value
Type Description
System.Single
| Improve this Doc View Source

TeleportableLayers

Declaration
[Tooltip("Layers of the ray hit object that the player can stand on")]
public LayerMask TeleportableLayers
Field Value
Type Description
UnityEngine.LayerMask
| Improve this Doc View Source

TeleportDistance

Declaration
public float TeleportDistance
Field Value
Type Description
System.Single
| Improve this Doc View Source

TeleportLineSourceLeft

Declaration
public Transform TeleportLineSourceLeft
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

TeleportLineSourceRight

Declaration
public Transform TeleportLineSourceRight
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

TeleportMarker

Declaration
public HVRTeleportMarkerBase TeleportMarker
Field Value
Type Description
HVRTeleportMarkerBase
| Improve this Doc View Source

TeleportState

Declaration
public TeleportState TeleportState
Field Value
Type Description
TeleportState
| Improve this Doc View Source

TimeStep

Declaration
public float TimeStep
Field Value
Type Description
System.Single
| Improve this Doc View Source

ValidColor

Declaration
[Header("Visuals")]
public Color ValidColor
Field Value
Type Description
UnityEngine.Color

Properties

| Improve this Doc View Source

CanTeleport

Declaration
public bool CanTeleport { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CapsuleBottom

Declaration
public Vector3 CapsuleBottom { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

CharacterController

Declaration
public CharacterController CharacterController { get; }
Property Value
Type Description
UnityEngine.CharacterController
| Improve this Doc View Source

Color

Declaration
public Color Color { get; }
Property Value
Type Description
UnityEngine.Color
| Improve this Doc View Source

DownHitCollider

The last collider hit by the downward raycast

Declaration
protected Collider DownHitCollider { get; set; }
Property Value
Type Description
UnityEngine.Collider
| Improve this Doc View Source

FeetPosition

Declaration
protected virtual Vector3 FeetPosition { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

Forward

Declaration
public Vector3 Forward { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

HandPrevents

Declaration
protected virtual bool HandPrevents { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

HitCollider

The last collider hit by the forward raycast

Declaration
protected Collider HitCollider { get; set; }
Property Value
Type Description
UnityEngine.Collider
| Improve this Doc View Source

HitPosition

World position where the teleport line collided

Declaration
public Vector3 HitPosition { get; protected set; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

IsAiming

Declaration
public bool IsAiming { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsRaycastValid

Did the forward raycast find a valid teleportable location

Declaration
public bool IsRaycastValid { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsTeleporting

Declaration
public bool IsTeleporting { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsTeleportPreviouslyValid

Declaration
public bool IsTeleportPreviouslyValid { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsTeleportValid

Declaration
public bool IsTeleportValid { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

LastDownwardPoint

Last world position hit by the downward raycast

Declaration
public Vector3 LastDownwardPoint { get; set; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

LastIndex

Last index of the curve array before the ray cast hit something.

Declaration
public int LastIndex { get; protected set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

LastPoint

The last raycast origin

Declaration
public Vector3 LastPoint { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

LastValidDownwardPoint

Last valid world position hit by the downward raycast

Declaration
public Vector3 LastValidDownwardPoint { get; set; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

LastValidIndex

Last index of the curve array that produced a valid destination for the player to land

Declaration
public int LastValidIndex { get; protected set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

LastValidPoint

The last valid raycast origin

Declaration
public Vector3 LastValidPoint { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

LeftHandPrevents

Declaration
protected virtual bool LeftHandPrevents { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

LineRendererPoints

Declaration
protected Vector3[] LineRendererPoints { get; set; }
Property Value
Type Description
UnityEngine.Vector3[]
| Improve this Doc View Source

Origin

Declaration
public Vector3 Origin { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

PlayerInputs

Declaration
public HVRPlayerInputs PlayerInputs { get; }
Property Value
Type Description
HVRPlayerInputs
| Improve this Doc View Source

PreviousAiming

Declaration
protected bool PreviousAiming { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

RightHandPrevents

Declaration
protected virtual bool RightHandPrevents { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

SurfaceNormal

Normal of the plane hit by the valid raycast.

Declaration
public Vector3 SurfaceNormal { get; protected set; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

TeleportDestination

The world position of the valid teleport destination

Declaration
public Vector3 TeleportDestination { get; protected set; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

TeleportHand

Declaration
public virtual HVRHandSide TeleportHand { get; }
Property Value
Type Description
HVRHandSide
| Improve this Doc View Source

TeleportLineSource

Declaration
public Transform TeleportLineSource { get; }
Property Value
Type Description
UnityEngine.Transform

Methods

| Improve this Doc View Source

AfterRaycast()

Declaration
protected virtual void AfterRaycast()
| Improve this Doc View Source

Awake()

Declaration
protected virtual void Awake()
| Improve this Doc View Source

BeforeRaycast()

Declaration
protected virtual void BeforeRaycast()
| Improve this Doc View Source

CalculateCurve(Vector3[])

Declaration
protected virtual void CalculateCurve(Vector3[] points)
Parameters
Type Name Description
UnityEngine.Vector3[] points
| Improve this Doc View Source

CheckCanTeleport()

Declaration
protected virtual bool CheckCanTeleport()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckCapsuleFits(Vector3)

Determines if the player is allowed to land at the provided destination using a capsule overlap check.

Declaration
protected virtual bool CheckCapsuleFits(Vector3 destination)
Parameters
Type Name Description
UnityEngine.Vector3 destination
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckDestinationAllowed(GameObject, Vector3)

Determines if the player is allowed to land at the provided destination

Declaration
protected virtual bool CheckDestinationAllowed(GameObject hitObject, Vector3 destination)
Parameters
Type Name Description
UnityEngine.GameObject hitObject

The gameobject that the final ray cast hit.
UnityEngine.Vector3 destination
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckDestinationLineOfSight(Vector3)

Determine if the destination is in line of sight, by default the Camera is the origin of the ray cast.

Declaration
protected virtual bool CheckDestinationLineOfSight(Vector3 destination)
Parameters
Type Name Description
UnityEngine.Vector3 destination
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckFallDistance(Vector3)

Determine if the player is allowed to teleport to a destination lower than the current position.

Declaration
protected virtual bool CheckFallDistance(Vector3 destination)
Parameters
Type Name Description
UnityEngine.Vector3 destination
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckOriginLineOfSight()

Determine if the origin of the teleport is in line of sight of the player's hmd.

Declaration
protected virtual bool CheckOriginLineOfSight()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckPlayerFits(Vector3)

Determines if the player is allowed to land at the provided destination

Declaration
protected virtual bool CheckPlayerFits(Vector3 destination)
Parameters
Type Name Description
UnityEngine.Vector3 destination
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckPlayerRotation()

Declaration
protected virtual void CheckPlayerRotation()
| Improve this Doc View Source

CheckSurfaceAngle(Vector3)

Determine if the surface angle is too steep using the raycast hit normal.

Declaration
protected virtual bool CheckSurfaceAngle(Vector3 normal)
Parameters
Type Name Description
UnityEngine.Vector3 normal
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckTeleport()

Declaration
protected virtual void CheckTeleport()
| Improve this Doc View Source

CheckValidDestination(GameObject, Vector3, Vector3)

Determine if the player is allowed to teleport to a destination.

Declaration
protected virtual bool CheckValidDestination(GameObject hitObject, Vector3 destination, Vector3 surfaceNormal)
Parameters
Type Name Description
UnityEngine.GameObject hitObject

The object hit by the raycast
UnityEngine.Vector3 destination

The position of the final ray cast hit
UnityEngine.Vector3 surfaceNormal

The normal of the ray cast hit, useful for ground angle validation
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckValidTeleportChanged(Boolean)

Declaration
protected virtual void CheckValidTeleportChanged(bool previousValid)
Parameters
Type Name Description
System.Boolean previousValid
| Improve this Doc View Source

CheckVerticalDistance(Vector3)

Determine if the player is allowed to reach a destination above the player's current position.

Declaration
protected virtual bool CheckVerticalDistance(Vector3 destination)
Parameters
Type Name Description
UnityEngine.Vector3 destination
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Disable()

Declaration
public virtual void Disable()
| Improve this Doc View Source

Enable()

Declaration
public virtual void Enable()
| Improve this Doc View Source

EnabledCheck()

Declaration
protected virtual void EnabledCheck()
| Improve this Doc View Source

FixedUpdate()

Declaration
protected virtual void FixedUpdate()
| Improve this Doc View Source

GenerateBallisticCurve(Vector3[])

Declaration
protected virtual void GenerateBallisticCurve(Vector3[] points)
Parameters
Type Name Description
UnityEngine.Vector3[] points
| Improve this Doc View Source

GenerateBezierCurve(Vector3, Vector3, Vector3, Vector3[])

Declaration
protected virtual void GenerateBezierCurve(Vector3 p0, Vector3 p1, Vector3 p2, Vector3[] points)
Parameters
Type Name Description
UnityEngine.Vector3 p0
UnityEngine.Vector3 p1
UnityEngine.Vector3 p2
UnityEngine.Vector3[] points
| Improve this Doc View Source

GenerateBezierCurve(Vector3[])

Declaration
protected virtual void GenerateBezierCurve(Vector3[] points)
Parameters
Type Name Description
UnityEngine.Vector3[] points
| Improve this Doc View Source

GetCapsuleData(out Single, out Single, out Single)

Gathers the height, radius, and collider width offset that will be used for the overlap fits check

Declaration
protected virtual void GetCapsuleData(out float height, out float radius, out float offset)
Parameters
Type Name Description
System.Single height

Height of the capsule
System.Single radius

Radius of the capsule
System.Single offset

Y offset (buffer) above the destination point to start the overlap check
| Improve this Doc View Source

GetCollisionMask()

Declaration
protected virtual LayerMask GetCollisionMask()
Returns
Type Description
UnityEngine.LayerMask
| Improve this Doc View Source

GetHorizontalPoint(Vector3)

Declaration
protected virtual Vector3 GetHorizontalPoint(Vector3 direction)
Parameters
Type Name Description
UnityEngine.Vector3 direction
Returns
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

GetTeleportDirection(out Single)

Declaration
protected virtual Vector3 GetTeleportDirection(out float angle)
Parameters
Type Name Description
System.Single angle
Returns
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

HandleValidStatus(Boolean)

Declaration
protected virtual void HandleValidStatus(bool valid)
Parameters
Type Name Description
System.Boolean valid
| Improve this Doc View Source

IsTeleportActivated()

Declaration
protected virtual bool IsTeleportActivated()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsTeleportDeactivated()

Declaration
protected virtual bool IsTeleportDeactivated()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LeftHandGrabbed(HVRGrabberBase, HVRGrabbable)

Declaration
protected virtual void LeftHandGrabbed(HVRGrabberBase arg0, HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabberBase arg0
HVRGrabbable grabbable
| Improve this Doc View Source

LeftHandReleased(HVRGrabberBase, HVRGrabbable)

Declaration
protected virtual void LeftHandReleased(HVRGrabberBase arg0, HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabberBase arg0
HVRGrabbable grabbable
| Improve this Doc View Source

OnAfterDashTeleport()

Declaration
protected virtual void OnAfterDashTeleport()
| Improve this Doc View Source

OnAfterTeleport()

Declaration
protected virtual void OnAfterTeleport()
| Improve this Doc View Source

OnBeforeDashTeleport()

Declaration
protected virtual void OnBeforeDashTeleport()
| Improve this Doc View Source

OnBeforeTeleport()

Declaration
protected virtual void OnBeforeTeleport()
| Improve this Doc View Source

OnTeleportActivated()

Declaration
protected virtual void OnTeleportActivated()
| Improve this Doc View Source

OnTeleportDeactivated()

Declaration
protected virtual void OnTeleportDeactivated()
| Improve this Doc View Source

OnValidTeleport()

Declaration
protected virtual void OnValidTeleport()
| Improve this Doc View Source

OnValidTeleportChanged(Boolean)

Declaration
public virtual void OnValidTeleportChanged(bool isTeleportValid)
Parameters
Type Name Description
System.Boolean isTeleportValid
| Improve this Doc View Source

ProjectDownwardRay(Vector3, out RaycastHit, Single)

Declaration
protected virtual bool ProjectDownwardRay(Vector3 origin, out RaycastHit hit, float length)
Parameters
Type Name Description
UnityEngine.Vector3 origin
UnityEngine.RaycastHit hit
System.Single length
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ProjectForwardRay(Vector3, Vector3, out RaycastHit)

Declaration
protected virtual bool ProjectForwardRay(Vector3 origin, Vector3 target, out RaycastHit hit)
Parameters
Type Name Description
UnityEngine.Vector3 origin
UnityEngine.Vector3 target
UnityEngine.RaycastHit hit
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Raycast()

Declaration
protected virtual void Raycast()
| Improve this Doc View Source

RightHandGrabbed(HVRGrabberBase, HVRGrabbable)

Declaration
protected virtual void RightHandGrabbed(HVRGrabberBase arg0, HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabberBase arg0
HVRGrabbable grabbable
| Improve this Doc View Source

RightHandReleased(HVRGrabberBase, HVRGrabbable)

Declaration
protected virtual void RightHandReleased(HVRGrabberBase arg0, HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabberBase arg0
HVRGrabbable grabbable
| Improve this Doc View Source

Start()

Declaration
protected virtual void Start()
| Improve this Doc View Source

Teleport(Vector3)

Declaration
public virtual bool Teleport(Vector3 position)
Parameters
Type Name Description
UnityEngine.Vector3 position
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Teleport(Vector3, Vector3)

Declaration
public virtual void Teleport(Vector3 position, Vector3 direction)
Parameters
Type Name Description
UnityEngine.Vector3 position
UnityEngine.Vector3 direction
| Improve this Doc View Source

ToggleGraphics(Boolean)

Declaration
protected virtual void ToggleGraphics(bool toggle)
Parameters
Type Name Description
System.Boolean toggle
| Improve this Doc View Source

Update()

Declaration
protected virtual void Update()
| Improve this Doc View Source

UpdateDashTeleport()

Declaration
protected virtual void UpdateDashTeleport()
| Improve this Doc View Source

UpdateDownRenderer(Vector3, Vector3, Boolean)

Declaration
protected virtual void UpdateDownRenderer(Vector3 origin, Vector3 targetPoint, bool forwardLineValid)
Parameters
Type Name Description
UnityEngine.Vector3 origin
UnityEngine.Vector3 targetPoint
System.Boolean forwardLineValid
| Improve this Doc View Source

UpdateLineRenderer(Vector3, Int32, Boolean)

Declaration
protected virtual void UpdateLineRenderer(Vector3 hitPoint, int lastValidIndex, bool lineValid)
Parameters
Type Name Description
UnityEngine.Vector3 hitPoint
System.Int32 lastValidIndex
System.Boolean lineValid
| Improve this Doc View Source

UpdateMarkerPosition()

Declaration
protected virtual void UpdateMarkerPosition()
| Improve this Doc View Source

UpdatePlayerPosition(Vector3)

Declaration
protected virtual void UpdatePlayerPosition(Vector3 position)
Parameters
Type Name Description
UnityEngine.Vector3 position
| Improve this Doc View Source

UpdateTeleport()

Declaration
protected virtual void UpdateTeleport()
| Improve this Doc View Source

UpdateTeleportMarker(Boolean)

Declaration
protected virtual void UpdateTeleportMarker(bool isTeleportValid)
Parameters
Type Name Description
System.Boolean isTeleportValid

Extension Methods