b68dd2e189
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
31 lines
1.3 KiB
XML
31 lines
1.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="VisualScriptYield" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
|
<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>
|
|
<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.
|
|
</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>
|
|
<constant name="YIELD_FRAME" value="1" enum="YieldMode">
|
|
Yields during an idle frame.
|
|
</constant>
|
|
<constant name="YIELD_PHYSICS_FRAME" value="2" enum="YieldMode">
|
|
Yields during a physics frame.
|
|
</constant>
|
|
<constant name="YIELD_WAIT" value="3" enum="YieldMode">
|
|
Yields a function and waits the given time.
|
|
</constant>
|
|
</constants>
|
|
</class>
|