Struct Thread

A unit of execution in a process.

struct Thread ;

Can run methods on GodotObjects simultaneously. The use of synchronization via Mutex or Semaphore is advised if working with shared objects.

Methods

NameDescription
getId Returns the current Thread's ID, uniquely identifying it among all threads.
isActive Returns true if this Thread is currently active. An active Thread cannot start work on a new method but can be joined with waitToFinish.
start Starts a new Thread that runs method on object instance with userdata passed as an argument. The priority of the Thread can be changed by passing a value from the priority enum. Returns constant OK on success, or constant ERR_CANT_CREATE on failure.
waitToFinish Joins the Thread and waits for it to finish. Returns what the method called returned.

Enums

NameDescription
Constants
Priority