Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
A unit of execution in a process.
Note: Breakpoints won't break on code if it's running in a thread. This is a current limitation of the GDScript debugger.
get_id ( ) const
is_alive ( ) const
is_started ( ) const
wait_to_finish ( )
Priority PRIORITY_LOW =
A thread running with lower priority than normally.
Priority PRIORITY_NORMAL =
A thread with a standard priority.
Priority PRIORITY_HIGH =
A thread running with higher priority than normally.
String get_id ( ) const
Returns the current Thread's ID, uniquely identifying it among all threads. If the Thread has not started running or if wait_to_finish has been called, this returns an empty string.
bool is_alive ( ) const
true if this Thread is currently running the provided function. This is useful for determining if wait_to_finish can be called without blocking the calling thread.
To check if a Thread is joinable, use is_started.
bool is_started ( ) const
Starts a new Thread that calls
If the method takes some arguments, you can pass them using Callable.bind.
priority of the Thread can be changed by passing a value from the Priority enum.
Variant wait_to_finish ( )
Should either be used when you want to retrieve the value returned from the method called by the Thread or before freeing the instance that contains the Thread.
To determine if this can be called without blocking the calling thread, check if is_alive is