mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-06-24 22:23:21 +00:00
9ae0f4a993
Credit to @BradyFromDiscord for writing these. See #640 and #565. Co-authored-by: Brady <bradyakent@gmail.com
992 B
992 B
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=%b"):format(keys.getName(key), is_held))
end