Thread

A unit of execution in a process.

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

@GodotBaseClass

struct Thread {

enum string _GODOT_internal_name;

union __anonymous;

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

bool opEquals(Thread other);

Thread opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static Thread _new();

enum Constants;

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

String getId();

bool isActive();

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 Threads id, uniquely identifying it among all threads.
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 Thread opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Thread other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
start GodotError start(GodotObject instance, StringArg1 method, VariantArg2 userdata, long priority): 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 PRIORITY_* enum. Returns OK on success, or ERR_CANT_CREATE on failure.
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(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: 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 To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as 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.

Meta

Source

See Implementation

godot thread structs

Thread