Class InputHelpers
Helper class for different kinds of input.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
[MovedFrom("")]
public static class InputHelpersMethods
IsPressed(InputDevice, InputHelpers.Button, out Boolean, Single)
Checks whether button is pressed or not.
Declaration
public static bool IsPressed(this InputDevice device, InputHelpers.Button button, out bool isPressed, float pressThreshold = -1F)Parameters
| Type | Name | Description |
|---|---|---|
| InputDevice | device | The input device. |
| InputHelpers.Button | button | The button that is being checked. |
| Boolean | isPressed | A boolean that will be true if button is pressed and false if not. |
| Single | pressThreshold | The threshold of what defines a press. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if device and button are valid. Otherwise, returns false. |
TryReadAxis2DValue(InputDevice, InputHelpers.Axis2D, out Vector2)
Tries to read and return the supplied 2D axis value.
Declaration
public static bool TryReadAxis2DValue(this InputDevice device, InputHelpers.Axis2D axis2D, out Vector2 value)Parameters
| Type | Name | Description |
|---|---|---|
| InputDevice | device | The input device. |
| InputHelpers.Axis2D | axis2D | The 2D axis to read the value. |
| Vector2 | value | The 2D axis value; it will have the default Vector2 value if the 2D axis value can't be read. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if the 2D axis value can be read. Otherwise, returns false. |
TryReadSingleValue(InputDevice, InputHelpers.Button, out Single)
Tries to read and return the supplied button value.
Declaration
public static bool TryReadSingleValue(this InputDevice device, InputHelpers.Button button, out float singleValue)Parameters
| Type | Name | Description |
|---|---|---|
| InputDevice | device | The input device. |
| InputHelpers.Button | button | The button to read the value. |
| Single | singleValue | The button value; it will have the default float value ( |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if the button value can be read. Otherwise, returns false. |