Class CommonUsages

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

Inheritance

System.Object

CommonUsages

Namespace: UnityEngine.InputSystem

Syntax

public static class CommonUsages

Fields

Accept

Button to confirm the current choice.

Declaration

public static readonly InternedString Accept

Field Value

Type	Description
InternedString

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

Declaration

public static readonly InternedString Hatswitch

Field Value

Type	Description
InternedString

HighFreqMotor

Declaration

public static readonly InternedString HighFreqMotor

Field Value

Type	Description
InternedString

Horizontal

Declaration

public static readonly InternedString Horizontal

Field Value

Type	Description
InternedString

LeftHand

Device in left hand.

Declaration

public static readonly InternedString LeftHand

Field Value

Type	Description
InternedString

Remarks

Example: left hand XR controller.

LowFreqMotor

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

Declaration

public static readonly InternedString Modifier

Field Value

Type	Description
InternedString

Orientation

Declaration

public static readonly InternedString Orientation

Field Value

Type	Description
InternedString

Point

Declaration

public static readonly InternedString Point

Field Value

Type	Description
InternedString

Position

Declaration

public static readonly InternedString Position

Field Value

Type	Description
InternedString

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 gamepad.

PrimaryAction

Declaration

public static readonly InternedString PrimaryAction

Field Value

Type	Description
InternedString

PrimaryTrigger

Declaration

public static readonly InternedString PrimaryTrigger

Field Value

Type	Description
InternedString

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 gamepad.

SecondaryAction

Declaration

public static readonly InternedString SecondaryAction

Field Value

Type	Description
InternedString

SecondaryTrigger

Declaration

public static readonly InternedString SecondaryTrigger

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.