Atlas Engine
API Referenceatlasatlas/input

Key

Keyboard identifiers used by input polling and trigger bindings.

Module: atlas/input

Keyboard identifiers used by input polling and trigger bindings.

Declaration

export enum Key {
        /**
         * Identifies the Unknown keyboard key.
         */
        Unknown,
        /**
         * Identifies the Space keyboard key.
         */
        Space,
        /**
         * Identifies the Apostrophe keyboard key.
         */
        Apostrophe,
        /**
         * Identifies the Comma keyboard key.
         */
        Comma,
        /**
         * Identifies the Minus keyboard key.
         */
        Minus,
        /**
         * Identifies the Period keyboard key.
         */
        Period,
        /**
         * Identifies the Slash keyboard key.
         */
        Slash,
        /**
         * Identifies the 0 keyboard key.
         */
        Key0,
        /**
         * Identifies the 1 keyboard key.
         */
        Key1,
        /**
         * Identifies the 2 keyboard key.
         */
        Key2,
        /**
         * Identifies the 3 keyboard key.
         */
        Key3,
        /**
         * Identifies the 4 keyboard key.
         */
        Key4,
        /**
         * Identifies the 5 keyboard key.
         */
        Key5,
        /**
         * Identifies the 6 keyboard key.
         */
        Key6,
        /**
         * Identifies the 7 keyboard key.
         */
        Key7,
        /**
         * Identifies the 8 keyboard key.
         */
        Key8,
        /**
         * Identifies the 9 keyboard key.
         */
        Key9,
        /**
         * Identifies the Semicolon keyboard key.
         */
        Semicolon,
        /**
         * Identifies the Equal keyboard key.
         */
        Equal,
        /**
         * Identifies the A keyboard key.
         */
        A,
        /**
         * Identifies the B keyboard key.
         */
        B,
        /**
         * Identifies the C keyboard key.
         */
        C,
        /**
         * Identifies the D keyboard key.
         */
        D,
        /**
         * Identifies the E keyboard key.
         */
        E,
        /**
         * Identifies the F keyboard key.
         */
        F,
        /**
         * Identifies the G keyboard key.
         */
        G,
        /**
         * Identifies the H keyboard key.
         */
        H,
        /**
         * Identifies the I keyboard key.
         */
        I,
        /**
         * Identifies the J keyboard key.
         */
        J,
        /**
         * Identifies the K keyboard key.
         */
        K,
        /**
         * Identifies the L keyboard key.
         */
        L,
        /**
         * Identifies the M keyboard key.
         */
        M,
        /**
         * Identifies the N keyboard key.
         */
        N,
        /**
         * Identifies the O keyboard key.
         */
        O,
        /**
         * Identifies the P keyboard key.
         */
        P,
        /**
         * Identifies the Q keyboard key.
         */
        Q,
        /**
         * Identifies the R keyboard key.
         */
        R,
        /**
         * Identifies the S keyboard key.
         */
        S,
        /**
         * Identifies the T keyboard key.
         */
        T,
        /**
         * Identifies the U keyboard key.
         */
        U,
        /**
         * Identifies the V keyboard key.
         */
        V,
        /**
         * Identifies the W keyboard key.
         */
        W,
        /**
         * Identifies the X keyboard key.
         */
        X,
        /**
         * Identifies the Y keyboard key.
         */
        Y,
        /**
         * Identifies the Z keyboard key.
         */
        Z,
        /**
         * Identifies the LeftBracket keyboard key.
         */
        LeftBracket,
        /**
         * Identifies the Backslash keyboard key.
         */
        Backslash,
        /**
         * Identifies the RightBracket keyboard key.
         */
        RightBracket,
        /**
         * Identifies the GraveAccent keyboard key.
         */
        GraveAccent,
        /**
         * Identifies the Escape keyboard key.
         */
        Escape,
        /**
         * Identifies the Enter keyboard key.
         */
        Enter,
        /**
         * Identifies the Tab keyboard key.
         */
        Tab,
        /**
         * Identifies the Backspace keyboard key.
         */
        Backspace,
        /**
         * Identifies the Insert keyboard key.
         */
        Insert,
        /**
         * Identifies the Delete keyboard key.
         */
        Delete,
        /**
         * Identifies the Right keyboard key.
         */
        Right,
        /**
         * Identifies the Left keyboard key.
         */
        Left,
        /**
         * Identifies the Down keyboard key.
         */
        Down,
        /**
         * Identifies the Up keyboard key.
         */
        Up,
        /**
         * Identifies the PageUp keyboard key.
         */
        PageUp,
        /**
         * Identifies the PageDown keyboard key.
         */
        PageDown,
        /**
         * Identifies the Home keyboard key.
         */
        Home,
        /**
         * Identifies the End keyboard key.
         */
        End,
        /**
         * Identifies the CapsLock keyboard key.
         */
        CapsLock,
        /**
         * Identifies the ScrollLock keyboard key.
         */
        ScrollLock,
        /**
         * Identifies the NumLock keyboard key.
         */
        NumLock,
        /**
         * Identifies the PrintScreen keyboard key.
         */
        PrintScreen,
        /**
         * Identifies the Pause keyboard key.
         */
        Pause,
        /**
         * Identifies the F1 keyboard key.
         */
        F1,
        /**
         * Identifies the F2 keyboard key.
         */
        F2,
        /**
         * Identifies the F3 keyboard key.
         */
        F3,
        /**
         * Identifies the F4 keyboard key.
         */
        F4,
        /**
         * Identifies the F5 keyboard key.
         */
        F5,
        /**
         * Identifies the F6 keyboard key.
         */
        F6,
        /**
         * Identifies the F7 keyboard key.
         */
        F7,
        /**
         * Identifies the F8 keyboard key.
         */
        F8,
        /**
         * Identifies the F9 keyboard key.
         */
        F9,
        /**
         * Identifies the F10 keyboard key.
         */
        F10,
        /**
         * Identifies the F11 keyboard key.
         */
        F11,
        /**
         * Identifies the F12 keyboard key.
         */
        F12,
        /**
         * Identifies the F13 keyboard key.
         */
        F13,
        /**
         * Identifies the F14 keyboard key.
         */
        F14,
        /**
         * Identifies the F15 keyboard key.
         */
        F15,
        /**
         * Identifies the F16 keyboard key.
         */
        F16,
        /**
         * Identifies the F17 keyboard key.
         */
        F17,
        /**
         * Identifies the F18 keyboard key.
         */
        F18,
        /**
         * Identifies the F19 keyboard key.
         */
        F19,
        /**
         * Identifies the F20 keyboard key.
         */
        F20,
        /**
         * Identifies the F21 keyboard key.
         */
        F21,
        /**
         * Identifies the F22 keyboard key.
         */
        F22,
        /**
         * Identifies the F23 keyboard key.
         */
        F23,
        /**
         * Identifies the F24 keyboard key.
         */
        F24,
        /**
         * Identifies the F25 keyboard key.
         */
        F25,
        /**
         * Identifies the KP0 keyboard key.
         */
        KP0,
        /**
         * Identifies the KP1 keyboard key.
         */
        KP1,
        /**
         * Identifies the KP2 keyboard key.
         */
        KP2,
        /**
         * Identifies the KP3 keyboard key.
         */
        KP3,
        /**
         * Identifies the KP4 keyboard key.
         */
        KP4,
        /**
         * Identifies the KP5 keyboard key.
         */
        KP5,
        /**
         * Identifies the KP6 keyboard key.
         */
        KP6,
        /**
         * Identifies the KP7 keyboard key.
         */
        KP7,
        /**
         * Identifies the KP8 keyboard key.
         */
        KP8,
        /**
         * Identifies the KP9 keyboard key.
         */
        KP9,
        /**
         * Identifies the KPDecimal keyboard key.
         */
        KPDecimal,
        /**
         * Identifies the KPDivide keyboard key.
         */
        KPDivide,
        /**
         * Identifies the KPMultiply keyboard key.
         */
        KPMultiply,
        /**
         * Identifies the KPSubtract keyboard key.
         */
        KPSubtract,
        /**
         * Identifies the KPAdd keyboard key.
         */
        KPAdd,
        /**
         * Identifies the KPEnter keyboard key.
         */
        KPEnter,
        /**
         * Identifies the KPEqual keyboard key.
         */
        KPEqual,
        /**
         * Identifies the LeftShift keyboard key.
         */
        LeftShift,
        /**
         * Identifies the LeftControl keyboard key.
         */
        LeftControl,
        /**
         * Identifies the LeftAlt keyboard key.
         */
        LeftAlt,
        /**
         * Identifies the LeftSuper keyboard key.
         */
        LeftSuper,
        /**
         * Identifies the RightShift keyboard key.
         */
        RightShift,
        /**
         * Identifies the RightControl keyboard key.
         */
        RightControl,
        /**
         * Identifies the RightAlt keyboard key.
         */
        RightAlt,
        /**
         * Identifies the RightSuper keyboard key.
         */
        RightSuper,
        /**
         * Identifies the Menu keyboard key.
         */
        Menu,
    }

Values

Unknown

Identifies the Unknown keyboard key.

Unknown

Space

Identifies the Space keyboard key.

Space

Apostrophe

Identifies the Apostrophe keyboard key.

Apostrophe

Comma

Identifies the Comma keyboard key.

Comma

Minus

Identifies the Minus keyboard key.

Minus

Period

Identifies the Period keyboard key.

Period

Slash

Identifies the Slash keyboard key.

Slash

Key0

Identifies the 0 keyboard key.

Key0

Key1

Identifies the 1 keyboard key.

Key1

Key2

Identifies the 2 keyboard key.

Key2

Key3

Identifies the 3 keyboard key.

Key3

Key4

Identifies the 4 keyboard key.

Key4

Key5

Identifies the 5 keyboard key.

Key5

Key6

Identifies the 6 keyboard key.

Key6

Key7

Identifies the 7 keyboard key.

Key7

Key8

Identifies the 8 keyboard key.

Key8

Key9

Identifies the 9 keyboard key.

Key9

Semicolon

Identifies the Semicolon keyboard key.

Semicolon

Equal

Identifies the Equal keyboard key.

Equal

A

Identifies the A keyboard key.

A

B

Identifies the B keyboard key.

B

C

Identifies the C keyboard key.

C

D

Identifies the D keyboard key.

D

E

Identifies the E keyboard key.

E

F

Identifies the F keyboard key.

F

G

Identifies the G keyboard key.

G

H

Identifies the H keyboard key.

H

I

Identifies the I keyboard key.

I

J

Identifies the J keyboard key.

J

K

Identifies the K keyboard key.

K

L

Identifies the L keyboard key.

L

M

Identifies the M keyboard key.

M

N

Identifies the N keyboard key.

N

O

Identifies the O keyboard key.

O

P

Identifies the P keyboard key.

P

Q

Identifies the Q keyboard key.

Q

R

Identifies the R keyboard key.

R

S

Identifies the S keyboard key.

S

T

Identifies the T keyboard key.

T

U

Identifies the U keyboard key.

U

V

Identifies the V keyboard key.

V

W

Identifies the W keyboard key.

W

X

Identifies the X keyboard key.

X

Y

Identifies the Y keyboard key.

Y

Z

Identifies the Z keyboard key.

Z

LeftBracket

Identifies the LeftBracket keyboard key.

LeftBracket

Backslash

Identifies the Backslash keyboard key.

Backslash

RightBracket

Identifies the RightBracket keyboard key.

RightBracket

GraveAccent

Identifies the GraveAccent keyboard key.

GraveAccent

Escape

Identifies the Escape keyboard key.

Escape

Enter

Identifies the Enter keyboard key.

Enter

Tab

Identifies the Tab keyboard key.

Tab

Backspace

Identifies the Backspace keyboard key.

Backspace

Insert

Identifies the Insert keyboard key.

Insert

Delete

Identifies the Delete keyboard key.

Delete

Identifies the Right keyboard key.

Right

Left

Identifies the Left keyboard key.

Left

Down

Identifies the Down keyboard key.

Down

Up

Identifies the Up keyboard key.

Up

PageUp

Identifies the PageUp keyboard key.

PageUp

PageDown

Identifies the PageDown keyboard key.

PageDown

Home

Identifies the Home keyboard key.

Home

End

Identifies the End keyboard key.

End

CapsLock

Identifies the CapsLock keyboard key.

CapsLock

ScrollLock

Identifies the ScrollLock keyboard key.

ScrollLock

NumLock

Identifies the NumLock keyboard key.

NumLock

PrintScreen

Identifies the PrintScreen keyboard key.

PrintScreen

Pause

Identifies the Pause keyboard key.

Pause

F1

Identifies the F1 keyboard key.

F1

F2

Identifies the F2 keyboard key.

F2

F3

Identifies the F3 keyboard key.

F3

F4

Identifies the F4 keyboard key.

F4

F5

Identifies the F5 keyboard key.

F5

F6

Identifies the F6 keyboard key.

F6

F7

Identifies the F7 keyboard key.

F7

F8

Identifies the F8 keyboard key.

F8

F9

Identifies the F9 keyboard key.

F9

F10

Identifies the F10 keyboard key.

F10

F11

Identifies the F11 keyboard key.

F11

F12

Identifies the F12 keyboard key.

F12

F13

Identifies the F13 keyboard key.

F13

F14

Identifies the F14 keyboard key.

F14

F15

Identifies the F15 keyboard key.

F15

F16

Identifies the F16 keyboard key.

F16

F17

Identifies the F17 keyboard key.

F17

F18

Identifies the F18 keyboard key.

F18

F19

Identifies the F19 keyboard key.

F19

F20

Identifies the F20 keyboard key.

F20

F21

Identifies the F21 keyboard key.

F21

F22

Identifies the F22 keyboard key.

F22

F23

Identifies the F23 keyboard key.

F23

F24

Identifies the F24 keyboard key.

F24

F25

Identifies the F25 keyboard key.

F25

KP0

Identifies the KP0 keyboard key.

KP0

KP1

Identifies the KP1 keyboard key.

KP1

KP2

Identifies the KP2 keyboard key.

KP2

KP3

Identifies the KP3 keyboard key.

KP3

KP4

Identifies the KP4 keyboard key.

KP4

KP5

Identifies the KP5 keyboard key.

KP5

KP6

Identifies the KP6 keyboard key.

KP6

KP7

Identifies the KP7 keyboard key.

KP7

KP8

Identifies the KP8 keyboard key.

KP8

KP9

Identifies the KP9 keyboard key.

KP9

KPDecimal

Identifies the KPDecimal keyboard key.

KPDecimal

KPDivide

Identifies the KPDivide keyboard key.

KPDivide

KPMultiply

Identifies the KPMultiply keyboard key.

KPMultiply

KPSubtract

Identifies the KPSubtract keyboard key.

KPSubtract

KPAdd

Identifies the KPAdd keyboard key.

KPAdd

KPEnter

Identifies the KPEnter keyboard key.

KPEnter

KPEqual

Identifies the KPEqual keyboard key.

KPEqual

LeftShift

Identifies the LeftShift keyboard key.

LeftShift

LeftControl

Identifies the LeftControl keyboard key.

LeftControl

LeftAlt

Identifies the LeftAlt keyboard key.

LeftAlt

LeftSuper

Identifies the LeftSuper keyboard key.

LeftSuper

RightShift

Identifies the RightShift keyboard key.

RightShift

RightControl

Identifies the RightControl keyboard key.

RightControl

RightAlt

Identifies the RightAlt keyboard key.

RightAlt

RightSuper

Identifies the RightSuper keyboard key.

RightSuper

Identifies the Menu keyboard key.

Menu

On this page