virtualx-engine/modules/visual_script/doc_classes/VisualScriptYield.xml

33 lines
1.2 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2021-11-05 15:02:42 +01:00
<class name="VisualScriptYield" inherits="VisualScriptNode" version="3.5">
<brief_description>
A Visual Script node used to pause a function execution.
</brief_description>
<description>
[VisualScriptYield] will pause the function call and return [VisualScriptFunctionState], which can be used to resume the function.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="mode" type="int" setter="set_yield_mode" getter="get_yield_mode" enum="VisualScriptYield.YieldMode" default="1">
The mode to use for yielding. See [enum YieldMode] for available options.
2018-01-11 23:38:35 +01:00
</member>
<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time">
The time to wait when [member mode] is set to [constant YIELD_WAIT].
</member>
</members>
<constants>
2017-11-24 23:16:30 +01:00
<constant name="YIELD_FRAME" value="1" enum="YieldMode">
Yields during an idle frame.
</constant>
2017-11-24 23:16:30 +01:00
<constant name="YIELD_PHYSICS_FRAME" value="2" enum="YieldMode">
Yields during a physics frame.
</constant>
2017-11-24 23:16:30 +01:00
<constant name="YIELD_WAIT" value="3" enum="YieldMode">
Yields a function and waits the given time.
</constant>
</constants>
</class>