From bf9f01aae70218b8af13fcc3571ce2b27a48b2d7 Mon Sep 17 00:00:00 2001 From: Erb3 <49862976+Erb3@users.noreply.github.com> Date: Mon, 12 Sep 2022 21:07:31 +0200 Subject: [PATCH] Docs: basalt.isKeyDown --- docs/objects/Basalt/isKeyDown.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/objects/Basalt/isKeyDown.md b/docs/objects/Basalt/isKeyDown.md index cdae2a8..1cf6e7c 100644 --- a/docs/objects/Basalt/isKeyDown.md +++ b/docs/objects/Basalt/isKeyDown.md @@ -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() -``` \ No newline at end of file +```