Docs 1.6
Accidentally uploaded outdated 1.6 docs
This commit is contained in:
@@ -1,65 +1,7 @@
|
||||
Threads are being executed simultaneously.
|
||||
<br>
|
||||
## Methods
|
||||
|
||||
## start
|
||||
starts a new thread and executes the function
|
||||
#### Parameters:
|
||||
1. `function` the function which should be executed
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Starts a new thread
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aThread = mainFrame:addThread()
|
||||
local function randomThreadFunction()
|
||||
while true do
|
||||
basalt.debug("Thread is active")
|
||||
os.sleep(1) -- a sleep/coroutine.yield() or pullEvent is required otherwise we will never come back to the main program (error)
|
||||
end
|
||||
end
|
||||
aThread:start(randomThreadfunction)
|
||||
```
|
||||
you are also able to start threads via xml:
|
||||
```lua
|
||||
basalt.setVariable("myThread", function() while true do os.sleep(1) end end)
|
||||
```
|
||||
```xml
|
||||
<thread thread="myThread" start="true"/>
|
||||
```
|
||||
|
||||
## stop
|
||||
stops the thread
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Stops the current running thread by clicking on a button
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aThread = mainFrame:addThread()
|
||||
local function randomThreadFunction()
|
||||
while true do
|
||||
basalt.debug("Thread is active")
|
||||
os.sleep(1) -- a sleep/coroutine.yield() or pullEvent is required otherwise we will never come back to the main program (error)
|
||||
end
|
||||
end
|
||||
aThread:start(randomThreadfunction)
|
||||
local aButton = mainFrame:addButton():setText("Stop Thread"):onClick(function() aThread:stop() end)
|
||||
```
|
||||
|
||||
## getStatus
|
||||
gets the current thread status
|
||||
|
||||
#### Returns:
|
||||
1. `string` current status - ("running", "normal", "suspended", "dead")
|
||||
|
||||
#### Usage:
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aThread = mainFrame:addThread()
|
||||
basalt.debug(aThread:getStatus())
|
||||
```
|
||||
| | |
|
||||
|---|---|
|
||||
|[start](objects/Thread/start.md)|starts a new thread and executes the function
|
||||
|[stop](objects/Thread/stop.md)|stops the currently running thread
|
||||
|[getStatus](objects/Thread/getStatus.md)|Returns the current thread status
|
||||
|
||||
Reference in New Issue
Block a user