GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity

Docs: basalt.isKeyDown

Browse Source
This commit is contained in:
Erb3
2022-09-12 21:07:31 +02:00
parent 651690d8ab
commit bf9f01aae7
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/objects/Basalt/isKeyDown.md
View File

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