mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-12-26 10:00:36 +00:00
52b78f92cd
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
1.1 KiB
1.1 KiB
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, F1 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
- [
string]: The event name. - [
number]: The numerical key value of the key pressed. - [
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.
while true do
local event, key, is_held = os.pullEvent("key")
print(("%s held=%s"):format(keys.getName(key), is_held))
end