godot/doc/classes/Mutex.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Mutex" inherits="Reference" category="Core" version="3.2">
	<brief_description>
		A synchronization mutex (mutual exclusion).
	</brief_description>
	<description>
		A synchronization mutex (mutual exclusion). This is used to synchronize multiple [Thread]s, and is equivalent to a binary [Semaphore]. It guarantees that only one thread can ever acquire the lock at a time. A mutex can be used to protect a critical section; however, be careful to avoid deadlocks.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="lock">
			<return type="void">
			</return>
			<description>
				Locks this [Mutex], blocks until it is unlocked by the current owner.
			</description>
		</method>
		<method name="try_lock">
			<return type="int" enum="Error">
			</return>
			<description>
				Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
			</description>
		</method>
		<method name="unlock">
			<return type="void">
			</return>
			<description>
				Unlocks this [Mutex], leaving it to other threads.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>