1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-06-24 22:23:21 +00:00
CC-Tweaked/doc/events/key.md
Jonathan Coates eb2d617ed8 Add a pre commit hook to lint code
This uses pre-commit [1] to check patches are well formed and run
several linters on them. We currently do some boring things (check files
are syntactically valid) as well as some project-specific ones:
 - Run illuaminate on the Lua files
 - Run checkstyle on Java

[1]: https://pre-commit.com/
2021-04-28 21:24:27 +01:00

987 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

  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.

while true do
  local event, key, is_held = os.pullEvent("key")
  print(("%s held=%s"):format(keys.getName(key), is_held))
end