Show / Hide Table of Contents

    Interface ISteamVR_ActionSet

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

    Namespace: Valve.VR
    Assembly: Assembly-CSharp.dll
    Syntax
    public interface ISteamVR_ActionSet

    Properties

    allActions

    All actions within this set (including out actions)

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

    fullPath

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

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

    handle

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

    nonVisualInActions

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

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

    outActionArray

    All out actions within this set

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

    poseActions

    All pose actions within this set

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

    skeletonActions

    All skeleton actions within this set

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

    usage

    How the binding UI should display this set

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

    visualActions

    All pose and skeleton actions within this set

    Declaration
    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
    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

    Deactivate(SteamVR_Input_Sources)

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

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

    GetShortName()

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

    Declaration
    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
    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

    IsActive(SteamVR_Input_Sources)

    Returns whether the set is currently active or not.

    Declaration
    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

    ReadRawSetActive(SteamVR_Input_Sources)

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

    ReadRawSetLastChanged(SteamVR_Input_Sources)

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

    ReadRawSetPriority(SteamVR_Input_Sources)

    Declaration
    int ReadRawSetPriority(SteamVR_Input_Sources inputSource)
    Parameters
    Type Name Description
    SteamVR_Input_Sources inputSource
    Returns
    Type Description
    System.Int32
    In This Article
    • Properties
      • allActions
      • fullPath
      • handle
      • nonVisualInActions
      • outActionArray
      • poseActions
      • skeletonActions
      • usage
      • visualActions
    • Methods
      • Activate(SteamVR_Input_Sources, Int32, Boolean)
      • Deactivate(SteamVR_Input_Sources)
      • GetShortName()
      • GetTimeLastChanged(SteamVR_Input_Sources)
      • IsActive(SteamVR_Input_Sources)
      • ReadRawSetActive(SteamVR_Input_Sources)
      • ReadRawSetLastChanged(SteamVR_Input_Sources)
      • ReadRawSetPriority(SteamVR_Input_Sources)
    Back to top Copyright (c) Valve Corporation, All rights reserved.