GDScriptFunctionState

State of a function call after yielding.

Calling @GDScript.yield within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling resume on this state object.

Members

Aliases

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

Functions

_signalCallback
Variant _signalCallback(VarArgs varArgs)
isValid
bool isValid(bool extended_check)

Check whether the function call may be resumed. This is not the case if the function state was already resumed. If extended_check is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of GDScriptFunctionState.resume, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point.

opAssign
typeof(null) opAssign(typeof(null) n)
opEquals
bool opEquals(GDScriptFunctionState other)
opEquals
bool opEquals(typeof(null) n)
resume
Variant resume(VariantArg0 arg)

Resume execution of the yielded function call. If handed an argument, return the argument from the @GDScript.yield call in the yielded function call. You can pass e.g. an Array to hand multiple arguments. This function returns what the resumed function call returns, possibly another function state if yielded again.

toHash
size_t toHash()

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Static functions

_new
GDScriptFunctionState _new()

Construct a new instance of GDScriptFunctionState. Note: use memnew!GDScriptFunctionState 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.

Meta