Class SteamVR_ActionSet

Action sets are logical groupings of actions. Multiple sets can be active at one time.

Inheritance
System.Object
SteamVR_ActionSet
SteamVR_Input_ActionSet_buggy
SteamVR_Input_ActionSet_default
SteamVR_Input_ActionSet_mixedreality
SteamVR_Input_ActionSet_platformer
Implements
System.IEquatable<SteamVR_ActionSet>
UnityEngine.ISerializationCallbackReceiver
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Valve.VR
Assembly: Assembly-CSharp.dll
Syntax
[Serializable]
public class SteamVR_ActionSet : IEquatable<SteamVR_ActionSet>, ISteamVR_ActionSet, ISerializationCallbackReceiver

Constructors

SteamVR_ActionSet()

Declaration
public SteamVR_ActionSet()

Fields

initialized

Declaration
[NonSerialized]
protected bool initialized
Field Value
Type Description
System.Boolean

setData

Declaration
[NonSerialized]
protected SteamVR_ActionSet_Data setData
Field Value
Type Description
SteamVR_ActionSet_Data

Properties

allActions

All actions within this set (including out actions)

Declaration
public SteamVR_Action[] allActions { get; }
Property Value
Type Description
SteamVR_Action[]

fullPath

The full path to this action set (ex: /actions/in/default)

Declaration
public string fullPath { get; }
Property Value
Type Description
System.String

handle

Declaration
public ulong handle { get; }
Property Value
Type Description
System.UInt64

nonVisualInActions

All IN actions within this set that are NOT pose or skeleton actions

Declaration
public ISteamVR_Action_In[] nonVisualInActions { get; }
Property Value
Type Description
ISteamVR_Action_In[]

outActionArray

All out actions within this set

Declaration
public ISteamVR_Action_Out[] outActionArray { get; }
Property Value
Type Description
ISteamVR_Action_Out[]

poseActions

All pose actions within this set

Declaration
public SteamVR_Action_Pose[] poseActions { get; }
Property Value
Type Description
SteamVR_Action_Pose[]

skeletonActions

All skeleton actions within this set

Declaration
public SteamVR_Action_Skeleton[] skeletonActions { get; }
Property Value
Type Description
SteamVR_Action_Skeleton[]

usage

Declaration
public string usage { get; }
Property Value
Type Description
System.String

visualActions

All pose and skeleton actions within this set

Declaration
public ISteamVR_Action_In[] visualActions { get; }
Property Value
Type Description
ISteamVR_Action_In[]

Methods

Activate(SteamVR_Input_Sources, Int32, Boolean)

Activate this set so its actions can be called

Declaration
public void Activate(SteamVR_Input_Sources activateForSource = SteamVR_Input_Sources.Any, int priority = 0, bool disableAllOtherActionSets = false)
Parameters
Type Name Description
SteamVR_Input_Sources activateForSource

Will activate this action set only for the specified source. Any if you want to activate for everything
System.Int32 priority

The priority of this action set. If you have two actions bound to the same input (button) the higher priority set will override the lower priority. If they are the same priority both will execute.
System.Boolean disableAllOtherActionSets

Disable all other action sets at the same time

Create<CreateType>(String)

Declaration
public static CreateType Create<CreateType>(string newSetPath)
    where CreateType : SteamVR_ActionSet, new()
Parameters
Type Name Description
System.String newSetPath
Returns
Type Description
CreateType
Type Parameters
Name Description
CreateType

CreateFromName<CreateType>(String)

Declaration
public static CreateType CreateFromName<CreateType>(string newSetName)
    where CreateType : SteamVR_ActionSet, new()
Parameters
Type Name Description
System.String newSetName
Returns
Type Description
CreateType
Type Parameters
Name Description
CreateType

Deactivate(SteamVR_Input_Sources)

Deactivate the action set so its actions can no longer be called

Declaration
public void Deactivate(SteamVR_Input_Sources forSource = SteamVR_Input_Sources.Any)
Parameters
Type Name Description
SteamVR_Input_Sources forSource

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

Equals(SteamVR_ActionSet)

Declaration
public bool Equals(SteamVR_ActionSet other)
Parameters
Type Name Description
SteamVR_ActionSet other
Returns
Type Description
System.Boolean

FinishPreInitialize()

Declaration
public virtual void FinishPreInitialize()

GetActionSetData()

Declaration
public SteamVR_ActionSet_Data GetActionSetData()
Returns
Type Description
SteamVR_ActionSet_Data

GetCopy<CreateType>()

Declaration
public CreateType GetCopy<CreateType>()
    where CreateType : SteamVR_ActionSet, new()
Returns
Type Description
CreateType
Type Parameters
Name Description
CreateType

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

GetPath()

Declaration
public string GetPath()
Returns
Type Description
System.String

GetShortName()

Gets the last part of the path for this action. Removes "actions" and direction.

Declaration
public string GetShortName()
Returns
Type Description
System.String

GetTimeLastChanged(SteamVR_Input_Sources)

Returns the last time this action set was changed (set to active or inactive)

Declaration
public float GetTimeLastChanged(SteamVR_Input_Sources source = SteamVR_Input_Sources.Any)
Parameters
Type Name Description
SteamVR_Input_Sources source

The device to check. Any means all devices here (not left or right, but all)
Returns
Type Description
System.Single

Initialize(Boolean, Boolean)

Initializes the handle for the action

Declaration
public virtual void Initialize(bool createNew = false, bool throwErrors = true)
Parameters
Type Name Description
System.Boolean createNew
System.Boolean throwErrors

IsActive(SteamVR_Input_Sources)

Returns whether the set is currently active or not.

Declaration
public bool IsActive(SteamVR_Input_Sources source = SteamVR_Input_Sources.Any)
Parameters
Type Name Description
SteamVR_Input_Sources source

The device to check. Any means all devices here (not left or right, but all)
Returns
Type Description
System.Boolean

PreInitialize(String)

Declaration
public void PreInitialize(string newActionPath)
Parameters
Type Name Description
System.String newActionPath

ReadRawSetActive(SteamVR_Input_Sources)

Declaration
public bool ReadRawSetActive(SteamVR_Input_Sources inputSource)
Parameters
Type Name Description
SteamVR_Input_Sources inputSource
Returns
Type Description
System.Boolean

ReadRawSetLastChanged(SteamVR_Input_Sources)

Declaration
public float ReadRawSetLastChanged(SteamVR_Input_Sources inputSource)
Parameters
Type Name Description
SteamVR_Input_Sources inputSource
Returns
Type Description
System.Single

ReadRawSetPriority(SteamVR_Input_Sources)

Declaration
public int ReadRawSetPriority(SteamVR_Input_Sources inputSource)
Parameters
Type Name Description
SteamVR_Input_Sources inputSource
Returns
Type Description
System.Int32

Operators

Equality(SteamVR_ActionSet, SteamVR_ActionSet)

Declaration
public static bool operator ==(SteamVR_ActionSet set1, SteamVR_ActionSet set2)
Parameters
Type Name Description
SteamVR_ActionSet set1
SteamVR_ActionSet set2
Returns
Type Description
System.Boolean

Inequality(SteamVR_ActionSet, SteamVR_ActionSet)

Declaration
public static bool operator !=(SteamVR_ActionSet set1, SteamVR_ActionSet set2)
Parameters
Type Name Description
SteamVR_ActionSet set1
SteamVR_ActionSet set2
Returns
Type Description
System.Boolean

Explicit Interface Implementations

ISerializationCallbackReceiver.OnAfterDeserialize()

Declaration
void ISerializationCallbackReceiver.OnAfterDeserialize()

ISerializationCallbackReceiver.OnBeforeSerialize()

Declaration
void ISerializationCallbackReceiver.OnBeforeSerialize()

Implements

System.IEquatable<T>
UnityEngine.ISerializationCallbackReceiver