/Godot 3.2


Inherits: Reference < Object

A synchronization mutex (mutual exclusion).


A synchronization mutex (mutual exclusion). This is used to synchronize multiple Threads, 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.



void lock ( )
Error try_lock ( )
void unlock ( )

Method Descriptions

void lock ( )

Locks this Mutex, blocks until it is unlocked by the current owner.

Error try_lock ( )

Tries locking this Mutex, but does not block. Returns @GlobalScope.OK on success, @GlobalScope.ERR_BUSY otherwise.

void unlock ( )

Unlocks this Mutex, leaving it to other threads.

© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.