Show / Hide Table of Contents

    Interface ISteamVR_Action_In

    Inherited Members
    ISteamVR_Action.GetActive(SteamVR_Input_Sources)
    ISteamVR_Action.GetShortName()
    ISteamVR_Action_In_Source.changed
    ISteamVR_Action_In_Source.lastChanged
    ISteamVR_Action_In_Source.changedTime
    ISteamVR_Action_In_Source.updateTime
    ISteamVR_Action_In_Source.activeOrigin
    ISteamVR_Action_In_Source.lastActiveOrigin
    ISteamVR_Action_In_Source.activeDevice
    ISteamVR_Action_In_Source.trackedDeviceIndex
    ISteamVR_Action_In_Source.renderModelComponentName
    ISteamVR_Action_In_Source.localizedOriginName
    ISteamVR_Action_Source.active
    ISteamVR_Action_Source.activeBinding
    ISteamVR_Action_Source.lastActive
    ISteamVR_Action_Source.lastActiveBinding
    ISteamVR_Action_Source.fullPath
    ISteamVR_Action_Source.handle
    ISteamVR_Action_Source.actionSet
    ISteamVR_Action_Source.direction
    Namespace: Valve.VR
    Assembly: Assembly-CSharp.dll
    Syntax
    public interface ISteamVR_Action_In : ISteamVR_Action, ISteamVR_Action_In_Source, ISteamVR_Action_Source

    Methods

    GetActiveDevice(SteamVR_Input_Sources)

    The input source that triggered the action to be updated last

    Declaration
    SteamVR_Input_Sources GetActiveDevice(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
    SteamVR_Input_Sources

    GetChanged(SteamVR_Input_Sources)

    Indicates whether or not the data for this action and specified input source has changed since the last update. Determined by SteamVR or 'changeTolerance'.

    Declaration
    bool GetChanged(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

    GetDeviceIndex(SteamVR_Input_Sources)

    Gets the device index for the controller this action is bound to. This can be used for render models or the pose tracking system.

    Declaration
    uint GetDeviceIndex(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.UInt32

    GetLocalizedOrigin(SteamVR_Input_Sources)

    Gets the localized full name of the device that the action was updated by. ex: "Left Hand Vive Controller Trackpad"

    Declaration
    string GetLocalizedOrigin(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.String

    GetLocalizedOriginPart(SteamVR_Input_Sources, EVRInputStringBits[])

    Gets the localized name of the device that the action corresponds to. Include as many EVRInputStringBits as you want to add to the localized string

    Declaration
    string GetLocalizedOriginPart(SteamVR_Input_Sources inputSource, params EVRInputStringBits[] localizedParts)
    Parameters
    Type Name Description
    SteamVR_Input_Sources inputSource
    EVRInputStringBits[] localizedParts
    • VRInputString_Hand - Which hand the origin is in. ex: "Left Hand".
    • VRInputString_ControllerType - What kind of controller the user has in that hand. ex: "Vive Controller".
    • VRInputString_InputSource - What part of that controller is the origin. ex: "Trackpad".
    • VRInputString_All - All of the above. ex: "Left Hand Vive Controller Trackpad".
    Returns
    Type Description
    System.String

    GetRenderModelComponentName(SteamVR_Input_Sources)

    The name of the component on the render model that caused the action to be updated (not localized)

    Declaration
    string GetRenderModelComponentName(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.String

    UpdateValues()

    [Should not be called by user code] Updates the data for all the input sources the system has detected need to be updated.

    Declaration
    void UpdateValues()
    In This Article
    • Methods
      • GetActiveDevice(SteamVR_Input_Sources)
      • GetChanged(SteamVR_Input_Sources)
      • GetDeviceIndex(SteamVR_Input_Sources)
      • GetLocalizedOrigin(SteamVR_Input_Sources)
      • GetLocalizedOriginPart(SteamVR_Input_Sources, EVRInputStringBits[])
      • GetRenderModelComponentName(SteamVR_Input_Sources)
      • UpdateValues()
    Back to top Copyright (c) Valve Corporation, All rights reserved.