class Keyboard

package openfl.ui

Available on all platforms

The Keyboard class is used to build an interface that can be controlled by a user with a standard keyboard. You can use the methods and properties of the Keyboard class without using a constructor. The properties of the Keyboard class are constants representing the keys that are most commonly used to control games.

Static variables

staticinline read onlyA:Int = 65

Constant associated with the key code value for the A key(65).

staticinline read onlyALTERNATE:Int = 18

Constant associated with the key code value for the Alternate(Option) key (18).

staticinline read onlyB:Int = 66

Constant associated with the key code value for the B key(66).

staticinline read onlyBACKQUOTE:Int = 192

Constant associated with the key code value for the ` key(192).

staticinline read onlyBACKSLASH:Int = 220

Constant associated with the key code value for the \ key(220).

staticinline read onlyBACKSPACE:Int = 8

Constant associated with the key code value for the Backspace key(8).

staticinline read onlyBREAK:Int = 19

staticinline read onlyC:Int = 67

Constant associated with the key code value for the C key(67).

staticinline read onlyCAPS_LOCK:Int = 20

Constant associated with the key code value for the Caps Lock key(20).

staticinline read onlyCOMMA:Int = 188

Constant associated with the key code value for the , key(188).

staticinline read onlyCOMMAND:Int = 15

Constant associated with the Mac command key(15). This constant is currently only used for setting menu key equivalents.

staticinline read onlyCONTROL:Int = 17

Constant associated with the key code value for the Control key(17).

staticinline read onlyD:Int = 68

Constant associated with the key code value for the D key(68).

staticinline read onlyDELETE:Int = 46

Constant associated with the key code value for the Delete key(46).

staticinline read onlyDOWN:Int = 40

Constant associated with the key code value for the Down Arrow key(40).

staticinline read onlyE:Int = 69

Constant associated with the key code value for the E key(69).

staticinline read onlyEND:Int = 35

Constant associated with the key code value for the End key(35).

staticinline read onlyENTER:Int = 13

Constant associated with the key code value for the Enter key(13).

staticinline read onlyEQUAL:Int = 187

Constant associated with the key code value for the = key(187).

staticinline read onlyESCAPE:Int = 27

Constant associated with the key code value for the Escape key(27).

staticinline read onlyF:Int = 70

Constant associated with the key code value for the F key(70).

staticinline read onlyF1:Int = 112

Constant associated with the key code value for the F1 key(112).

staticinline read onlyF10:Int = 121

Constant associated with the key code value for the F10 key(121).

staticinline read onlyF11:Int = 122

Constant associated with the key code value for the F11 key(122).

staticinline read onlyF12:Int = 123

Constant associated with the key code value for the F12 key(123).

staticinline read onlyF13:Int = 124

Constant associated with the key code value for the F13 key(124).

staticinline read onlyF14:Int = 125

Constant associated with the key code value for the F14 key(125).

staticinline read onlyF15:Int = 126

Constant associated with the key code value for the F15 key(126).

staticinline read onlyF2:Int = 113

Constant associated with the key code value for the F2 key(113).

staticinline read onlyF3:Int = 114

Constant associated with the key code value for the F3 key(114).

staticinline read onlyF4:Int = 115

Constant associated with the key code value for the F4 key(115).

staticinline read onlyF5:Int = 116

Constant associated with the key code value for the F5 key(116).

staticinline read onlyF6:Int = 117

Constant associated with the key code value for the F6 key(117).

staticinline read onlyF7:Int = 118

Constant associated with the key code value for the F7 key(118).

staticinline read onlyF8:Int = 119

Constant associated with the key code value for the F8 key(119).

staticinline read onlyF9:Int = 120

Constant associated with the key code value for the F9 key(120).

staticinline read onlyG:Int = 71

Constant associated with the key code value for the G key(71).

staticinline read onlyH:Int = 72

Constant associated with the key code value for the H key(72).

staticinline read onlyHOME:Int = 36

Constant associated with the key code value for the Home key(36).

staticinline read onlyI:Int = 73

Constant associated with the key code value for the I key(73).

staticinline read onlyINSERT:Int = 45

Constant associated with the key code value for the Insert key(45).

staticinline read onlyJ:Int = 74

Constant associated with the key code value for the J key(74).

staticinline read onlyK:Int = 75

Constant associated with the key code value for the K key(75).

staticinline read onlyL:Int = 76

Constant associated with the key code value for the L key(76).

staticinline read onlyLEFT:Int = 37

Constant associated with the key code value for the Left Arrow key(37).

staticinline read onlyLEFTBRACKET:Int = 219

Constant associated with the key code value for the [ key(219).

staticinline read onlyM:Int = 77

Constant associated with the key code value for the M key(77).

staticinline read onlyMINUS:Int = 189

Constant associated with the key code value for the - key(189).

staticinline read onlyN:Int = 78

Constant associated with the key code value for the N key(78).

staticinline read onlyNUMBER_0:Int = 48

Constant associated with the key code value for the 0 key(48).

staticinline read onlyNUMBER_1:Int = 49

Constant associated with the key code value for the 1 key(49).

staticinline read onlyNUMBER_2:Int = 50

Constant associated with the key code value for the 2 key(50).

staticinline read onlyNUMBER_3:Int = 51

Constant associated with the key code value for the 3 key(51).

staticinline read onlyNUMBER_4:Int = 52

Constant associated with the key code value for the 4 key(52).

staticinline read onlyNUMBER_5:Int = 53

Constant associated with the key code value for the 5 key(53).

staticinline read onlyNUMBER_6:Int = 54

Constant associated with the key code value for the 6 key(54).

staticinline read onlyNUMBER_7:Int = 55

Constant associated with the key code value for the 7 key(55).

staticinline read onlyNUMBER_8:Int = 56

Constant associated with the key code value for the 8 key(56).

staticinline read onlyNUMBER_9:Int = 57

Constant associated with the key code value for the 9 key(57).

staticinline read onlyNUMLOCK:Int = 144

staticinline read onlyNUMPAD:Int = 21

Constant associated with the pseudo-key code for the the number pad(21). Use to set numpad modifier on key equivalents

staticinline read onlyNUMPAD_0:Int = 96

Constant associated with the key code value for the number 0 key on the number pad(96).

staticinline read onlyNUMPAD_1:Int = 97

Constant associated with the key code value for the number 1 key on the number pad(97).

staticinline read onlyNUMPAD_2:Int = 98

Constant associated with the key code value for the number 2 key on the number pad(98).

staticinline read onlyNUMPAD_3:Int = 99

Constant associated with the key code value for the number 3 key on the number pad(99).

staticinline read onlyNUMPAD_4:Int = 100

Constant associated with the key code value for the number 4 key on the number pad(100).

staticinline read onlyNUMPAD_5:Int = 101

Constant associated with the key code value for the number 5 key on the number pad(101).

staticinline read onlyNUMPAD_6:Int = 102

Constant associated with the key code value for the number 6 key on the number pad(102).

staticinline read onlyNUMPAD_7:Int = 103

Constant associated with the key code value for the number 7 key on the number pad(103).

staticinline read onlyNUMPAD_8:Int = 104

Constant associated with the key code value for the number 8 key on the number pad(104).

staticinline read onlyNUMPAD_9:Int = 105

Constant associated with the key code value for the number 9 key on the number pad(105).

staticinline read onlyNUMPAD_ADD:Int = 107

Constant associated with the key code value for the addition key on the number pad(107).

staticinline read onlyNUMPAD_DECIMAL:Int = 110

Constant associated with the key code value for the decimal key on the number pad(110).

staticinline read onlyNUMPAD_DIVIDE:Int = 111

Constant associated with the key code value for the division key on the number pad(111).

staticinline read onlyNUMPAD_ENTER:Int = 108

Constant associated with the key code value for the Enter key on the number pad(108).

staticinline read onlyNUMPAD_MULTIPLY:Int = 106

Constant associated with the key code value for the multiplication key on the number pad(106).

staticinline read onlyNUMPAD_SUBTRACT:Int = 109

Constant associated with the key code value for the subtraction key on the number pad(109).

staticinline read onlyO:Int = 79

Constant associated with the key code value for the O key(79).

staticinline read onlyP:Int = 80

Constant associated with the key code value for the P key(80).

staticinline read onlyPAGE_DOWN:Int = 34

Constant associated with the key code value for the Page Down key(34).

staticinline read onlyPAGE_UP:Int = 33

Constant associated with the key code value for the Page Up key(33).

staticinline read onlyPERIOD:Int = 190

Constant associated with the key code value for the . key(190).

staticinline read onlyQ:Int = 81

Constant associated with the key code value for the Q key(81).

staticinline read onlyQUOTE:Int = 222

Constant associated with the key code value for the ' key(222).

staticinline read onlyR:Int = 82

Constant associated with the key code value for the R key(82).

staticinline read onlyRIGHT:Int = 39

Constant associated with the key code value for the Right Arrow key(39).

staticinline read onlyRIGHTBRACKET:Int = 221

Constant associated with the key code value for the ] key(221).

staticinline read onlyS:Int = 83

Constant associated with the key code value for the S key(83).

staticinline read onlySEMICOLON:Int = 186

Constant associated with the key code value for the ; key(186).

staticinline read onlySHIFT:Int = 16

Constant associated with the key code value for the Shift key(16).

staticinline read onlySLASH:Int = 191

Constant associated with the key code value for the / key(191).

staticinline read onlySPACE:Int = 32

Constant associated with the key code value for the Spacebar(32).

staticinline read onlyT:Int = 84

Constant associated with the key code value for the T key(84).

staticinline read onlyTAB:Int = 9

Constant associated with the key code value for the Tab key(9).

staticinline read onlyU:Int = 85

Constant associated with the key code value for the U key(85).

staticinline read onlyUP:Int = 38

Constant associated with the key code value for the Up Arrow key(38).

staticinline read onlyV:Int = 86

Constant associated with the key code value for the V key(85).

staticinline read onlyW:Int = 87

Constant associated with the key code value for the W key(87).

staticinline read onlyX:Int = 88

Constant associated with the key code value for the X key(88).

staticinline read onlyY:Int = 89

Constant associated with the key code value for the Y key(89).

staticinline read onlyZ:Int = 90

Constant associated with the key code value for the Z key(90).

staticread onlycapsLock:Bool

Specifies whether the Caps Lock key is activated(true) or not(false).

staticread onlynumLock:Bool

Specifies whether the Num Lock key is activated(true) or not (false).

Static methods

staticisAccessible ():Bool

Specifies whether the last key pressed is accessible by other SWF files. By default, security restrictions prevent code from a SWF file in one domain from accessing a keystroke generated from a SWF file in another domain.

Returns:

The value true if the last key pressed can be accessed. If access is not permitted, this method returns false.