InputAction Class Members

The following tables list the members exposed by InputAction.

Public Constructors

	Name	Description
	InputAction Constructor

Top

Public Fields

	Name	Description
	heldButtonList	List of Input Buttons which fire this Input Action when they are held.
	heldKeyList	List of Unity KeyCodes which fire this Input Action when held.
	internalDescription	A textual description of the Input Action - may be useful for documentation and validation.
	leftTriggerAxisList	A list of Input Axes that are intended to manipulate the Left Trigger when moved.
	pitchAxisList	A list of Input Axes that are intended to manipulate the camera Pitch when moved.
	pressedAndHeldButtonList	List of Input Buttons which fire this Input Action when they are pressed and held.
	pressedAndHeldKeyList	List of Unity KeyCodes which fire this Input Action when pressed and held.
	pressedButtonList	List of Input Buttons which fire this Input Action when they are pressed.
	pressedKeyList	List of Unity KeyCodes which fire this Input Action when pressed.
	releasedButtonList	List of Input Buttons which fire this Input Action when they are released.
	releasedKeyList	List of Unity KeyCodes which fire this Input Action when released.
	rightTriggerAxisList	A list of Input Axes that are intended to manipulate the Right Trigger when moved.
	xAxisList	A list of Input Axes that are intended to manipulate the user's position on the X-Axis in worldspace when moved.
	yawAxisList	A list of Input Axes that are intended to manipulate the camera's Yaw when moved.
	yAxisList	A list of Input Axes that are intended to manipulate the user's position along the Y-Axis in worldspace when moved.
	zAxisList	A list of Input Axes that are intended to manipulate the user's position along the Z-Axis in worldspace when moved.

Top

Public Properties

Name

Description

buttonValue

hasAxis

Indicates whether the InputAction has one or more Input Axes defined for any of its available axes.

hasAxisFired

Indicates whether one or more of Input Action's defined axes has fired (i.e. was not at rest).

hasButton

Indicates the Input Action has one or more Input Buttons defined.

hasButtonFired

Indicates one of the Input Action's defined InputButtons has fired.

hasFired

Indicates that one or more of the inputs that kick off this Input Action were received from the user.

hasKey

Indicates that the Input Action has one or more input keys defined.

hasKeyFired

Indicates whether an input key defined for this Input Action has been fired.

isButtonHeld

Indicates whether a defined InputButton for this Input Action is held in the most-recent frame.

isButtonPressed

Indicates whether a defined InputButton for this Input Action is pressed in the most-recent frame.

isButtonPressedAndHeld

Indicates whether a defined InputButton for this Input Action is pressed and held in the most-recent frame.

isButtonReleased

Indicates whether a defined InputButton for this Input Action is released in the most-recent frame.

isKeyHeld

Indicates whether a defined input key for this Input Action is held in the most-recent frame.

isKeyPressed

Indicates whether a defined input key for this Input Action is pressed in the most-recent frame.

isKeyPressedAndHeld

Indicates whether a defined input key for this Input Action is pressed and held in the most-recent frame.

isKeyReleased

Indicates whether a defined input key for this Input Action is released in the most-recent frame.

isLeftTriggerAxisAtMax

Indicates whether the Left Trigger Axis is currently at its maximum value.

isLeftTriggerAxisAtMin

Indicates whether the Left Trigger Axis is currently at its minimum value.

isLeftTriggerAxisAtRest

Indicates whether the Left Trigger Axis is currently at its resting value.

isPitchAxisAtMax

Indicates whether the Pitch Axis is currently at its maximum value.

isPitchAxisAtMin

Indicates whether the Pitch Axis is currently at its minimum value.

isPitchAxisAtRest

Indicates whether the Pitch Axis is currently at its resting value.

isRightTriggerAxisAtMax

Indicates whether the Right Trigger Axis is currently at its maximum value.

isRightTriggerAxisAtMin

Indicates whether the Right Trigger Axis is currently at its minimum value.

isRightTriggerAxisAtRest

Indicates whether the Right Trigger Axis is currently at its resting value.

isXAxisAtMax

Indicates whether the input X-Axis is currently at its maximum value.

isXAxisAtMin

Indicates whether the input X-Axis is currently at its minimum value.

isXAxisAtRest

Indicates whether the input X-Axis is currently at its resting value.

isYawAxisAtMax

Indicates whether the Yaw Axis is currently at its maximum value.

isYawAxisAtMin

Indicates whether the Yaw Axis is currently at its minimum value.

isYawAxisAtRest

Indicates whether the Yaw Axis is currently at its resting value.

isYAxisAtMax

Indicates whether the input Y-Axis is currently at its maximum value.

isYAxisAtMin

Indicates whether the input Y-Axis is currently at its minimum value.

isYAxisAtRest

Indicates whether the input Y-Axis is currently at its resting value.

isZAxisAtMax

Indicates whether the input Z-Axis is currently at its maximum value.

isZAxisAtMin

Indicates whether the input Z-Axis is currently at its minimum value.

isZAxisAtRest

Indicates whether the input Z-Axis is currently at its resting value.

leftTriggerAxisRawValue

The raw value from the Left Trigger Axis.

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

leftTriggerAxisRawValue2D

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

	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.

leftTriggerAxisValue

The value from the Left Trigger Axis.

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

leftTriggerAxisValue2D

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

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

name

The unique name given to the Input Action.

pitchAxisRawValue

The raw value from the Pitch Axis$$.

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

pitchAxisRawValue2D

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

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

pitchAxisValue

The value from the Pitch Axis.

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

pitchAxisValue2D

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

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

rightTriggerAxisRawValue

The raw value from the Right Trigger Axis.

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

rightTriggerAxisRawValue2D

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

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

rightTriggerAxisValue

The value from the Right Trigger Axis.

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

rightTriggerAxisValue2D

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

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

xAxisRawValue

The raw value from the input X-Axis.

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

xAxisRawValue2D

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

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

xAxisValue

The value from the input X-Axis.

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

xAxisValue2D

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

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

yawAxisRawValue

The raw value from the Yaw Axis.

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

yawAxisRawValue2D

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

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

yawAxisValue

The value from the Yaw Axis.

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

yawAxisValue2D

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

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

yAxisRawValue

The raw value from the input Y-Axis.

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

yAxisRawValue2D

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

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

yAxisValue

The value from the input Y-Axis.

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

yAxisValue2D

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

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

zAxisRawValue

The raw value from the input Z-Axis.

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

zAxisRawValue2D

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

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

zAxisValue

The value from the input Z-Axis.

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

zAxisValue2D

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

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

$$Top$$

Public Methods

Name

Description

deregisterAction

Removes the InputAction from the list of registered InputActions recognized/monitored by the InputActionManager.

Equals

Overloaded. Determines whether the specified object is equal to the current object.

getAxisValueSource

Returns the type of input device from which the axis value is being returned.

	Best Practice
	When an InputAction axis has multiple Input Axes defined, the ImmerseumSDK always returns the axis value with the highest value or greatest magnitude.

GetHashCode

Serves as the default hash function.

registerAction

Registers the InputAction with the InputActionManager, thus supporting it in your VR Scene.

Once an InputAction has been registered, the InputActionManager will fire the OnInputActionStart event whenever the InputAction is received from the user's input devices.

ToString

Returns a string that represents the current object.Returns the name property of the InputAction.

Top

Public Operators

Equality
Inequality

Top

Reference

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