Thread

A unit of execution in a process.

Can run methods on GodotObjects simultaneously. The use of synchronization via Mutex or Semaphore is advised if working with shared objects. Note: Breakpoints won't break on code if it's running in a thread. This is a current limitation of the GDScript debugger.

@GodotBaseClass

struct Thread {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(Thread other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static Thread _new();

GodotError start(GodotObject instance, String method, VariantArg2 userdata, long priority);

Variant waitToFinish();

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
Priority enum Priority

Functions

getId String getId(): Returns the current Thread's ID, uniquely identifying it among all threads. If the Thread is not running this returns an empty string.
isActive bool 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.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(Thread other)
opEquals bool opEquals(typeof(null) n)
start GodotError start(GodotObject instance, String method, VariantArg2 userdata, long priority): Starts a new Thread that runs method on object instance with userdata passed as an argument. Even if no userdata is passed, method must accept one argument and it will be null. 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.
toHash size_t toHash()
waitToFinish Variant waitToFinish(): Joins the Thread and waits for it to finish. Returns what the method called returned.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new Thread _new(): Construct a new instance of Thread. Note: use memnew!Thread instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Thread

Members

Aliases

Enums

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

Thread

From mixin baseCasts

From `mixin baseCasts`