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

Docs: Clean up basalt.scheduel.md

Browse Source
This commit is contained in:
Erb3
2022-09-17 14:21:55 +02:00
parent 9a514e6f7c
commit 1ebeda0375
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/schedule.md
View File

@@ -1,14 +1,20 @@
## basalt.schedule # 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.
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 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 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 * Creates a schedule which switches the color between red and gray
```lua ```lua
local mainFrame = basalt.createFrame() local mainFrame = basalt.createFrame()
local aButton = mainFrame:addButton():setText("Click me") local aButton = mainFrame:addButton():setText("Click me")
@@ -25,4 +31,4 @@ aButton:onClick(basalt.schedule(function(self)
os.sleep(0.1) os.sleep(0.1)
self:setBackground(colors.gray) self:setBackground(colors.gray)
end)) end))
``` ```