Merge pull request #182 from Bottinator22/scriptablethreads

Scriptable threads

1 files changed, 66 insertions, 0 deletions

diff --git a/doc/lua/openstarbound/threads.md b/doc/lua/openstarbound/threads.md
new file mode 100644
index 0000000..4560b89
--- /dev/null
+++ b/doc/lua/openstarbound/threads.md
@@ -0,0 +1,66 @@
+
+# Threads
+
+The new threads table is accessible from every script and allows creating, communicating with, and destroying scriptable threads.
+Scriptable threads are also automatically destroyed when their parent script component is destroyed.
+
+---
+
+#### `String` threads.create(`Json` parameters)
+
+Creates a thread using the given parameters.
+Here's an example that uses all available parameters:
+```
+threads.create({
+    name="example", -- this is the thread name you'll use to index the thread
+    scripts={
+        main={"/scripts/examplethread.lua"}, -- a list of scripts for each context, similarly to how other scripts work
+        other={"/scripts/examplesecondthreadscript.lua"}, -- threads can have multiple contexts
+    },
+    instructionLimit=100000000, -- optional, threads are allowed to change their own instruction limit (as they have nothing else to block if stuck)
+    tickRate=60, -- optional, how many ticks per second the thread runs at, defaults to 60 but can be any number
+    updateMeasureWindow=0.5, -- optional, defaults to 0.5, changing this is unnecessary unless you really care about an accurate tickrate for some reason
+    someParameter="scrungus" -- parameters for the scripts, all parameters are accessible using config.getParameter in the scripts
+}),
+```
+Returns the thread's name.
+
+---
+
+#### `void` threads.setPause(`String` name, `bool` paused)
+
+Pauses or unpauses a thread.
+
+---
+
+#### `void` threads.stop(`String` name)
+
+Stops and destroys a thread.
+
+---
+
+#### `RpcPromise<Json>` threads.sendMessage(`String` threadName, `String` messageName, [`LuaValue` args...])
+
+Sends a message to the given thread. Note that the return value from this is currently the only way to get data from the thread.
+
+---
+
+Threads have simple updateable scripts with access to only a few tables.
+They include:
+ - the basic tables all scripts have access to (including `threads`)
+ - `updateablescript` bindings
+ - `message`
+ - `config`
+ - `thread`
+ 
+---
+The `thread` table has only a single function.
+
+#### `void` thread.stop()
+
+Stops the thread.
+This does not destroy the thread; the parent script still has to stop the thread itself to destroy it, so avoid using this too much as it can cause memory leaks.
+
+---
+
+