Show / Hide Table of Contents

    Class SteamVR_Action_Source

    Inheritance
    System.Object
    SteamVR_Action_Source
    SteamVR_Action_In_Source
    SteamVR_Action_Out_Source
    Implements
    ISteamVR_Action_Source
    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 abstract class SteamVR_Action_Source : ISteamVR_Action_Source

    Constructors

    SteamVR_Action_Source()

    Declaration
    public SteamVR_Action_Source()

    Fields

    action

    Declaration
    protected SteamVR_Action action
    Field Value
    Type Description
    SteamVR_Action

    inputSourceHandle

    Declaration
    protected ulong inputSourceHandle
    Field Value
    Type Description
    System.UInt64

    Properties

    actionSet

    The ActionSet this action is contained within

    Declaration
    public SteamVR_ActionSet actionSet { get; }
    Property Value
    Type Description
    SteamVR_ActionSet

    active

    Returns true if this action is bound and the ActionSet is active

    Declaration
    public abstract bool active { get; }
    Property Value
    Type Description
    System.Boolean

    activeBinding

    Returns true if the action is bound

    Declaration
    public abstract bool activeBinding { get; }
    Property Value
    Type Description
    System.Boolean

    direction

    The action direction of this action (in for input - most actions, out for output - haptics)

    Declaration
    public SteamVR_ActionDirections direction { get; }
    Property Value
    Type Description
    SteamVR_ActionDirections

    fullPath

    The full string path for this action (from the action manifest)

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

    handle

    The underlying handle for this action used for native SteamVR Input calls. Retrieved on Initialization from SteamVR.

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

    inputSource

    The input source that this instance corresponds to. ex. LeftHand, RightHand

    Declaration
    public SteamVR_Input_Sources inputSource { get; protected set; }
    Property Value
    Type Description
    SteamVR_Input_Sources

    lastActive

    Returns true if the action was bound and the ActionSet was active during the previous update

    Declaration
    public abstract bool lastActive { get; protected set; }
    Property Value
    Type Description
    System.Boolean

    lastActiveBinding

    Returns true if the action was bound during the previous update

    Declaration
    public abstract bool lastActiveBinding { get; }
    Property Value
    Type Description
    System.Boolean

    setActive

    Returns true if the action set this is contained in is active for this input source (or Any)

    Declaration
    public bool setActive { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Initialize()

    [Should not be called by user code] Initializes the handle for the inputSource, and any other related SteamVR data.

    Declaration
    public virtual void Initialize()

    Preinitialize(SteamVR_Action, SteamVR_Input_Sources)

    [Should not be called by user code] Sets up the internals of the action source before SteamVR has been initialized.

    Declaration
    public virtual void Preinitialize(SteamVR_Action wrappingAction, SteamVR_Input_Sources forInputSource)
    Parameters
    Type Name Description
    SteamVR_Action wrappingAction
    SteamVR_Input_Sources forInputSource

    Implements

    ISteamVR_Action_Source
    In This Article
    • Constructors
      • SteamVR_Action_Source()
    • Fields
      • action
      • inputSourceHandle
    • Properties
      • actionSet
      • active
      • activeBinding
      • direction
      • fullPath
      • handle
      • inputSource
      • lastActive
      • lastActiveBinding
      • setActive
    • Methods
      • Initialize()
      • Preinitialize(SteamVR_Action, SteamVR_Input_Sources)
    • Implements
    Back to top Copyright (c) Valve Corporation, All rights reserved.