Enumeration ButtonCode

Contains all possible input buttons, including keyboard scan codes, mouse buttons and gamepad buttons.

Index

Constructors

Values

A Apostrophe At B Back Backslash C CapsLock Colon Comma Command Count D Delete Down E End Equals Escape F F1 F10 F11 F12 F13 F14 F15 F2 F3 F4 F5 F6 F7 F8 F9 G GamepadA GamepadB GamepadBack GamepadBtn1 GamepadBtn10 GamepadBtn11 GamepadBtn12 GamepadBtn13 GamepadBtn14 GamepadBtn15 GamepadBtn16 GamepadBtn2 GamepadBtn3 GamepadBtn4 GamepadBtn5 GamepadBtn6 GamepadBtn7 GamepadBtn8 GamepadBtn9 GamepadDPadLeft GamepadDPadRight GamepadDPadUp GamepadDPatDown GamepadLb GamepadLs GamepadRb GamepadRs GamepadStart GamepadX GamepadY Grave H Home I Insert J K Keypad0 Keypad1 Keypad2 Keypad3 Keypad4 Keypad5 Keypad6 Keypad7 Keypad8 Keypad9 KeypadAdd KeypadComma KeypadDecimal KeypadDivide KeypadEquals KeypadMultiply KeypadSubtract L Left LeftBracket LeftControl LeftMenu LeftShift LeftWindows M Minus MouseBtn10 MouseBtn11 MouseBtn12 MouseBtn13 MouseBtn14 MouseBtn15 MouseBtn16 MouseBtn4 MouseBtn5 MouseBtn6 MouseBtn7 MouseBtn8 MouseBtn9 MouseLeft MouseMiddle MouseRight N Num0 Num1 Num2 Num3 Num4 Num5 Num6 Num7 Num8 Num9 NumGamepadButtons NumKeys NumLock NumMouseButtons NumpadEnter O P PageDown PageUp Pause Period Q R Return Right RightBracket RightControl RightMenu RightShift RightWindows S ScrollLock Semicolon Slash Space T Tab U Unassigned Up V W X Y Z

Methods

addFlag combineFlags getEnumName getEnumNames getEnumValue getEnumValues getNameForValue getNames getValueAtIndex getValues hasFlag hasFlagChanged iterateNames iterateValues removeFlag splitFlags

Constructors

`Protected`constructor

new ButtonCode(do_not_, construct_, this_, type_): ButtonCode
Parameters
- do_not_: undefined
- construct_: undefined
- this_: undefined
- type_: undefined
Returns ButtonCode

Values

`Static` `Readonly`A

A = 30

`Static` `Readonly`Apostrophe

Apostrophe = 40

`Static` `Readonly`At

At = 145

`Static` `Readonly`B

B = 48

`Static` `Readonly`Back

Back = 14

`Static` `Readonly`Backslash

Backslash = 43

`Static` `Readonly`C

C = 46

`Static` `Readonly`CapsLock

CapsLock = 58

`Static` `Readonly`Colon

Colon = 146

`Static` `Readonly`Comma

Comma = 51

`Static` `Readonly`Command

Command = 219

`Static` `Readonly`Count

Count = 249

`Static` `Readonly`D

D = 32

`Static` `Readonly`Delete

Delete = 211

`Static` `Readonly`Down

Down = 208

`Static` `Readonly`E

E = 18

`Static` `Readonly`End

End = 207

`Static` `Readonly`Equals

Equals = 13

`Static` `Readonly`Escape

Escape = 1

`Static` `Readonly`F

F = 33

`Static` `Readonly`F1

F1 = 59

`Static` `Readonly`F10

F10 = 68

`Static` `Readonly`F11

F11 = 87

`Static` `Readonly`F12

F12 = 88

`Static` `Readonly`F13

F13 = 100

`Static` `Readonly`F14

F14 = 101

`Static` `Readonly`F15

F15 = 102

`Static` `Readonly`F2

F2 = 60

`Static` `Readonly`F3

F3 = 61

`Static` `Readonly`F4

F4 = 62

`Static` `Readonly`F5

F5 = 63

`Static` `Readonly`F6

F6 = 64

`Static` `Readonly`F7

F7 = 65

`Static` `Readonly`F8

F8 = 66

`Static` `Readonly`F9

F9 = 67

`Static` `Readonly`G

G = 34

`Static` `Readonly`GamepadA

GamepadA = 1073742095

`Static` `Readonly`GamepadB

GamepadB = 1073742096

`Static` `Readonly`GamepadBack

GamepadBack = 1073742103

`Static` `Readonly`GamepadBtn1

GamepadBtn1 = 1073742109

`Static` `Readonly`GamepadBtn10

GamepadBtn10 = 1073742118

`Static` `Readonly`GamepadBtn11

GamepadBtn11 = 1073742119

`Static` `Readonly`GamepadBtn12

GamepadBtn12 = 1073742120

`Static` `Readonly`GamepadBtn13

GamepadBtn13 = 1073742121

`Static` `Readonly`GamepadBtn14

GamepadBtn14 = 1073742122

`Static` `Readonly`GamepadBtn15

GamepadBtn15 = 1073742123

`Static` `Readonly`GamepadBtn16

GamepadBtn16 = 1073742124

`Static` `Readonly`GamepadBtn2

GamepadBtn2 = 1073742110

`Static` `Readonly`GamepadBtn3

GamepadBtn3 = 1073742111

`Static` `Readonly`GamepadBtn4

GamepadBtn4 = 1073742112

`Static` `Readonly`GamepadBtn5

GamepadBtn5 = 1073742113

`Static` `Readonly`GamepadBtn6

GamepadBtn6 = 1073742114

`Static` `Readonly`GamepadBtn7

GamepadBtn7 = 1073742115

`Static` `Readonly`GamepadBtn8

GamepadBtn8 = 1073742116

`Static` `Readonly`GamepadBtn9

GamepadBtn9 = 1073742117

`Static` `Readonly`GamepadDPadLeft

GamepadDPadLeft = 1073742105

`Static` `Readonly`GamepadDPadRight

GamepadDPadRight = 1073742106

`Static` `Readonly`GamepadDPadUp

GamepadDPadUp = 1073742107

`Static` `Readonly`GamepadDPatDown

GamepadDPatDown = 1073742108

`Static` `Readonly`GamepadLb

GamepadLb = 1073742099

`Static` `Readonly`GamepadLs

GamepadLs = 1073742101

`Static` `Readonly`GamepadRb

GamepadRb = 1073742100

`Static` `Readonly`GamepadRs

GamepadRs = 1073742102

`Static` `Readonly`GamepadStart

GamepadStart = 1073742104

`Static` `Readonly`GamepadX

GamepadX = 1073742097

`Static` `Readonly`GamepadY

GamepadY = 1073742098

`Static` `Readonly`Grave

Grave = 41

`Static` `Readonly`H

H = 35

`Static` `Readonly`Home

Home = 199

`Static` `Readonly`I

I = 23

`Static` `Readonly`Insert

Insert = 210

`Static` `Readonly`J

J = 36

`Static` `Readonly`K

K = 37

`Static` `Readonly`Keypad0

Keypad0 = 82

`Static` `Readonly`Keypad1

Keypad1 = 79

`Static` `Readonly`Keypad2

Keypad2 = 80

`Static` `Readonly`Keypad3

Keypad3 = 81

`Static` `Readonly`Keypad4

Keypad4 = 75

`Static` `Readonly`Keypad5

Keypad5 = 76

`Static` `Readonly`Keypad6

Keypad6 = 77

`Static` `Readonly`Keypad7

Keypad7 = 71

`Static` `Readonly`Keypad8

Keypad8 = 72

`Static` `Readonly`Keypad9

Keypad9 = 73

`Static` `Readonly`KeypadAdd

KeypadAdd = 78

`Static` `Readonly`KeypadComma

KeypadComma = 179

`Static` `Readonly`KeypadDecimal

KeypadDecimal = 83

`Static` `Readonly`KeypadDivide

KeypadDivide = 181

`Static` `Readonly`KeypadEquals

KeypadEquals = 141

`Static` `Readonly`KeypadMultiply

KeypadMultiply = 55

`Static` `Readonly`KeypadSubtract

KeypadSubtract = 74

`Static` `Readonly`L

L = 38

`Static` `Readonly`Left

Left = 203

`Static` `Readonly`LeftBracket

LeftBracket = 26

`Static` `Readonly`LeftControl

LeftControl = 29

`Static` `Readonly`LeftMenu

LeftMenu = 56

`Static` `Readonly`LeftShift

LeftShift = 42

`Static` `Readonly`LeftWindows

LeftWindows = 219

`Static` `Readonly`M

M = 50

`Static` `Readonly`Minus

Minus = 12

`Static` `Readonly`MouseBtn10

MouseBtn10 = 2147483895

`Static` `Readonly`MouseBtn11

MouseBtn11 = 2147483896

`Static` `Readonly`MouseBtn12

MouseBtn12 = 2147483897

`Static` `Readonly`MouseBtn13

MouseBtn13 = 2147483898

`Static` `Readonly`MouseBtn14

MouseBtn14 = 2147483899

`Static` `Readonly`MouseBtn15

MouseBtn15 = 2147483900

`Static` `Readonly`MouseBtn16

MouseBtn16 = 2147483901

`Static` `Readonly`MouseBtn4

MouseBtn4 = 2147483889

`Static` `Readonly`MouseBtn5

MouseBtn5 = 2147483890

`Static` `Readonly`MouseBtn6

MouseBtn6 = 2147483891

`Static` `Readonly`MouseBtn7

MouseBtn7 = 2147483892

`Static` `Readonly`MouseBtn8

MouseBtn8 = 2147483893

`Static` `Readonly`MouseBtn9

MouseBtn9 = 2147483894

`Static` `Readonly`MouseLeft

MouseLeft = 2147483886

`Static` `Readonly`MouseMiddle

MouseMiddle = 2147483888

`Static` `Readonly`MouseRight

MouseRight = 2147483887

`Static` `Readonly`N

N = 49

`Static` `Readonly`Num0

Num0 = 11

`Static` `Readonly`Num1

Num1 = 2

`Static` `Readonly`Num2

Num2 = 3

`Static` `Readonly`Num3

Num3 = 4

`Static` `Readonly`Num4

Num4 = 5

`Static` `Readonly`Num5

Num5 = 6

`Static` `Readonly`Num6

Num6 = 7

`Static` `Readonly`Num7

Num7 = 8

`Static` `Readonly`Num8

Num8 = 9

`Static` `Readonly`Num9

Num9 = 10

`Static` `Readonly`NumGamepadButtons

NumGamepadButtons = 30

`Static` `Readonly`NumKeys

NumKeys = 203

`Static` `Readonly`NumLock

NumLock = 69

`Static` `Readonly`NumMouseButtons

NumMouseButtons = 16

`Static` `Readonly`NumpadEnter

NumpadEnter = 156

`Static` `Readonly`O

O = 24

`Static` `Readonly`P

P = 25

`Static` `Readonly`PageDown

PageDown = 209

`Static` `Readonly`PageUp

PageUp = 201

`Static` `Readonly`Pause

Pause = 197

`Static` `Readonly`Period

Period = 52

`Static` `Readonly`Q

Q = 16

`Static` `Readonly`R

R = 19

`Static` `Readonly`Return

Return = 28

`Static` `Readonly`Right

Right = 205

`Static` `Readonly`RightBracket

RightBracket = 27

`Static` `Readonly`RightControl

RightControl = 157

`Static` `Readonly`RightMenu

RightMenu = 184

`Static` `Readonly`RightShift

RightShift = 54

`Static` `Readonly`RightWindows

RightWindows = 220

`Static` `Readonly`S

S = 31

`Static` `Readonly`ScrollLock

ScrollLock = 70

`Static` `Readonly`Semicolon

Semicolon = 39

`Static` `Readonly`Slash

Slash = 53

`Static` `Readonly`Space

Space = 57

`Static` `Readonly`T

T = 20

`Static` `Readonly`Tab

Tab = 15

`Static` `Readonly`U

U = 22

`Static` `Readonly`Unassigned

Unassigned = 0

`Static` `Readonly`Up

Up = 200

`Static` `Readonly`V

V = 47

`Static` `Readonly`W

W = 17

`Static` `Readonly`X

X = 45

`Static` `Readonly`Y

Y = 21

`Static` `Readonly`Z

Z = 44

Methods

`Static`addFlag

addFlag<T, K>(value, bits): K
Adds the flag bits to the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`combineFlags

combineFlags<T>(values): EnumValueTyped<T, number>
Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- values: EnumValue<T, number>[] | EnumValueTyped<T, number>[]
  The array of values to be combined using bitwise-or operator.
Returns EnumValueTyped<T, number>
The combined enum value.

`Static`getEnumName

getEnumName<T>(index): string
Type Parameters
- T
Parameters
- index: EnumValue<T, number>
Returns string
Obsolete
Compatibility

`Static`getEnumNames

getEnumNames(): string[]
Returns string[]
Obsolete
Compatibility

`Static`getEnumValue

getEnumValue(index): number
Parameters
- index: number
Returns number
Obsolete
Compatibility

`Static`getEnumValues

getEnumValues(): number[]
Returns number[]
Obsolete
Compatibility

`Static`getNameForValue

getNameForValue<T>(enumValue): string
Gets the name for the enumeration value that matches the specified enumValue.
Type Parameters
- T
Parameters
- enumValue: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enumeration value.
Returns string
The enumeration value or undefined if not found.

`Static`getNames

getNames(): string[]
Gets the enumeration names

Returns string[]
The enumeration names.

`Static`getValueAtIndex

getValueAtIndex<T>(index): EnumValueTyped<T, number>
Gets the enumeration value at the specified index.
Type Parameters
- T = number
Parameters
- index: number
  The index.
Returns EnumValueTyped<T, number>
The enumeration value or undefined if not found.

`Static`getValues

getValues<T>(): EnumValueTyped<T, number>[]
Gets the enumeration values
Type Parameters
- T = any
Returns EnumValueTyped<T, number>[]
The enumeration values.

`Static`hasFlag

hasFlag<T, K>(value, bits): boolean
Determines if the enum value has the flags set.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`hasFlagChanged

hasFlagChanged<T, K>(previousValue, newValue, bits): boolean
Determines if the enum bits were changed from previousValue to currentValue.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- previousValue: K
- newValue: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`iterateNames

iterateNames(): Generator<string, any, any>
Iterates the enumeration names

Returns Generator<string, any, any>
The enumeration names.

`Static`iterateValues

iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>
Iterates the enumeration values
Type Parameters
- T = any
Returns Generator<EnumValueTyped<T, number>, any, any>
The enumeration values.

`Static`removeFlag

removeFlag<T, K>(value, bits): K
Removes the flag bits from the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`splitFlags

splitFlags<T>(value): EnumValueTyped<T, number>[]
Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.
Type Parameters
- T extends Enum
Parameters
- value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enum value to have it's value split using bitwise-and operator.
Returns EnumValueTyped<T, number>[]
An array of each "bit flag" set in the enum.

Enumeration ButtonCode

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns ButtonCode

Values

Static ReadonlyA

Static ReadonlyApostrophe

Static ReadonlyAt

Static ReadonlyB

Static ReadonlyBack

Static ReadonlyBackslash

Static ReadonlyC

Static ReadonlyCapsLock

Static ReadonlyColon

Static ReadonlyComma

Static ReadonlyCommand

Static ReadonlyCount

Static ReadonlyD

Static ReadonlyDelete

Static ReadonlyDown

Static ReadonlyE

Static ReadonlyEnd

Static ReadonlyEquals

Static ReadonlyEscape

Static ReadonlyF

Static ReadonlyF1

Static ReadonlyF10

Static ReadonlyF11

Static ReadonlyF12

Static ReadonlyF13

Static ReadonlyF14

Static ReadonlyF15

Static ReadonlyF2

Static ReadonlyF3

Static ReadonlyF4

Static ReadonlyF5

Static ReadonlyF6

Static ReadonlyF7

Static ReadonlyF8

Static ReadonlyF9

Static ReadonlyG

Static ReadonlyGamepadA

Static ReadonlyGamepadB

Static ReadonlyGamepadBack

Static ReadonlyGamepadBtn1

Static ReadonlyGamepadBtn10

Static ReadonlyGamepadBtn11

Static ReadonlyGamepadBtn12

Static ReadonlyGamepadBtn13

Static ReadonlyGamepadBtn14

Static ReadonlyGamepadBtn15

Static ReadonlyGamepadBtn16

Static ReadonlyGamepadBtn2

Static ReadonlyGamepadBtn3

Static ReadonlyGamepadBtn4

Static ReadonlyGamepadBtn5

Static ReadonlyGamepadBtn6

Static ReadonlyGamepadBtn7

Static ReadonlyGamepadBtn8

Static ReadonlyGamepadBtn9

Static ReadonlyGamepadDPadLeft

Static ReadonlyGamepadDPadRight

Static ReadonlyGamepadDPadUp

Static ReadonlyGamepadDPatDown

Static ReadonlyGamepadLb

Static ReadonlyGamepadLs

Static ReadonlyGamepadRb

Static ReadonlyGamepadRs

Static ReadonlyGamepadStart

Static ReadonlyGamepadX

Static ReadonlyGamepadY

Static ReadonlyGrave

Static ReadonlyH

Static ReadonlyHome

Static ReadonlyI

`Protected`constructor

`Static` `Readonly`A

`Static` `Readonly`Apostrophe

`Static` `Readonly`At

`Static` `Readonly`B

`Static` `Readonly`Back

`Static` `Readonly`Backslash

`Static` `Readonly`C

`Static` `Readonly`CapsLock

`Static` `Readonly`Colon

`Static` `Readonly`Comma

`Static` `Readonly`Command

`Static` `Readonly`Count

`Static` `Readonly`D

`Static` `Readonly`Delete

`Static` `Readonly`Down

`Static` `Readonly`E

`Static` `Readonly`End

`Static` `Readonly`Equals

`Static` `Readonly`Escape

`Static` `Readonly`F

`Static` `Readonly`F1

`Static` `Readonly`F10

`Static` `Readonly`F11

`Static` `Readonly`F12

`Static` `Readonly`F13

`Static` `Readonly`F14

`Static` `Readonly`F15

`Static` `Readonly`F2

`Static` `Readonly`F3

`Static` `Readonly`F4

`Static` `Readonly`F5

`Static` `Readonly`F6

`Static` `Readonly`F7

`Static` `Readonly`F8

`Static` `Readonly`F9

`Static` `Readonly`G

`Static` `Readonly`GamepadA

`Static` `Readonly`GamepadB

`Static` `Readonly`GamepadBack

`Static` `Readonly`GamepadBtn1

`Static` `Readonly`GamepadBtn10

`Static` `Readonly`GamepadBtn11

`Static` `Readonly`GamepadBtn12

`Static` `Readonly`GamepadBtn13

`Static` `Readonly`GamepadBtn14

`Static` `Readonly`GamepadBtn15

`Static` `Readonly`GamepadBtn16

`Static` `Readonly`GamepadBtn2

`Static` `Readonly`GamepadBtn3

`Static` `Readonly`GamepadBtn4

`Static` `Readonly`GamepadBtn5

`Static` `Readonly`GamepadBtn6

`Static` `Readonly`GamepadBtn7

`Static` `Readonly`GamepadBtn8

`Static` `Readonly`GamepadBtn9

`Static` `Readonly`GamepadDPadLeft

`Static` `Readonly`GamepadDPadRight

`Static` `Readonly`GamepadDPadUp

`Static` `Readonly`GamepadDPatDown

`Static` `Readonly`GamepadLb

`Static` `Readonly`GamepadLs

`Static` `Readonly`GamepadRb

`Static` `Readonly`GamepadRs

`Static` `Readonly`GamepadStart

`Static` `Readonly`GamepadX

`Static` `Readonly`GamepadY

`Static` `Readonly`Grave

`Static` `Readonly`H

`Static` `Readonly`Home

`Static` `Readonly`I

`Static` `Readonly`Insert

`Static` `Readonly`J

`Static` `Readonly`K

`Static` `Readonly`Keypad0

`Static` `Readonly`Keypad1

`Static` `Readonly`Keypad2

`Static` `Readonly`Keypad3

`Static` `Readonly`Keypad4

`Static` `Readonly`Keypad5