Module system.keys¶
The keys module assigns names to the keycode constants that Phoenix sends in
key events, and adds a few functions to make using them easier. This module
uses the same names as the CraftOS keys API, so porting programs should be
trivial.
Index¶
Data
The rest have to be added manually |
|
Function
Returns a printable representation of the keycode if available. |
|
Returns the name for the specified keycode. |
API Reference¶
-
system.keys.backspace:
integer¶ The rest have to be added manually
-
system.keys.tab:
integer¶
-
system.keys.enter:
integer¶
-
system.keys.space:
integer¶
-
system.keys.apostrophe:
integer¶
-
system.keys.comma:
integer¶
-
system.keys.minus:
integer¶
-
system.keys.period:
integer¶
-
system.keys.slash:
integer¶
-
system.keys.zero:
integer¶
-
system.keys.one:
integer¶
-
system.keys.two:
integer¶
-
system.keys.three:
integer¶
-
system.keys.four:
integer¶
-
system.keys.five:
integer¶
-
system.keys.six:
integer¶
-
system.keys.seven:
integer¶
-
system.keys.eight:
integer¶
-
system.keys.nine:
integer¶
-
system.keys.semicolon:
integer¶
-
system.keys.equals:
integer¶
-
system.keys.leftBracket:
integer¶
-
system.keys.backslash:
integer¶
-
system.keys.rightBracket:
integer¶
-
system.keys.grave:
integer¶
-
system.keys.delete:
integer¶
-
system.keys.insert:
integer¶
-
system.keys.convert:
integer¶
-
system.keys.noconvert:
integer¶
-
system.keys.kana:
integer¶
-
system.keys.kanji:
integer¶
-
system.keys.yen:
integer¶
-
system.keys.numPadDecimal:
integer¶
-
system.keys.numPadAdd:
integer¶
-
system.keys.numPadSubtract:
integer¶
-
system.keys.numPadMultiply:
integer¶
-
system.keys.numPadDivide:
integer¶
-
system.keys.numPadEqual:
integer¶
-
system.keys.numPadEnter:
integer¶
-
system.keys.leftCtrl:
integer¶
-
system.keys.rightCtrl:
integer¶
-
system.keys.leftAlt:
integer¶
-
system.keys.rightAlt:
integer¶
-
system.keys.leftShift:
integer¶
-
system.keys.rightShift:
integer¶
-
system.keys.leftSuper:
integer¶
-
system.keys.rightSuper:
integer¶
-
system.keys.capsLock:
integer¶
-
system.keys.numLock:
integer¶
-
system.keys.scrollLock:
integer¶
-
system.keys.printScreen:
integer¶
-
system.keys.pause:
integer¶
-
system.keys.stop:
integer¶
-
system.keys.ax:
integer¶
-
system.keys.up:
integer¶
-
system.keys.down:
integer¶
-
system.keys.left:
integer¶
-
system.keys.right:
integer¶
-
system.keys.pageUp:
integer¶
-
system.keys.pageDown:
integer¶
-
system.keys.home:
integer¶
-
system.keys.circumflex:
integer¶
-
system.keys.at:
integer¶
-
system.keys.colon:
integer¶
-
system.keys.underscore:
integer¶
-
system.keys.getName(id:
number): (result:string|nil)¶ Returns the name for the specified keycode.
- Parameters:
id (
number) – The keycode to check- Returns:
result (
string|nil) – The name (which is a key inkeys), ornilif the code is invalid
-
system.keys.getCharacter(id:
number): (result:string|nil)¶ Returns a printable representation of the keycode if available.
- Parameters:
id (
number) – The keycode to check- Returns:
result (
string|nil) – The keycode’s character (in lowercase), ornilif the code doesn’t have a printable representation