Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
Inherits: RefCounted < 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.
lock ( )
try_lock ( )
unlock ( )
void lock ( )
Locks this Mutex, blocks until it is unlocked by the current owner.
Note: This function returns without blocking if the thread already has ownership of the mutex.
bool try_lock ( )
Tries locking this Mutex, but does not block. Returns
true on success,
Note: This function returns @GlobalScope.OK if the thread already has ownership of the mutex.
void unlock ( )
Unlocks this Mutex, leaving it to other threads.
Note: If a thread called lock or try_lock multiple times while already having ownership of the mutex, it must also call unlock the same number of times in order to unlock it correctly.