mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-06-16 01:59:54 +00:00
e1e7ef59c6
More importantly, `./gradlew check' actually runs the in-game tests, which makes the CI steps look a little more sensible again. Somewhat depressing that one of the longest files (15th) in CC:T is the build script.
27 lines
992 B
Markdown
27 lines
992 B
Markdown
---
|
|
module: [kind=event] key
|
|
---
|
|
|
|
This event is fired when any key is pressed while the terminal is focused.
|
|
|
|
This event returns a numerical "key code" (for instance, <kbd>F1</kbd> is 290). This value may vary between versions and
|
|
so it is recommended to use the constants in the @{keys} API rather than hard coding numeric values.
|
|
|
|
If the button pressed represented a printable character, then the @{key} event will be followed immediately by a @{char}
|
|
event. If you are consuming text input, use a @{char} event instead!
|
|
|
|
## Return values
|
|
1. [`string`]: The event name.
|
|
2. [`number`]: The numerical key value of the key pressed.
|
|
3. [`boolean`]: Whether the key event was generated while holding the key (@{true}), rather than pressing it the first time (@{false}).
|
|
|
|
## Example
|
|
Prints each key when the user presses it, and if the key is being held.
|
|
|
|
```lua
|
|
while true do
|
|
local event, key, is_held = os.pullEvent("key")
|
|
print(("%s held=%s"):format(keys.getName(key), is_held))
|
|
end
|
|
```
|