EKeys

Choose your operating system:

Windows

macOS

Linux

References

Module

InputCore

Header

/Engine/Source/Runtime/InputCore/Classes/InputCoreTypes.h

Include

#include "InputCoreTypes.h"

Syntax

struct EKeys

Functions

Name Description

Public function Static

void

 

AddKey

(
    const FKeyDetails& KeyDetails
)

Public function Static

void

 

AddMenuCategoryDisplayInfo

(
    const FName CategoryName,
    const FText DisplayName,
    const FName PaletteIcon
)

Public function Static

void

 

AddPairedKey

(
    const FKeyDetails& PairedKeyDetail...,
    FKey KeyX,
    FKey KeyY
)

Public function Static

void

 

GetAllKeys

(
    TArray< FKey >& OutKeys
)

Public function Static

FText

 

GetGamepadDisplayName

(
    const FKey Key
)

Function that provides remapping for some gamepad keys in display windows.

Public function Static

TSharedPtr< ...

 

GetKeyDetails

(
    const FKey Key
)

Public function Static

FText

 

GetMenuCategoryDisplayName

(
    const FName CategoryName
)

Public function Static

FName

 

GetMenuCategoryPaletteIcon

(
    const FName CategoryName
)

Public function Static

void

 

Initialize()

Public function Static

bool

 

IsAxis

(
    FKey Key
)

Public function Static

bool

 

IsBindableInBlueprints

(
    const FKey Key
)

Public function Static

bool

 

IsGamepadKey

(
    FKey Key
)

Public function Static

bool

 

IsModifierKey

(
    FKey Key
)

These exist for backwards compatibility reasons only.

Public function Static

void

 

RemoveKeysWithCategory

(
    const FName InCategory
)

Public function Static

void

 

SetConsoleForGamepadLabels

(
    const EConsoleForGamepadLabels::Typ...
)

Constants

Name

Description

A

A_AccentGrave

Acceleration

Add

Ampersand

Android_Back

Android-specific.

Android_Menu

Android_Volume_Down

Android_Volume_Up

AnyKey

Apostrophe

Asterix

B

Backslash

BackSpace

bInitialized

C

C_Cedille

CapsLock

Caret

Colon

Comma

ConsoleForGamepadLabels

D

Decimal

Delete

Divide

Dollar

Down

E

E_AccentAigu

E_AccentGrave

Eight

End

Enter

Equals

Escape

Exclamation

F

F1

F10

F11

F12

F2

F3

F4

F5

F6

F7

F8

F9

Five

Four

G

Gamepad_DPad_Down

Gamepad_DPad_Left

Gamepad_DPad_Right

Gamepad_DPad_Up

Gamepad_FaceButton_Bottom

Gamepad_FaceButton_Left

Gamepad_FaceButton_Right

Gamepad_FaceButton_Top

Gamepad_Left2D

Gamepad Keys.

Gamepad_LeftShoulder

Gamepad_LeftStick_Down

Gamepad_LeftStick_Left

Gamepad_LeftStick_Right

Gamepad_LeftStick_Up

Virtual key codes used for input axis button press/release emulation.

Gamepad_LeftThumbstick

Gamepad_LeftTrigger

Gamepad_LeftTriggerAxis

Gamepad_LeftX

Gamepad_LeftY

Gamepad_Right2D

Gamepad_RightShoulder

Gamepad_RightStick_Down

Gamepad_RightStick_Left

Gamepad_RightStick_Right

Gamepad_RightStick_Up

Gamepad_RightThumbstick

Gamepad_RightTrigger

Gamepad_RightTriggerAxis

Gamepad_RightX

Gamepad_RightY

Gamepad_Special_Left

Gamepad_Special_Left_X

Gamepad_Special_Left_Y

Gamepad_Special_Right

Gesture_Flick

Gesture_Pinch

Gestures.

Gesture_Rotate

Global_Back

Global_Menu

Xbox One global speech commands.

Global_Pause

Global_Play

Global_View

Gravity

H

Home

Hyphen

I

InputKeys

Insert

Invalid

J

K

L

Left

LeftAlt

LeftBracket

LeftCommand

LeftControl

LeftMouseButton

LeftParantheses

LeftShift

M

MenuCategoryDisplayInfo

MiddleMouseButton

MixedReality_Left_Grip_Click

MixedReality_Left_Menu_Click

Microsoft Mixed Reality Motion Controller.

MixedReality_Left_Thumbstick_Click

MixedReality_Left_Thumbstick_Down

MixedReality_Left_Thumbstick_Left

MixedReality_Left_Thumbstick_Right

MixedReality_Left_Thumbstick_Up

MixedReality_Left_Thumbstick_X

MixedReality_Left_Thumbstick_Y

MixedReality_Left_Trackpad_Click

MixedReality_Left_Trackpad_Down

MixedReality_Left_Trackpad_Left

MixedReality_Left_Trackpad_Right

MixedReality_Left_Trackpad_Touch

MixedReality_Left_Trackpad_Up

MixedReality_Left_Trackpad_X

MixedReality_Left_Trackpad_Y

MixedReality_Left_Trigger_Axis

MixedReality_Left_Trigger_Click

MixedReality_Right_Grip_Click

MixedReality_Right_Menu_Click

MixedReality_Right_Thumbstick_Click

MixedReality_Right_Thumbstick_Down

MixedReality_Right_Thumbstick_Left

MixedReality_Right_Thumbstick_Right

MixedReality_Right_Thumbstick_Up

MixedReality_Right_Thumbstick_X

MixedReality_Right_Thumbstick_Y

MixedReality_Right_Trackpad_Click

MixedReality_Right_Trackpad_Down

MixedReality_Right_Trackpad_Left

MixedReality_Right_Trackpad_Right

MixedReality_Right_Trackpad_Touch

MixedReality_Right_Trackpad_Up

MixedReality_Right_Trackpad_X

MixedReality_Right_Trackpad_Y

MixedReality_Right_Trigger_Axis

MixedReality_Right_Trigger_Click

Mouse2D

MouseScrollDown

MouseScrollUp

MouseWheelAxis

MouseX

MouseY

Multiply

N

NAME_GamepadCategory

NAME_KeyboardCategory

NAME_MouseCategory

Nine

NUM_TOUCH_KEYS

NUM_XR_KEY_TOKENS

XR key names are parseable into exactly 4 tokens.

NumLock

NumPadEight

NumPadFive

NumPadFour

NumPadNine

NumPadOne

NumPadSeven

NumPadSix

NumPadThree

NumPadTwo

NumPadZero

O

OculusTouch_Left_Grip_Axis

OculusTouch_Left_Grip_Click

OculusTouch_Left_Menu_Click

OculusTouch_Left_Thumbstick_Click

OculusTouch_Left_Thumbstick_Down

OculusTouch_Left_Thumbstick_Left

OculusTouch_Left_Thumbstick_Right

OculusTouch_Left_Thumbstick_Touch

OculusTouch_Left_Thumbstick_Up

OculusTouch_Left_Thumbstick_X

OculusTouch_Left_Thumbstick_Y

OculusTouch_Left_Trigger_Axis

OculusTouch_Left_Trigger_Click

OculusTouch_Left_Trigger_Touch

OculusTouch_Left_X_Click

Oculus Touch Controller.

OculusTouch_Left_X_Touch

OculusTouch_Left_Y_Click

OculusTouch_Left_Y_Touch

OculusTouch_Right_A_Click

OculusTouch_Right_A_Touch

OculusTouch_Right_B_Click

OculusTouch_Right_B_Touch

OculusTouch_Right_Grip_Axis

OculusTouch_Right_Grip_Click

OculusTouch_Right_System_Click

OculusTouch_Right_Thumbstick_Click

OculusTouch_Right_Thumbstick_Down

OculusTouch_Right_Thumbstick_Left

OculusTouch_Right_Thumbstick_Right

OculusTouch_Right_Thumbstick_Touch

OculusTouch_Right_Thumbstick_Up

OculusTouch_Right_Thumbstick_X

OculusTouch_Right_Thumbstick_Y

OculusTouch_Right_Trigger_Axis

OculusTouch_Right_Trigger_Click

OculusTouch_Right_Trigger_Touch

One

P

PageDown

PageUp

Pause

Period

Platform_Delete

Platform Keys These keys platform specific versions of keys that go by different names.

PS4_Special

PS4-specific

Q

Quote

R

Right

RightAlt

RightBracket

RightCommand

RightControl

RightMouseButton

RightParantheses

RightShift

RotationRate

S

ScrollLock

Section

Semicolon

Seven

Six

Slash

SpaceBar

Steam_Back_Left

Steam_Back_Right

Steam_Touch_0

Steam Controller Specific.

Steam_Touch_1

Steam_Touch_2

Steam_Touch_3

Subtract

T

Tab

Three

ThumbMouseButton

ThumbMouseButton2

Tilde

Tilt

Static const FKey Vector axes (FVector; not float)

TouchKeys

Two

U

Underscore

Up

V

ValveIndex_Left_A_Click

Valve Index Controller.

ValveIndex_Left_A_Touch

ValveIndex_Left_B_Click

ValveIndex_Left_B_Touch

ValveIndex_Left_Grip_Axis

ValveIndex_Left_Grip_Force

ValveIndex_Left_System_Click

ValveIndex_Left_System_Touch

ValveIndex_Left_Thumbstick_Click

ValveIndex_Left_Thumbstick_Down

ValveIndex_Left_Thumbstick_Left

ValveIndex_Left_Thumbstick_Right

ValveIndex_Left_Thumbstick_Touch

ValveIndex_Left_Thumbstick_Up

ValveIndex_Left_Thumbstick_X

ValveIndex_Left_Thumbstick_Y

ValveIndex_Left_Trackpad_Down

ValveIndex_Left_Trackpad_Force

ValveIndex_Left_Trackpad_Left

ValveIndex_Left_Trackpad_Right

ValveIndex_Left_Trackpad_Touch

ValveIndex_Left_Trackpad_Up

ValveIndex_Left_Trackpad_X

ValveIndex_Left_Trackpad_Y

ValveIndex_Left_Trigger_Axis

ValveIndex_Left_Trigger_Click

ValveIndex_Left_Trigger_Touch

ValveIndex_Right_A_Click

ValveIndex_Right_A_Touch

ValveIndex_Right_B_Click

ValveIndex_Right_B_Touch

ValveIndex_Right_Grip_Axis

ValveIndex_Right_Grip_Force

ValveIndex_Right_System_Click

ValveIndex_Right_System_Touch

ValveIndex_Right_Thumbstick_Click

ValveIndex_Right_Thumbstick_Down

ValveIndex_Right_Thumbstick_Left

ValveIndex_Right_Thumbstick_Right

ValveIndex_Right_Thumbstick_Touch

ValveIndex_Right_Thumbstick_Up

ValveIndex_Right_Thumbstick_X

ValveIndex_Right_Thumbstick_Y

ValveIndex_Right_Trackpad_Down

ValveIndex_Right_Trackpad_Force

ValveIndex_Right_Trackpad_Left

ValveIndex_Right_Trackpad_Right

ValveIndex_Right_Trackpad_Touch

ValveIndex_Right_Trackpad_Up

ValveIndex_Right_Trackpad_X

ValveIndex_Right_Trackpad_Y

ValveIndex_Right_Trigger_Axis

ValveIndex_Right_Trigger_Click

ValveIndex_Right_Trigger_Touch

Virtual_Accept

Virtual buttons that use other buttons depending on the platform.

Virtual_Back

Vive_Left_Grip_Click

Vive_Left_Menu_Click

Vive_Left_System_Click

HTC Vive Controller.

Vive_Left_Trackpad_Click

Vive_Left_Trackpad_Down

Vive_Left_Trackpad_Left

Vive_Left_Trackpad_Right

Vive_Left_Trackpad_Touch

Vive_Left_Trackpad_Up

Vive_Left_Trackpad_X

Vive_Left_Trackpad_Y

Vive_Left_Trigger_Axis

Vive_Left_Trigger_Click

Vive_Right_Grip_Click

Vive_Right_Menu_Click

Vive_Right_System_Click

Vive_Right_Trackpad_Click

Vive_Right_Trackpad_Down

Vive_Right_Trackpad_Left

Vive_Right_Trackpad_Right

Vive_Right_Trackpad_Touch

Vive_Right_Trackpad_Up

Vive_Right_Trackpad_X

Vive_Right_Trackpad_Y

Vive_Right_Trigger_Axis

Vive_Right_Trigger_Click

W

X

Y

Z

Zero