mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-12-26 18:10:29 +00:00
895bc7721a
This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/
33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
---
|
|
module: [kind=event] key
|
|
---
|
|
|
|
<!--
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: LicenseRef-CCPL
|
|
-->
|
|
|
|
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
|
|
```
|