d516aab8fa
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
38 lines
1.1 KiB
XML
38 lines
1.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Mutex" inherits="Reference" category="Core" version="3.0-stable">
|
|
<brief_description>
|
|
A synchronization Mutex.
|
|
</brief_description>
|
|
<description>
|
|
A synchronization Mutex. Element used to synchronize multiple [Thread]s. Basically a binary [Semaphore]. Guarantees that only one thread can ever acquire this lock at a time. Can be used to protect a critical section. Be careful to avoid deadlocks.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="lock">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Lock this [code]Mutex[/code], blocks until it is unlocked by the current owner.
|
|
</description>
|
|
</method>
|
|
<method name="try_lock">
|
|
<return type="int" enum="Error">
|
|
</return>
|
|
<description>
|
|
Try locking this [code]Mutex[/code], does not block. Returns [OK] on success, [ERR_BUSY] otherwise.
|
|
</description>
|
|
</method>
|
|
<method name="unlock">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Unlock this [code]Mutex[/code], leaving it to other threads.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|