Class CommonUsages

A collection of common usage string values as reported by usages.

Inheritance

object

CommonUsages

Namespace: UnityEngine.InputSystem

Assembly: Unity.InputSystem.dll

Syntax

public static class CommonUsages

Fields

Back

Button to navigate to previous location.

Declaration

public static readonly InternedString Back

Field 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 BatteryStrength

Field Value

Type	Description
InternedString

Cancel

Button to not accept the current choice.

Declaration

public static readonly InternedString Cancel

Field Value

Type	Description
InternedString

Forward

Button to navigate to next location.

Declaration

public static readonly InternedString Forward

Field Value

Type	Description
InternedString

Hatswitch

The primary hat-switch control on input devices with hat-switches such as joysticks or gamepads.

Declaration

public static readonly InternedString Hatswitch

Field Value

Type	Description
InternedString

Remarks

Example: Joystick or gamepad hat-switch.

HighFreqMotor

High-frequency haptic motor for force-feedback.

Declaration

public static readonly InternedString HighFreqMotor

Field Value

Type	Description
InternedString

Horizontal

Horizontal motion axis.

Declaration

public static readonly InternedString Horizontal

Field Value

Type	Description
InternedString

Remarks

Example: X axis on mouse.

LeftHand

Device in left hand.

Declaration

public static readonly InternedString LeftHand

Field Value

Type	Description
InternedString

Remarks

Example: left hand XR controller.

LowFreqMotor

Low-frequency haptic motor for force-feedback.

Declaration

public static readonly InternedString LowFreqMotor

Field Value

Type	Description
InternedString

Menu

Button to bring up menu.

Declaration

public static readonly InternedString Menu

Field Value

Type	Description
InternedString

Modifier

A modifier action control that modifies usage of other controls.

Declaration

public static readonly InternedString Modifier

Field Value

Type	Description
InternedString

Remarks

Example: Keyboard modifier keys like CTRL, SHIFT, ALT, OPTION, etc.

Orientation

The spatial orientation control on input devices with spatial tracking.

Declaration

public static readonly InternedString Orientation

Field Value

Type	Description
InternedString

Remarks

Example: User head-orientation in tracking-space using e.g. a head-tracking system. This could for example be a VR tracking system or another user-facing tracking sensor.

Point

A screen-space point.

Declaration

public static readonly InternedString Point

Field Value

Type	Description
InternedString

Remarks

Example: Touch contact point.

Position

The spatial position control on input devices with spatial tracking.

Declaration

public static readonly InternedString Position

Field Value

Type	Description
InternedString

Remarks

Example: User head position in tracking-space using e.g. a head-tracking system. This could for example be a VR tracking system or another user-facing tracking sensor.

Pressure

Pressure level axis.

Declaration

public static readonly InternedString Pressure

Field Value

Type	Description
InternedString

Remarks

Example: pen pressure.

Primary2DMotion

Primary 2D motion control.

Declaration

public static readonly InternedString Primary2DMotion

Field Value

Type	Description
InternedString

Remarks

Example: Left stick on a gamepad.

PrimaryAction

The primary action control on any input device, such as a gamepad, mouse, or keyboard.

Declaration

public static readonly InternedString PrimaryAction

Field Value

Type	Description
InternedString

Remarks

Example: Primary mouse button (left button on right-handed configuration, right button on left-handed configuration), south-button on a gamepad.

PrimaryTrigger

The primary trigger control on input devices with triggers.

Declaration

public static readonly InternedString PrimaryTrigger

Field Value

Type	Description
InternedString

Remarks

Example: Right trigger-button on a gamepad.

RightHand

Device in right hand.

Declaration

public static readonly InternedString RightHand

Field Value

Type	Description
InternedString

Remarks

Example: right hand XR controller.

ScrollHorizontal

Axis to scroll horizontally.

Declaration

public static readonly InternedString ScrollHorizontal

Field Value

Type	Description
InternedString

ScrollVertical

Axis to scroll vertically.

Declaration

public static readonly InternedString ScrollVertical

Field Value

Type	Description
InternedString

Secondary2DMotion

Secondary 2D motion control.

Declaration

public static readonly InternedString Secondary2DMotion

Field Value

Type	Description
InternedString

Remarks

Example: Right stick on a gamepad.

SecondaryAction

Secondary action control on any input device, such as a gamepad, mouse, or keyboard.

Declaration

public static readonly InternedString SecondaryAction

Field Value

Type	Description
InternedString

Remarks

Example: Secondary mouse button (right button on right-handed configuration, left button on left-handed configuration), east-button on a gamepad.

SecondaryTrigger

The secondary trigger control on input devices with triggers.

Declaration

public static readonly InternedString SecondaryTrigger

Field Value

Type	Description
InternedString

Remarks

Example: Left trigger-button on a gamepad.

Submit

Button to confirm the current choice.

Declaration

public static readonly InternedString Submit

Field Value

Type	Description
InternedString

Twist

Rotation around single, fixed axis.

Declaration

public static readonly InternedString Twist

Field 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 Vertical

Field Value

Type	Description
InternedString

Remarks

Example: Y axis on mouse.