2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 12:40:43 +00:00
<class name= "Thread" inherits= "Reference" category= "Core" version= "3.1" >
2017-09-12 20:42:36 +00:00
<brief_description >
A unit of execution in a process.
</brief_description>
<description >
2017-10-21 10:33:50 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "get_id" qualifiers= "const" >
<return type= "String" >
</return>
<description >
2019-03-29 22:37:35 +00:00
Returns the current [Thread]s id, uniquely identifying it among all threads.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_active" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2019-03-29 22:37:35 +00:00
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].
2017-09-12 20:42:36 +00:00
</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 >
2019-03-29 22:37:35 +00:00
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.
2017-09-12 20:42:36 +00:00
Returns OK on success, or ERR_CANT_CREATE on failure.
</description>
</method>
<method name= "wait_to_finish" >
<return type= "Variant" >
</return>
<description >
2019-03-29 22:37:35 +00:00
Joins the [Thread] and waits for it to finish. Returns what the method called returned.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "PRIORITY_LOW" value= "0" enum= "Priority" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PRIORITY_NORMAL" value= "1" enum= "Priority" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PRIORITY_HIGH" value= "2" enum= "Priority" >
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>