Class HVRPlayerInputs

Used by the player controller, teleporter, and hand grabbing systems to drive their actions. Subclass and override the virtual methods if you wish to customize inputs per device.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
HVRPlayerInputs
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.ControllerInput
Assembly: HurricaneVR.Framework.dll
Syntax
public class HVRPlayerInputs : MonoBehaviour

Fields

| Improve this Doc View Source

CanDistanceGrab

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

CanTriggerGrab

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

CrouchState

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

ForceGrabActivation

Declaration
[Tooltip("For non flick style force grabber")]
public HVRForceGrabActivation ForceGrabActivation
Field Value
Type Description
HVRForceGrabActivation
| Improve this Doc View Source

IsCrouchActivated

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

IsJumpActivated

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

IsLeftForceGrabActivated

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

IsLeftForceGrabActive

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

IsLeftGrabActivated

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

IsLeftGripHoldActive

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

IsLeftHoldActive

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

IsLeftTriggerHoldActive

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

IsMouseDown

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

IsRightForceGrabActivated

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

IsRightForceGrabActive

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

IsRightGrabActivated

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

IsRightGripHoldActive

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

IsRightHoldActive

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

IsRightTriggerHoldActive

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

IsSprintingActivated

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

IsStandActivated

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

IsTeleportActivated

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

IsTeleportDeactivated

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

JumpState

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

LeftTriggerGrabState

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

MouseAxis

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

MovementAxis

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

RightTriggerGrabState

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

SprintRequiresDoubleClick

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

StandState

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

SwapMovementAxis

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

TeleportHandSide

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

TriggerGrabThreshold

Declaration
[Range(0F, 1F)]
public float TriggerGrabThreshold
Field Value
Type Description
System.Single
| Improve this Doc View Source

TurnAxis

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

UseWASD

Declaration
[Header("Debugging")]
public bool UseWASD
Field Value
Type Description
System.Boolean

Properties

| Improve this Doc View Source

LeftController

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

LeftControllerType

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

RightController

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

RightControllerType

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

TeleportController

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

UpdateInputs

Declaration
public bool UpdateInputs { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

AfterInputUpdate()

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

GetCrouch()

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

GetForceGrabActivated(HVRHandSide)

Declaration
public bool GetForceGrabActivated(HVRHandSide side)
Parameters
Type Name Description
HVRHandSide side
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetForceGrabActivated(out Boolean, out Boolean)

Declaration
protected virtual void GetForceGrabActivated(out bool left, out bool right)
Parameters
Type Name Description
System.Boolean left
System.Boolean right
| Improve this Doc View Source

GetForceGrabActive(HVRHandSide)

Declaration
public bool GetForceGrabActive(HVRHandSide side)
Parameters
Type Name Description
HVRHandSide side
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetForceGrabActive(out Boolean, out Boolean)

Declaration
protected virtual void GetForceGrabActive(out bool left, out bool right)
Parameters
Type Name Description
System.Boolean left
System.Boolean right
| Improve this Doc View Source

GetGrabActivated(HVRHandSide)

Declaration
public bool GetGrabActivated(HVRHandSide side)
Parameters
Type Name Description
HVRHandSide side
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetGripHoldActive(HVRHandSide)

Declaration
public bool GetGripHoldActive(HVRHandSide side)
Parameters
Type Name Description
HVRHandSide side
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetHoldActive(HVRHandSide)

Declaration
public bool GetHoldActive(HVRHandSide side)
Parameters
Type Name Description
HVRHandSide side
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetIsJumpActivated()

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

GetIsLeftGrabActivated()

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

GetIsLeftHoldActive()

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

GetIsRightGrabActivated()

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

GetIsRightHoldActive()

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

GetMouse(out Boolean)

Declaration
protected virtual Vector2 GetMouse(out bool mouseDown)
Parameters
Type Name Description
System.Boolean mouseDown
Returns
Type Description
UnityEngine.Vector2
| Improve this Doc View Source

GetMovementAxis()

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

GetSprinting()

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

GetStand()

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

GetTeleportActivated()

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

GetTeleportDeactivated()

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

GetTriggerGrabState(HVRHandSide)

Declaration
public HVRButtonState GetTriggerGrabState(HVRHandSide side)
Parameters
Type Name Description
HVRHandSide side
Returns
Type Description
HVRButtonState
| Improve this Doc View Source

GetTurnAxis()

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

ResetState(ref HVRButtonState)

Declaration
protected void ResetState(ref HVRButtonState buttonState)
Parameters
Type Name Description
HVRButtonState buttonState
| Improve this Doc View Source

SetState(ref HVRButtonState, Boolean)

Declaration
protected void SetState(ref HVRButtonState buttonState, bool pressed)
Parameters
Type Name Description
HVRButtonState buttonState
System.Boolean pressed
| Improve this Doc View Source

Update()

Declaration
public void Update()
| Improve this Doc View Source

UpdateInput()

Declaration
protected virtual void UpdateInput()

Extension Methods