Immerseum SDK: VR Simulator (version: RC-1.0.0)
       [view as Desktop | Tablet | Mobile]
InputAction Class Properties

Immerseum.VRSimulator Namespace : InputAction Class

For a list of all members of this type, see InputAction members.

Public Properties
 NameDescription
Public PropertybuttonValue  
Public PropertyhasAxisIndicates whether the InputAction has one or more Input Axes defined for any of its available axes.  
Public PropertyhasAxisFiredIndicates whether one or more of Input Action's defined axes has fired (i.e. was not at rest).  
Public PropertyhasButtonIndicates the Input Action has one or more Input Buttons defined.  
Public PropertyhasButtonFiredIndicates one of the Input Action's defined InputButtons has fired.  
Public PropertyhasFiredIndicates that one or more of the inputs that kick off this Input Action were received from the user.  
Public PropertyhasKeyIndicates that the Input Action has one or more input keys defined.  
Public PropertyhasKeyFiredIndicates whether an input key defined for this Input Action has been fired.  
Public PropertyisButtonHeldIndicates whether a defined InputButton for this Input Action is held in the most-recent frame.  
Public PropertyisButtonPressedIndicates whether a defined InputButton for this Input Action is pressed in the most-recent frame.  
Public PropertyisButtonPressedAndHeldIndicates whether a defined InputButton for this Input Action is pressed and held in the most-recent frame.  
Public PropertyisButtonReleasedIndicates whether a defined InputButton for this Input Action is released in the most-recent frame.  
Public PropertyisKeyHeldIndicates whether a defined input key for this Input Action is held in the most-recent frame.  
Public PropertyisKeyPressedIndicates whether a defined input key for this Input Action is pressed in the most-recent frame.  
Public PropertyisKeyPressedAndHeldIndicates whether a defined input key for this Input Action is pressed and held in the most-recent frame.  
Public PropertyisKeyReleasedIndicates whether a defined input key for this Input Action is released in the most-recent frame.  
Public PropertyisLeftTriggerAxisAtMaxIndicates whether the Left Trigger Axis is currently at its maximum value.  
Public PropertyisLeftTriggerAxisAtMinIndicates whether the Left Trigger Axis is currently at its minimum value.  
Public PropertyisLeftTriggerAxisAtRestIndicates whether the Left Trigger Axis is currently at its resting value.  
Public PropertyisPitchAxisAtMaxIndicates whether the Pitch Axis is currently at its maximum value.  
Public PropertyisPitchAxisAtMinIndicates whether the Pitch Axis is currently at its minimum value.  
Public PropertyisPitchAxisAtRestIndicates whether the Pitch Axis is currently at its resting value.  
Public PropertyisRightTriggerAxisAtMaxIndicates whether the Right Trigger Axis is currently at its maximum value.  
Public PropertyisRightTriggerAxisAtMinIndicates whether the Right Trigger Axis is currently at its minimum value.  
Public PropertyisRightTriggerAxisAtRestIndicates whether the Right Trigger Axis is currently at its resting value.  
Public PropertyisXAxisAtMaxIndicates whether the input X-Axis is currently at its maximum value.  
Public PropertyisXAxisAtMinIndicates whether the input X-Axis is currently at its minimum value.  
Public PropertyisXAxisAtRestIndicates whether the input X-Axis is currently at its resting value.  
Public PropertyisYawAxisAtMaxIndicates whether the Yaw Axis is currently at its maximum value.  
Public PropertyisYawAxisAtMinIndicates whether the Yaw Axis is currently at its minimum value.  
Public PropertyisYawAxisAtRestIndicates whether the Yaw Axis is currently at its resting value.  
Public PropertyisYAxisAtMaxIndicates whether the input Y-Axis is currently at its maximum value.  
Public PropertyisYAxisAtMinIndicates whether the input Y-Axis is currently at its minimum value.  
Public PropertyisYAxisAtRestIndicates whether the input Y-Axis is currently at its resting value.  
Public PropertyisZAxisAtMaxIndicates whether the input Z-Axis is currently at its maximum value.  
Public PropertyisZAxisAtMinIndicates whether the input Z-Axis is currently at its minimum value.  
Public PropertyisZAxisAtRestIndicates whether the input Z-Axis is currently at its resting value.  
Public PropertyleftTriggerAxisRawValue

The raw value from the Left Trigger Axis.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns the greatest raw value from defined Input Axes.
 
Public PropertyleftTriggerAxisRawValue2D

The raw value from the Left Trigger Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns raw value with the greatest magnitude from defined Input Axes.
 
Public PropertyleftTriggerAxisValue

The value from the Left Trigger Axis.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns the greatest value from defined Input Axes.

 
Public PropertyleftTriggerAxisValue2D

The axis value from the Left Trigger Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns the axis value with the greatest magnitude from defined Input Axes.
 
Public PropertynameThe unique name given to the Input Action.  
Public PropertypitchAxisRawValue

The raw value from the Pitch Axis$$.

Please Note Please Note
If multiple Input Axes are defined for the $$Left Trigger Axis, then returns the greatest raw value$$ from defined Input Axes.
 
Public PropertypitchAxisRawValue2D

The raw value from the Pitch Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns raw value with the greatest magnitude from defined Input Axes.
 
Public PropertypitchAxisValue

The value from the Pitch Axis.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns the greatest value from defined Input Axes.

 
Public PropertypitchAxisValue2D

The axis value from the Pitch Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns the axis value with the greatest magnitude from defined Input Axes.
 
Public PropertyrightTriggerAxisRawValue

The raw value from the Right Trigger Axis.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns the greatest raw value from defined Input Axes.
 
Public PropertyrightTriggerAxisRawValue2D

The raw value from the Right Trigger Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns raw value with the greatest magnitude from defined Input Axes.
 
Public PropertyrightTriggerAxisValue

The value from the Right Trigger Axis.

Please Note Please Note
If multiple Input Axes are defined for the Right Trigger Axis, then returns the greatest value from defined Input Axes.

 
Public PropertyrightTriggerAxisValue2D

The axis value from the Right Trigger Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns the axis value with the greatest magnitude from defined Input Axes.
 
Public PropertyxAxisRawValue

The raw value from the input X-Axis.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns the greatest raw value from defined Input Axes.
 
Public PropertyxAxisRawValue2D

The raw value from the input X-Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns raw value with the greatest magnitude from defined Input Axes.
 
Public PropertyxAxisValue

The value from the input X-Axis.

Please Note Please Note
If multiple Input Axes are defined for the input X-Axis, then returns the greatest value from defined Input Axes.

 
Public PropertyxAxisValue2D

The axis value from the input X-Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns the axis value with the greatest magnitude from defined Input Axes.
 
Public PropertyyawAxisRawValue

The raw value from the Yaw Axis.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns the greatest raw value from defined Input Axes.
 
Public PropertyyawAxisRawValue2D

The raw value from the Yaw Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns raw value with the greatest magnitude from defined Input Axes.
 
Public PropertyyawAxisValue

The value from the Yaw Axis.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns the greatest value from defined Input Axes.

 
Public PropertyyawAxisValue2D

The axis value from the Yaw Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns the axis value with the greatest magnitude from defined Input Axes.
 
Public PropertyyAxisRawValue

The raw value from the input Y-Axis.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns the greatest raw value from defined Input Axes.
 
Public PropertyyAxisRawValue2D

The raw value from the input Y-Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns raw value with the greatest magnitude from defined Input Axes.
 
Public PropertyyAxisValue

The value from the input Y-Axis.

Please Note Please Note
If multiple Input Axes are defined for the input Y-Axis, then returns the greatest value from defined Input Axes.

 
Public PropertyyAxisValue2D

The axis value from the input Y-Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns the axis value with the greatest magnitude from defined Input Axes.
 
Public PropertyzAxisRawValue

The raw value from the input Z-Axis.

Please Note Please Note
If multiple Input Axes are defined for the Left Trigger Axis, then returns the greatest raw value from defined Input Axes.
 
Public PropertyzAxisRawValue2D

The raw value from the input Z-Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns raw value with the greatest magnitude from defined Input Axes.
 
Public PropertyzAxisValue

The value from the input Z-Axis.

Please Note Please Note
If multiple Input Axes are defined for the input Z-Axis, then returns the greatest value from defined Input Axes.

 
Public PropertyzAxisValue2D

The axis value from the input Z-Axis expressed as a Vector2.

Please Note Please Note
If multiple Input Axes are defined, then returns the axis value with the greatest magnitude from defined Input Axes.
 
$$Top$$
See Also

Reference

InputAction Class
Immerseum.VRSimulator Namespace
Custom Input Handling
Configuring Input & Movement
Custom InputAction Mapping

 

 

Copyright (c) 2016-2017 Immerseum Inc. All rights reserved.

Send Feedback