Docs: basalt.isKeyDown

This commit is contained in:
Erb3
2022-09-12 21:07:31 +02:00
parent 651690d8ab
commit bf9f01aae7

View File

@@ -1,14 +1,20 @@
## basalt.isKeyDown
# basalt.isKeyDown
Checks if the user is currently holding a key
#### Parameters:
1. `number` key code (use the keys table for that)
## Parameters
1. `number` key code (use the [keys table](https://tweaked.cc/module/keys.html) for that)
## Returns
#### Returns:
1. `boolean` true or false
#### Usage:
## Usage
* Shows a debug message with true or false if the left ctrl key is down, as soon as you click on the button.
```lua
local main = basalt.createFrame()
local aButton = mainFrame:addButton()
@@ -18,4 +24,4 @@ local aButton = mainFrame:addButton()
basalt.debug(basalt.isKeyDown(keys.leftCtrl))
end)
basalt.autoUpdate()
```
```