Reference for keyboard.lua Module 🔗

local keyboard = require("keyboard")

Use these codes to refer to the corresponding keys. That is, if you need the key code for K, write in keyboard.k. The actual key code is available here, but you probably shouldn’t use the number itself in your code.

Letters 🔗

keyboard.a

Code: 65

keyboard.b

Code: 66

keyboard.c

Code: 67

keyboard.d

Code: 68

keyboard.e

Code: 69

keyboard.f

Code: 70

keyboard.g

Code: 71

keyboard.h

Code: 72

keyboard.i

Code: 73

keyboard.j

Code: 74

keyboard.k

Code: 75

keyboard.l

Code: 76

keyboard.m

Code: 77

keyboard.n

Code: 78

keyboard.o

Code: 79

keyboard.p

Code: 80

keyboard.q

Code: 81

keyboard.r

Code: 82

keyboard.s

Code: 83

keyboard.t

Code: 84

keyboard.u

Code: 85

keyboard.v

Code: 86

keyboard.w

Code: 87

keyboard.x

Code: 88

keyboard.y

Code: 89

keyboard.z

Code: 90

Numbers above Letters 🔗

keyboard.zero

Code: 48

keyboard.one

Code: 49

keyboard.two

Code: 50

keyboard.three

Code: 51

keyboard.four

Code: 52

keyboard.five

Code: 53

keyboard.six

Code: 54

keyboard.seven

Code: 55

keyboard.eight

Code: 56

keyboard.nine

Code: 57

Miscellaneous Keys 🔗

keyboard.backspace

Code: 214

keyboard.tab

Code: 211

keyboard.enter

Code: 208

keyboard.escape

Code: 210

keyboard.esc

Code: 210

keyboard.delete

Code: 217

keyboard.numlockMinus

Code: 173

keyboard.numlockPlus

Code: 171

keyboard.numlockSlash

Code: 175

keyboard.numlockStar

Code: 170

keyboard.numlockAsterisk

Code: 170

Arrows and Directions 🔗

keyboard.up

Code: 192

keyboard.north

Code: 192

keyboard.right

Code: 195

keyboard.east

Code: 195

keyboard.down

Code: 193

keyboard.south

Code: 193

keyboard.left

Code: 194

keyboard.west

Code: 194

keyboard.northEast

Code: 197

keyboard.pageUp

Code: 197

keyboard.southEast

Code: 198

keyboard.pageDown

Code: 198

keyboard.southWest

Code: 199

keyboard.endKey

Code: 199

keyboard.northWest

Code: 196

keyboard.home

Code: 196

Number Pad Numbers 🔗

keyboard.numlock0

Code: 160

keyboard.numlock1

Code: 161

keyboard.numlock2

Code: 162

keyboard.numlock3

Code: 163

keyboard.numlock4

Code: 164

keyboard.numlock5

Code: 165

keyboard.numlock6

Code: 166

keyboard.numlock7

Code: 167

keyboard.numlock8

Code: 168

keyboard.numlock9

Code: 169

F Keys 🔗

keyboard.F1

Code: 176

keyboard.F2

Code: 177

keyboard.F3

Code: 178

keyboard.F4

Code: 179

keyboard.F5

Code: 180

keyboard.F6

Code: 181

keyboard.F7

Code: 182

keyboard.F8

Code: 183

keyboard.F9

Code: 184

F10 key does not have a code, and can't be used.

keyboard.F11

Code: 186

keyboard.F12

Code: 187

Shift and Ctrl 🔗

The Shift and Control keys modify the other keys, by adding 256 and 512, respectively, to the key codes.

If you reference a key by

keyboard.keyName

Then, to get the ID of that key when Shift is held down, write

keyboard.shift.keyName

Similarly, to get the ID of a key when Ctrl is held down, write

keyboard.ctrl.keyName

For Ctrl and Shift at the same time, you can use either of these commands:

keyboard.ctrl.shift.keyName
keyboard.shift.ctrl.keyName

If you happen to need the value for Shift or Ctrl itself, use these:

keyboard.shiftOffset

Code: 256

keyboard.ctrlOffset

Code: 512