Class SteamVR_Action_In<SourceMap, SourceElement>

Inheritance
System.Object
SteamVR_Action
SteamVR_Action<SourceMap, SourceElement>
SteamVR_Action_In<SourceMap, SourceElement>
SteamVR_Action_Boolean
SteamVR_Action_Pose_Base<SourceMap, SourceElement>
SteamVR_Action_Single
SteamVR_Action_Vector2
SteamVR_Action_Vector3
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 abstract class SteamVR_Action_In<SourceMap, SourceElement> : SteamVR_Action<SourceMap, SourceElement>, IEquatable<SteamVR_Action>, ISteamVR_Action_In, ISteamVR_Action, ISteamVR_Action_In_Source, ISteamVR_Action_Source where SourceMap : SteamVR_Action_In_Source_Map<SourceElement>, new()
    where SourceElement : SteamVR_Action_In_Source, new()
Type Parameters
Name Description
SourceMap
SourceElement

Properties

activeDevice

[Shortcut to: SteamVR_Input_Sources.Any] The input source that triggered the action to be changed

Declaration
public SteamVR_Input_Sources activeDevice { get; }
Property Value
Type Description
SteamVR_Input_Sources

activeOrigin

[Shortcut to: SteamVR_Input_Sources.Any] The handle to the component that triggered the action to be changed

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

changed

[Shortcut to: SteamVR_Input_Sources.Any] Returns true if the action has been changed since the previous update

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

changedTime

[Shortcut to: SteamVR_Input_Sources.Any] The time the action was changed (Time.realtimeSinceStartup)

Declaration
public float changedTime { get; }
Property Value
Type Description
System.Single

lastActiveOrigin

[Shortcut to: SteamVR_Input_Sources.Any] The handle to the component that triggered the action to be changed in the previous update

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

lastChanged

[Shortcut to: SteamVR_Input_Sources.Any] Returns true if the action was changed for the previous update cycle

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

localizedOriginName

[Shortcut to: SteamVR_Input_Sources.Any] The full localized name for the component, controller, and hand that caused the action to be changed

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

renderModelComponentName

[Shortcut to: SteamVR_Input_Sources.Any] The name of the component on the render model that caused the action to be changed (not localized)

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

trackedDeviceIndex

[Shortcut to: SteamVR_Input_Sources.Any] The device index (used by Render Models) used by the device that triggered the action to be changed

Declaration
public uint trackedDeviceIndex { get; }
Property Value
Type Description
System.UInt32

updateTime

[Shortcut to: SteamVR_Input_Sources.Any] The time the action was updated (Time.realtimeSinceStartup)

Declaration
public float updateTime { get; }
Property Value
Type Description
System.Single

Methods

ForceAddSourceToUpdateList(SteamVR_Input_Sources)

[Should not be called by user code] Forces the system to start updating the data for this action and the specified input source. Should only be used if you've set SteamVR_Action.startUpdatingSourceOnAccess to false.

Declaration
public void ForceAddSourceToUpdateList(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.

GetActiveDevice(SteamVR_Input_Sources)

The input source that triggered the action to be updated last

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

GetTimeLastChanged(SteamVR_Input_Sources)

The time the action was changed (Time.realtimeSinceStartup)

Declaration
public override float GetTimeLastChanged(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.Single
Overrides

IsUpdating(SteamVR_Input_Sources)

[Should not be called by user code] Returns whether the system has determined this source should be updated (based on code calls) Should only be used if you've set SteamVR_Action.startUpdatingSourceOnAccess to false.

Declaration
public override bool IsUpdating(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
Overrides

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
public virtual void UpdateValues()

Implements

System.IEquatable<T>