1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-05 09:36:19 +00:00
CC-Tweaked/doc/events/char.md
Jonathan Coates 895bc7721a
License CC:T according to the REUSE specification (#1351)
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/
2023-03-15 21:52:13 +00:00

864 B

module: [kind=event] char see: key To listen to any key press.

The @{char} event is fired when a character is typed on the keyboard.

The @{char} event is different to a key press. Sometimes multiple key presses may result in one character being typed (for instance, on some European keyboards). Similarly, some keys (e.g. Ctrl) do not have any corresponding character. The @{key} should be used if you want to listen to key presses themselves.

Return values

  1. @{string}: The event name.
  2. @{string}: The string representing the character that was pressed.

Example

Prints each character the user presses:

while true do
    local event, character = os.pullEvent("char")
    print(character .. " was pressed.")
end