diff options
| author | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:42:36 -0300 |
|---|---|---|
| committer | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:45:41 -0300 |
| commit | 4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch) | |
| tree | 730471182cae00f2e47c7430db441d057383d29b /doc/classes/Thread.xml | |
| parent | 175777596ec3521731665dd750fd7087793b10fc (diff) | |
| download | redot-engine-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.gz | |
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/Thread.xml')
| -rw-r--r-- | doc/classes/Thread.xml | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml new file mode 100644 index 0000000000..2156d04614 --- /dev/null +++ b/doc/classes/Thread.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Thread" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A unit of execution in a process. + </brief_description> + <description> + A unit of execution in a process. Can run methods on [Object]\ s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_id" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the current [Thread]\ s id, uniquely identifying it among all threads. + </description> + </method> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if this [Thread] is currently active. An active [Thread] cannot start work on a new method but can be joined with [method wait_to_finish]. + </description> + </method> + <method name="start"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="instance" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <argument index="2" name="userdata" type="Variant" default="null"> + </argument> + <argument index="3" name="priority" type="int" default="1"> + </argument> + <description> + Starts a new [Thread] that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the [Thread] can be changed by passing a PRIORITY_* enum. + Returns OK on success, or ERR_CANT_CREATE on failure. + </description> + </method> + <method name="wait_to_finish"> + <return type="Variant"> + </return> + <description> + Joins the [Thread] and waits for it to finish. Returns what the method called returned. + </description> + </method> + </methods> + <constants> + <constant name="PRIORITY_LOW" value="0"> + </constant> + <constant name="PRIORITY_NORMAL" value="1"> + </constant> + <constant name="PRIORITY_HIGH" value="2"> + </constant> + </constants> +</class> |