mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-11-14 22:04:53 +00:00
440fca6535
We've got in touch with Brady, so can now do the last of the docs \o/! Also pick up a couple of stragglers that I'd missed from before.
31 lines
858 B
Markdown
31 lines
858 B
Markdown
---
|
|
module: [kind=event] key_up
|
|
see: keys For a lookup table of the given keys.
|
|
---
|
|
|
|
<!--
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: MPL-2.0
|
|
-->
|
|
|
|
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
|
|
```
|