GDScriptFunctionState

Inherits: Reference < Object

Category: Core

Brief Description

State of a function call after yielding.

Methods

bool is_valid ( bool extended_check=false ) const
Variant resume ( Variant arg=null )

Signals

  • completed ( Nil result )

Description

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.

Method Descriptions

  • bool is_valid ( bool extended_check=false ) const

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.

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.