mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-12-16 13:10:31 +00:00
9ae0f4a993
Credit to @BradyFromDiscord for writing these. See #640 and #565. Co-authored-by: Brady <bradyakent@gmail.com
25 lines
754 B
Markdown
25 lines
754 B
Markdown
---
|
|
module: [kind=event] key_up
|
|
see: keys For a lookup table of the given keys.
|
|
---
|
|
|
|
Fired whenever a key is released (or the terminal is closed while a key was being pressed).
|
|
|
|
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.
|
|
|
|
## Return values
|
|
1. @{string}: The event name.
|
|
2. @{number}: The numerical key value of the key pressed.
|
|
|
|
## Example
|
|
Prints each key released on the keyboard whenever a @{key_up} event is fired.
|
|
|
|
```lua
|
|
while true do
|
|
local event, key = os.pullEvent("key_up")
|
|
local name = keys.getName(key) or "unknown key"
|
|
print(name .. " was released.")
|
|
end
|
|
```
|