Class SteamVR_Behaviour_Boolean

This component simplifies using boolean actions.

Provides editor accessible events: OnPress, OnPressDown, OnPressUp, OnChange, and OnUpdate.

Provides script accessible events: OnPressEvent, OnPressDownEvent, OnPressUpEvent, OnChangeEvent, and OnUpdateEvent.

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

SteamVR_Behaviour_Boolean

Inherited Members

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

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)

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

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.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

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.Component.rigidbody

UnityEngine.Component.rigidbody2D

UnityEngine.Component.camera

UnityEngine.Component.light

UnityEngine.Component.animation

UnityEngine.Component.constantForce

UnityEngine.Component.renderer

UnityEngine.Component.audio

UnityEngine.Component.guiText

UnityEngine.Component.networkView

UnityEngine.Component.guiElement

UnityEngine.Component.guiTexture

UnityEngine.Component.collider

UnityEngine.Component.collider2D

UnityEngine.Component.hingeJoint

UnityEngine.Component.particleEmitter

UnityEngine.Component.particleSystem

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.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.ToString()

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.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindObjectOfType<T>()

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: Valve.VR

Assembly: Assembly-CSharp.dll

Syntax

public class SteamVR_Behaviour_Boolean : MonoBehaviour

Fields

booleanAction

Declaration

[Tooltip("The SteamVR boolean action that this component should use")]
public SteamVR_Action_Boolean booleanAction

Field Value

Type	Description
SteamVR_Action_Boolean

inputSource

Declaration

[Tooltip("The device this action should apply to. Any if the action is not device specific.")]
public SteamVR_Input_Sources inputSource

Field Value

Type	Description
SteamVR_Input_Sources

onChange

This UnityEvent fires whenever a change happens in the action

Declaration

public SteamVR_Behaviour_BooleanEvent onChange

Field Value

Type	Description
SteamVR_Behaviour_BooleanEvent

onPress

This UnityEvent will fire whenever the boolean action is true and gets updated

Declaration

public SteamVR_Behaviour_BooleanEvent onPress

Field Value

Type	Description
SteamVR_Behaviour_BooleanEvent

onPressDown

This UnityEvent will fire whenever the boolean action has changed from false to true in the last update

Declaration

public SteamVR_Behaviour_BooleanEvent onPressDown

Field Value

Type	Description
SteamVR_Behaviour_BooleanEvent

onPressUp

This UnityEvent will fire whenever the boolean action has changed from true to false in the last update

Declaration

public SteamVR_Behaviour_BooleanEvent onPressUp

Field Value

Type	Description
SteamVR_Behaviour_BooleanEvent

onUpdate

This UnityEvent fires whenever the action is updated

Declaration

public SteamVR_Behaviour_BooleanEvent onUpdate

Field Value

Type	Description
SteamVR_Behaviour_BooleanEvent

Properties

actionSet

Returns the action set that this action is in.

Declaration

public SteamVR_ActionSet actionSet { get; }

Property Value

Type	Description
SteamVR_ActionSet

isActive

Returns true if this action is currently bound and its action set is active

Declaration

public bool isActive { get; }

Property Value

Type	Description
System.Boolean

Methods

AddHandlers()

Declaration

protected void AddHandlers()

GetLocalizedName(EVRInputStringBits[])

Gets the localized name of the device that the action corresponds to.

Declaration

public string GetLocalizedName(params EVRInputStringBits[] localizedParts)

Parameters

Type	Name	Description
EVRInputStringBits[]	localizedParts	VRInputString_Hand - Which hand the origin is in. E.g. "Left Hand" VRInputString_ControllerType - What kind of controller the user has in that hand.E.g. "Vive Controller" VRInputString_InputSource - What part of that controller is the origin. E.g. "Trackpad" VRInputString_All - All of the above. E.g. "Left Hand Vive Controller Trackpad"

Returns

Type	Description
System.String

OnDisable()

Declaration

protected virtual void OnDisable()

OnEnable()

Declaration

protected virtual void OnEnable()

RemoveHandlers()

Declaration

protected void RemoveHandlers()

Events

onChangeEvent

This C# event fires whenever a change happens in the action

Declaration

public event SteamVR_Behaviour_Boolean.ChangeHandler onChangeEvent

Event Type

Type	Description
SteamVR_Behaviour_Boolean.ChangeHandler

onPressDownEvent

This C# event will fire whenever the boolean action has changed from false to true in the last update

Declaration

public event SteamVR_Behaviour_Boolean.StateDownHandler onPressDownEvent

Event Type

Type	Description
SteamVR_Behaviour_Boolean.StateDownHandler

onPressEvent

This C# event will fire whenever the boolean action is true and gets updated

Declaration

public event SteamVR_Behaviour_Boolean.StateHandler onPressEvent

Event Type

Type	Description
SteamVR_Behaviour_Boolean.StateHandler

onPressUpEvent

This C# event will fire whenever the boolean action has changed from true to false in the last update

Declaration

public event SteamVR_Behaviour_Boolean.StateUpHandler onPressUpEvent

Event Type

Type	Description
SteamVR_Behaviour_Boolean.StateUpHandler

onUpdateEvent

This C# event fires whenever the action is updated

Declaration

public event SteamVR_Behaviour_Boolean.UpdateHandler onUpdateEvent

Event Type

Type	Description
SteamVR_Behaviour_Boolean.UpdateHandler