Class SteamVR_Input

Inheritance

System.Object

SteamVR_Input

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Valve.VR

Assembly: Assembly-CSharp.dll

Syntax

public class SteamVR_Input

Fields

actionFile

The serialized version of the actions file we're currently using (only used in editor)

Declaration

public static SteamVR_Input_ActionFile actionFile

Field Value

Type	Description
Valve.VR.SteamVR_Input_ActionFile

actionFileHash

The hash of the current action file on disk

Declaration

public static string actionFileHash

Field Value

Type	Description
System.String

actions

An array of all actions (in all action sets)

Declaration

public static SteamVR_Action[] actions

Field Value

Type	Description
SteamVR_Action[]

actionsBoolean

An array of all the boolean actions

Declaration

public static SteamVR_Action_Boolean[] actionsBoolean

Field Value

Type	Description
SteamVR_Action_Boolean[]

actionsByNameCache

Declaration

protected static Dictionary<string, SteamVR_Action> actionsByNameCache

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SteamVR_Action>

actionsByPath

Declaration

protected static Dictionary<string, SteamVR_Action> actionsByPath

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SteamVR_Action>

actionsByPathCache

Declaration

protected static Dictionary<string, SteamVR_Action> actionsByPathCache

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SteamVR_Action>

actionsByPathLowered

Declaration

protected static Dictionary<string, SteamVR_Action> actionsByPathLowered

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SteamVR_Action>

actionSets

An array of all action sets

Declaration

public static SteamVR_ActionSet[] actionSets

Field Value

Type	Description
SteamVR_ActionSet[]

actionSetsByNameCache

Declaration

protected static Dictionary<string, SteamVR_ActionSet> actionSetsByNameCache

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SteamVR_ActionSet>

actionSetsByPath

Declaration

protected static Dictionary<string, SteamVR_ActionSet> actionSetsByPath

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SteamVR_ActionSet>

actionSetsByPathCache

Declaration

protected static Dictionary<string, SteamVR_ActionSet> actionSetsByPathCache

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SteamVR_ActionSet>

actionSetsByPathLowered

Declaration

protected static Dictionary<string, SteamVR_ActionSet> actionSetsByPathLowered

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SteamVR_ActionSet>

actionsFilePath

Declaration

public static string actionsFilePath

Field Value

Type	Description
System.String

actionsIn

An array of all input actions

Declaration

public static ISteamVR_Action_In[] actionsIn

Field Value

Type	Description
ISteamVR_Action_In[]

actionsNonPoseNonSkeletonIn

An array of all the input actions that are not pose or skeleton actions (boolean, single, vector2, vector3)

Declaration

public static ISteamVR_Action_In[] actionsNonPoseNonSkeletonIn

Field Value

Type	Description
ISteamVR_Action_In[]

actionsOut

An array of all output actions (haptic)

Declaration

public static ISteamVR_Action_Out[] actionsOut

Field Value

Type	Description
ISteamVR_Action_Out[]

actionsPose

An array of all the pose actions

Declaration

public static SteamVR_Action_Pose[] actionsPose

Field Value

Type	Description
SteamVR_Action_Pose[]

actionsSingle

An array of all the single actions

Declaration

public static SteamVR_Action_Single[] actionsSingle

Field Value

Type	Description
SteamVR_Action_Single[]

actionsSkeleton

An array of all the skeleton actions

Declaration

public static SteamVR_Action_Skeleton[] actionsSkeleton

Field Value

Type	Description
SteamVR_Action_Skeleton[]

actionsVector2

An array of all the vector2 actions

Declaration

public static SteamVR_Action_Vector2[] actionsVector2

Field Value

Type	Description
SteamVR_Action_Vector2[]

actionsVector3

An array of all the vector3 actions

Declaration

public static SteamVR_Action_Vector3[] actionsVector3

Field Value

Type	Description
SteamVR_Action_Vector3[]

actionsVibration

An array of all the vibration (haptic) actions

Declaration

public static SteamVR_Action_Vibration[] actionsVibration

Field Value

Type	Description
SteamVR_Action_Vibration[]

defaultInputGameObjectName

Declaration

public const string defaultInputGameObjectName = "[SteamVR Input]"

Field Value

Type	Description
System.String

fileInitialized

True if the actions file has been initialized

Declaration

public static bool fileInitialized

Field Value

Type	Description
System.Boolean

initialized

True if the steamvr input system initialization process has completed successfully

Declaration

public static bool initialized

Field Value

Type	Description
System.Boolean

initializing

Declaration

protected static bool initializing

Field Value

Type	Description
System.Boolean

preInitialized

True if the preinitialization process (setting up dictionaries, etc) has completed successfully

Declaration

public static bool preInitialized

Field Value

Type	Description
System.Boolean

startupFrame

Declaration

protected static int startupFrame

Field Value

Type	Description
System.Int32

Properties

isStartupFrame

Declaration

public static bool isStartupFrame { get; }

Property Value

Type	Description
System.Boolean

Methods

CreateEmptyActionsFile(Boolean)

Declaration

public static bool CreateEmptyActionsFile(bool completelyEmpty = false)

Parameters

Type	Name	Description
System.Boolean	completelyEmpty

Returns

Type	Description
System.Boolean

DeleteManifestAndBindings()

Deletes the action manifest file and all the default bindings it had listed in the default bindings section

Declaration

public static bool DeleteManifestAndBindings()

Returns

Type	Description
System.Boolean	True if we deleted an action file, false if not.

DoesActionsFileExist()

Declaration

public static bool DoesActionsFileExist()

Returns

Type	Description
System.Boolean

FixedUpdate()

Gets called by SteamVR_Behaviour every FixedUpdate and updates actions if the steamvr settings are configured to update then.

Declaration

public static void FixedUpdate()

ForcePreinitialize()

Declaration

public static void ForcePreinitialize()

GetAction<T>(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static T GetAction<T>(string actionName, bool caseSensitive = false)
    where T : SteamVR_Action, new()

Parameters

Type	Name	Description
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
T

Type Parameters

Name	Description
T	The type of action you're expecting to get back

GetAction<T>(String, String, Boolean, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static T GetAction<T>(string actionSetName, string actionName, bool caseSensitive = false, bool returnNulls = false)
    where T : SteamVR_Action, new()

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster
System.Boolean	returnNulls	returns null if the action does not exist

Returns

Type	Description
T

Type Parameters

Name	Description
T	The type of action you're expecting to get back

GetActionDataFromPath<T>(String, Boolean)

Get an action's action data by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static T GetActionDataFromPath<T>(string path, bool caseSensitive = false)
    where T : SteamVR_Action_Source_Map

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action paths are in the format /actions/[actionSet]/[direction]/[actionName])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
T

Type Parameters

Name	Description
T	The type of action you're expecting to get back

GetActionFromPath<T>(String, Boolean, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static T GetActionFromPath<T>(string path, bool caseSensitive = false, bool returnNulls = false)
    where T : SteamVR_Action, new()

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action paths are in the format /actions/[actionSet]/[direction]/[actionName])
System.Boolean	caseSensitive	case sensitive searches are faster
System.Boolean	returnNulls

Returns

Type	Description
T

Type Parameters

Name	Description
T	The type of action you're expecting to get back

GetActions<T>()

Returns all of the actions of the specified type. If we're in the editor, doesn't rely on the arrays being filled.

Declaration

public static T[] GetActions<T>()
    where T : SteamVR_Action

Returns

Type	Description
T[]

Type Parameters

Name	Description
T	The type of actions you want to get

GetActionSet(String, Boolean, Boolean)

Get an action set by the full path to that action set. Action set paths are in the format /actions/[actionSet]

Declaration

public static SteamVR_ActionSet GetActionSet(string actionSetName, bool caseSensitive = false, bool returnsNulls = false)

Parameters

Type	Name	Description
System.String	actionSetName	The name to the action set you want
System.Boolean	caseSensitive	case sensitive searches are faster
System.Boolean	returnsNulls

Returns

Type	Description
SteamVR_ActionSet

GetActionSet<T>(String, Boolean, Boolean)

Get an action set by the full path to that action set. Action set paths are in the format /actions/[actionSet]

Declaration

public static T GetActionSet<T>(string actionSetName, bool caseSensitive = false, bool returnNulls = false)
    where T : SteamVR_ActionSet, new()

Parameters

Type	Name	Description
System.String	actionSetName	The name to the action set you want
System.Boolean	caseSensitive	case sensitive searches are faster
System.Boolean	returnNulls	returns a null if the set does not exist

Returns

Type	Description
T

Type Parameters

Name	Description
T	The type of action set you're expecting to get back

GetActionSetDataFromPath(String, Boolean)

Get an action set's data by the full path to that action. Action set paths are in the format /actions/[actionSet]

Declaration

public static SteamVR_ActionSet_Data GetActionSetDataFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action set paths are in the format /actions/[actionSet])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_ActionSet_Data

GetActionSetFromPath(String, Boolean)

Get an action set by the full path to that action set. Action set paths are in the format /actions/[actionSet]

Declaration

public static SteamVR_ActionSet GetActionSetFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path	The full path to the action set you want (Action paths are in the format /actions/[actionSet])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_ActionSet

GetActionSetFromPath<T>(String, Boolean, Boolean)

Get an action set by the full path to that action set. Action set paths are in the format /actions/[actionSet]

Declaration

public static T GetActionSetFromPath<T>(string path, bool caseSensitive = false, bool returnsNulls = false)
    where T : SteamVR_ActionSet, new()

Parameters

Type	Name	Description
System.String	path	The full path to the action set you want (Action paths are in the format /actions/[actionSet])
System.Boolean	caseSensitive	case sensitive searches are faster
System.Boolean	returnsNulls

Returns

Type	Description
T

Type Parameters

Name	Description
T	The type of action set you're expecting to get back

GetActionSets()

Returns all of the action sets. If we're in the editor, doesn't rely on the actionSets field being filled.

Declaration

public static SteamVR_ActionSet[] GetActionSets()

Returns

Type	Description
SteamVR_ActionSet[]

GetBaseAction(String, String, Boolean)

Declaration

public static SteamVR_Action GetBaseAction(string actionSetName, string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive

Returns

Type	Description
SteamVR_Action

GetBaseActionFromPath(String, Boolean)

Declaration

public static SteamVR_Action GetBaseActionFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path
System.Boolean	caseSensitive

Returns

Type	Description
SteamVR_Action

GetBooleanAction(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Boolean GetBooleanAction(string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Boolean

GetBooleanAction(String, String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Boolean GetBooleanAction(string actionSetName, string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Boolean

GetBooleanActionFromPath(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Boolean GetBooleanActionFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action paths are in the format /actions/[actionSet]/[direction]/[actionName])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Boolean

GetFloat(String, String, SteamVR_Input_Sources, Boolean)

Get the float value of an action by the action set name, action name, and input source. Optionally case sensitive (for faster results). (same as GetSingle)

Declaration

public static float GetFloat(string actionSet, string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSet	The name of the action set the action is contained in
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Single

GetFloat(String, SteamVR_Input_Sources, Boolean)

Get the float value of an action by the action name and input source. Optionally case sensitive (for faster results). (same as GetSingle)

Declaration

public static float GetFloat(string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Single

GetLocalizedName(UInt64, EVRInputStringBits[])

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

Declaration

public static string GetLocalizedName(ulong originHandle, params EVRInputStringBits[] localizedParts)

Parameters

Type	Name	Description
System.UInt64	originHandle
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

GetPoseAction(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Pose GetPoseAction(string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Pose

GetPoseAction(String, String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Pose GetPoseAction(string actionSetName, string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Pose

GetPoseActionFromPath(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Pose GetPoseActionFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action paths are in the format /actions/[actionSet]/[direction]/[actionName])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Pose

GetResourcesFolderPath(Boolean)

Declaration

public static string GetResourcesFolderPath(bool fromAssetsDirectory = false)

Parameters

Type	Name	Description
System.Boolean	fromAssetsDirectory

Returns

Type	Description
System.String

GetSingle(String, String, SteamVR_Input_Sources, Boolean)

Get the float value of an action by the action set name, action name, and input source. Optionally case sensitive (for faster results). (same as GetFloat)

Declaration

public static float GetSingle(string actionSet, string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSet	The name of the action set the action is contained in
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Single

GetSingle(String, SteamVR_Input_Sources, Boolean)

Get the float value of an action by the action name and input source. Optionally case sensitive (for faster results). (same as GetFloat)

Declaration

public static float GetSingle(string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Single

GetSingleAction(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Single GetSingleAction(string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Single

GetSingleAction(String, String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Single GetSingleAction(string actionSetName, string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Single

GetSingleActionFromPath(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Single GetSingleActionFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action paths are in the format /actions/[actionSet]/[direction]/[actionName])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Single

GetSkeletonAction(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Skeleton GetSkeletonAction(string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Skeleton

GetSkeletonAction(String, String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Skeleton GetSkeletonAction(string actionSetName, string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Skeleton

GetSkeletonActionFromPath(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Skeleton GetSkeletonActionFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action paths are in the format /actions/[actionSet]/[direction]/[actionName])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Skeleton

GetState(String, String, SteamVR_Input_Sources, Boolean)

Get the state of an action by the action set name, action name, and input source. Optionally case sensitive (for faster results)

Declaration

public static bool GetState(string actionSet, string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSet	The name of the action set the action is contained in
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Boolean

GetState(String, SteamVR_Input_Sources, Boolean)

Get the state of an action by the action name and input source. Optionally case sensitive (for faster results)

Declaration

public static bool GetState(string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Boolean

GetStateDown(String, String, SteamVR_Input_Sources, Boolean)

Get the state down of an action by the action set name, action name, and input source. Optionally case sensitive (for faster results)

Declaration

public static bool GetStateDown(string actionSet, string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSet	The name of the action set the action is contained in
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Boolean	True when the action was false last update and is now true. Returns false again afterwards.

GetStateDown(String, SteamVR_Input_Sources, Boolean)

Get the state down of an action by the action name and input source. Optionally case sensitive (for faster results)

Declaration

public static bool GetStateDown(string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Boolean	True when the action was false last update and is now true. Returns false again afterwards.

GetStateUp(String, String, SteamVR_Input_Sources, Boolean)

Get the state up of an action by the action set name, action name, and input source. Optionally case sensitive (for faster results)

Declaration

public static bool GetStateUp(string actionSet, string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSet	The name of the action set the action is contained in
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Boolean	True when the action was true last update and is now false. Returns false again afterwards.

GetStateUp(String, SteamVR_Input_Sources, Boolean)

Get the state up of an action by the action name and input source. Optionally case sensitive (for faster results)

Declaration

public static bool GetStateUp(string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
System.Boolean	True when the action was true last update and is now false. Returns false again afterwards.

GetVector2(String, String, SteamVR_Input_Sources, Boolean)

Get the Vector2 value of an action by the action set name, action name, and input source. Optionally case sensitive (for faster results)

Declaration

public static Vector2 GetVector2(string actionSet, string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSet	The name of the action set the action is contained in
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
UnityEngine.Vector2

GetVector2(String, SteamVR_Input_Sources, Boolean)

Get the Vector2 value of an action by the action name and input source. Optionally case sensitive (for faster results)

Declaration

public static Vector2 GetVector2(string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
UnityEngine.Vector2

GetVector2Action(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Vector2 GetVector2Action(string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Vector2

GetVector2Action(String, String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Vector2 GetVector2Action(string actionSetName, string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Vector2

GetVector2ActionFromPath(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Vector2 GetVector2ActionFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action paths are in the format /actions/[actionSet]/[direction]/[actionName])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Vector2

GetVector3(String, String, SteamVR_Input_Sources, Boolean)

Get the Vector3 value of an action by the action set name, action name, and input source. Optionally case sensitive (for faster results)

Declaration

public static Vector3 GetVector3(string actionSet, string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSet	The name of the action set the action is contained in
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
UnityEngine.Vector3

GetVector3(String, SteamVR_Input_Sources, Boolean)

Get the Vector3 value of an action by the action name and input source. Optionally case sensitive (for faster results)

Declaration

public static Vector3 GetVector3(string action, SteamVR_Input_Sources inputSource, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	action	The name of the action to get the state of
SteamVR_Input_Sources	inputSource	The input source to get the action state from
System.Boolean	caseSensitive	Whether or not the action set and action name searches should be case sensitive (case sensitive searches are faster)

Returns

Type	Description
UnityEngine.Vector3

GetVector3Action(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Vector3 GetVector3Action(string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Vector3

GetVector3Action(String, String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Vector3 GetVector3Action(string actionSetName, string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Vector3

GetVector3ActionFromPath(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Vector3 GetVector3ActionFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action paths are in the format /actions/[actionSet]/[direction]/[actionName])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Vector3

GetVibrationAction(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Vibration GetVibrationAction(string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Vibration

GetVibrationAction(String, String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Vibration GetVibrationAction(string actionSetName, string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Vibration

GetVibrationActionFromPath(String, Boolean)

Get an action by the full path to that action. Action paths are in the format /actions/[actionSet]/[direction]/[actionName]

Declaration

public static SteamVR_Action_Vibration GetVibrationActionFromPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path	The full path to the action you want (Action paths are in the format /actions/[actionSet]/[direction]/[actionName])
System.Boolean	caseSensitive	case sensitive searches are faster

Returns

Type	Description
SteamVR_Action_Vibration

HasAction(String, Boolean)

Declaration

public static bool HasAction(string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionName
System.Boolean	caseSensitive

Returns

Type	Description
System.Boolean

HasAction(String, String, Boolean)

Declaration

public static bool HasAction(string actionSetName, string actionName, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	actionSetName
System.String	actionName
System.Boolean	caseSensitive

Returns

Type	Description
System.Boolean

HasActionPath(String, Boolean)

Declaration

public static bool HasActionPath(string path, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	path
System.Boolean	caseSensitive

Returns

Type	Description
System.Boolean

HasActionSet(String, Boolean)

Declaration

protected static bool HasActionSet(string name, bool caseSensitive = false)

Parameters

Type	Name	Description
System.String	name
System.Boolean	caseSensitive

Returns

Type	Description
System.Boolean

HasFileInMemoryBeenModified()

Does the actions file in memory differ from the one on disk as determined by a md5 hash

Declaration

public static bool HasFileInMemoryBeenModified()

Returns

Type	Description
System.Boolean

IdentifyActionsFile(Boolean)

Tell SteamVR that we're using the actions file at the path defined in SteamVR_Settings.

Declaration

public static void IdentifyActionsFile(bool showLogs = true)

Parameters

Type	Name	Description
System.Boolean	showLogs

Initialize(Boolean)

Get all the handles for actions and action sets. Initialize our dictionaries of action / action set names. Setup the tracking space universe origin

Declaration

public static void Initialize(bool force = false)

Parameters

Type	Name	Description
System.Boolean	force

InitializeFile(Boolean, Boolean)

Load from disk and deserialize the actions file

Declaration

public static bool InitializeFile(bool force = false, bool showErrors = true)

Parameters

Type	Name	Description
System.Boolean	force	Force a refresh of this file from disk
System.Boolean	showErrors

Returns

Type	Description
System.Boolean

IsOpeningSetup()

Declaration

public static bool IsOpeningSetup()

Returns

Type	Description
System.Boolean

LateUpdate()

Gets called by SteamVR_Behaviour every LateUpdate and updates actions if the steamvr settings are configured to update then. Also updates skeletons regardless of settings are configured to so we can account for animations on the skeletons.

Declaration

public static void LateUpdate()

OnPreCull()

Gets called by SteamVR_Behaviour every OnPreCull and updates actions if the steamvr settings are configured to update then.

Declaration

public static void OnPreCull()

PreinitializeActionDictionaries()

Declaration

public static void PreinitializeActionDictionaries()

PreinitializeActionSetDictionaries()

Declaration

public static void PreinitializeActionSetDictionaries()

PreinitializeFinishActionSets()

Declaration

public static void PreinitializeFinishActionSets()

Update()

Gets called by SteamVR_Behaviour every Update and updates actions if the steamvr settings are configured to update then.

Declaration

public static void Update()

UpdateNonVisualActions()

Updates the states of all the non visual actions (boolean, single, vector2, vector3)

Declaration

public static void UpdateNonVisualActions()

UpdatePoseActions(Boolean)

Updates the states of all the pose actions

Declaration

public static void UpdatePoseActions(bool skipSendingEvents = false)

Parameters

Type	Name	Description
System.Boolean	skipSendingEvents	Controls whether or not events are fired from this update call

UpdateSkeletonActions(Boolean)

Updates the states of all the skeleton actions

Declaration

public static void UpdateSkeletonActions(bool skipSendingEvents = false)

Parameters

Type	Name	Description
System.Boolean	skipSendingEvents	Controls whether or not events are fired from this update call

UpdateVisualActions(Boolean)

Updates the states of all the visual actions (pose / skeleton)

Declaration

public static void UpdateVisualActions(bool skipStateAndEventUpdates = false)

Parameters

Type	Name	Description
System.Boolean	skipStateAndEventUpdates	Controls whether or not events are fired from this update call

Events

onNonVisualActionsUpdated

An event that fires when the non visual actions (everything except poses / skeletons) have been updated

Declaration

public static event Action onNonVisualActionsUpdated

Event Type

Type	Description
System.Action

onPosesUpdated

An event that fires when the pose actions have been updated

Declaration

public static event SteamVR_Input.PosesUpdatedHandler onPosesUpdated

Event Type

Type	Description
SteamVR_Input.PosesUpdatedHandler

onSkeletonsUpdated

An event that fires when the skeleton actions have been updated

Declaration

public static event SteamVR_Input.SkeletonsUpdatedHandler onSkeletonsUpdated

Event Type

Type	Description
SteamVR_Input.SkeletonsUpdatedHandler