Class CommonUsages
A collection of common usage string values as reported by usages.
Namespace: UnityEngine.InputSystem
Syntax
public static class CommonUsagesFields
Back
Button to navigate to previous location.
Declaration
public static readonly InternedString BackField Value
| Type | Description |
|---|---|
| InternedString |
Remarks
Example: Escape on keyboard, B button on gamepad.
In general, the "Back" control is used for moving backwards in the navigation history of a UI. This is used, for example, in hierarchical menu structures to move back to parent menus (e.g. from the "Settings" menu back to the "Main" menu). Consoles generally have stringent requirements as to which button has to fulfill this role.
BatteryStrength
Axis representing charge of battery (1=full, 0=empty).
Declaration
public static readonly InternedString BatteryStrengthField Value
| Type | Description |
|---|---|
| InternedString |
Cancel
Button to not accept the current choice.
Declaration
public static readonly InternedString CancelField Value
| Type | Description |
|---|---|
| InternedString |
Forward
Button to navigate to next location.
Declaration
public static readonly InternedString ForwardField Value
| Type | Description |
|---|---|
| InternedString |
Hatswitch
Declaration
public static readonly InternedString HatswitchField Value
| Type | Description |
|---|---|
| InternedString |
HighFreqMotor
Declaration
public static readonly InternedString HighFreqMotorField Value
| Type | Description |
|---|---|
| InternedString |
Horizontal
Horizontal motion axis.
Declaration
public static readonly InternedString HorizontalField Value
| Type | Description |
|---|---|
| InternedString |
Remarks
Example: X axis on mouse.
LeftHand
Device in left hand.
Declaration
public static readonly InternedString LeftHandField Value
| Type | Description |
|---|---|
| InternedString |
Remarks
Example: left hand XR controller.
LowFreqMotor
Declaration
public static readonly InternedString LowFreqMotorField Value
| Type | Description |
|---|---|
| InternedString |
Menu
Button to bring up menu.
Declaration
public static readonly InternedString MenuField Value
| Type | Description |
|---|---|
| InternedString |
Modifier
Declaration
public static readonly InternedString ModifierField Value
| Type | Description |
|---|---|
| InternedString |
Orientation
Declaration
public static readonly InternedString OrientationField Value
| Type | Description |
|---|---|
| InternedString |
Point
Declaration
public static readonly InternedString PointField Value
| Type | Description |
|---|---|
| InternedString |
Position
Declaration
public static readonly InternedString PositionField Value
| Type | Description |
|---|---|
| InternedString |
Pressure
Pressure level axis.
Declaration
public static readonly InternedString PressureField Value
| Type | Description |
|---|---|
| InternedString |
Remarks
Example: pen pressure.
Primary2DMotion
Primary 2D motion control.
Declaration
public static readonly InternedString Primary2DMotionField Value
| Type | Description |
|---|---|
| InternedString |
Remarks
Example: left stick on gamepad.
PrimaryAction
Declaration
public static readonly InternedString PrimaryActionField Value
| Type | Description |
|---|---|
| InternedString |
PrimaryTrigger
Declaration
public static readonly InternedString PrimaryTriggerField Value
| Type | Description |
|---|---|
| InternedString |
RightHand
Device in right hand.
Declaration
public static readonly InternedString RightHandField Value
| Type | Description |
|---|---|
| InternedString |
Remarks
Example: right hand XR controller.
ScrollHorizontal
Axis to scroll horizontally.
Declaration
public static readonly InternedString ScrollHorizontalField Value
| Type | Description |
|---|---|
| InternedString |
ScrollVertical
Axis to scroll vertically.
Declaration
public static readonly InternedString ScrollVerticalField Value
| Type | Description |
|---|---|
| InternedString |
Secondary2DMotion
Secondary 2D motion control.
Declaration
public static readonly InternedString Secondary2DMotionField Value
| Type | Description |
|---|---|
| InternedString |
Remarks
Example: right stick on gamepad.
SecondaryAction
Declaration
public static readonly InternedString SecondaryActionField Value
| Type | Description |
|---|---|
| InternedString |
SecondaryTrigger
Declaration
public static readonly InternedString SecondaryTriggerField Value
| Type | Description |
|---|---|
| InternedString |
Submit
Button to confirm the current choice.
Declaration
public static readonly InternedString SubmitField Value
| Type | Description |
|---|---|
| InternedString |
Twist
Rotation around single, fixed axis.
Declaration
public static readonly InternedString TwistField Value
| Type | Description |
|---|---|
| InternedString |
Remarks
Example: twist on joystick or twist of pen (few pens support that).
Vertical
Vertical motion axis.
Declaration
public static readonly InternedString VerticalField Value
| Type | Description |
|---|---|
| InternedString |
Remarks
Example: Y axis on mouse.