AstralTransRocketries/OpenComputers
1
0
Fork 0
mirror of https://github.com/MightyPirates/OpenComputers.git synced 2025-09-13 09:18:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

Created API/Keyboard (markdown)

Florian Nücke 2013-12-04 14:45:00 -08:00
parent 42867f174b
commit c6e9d8f9ed
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
API-Keyboard.md Normal file

@ -0,0 +1,18 @@
This API allows you to refer to key codes by name, using the `keyboard.keys` table. This is a two-directional table, for example, the value of `keyboard.keys.numpad0` is `0x52`, and the value of `keyboard.keys[0x52]` is the string `numpad0`.
Please see [the Lua file containing the API's implementation](keyboard) for the list of available names.
Additionally it registers event listeners to keep track of the state of individual keys. This internal state can be queried using the following functions:
- `keyboard.isAltDown(): boolean`
Checks if one of the Alt keys is currently being held by some user.
- `keyboard.isControl(char: number): boolean`
Checks if the specified character (from a keyboard event for example) is a control character as defined by Java's `Character` class. Control characters are usually not printable.
- `keyboard.isControlDown(): boolean`
Checks if one of the Control keys is currently being held by some user.
- `keyboard.isKeyDown(charOrCode: any): boolean`
Checks if a specific key is currently being by some user. If a number is specified it is assumed it's a key code. If a string is specified it is assumed it's a single character, such as the ones passed by keyboard events.
- `keyboard.isShiftDown(): boolean`
Checks if one of the Shift keys is currently being held by some user.
[keyboard]: https://github.com/MightyPirates/OpenComputers/assets/opencomputers/lua/rom/lib/keyboard.lua