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¶
|
||
Enumerations¶
enum YieldMode:
YIELD_FRAME = 1 --- Yields during an idle frame.
YIELD_PHYSICS_FRAME = 2 --- Yields during a physics frame.
YIELD_WAIT = 3 --- Yields a function and waits the given time.
Property Descriptions¶
YieldMode mode
Default |
|
Setter |
set_yield_mode(value) |
Getter |
get_yield_mode() |
The mode to use for yielding. See YieldMode for available options.
float wait_time
Setter |
set_wait_time(value) |
Getter |
get_wait_time() |
The time to wait when mode is set to YIELD_WAIT.