[Serializable]
public class SteamVR_Action_Boolean : SteamVR_Action_In<SteamVR_Action_Boolean_Source_Map, SteamVR_Action_Boolean_Source>, IEquatable<SteamVR_Action>, ISteamVR_Action_In, ISteamVR_Action, ISteamVR_Action_Boolean, ISteamVR_Action_In_Source, ISteamVR_Action_Source, ISerializationCallbackReceiver

Constructors

SteamVR_Action_Boolean()

Declaration

public SteamVR_Action_Boolean()

Properties

lastState

[Shortcut to: SteamVR_Input_Sources.Any] (previous update) True when the boolean action is true

Declaration

public bool lastState { get; }

Property Value

Type	Description
System.Boolean

lastStateDown

[Shortcut to: SteamVR_Input_Sources.Any] (previous update) True when the boolean action is true and the last state was false

Declaration

public bool lastStateDown { get; }

Property Value

Type	Description
System.Boolean

lastStateUp

[Shortcut to: SteamVR_Input_Sources.Any] (previous update) True when the boolean action is false and the last state was true

Declaration

public bool lastStateUp { get; }

Property Value

Type	Description
System.Boolean

state

[Shortcut to: SteamVR_Input_Sources.Any] True when the boolean action is true

Declaration

public bool state { get; }

Property Value

Type	Description
System.Boolean

stateDown

[Shortcut to: SteamVR_Input_Sources.Any] True when the boolean action is true and the last state was false

Declaration

public bool stateDown { get; }

Property Value

Type	Description
System.Boolean

stateUp

[Shortcut to: SteamVR_Input_Sources.Any] True when the boolean action is false and the last state was true

Declaration

public bool stateUp { get; }

Property Value

Type	Description
System.Boolean

Methods

AddOnActiveBindingChangeListener(SteamVR_Action_Boolean.ActiveChangeHandler, SteamVR_Input_Sources)

Executes a function when the active state of this action (with the specified inputSource) changes. This happens when the action is bound or unbound

Declaration

public void AddOnActiveBindingChangeListener(SteamVR_Action_Boolean.ActiveChangeHandler functionToCall, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.ActiveChangeHandler	functionToCall	A local function that receives the boolean action who's active state changes and the corresponding input source
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

AddOnActiveChangeListener(SteamVR_Action_Boolean.ActiveChangeHandler, SteamVR_Input_Sources)

Executes a function when the functional active state of this action (with the specified inputSource) changes. This happens when the action is bound or unbound, or when the ActionSet changes state.

Declaration

public void AddOnActiveChangeListener(SteamVR_Action_Boolean.ActiveChangeHandler functionToCall, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.ActiveChangeHandler	functionToCall	A local function that receives the boolean action who's active state changes and the corresponding input source
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

AddOnChangeListener(SteamVR_Action_Boolean.ChangeHandler, SteamVR_Input_Sources)

Executes a function when the state of this action (with the specified inputSource) changes

Declaration

public void AddOnChangeListener(SteamVR_Action_Boolean.ChangeHandler functionToCall, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.ChangeHandler	functionToCall	A local function that receives the boolean action who's state has changed, the corresponding input source, and the new value
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

AddOnStateDownListener(SteamVR_Action_Boolean.StateDownHandler, SteamVR_Input_Sources)

Executes a function when the state of this action (with the specified inputSource) changes to true (from false).

Declaration

public void AddOnStateDownListener(SteamVR_Action_Boolean.StateDownHandler functionToCall, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.StateDownHandler	functionToCall	A local function that receives the boolean action who's state has changed, the corresponding input source, and the new value
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

AddOnStateUpListener(SteamVR_Action_Boolean.StateUpHandler, SteamVR_Input_Sources)

Executes a function when the state of this action (with the specified inputSource) changes to false (from true).

Declaration

public void AddOnStateUpListener(SteamVR_Action_Boolean.StateUpHandler functionToCall, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.StateUpHandler	functionToCall	A local function that receives the boolean action who's state has changed, the corresponding input source, and the new value
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

AddOnUpdateListener(SteamVR_Action_Boolean.UpdateHandler, SteamVR_Input_Sources)

Executes a function when the state of this action (with the specified inputSource) is updated.

Declaration

public void AddOnUpdateListener(SteamVR_Action_Boolean.UpdateHandler functionToCall, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.UpdateHandler	functionToCall	A local function that receives the boolean action who's state has changed, the corresponding input source, and the new value
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

GetLastState(SteamVR_Input_Sources)

[For the previous update] Returns true if the value of the action was true.

Declaration

public bool GetLastState(SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

Returns

Type	Description
System.Boolean

GetLastStateDown(SteamVR_Input_Sources)

[For the previous update] Returns true if the value of the action has been set to true (from false).

Declaration

public bool GetLastStateDown(SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

Returns

Type	Description
System.Boolean

GetLastStateUp(SteamVR_Input_Sources)

[For the previous update] Returns true if the value of the action has been set to false (from true).

Declaration

public bool GetLastStateUp(SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

Returns

Type	Description
System.Boolean

GetState(SteamVR_Input_Sources)

Returns true if the value of the action (state) is currently true

Declaration

public bool GetState(SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

Returns

Type	Description
System.Boolean

GetStateDown(SteamVR_Input_Sources)

Returns true if the value of the action has been changed to true (from false) in the most recent update.

Declaration

public bool GetStateDown(SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

Returns

Type	Description
System.Boolean

GetStateUp(SteamVR_Input_Sources)

Returns true if the value of the action has been changed to false (from true) in the most recent update.

Declaration

public bool GetStateUp(SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

Returns

Type	Description
System.Boolean

RemoveOnActiveBindingChangeListener(SteamVR_Action_Boolean.ActiveChangeHandler, SteamVR_Input_Sources)

Stops executing the function setup by the corresponding AddListener

Declaration

public void RemoveOnActiveBindingChangeListener(SteamVR_Action_Boolean.ActiveChangeHandler functionToStopCalling, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.ActiveChangeHandler	functionToStopCalling	The local function that you've setup to receive update events
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

RemoveOnActiveChangeListener(SteamVR_Action_Boolean.ActiveChangeHandler, SteamVR_Input_Sources)

Stops executing a function when the functional active state of this action (with the specified inputSource) changes. This happens when the action is bound or unbound, or when the ActionSet changes state.

Declaration

public void RemoveOnActiveChangeListener(SteamVR_Action_Boolean.ActiveChangeHandler functionToStopCalling, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.ActiveChangeHandler	functionToStopCalling	The local function that you've setup to receive update events
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

RemoveOnChangeListener(SteamVR_Action_Boolean.ChangeHandler, SteamVR_Input_Sources)

Stops executing the function setup by the corresponding AddListener

Declaration

public void RemoveOnChangeListener(SteamVR_Action_Boolean.ChangeHandler functionToStopCalling, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.ChangeHandler	functionToStopCalling	The local function that you've setup to receive on change events
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

RemoveOnStateDownListener(SteamVR_Action_Boolean.StateDownHandler, SteamVR_Input_Sources)

Stops executing the function setup by the corresponding AddListener

Declaration

public void RemoveOnStateDownListener(SteamVR_Action_Boolean.StateDownHandler functionToStopCalling, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.StateDownHandler	functionToStopCalling	The local function that you've setup to receive update events
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

RemoveOnStateUpListener(SteamVR_Action_Boolean.StateUpHandler, SteamVR_Input_Sources)

Stops executing the function setup by the corresponding AddListener

Declaration

public void RemoveOnStateUpListener(SteamVR_Action_Boolean.StateUpHandler functionToStopCalling, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.StateUpHandler	functionToStopCalling	The local function that you've setup to receive events
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

RemoveOnUpdateListener(SteamVR_Action_Boolean.UpdateHandler, SteamVR_Input_Sources)

Stops executing the function setup by the corresponding AddListener

Declaration

public void RemoveOnUpdateListener(SteamVR_Action_Boolean.UpdateHandler functionToStopCalling, SteamVR_Input_Sources inputSource)

Parameters

Type	Name	Description
SteamVR_Action_Boolean.UpdateHandler	functionToStopCalling	The local function that you've setup to receive update events
SteamVR_Input_Sources	inputSource	The device you would like to get data from. Any if the action is not device specific.

Events

onActiveBindingChange

[Shortcut to: SteamVR_Input_Sources.Any] Event fires when the bound state of the binding changes

Declaration

public event SteamVR_Action_Boolean.ActiveChangeHandler onActiveBindingChange

Event Type

Type	Description
SteamVR_Action_Boolean.ActiveChangeHandler

onActiveChange

[Shortcut to: SteamVR_Input_Sources.Any] Event fires when the active state (ActionSet active and binding active) changes

Declaration

public event SteamVR_Action_Boolean.ActiveChangeHandler onActiveChange

Event Type

Type	Description
SteamVR_Action_Boolean.ActiveChangeHandler

onChange

[Shortcut to: SteamVR_Input_Sources.Any] This event fires whenever a state changes from false to true or true to false

Declaration

public event SteamVR_Action_Boolean.ChangeHandler onChange

Event Type

Type	Description
SteamVR_Action_Boolean.ChangeHandler

onState

[Shortcut to: SteamVR_Input_Sources.Any] This event fires whenever the boolean action is true and gets updated

Declaration

public event SteamVR_Action_Boolean.StateHandler onState

Event Type

Type	Description
SteamVR_Action_Boolean.StateHandler

onStateDown

[Shortcut to: SteamVR_Input_Sources.Any] This event fires whenever the state of the boolean action has changed from false to true in the most recent update

Declaration

public event SteamVR_Action_Boolean.StateDownHandler onStateDown

Event Type

Type	Description
SteamVR_Action_Boolean.StateDownHandler

onStateUp

[Shortcut to: SteamVR_Input_Sources.Any] This event fires whenever the state of the boolean action has changed from true to false in the most recent update

Declaration

public event SteamVR_Action_Boolean.StateUpHandler onStateUp

Event Type

Type	Description
SteamVR_Action_Boolean.StateUpHandler

onUpdate

[Shortcut to: SteamVR_Input_Sources.Any] This event fires whenever the action is updated

Declaration

public event SteamVR_Action_Boolean.UpdateHandler onUpdate

Event Type

Type	Description
SteamVR_Action_Boolean.UpdateHandler

Explicit Interface Implementations

ISerializationCallbackReceiver.OnAfterDeserialize()

Declaration

void ISerializationCallbackReceiver.OnAfterDeserialize()

ISerializationCallbackReceiver.OnBeforeSerialize()

Declaration

void ISerializationCallbackReceiver.OnBeforeSerialize()

Implements

System.IEquatable<T>

ISteamVR_Action_In

ISteamVR_Action

ISteamVR_Action_Boolean

ISteamVR_Action_In_Source

ISteamVR_Action_Source

UnityEngine.ISerializationCallbackReceiver