VisualScriptYield

Inherits: VisualScriptNode < Resource < Reference < Object

A Visual Script node used to pause a function execution.

Description

VisualScriptYield will pause the function call and return VisualScriptFunctionState, which can be used to resume the function.

Properties

YieldMode

mode

1

float

wait_time


Enumerations

enum YieldMode:

YieldMode YIELD_FRAME = 1

Yields during an idle frame.

YieldMode YIELD_PHYSICS_FRAME = 2

Yields during a physics frame.

YieldMode YIELD_WAIT = 3

Yields a function and waits the given time.


Property Descriptions

YieldMode mode = 1

The mode to use for yielding. See YieldMode for available options.


float wait_time

  • void set_wait_time ( float value )

  • float get_wait_time ( )

The time to wait when mode is set to YIELD_WAIT.