From 1ebeda037589edbf36752bf418ee73b5b48c0bbb Mon Sep 17 00:00:00 2001 From: Erb3 <49862976+Erb3@users.noreply.github.com> Date: Sat, 17 Sep 2022 14:21:55 +0200 Subject: [PATCH] Docs: Clean up basalt.scheduel.md --- docs/objects/Basalt/schedule.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/objects/Basalt/schedule.md b/docs/objects/Basalt/schedule.md index e8a995a..78b9d6e 100644 --- a/docs/objects/Basalt/schedule.md +++ b/docs/objects/Basalt/schedule.md @@ -1,14 +1,20 @@ -## basalt.schedule -Schedules a function which gets called in a coroutine. After the coroutine is finished it will get destroyed immediatly. It's something like threads, but with some limits. +# basalt.schedule + +Schedules a function which gets called in a coroutine. After the coroutine is finished it will get destroyed immediatly. It's something like threads, but with some limits. +**A guide can be found [here](/tips/logic).** + +## Parameters -#### Parameters: 1. `function` a function which should get executed -#### Returns: +## Returns + 1. `function` it returns the function which you have to execute in order to start the coroutine -#### Usage: +## Usage + * Creates a schedule which switches the color between red and gray + ```lua local mainFrame = basalt.createFrame() local aButton = mainFrame:addButton():setText("Click me") @@ -25,4 +31,4 @@ aButton:onClick(basalt.schedule(function(self) os.sleep(0.1) self:setBackground(colors.gray) end)) -``` \ No newline at end of file +```