State of a function call after yielding.
    public class GDScriptFunctionState : Reference

Calling yield within a GDScript 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(object) on this state object.

Inheritance Chain

Signals

    "completed" (Nil result)

Methods

    public bool IsValid(bool extendedCheck = false)

Check whether the function call may be resumed. This is not the case if the function state was already resumed.

If extendedCheck is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of Resume(object), 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.

    public object Resume(object arg = null)

Resume execution of the yielded function call.

If handed an argument, return the argument from the 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.

Tags: