blob: d1d19d91d7cb67fecae274bac6d819930d2b4aef (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Thread" inherits="Reference" category="Core" version="3.2">
<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>
<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" enum="Thread.Priority" 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" enum="Priority">
</constant>
<constant name="PRIORITY_NORMAL" value="1" enum="Priority">
</constant>
<constant name="PRIORITY_HIGH" value="2" enum="Priority">
</constant>
</constants>
</class>
|