Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Semaphore

Inherits: RefCounted < Object

A synchronization semaphore.

Description

A synchronization semaphore which can be used to synchronize multiple Threads. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see Mutex.

Tutorials

• Using multiple threads

Methods

void	post ( )
bool	try_wait ( )
void	wait ( )

---

Method Descriptions

void post ( )

Lowers the Semaphore, allowing one more thread in.

---

bool try_wait ( )

Like wait, but won't block, so if the value is zero, fails immediately and returns false. If non-zero, it returns true to report success.

---

void wait ( )

Waits for the Semaphore, if its value is zero, blocks until non-zero.