mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-12-14 12:10:30 +00:00
25 lines
753 B
Markdown
25 lines
753 B
Markdown
|
---
|
||
|
|
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. <kbd>Ctrl</kbd>) 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:
|
||
|
|
```lua
|
||
|
|
while true do
|
||
|
|
local event, character = os.pullEvent("char")
|
||
|
|
print(character .. " was pressed.")
|
||
|
|
end
|
||
|
|
```
|