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

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptYield" inherits="VisualScriptNode" version="3.5" 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>
	<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.
		</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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation 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. 2022-03-16 23:01:02 +01:00			`<class name="VisualScriptYield" inherits="VisualScriptNode" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`A Visual Script node used to pause a function execution.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`[VisualScriptYield] will pause the function call and return [VisualScriptFunctionState], which can be used to resume the function.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="mode" type="int" setter="set_yield_mode" getter="get_yield_mode" enum="VisualScriptYield.YieldMode" default="1">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`The mode to use for yielding. See [enum YieldMode] for available options.`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
doc: Remove null default values that can't be determined Applying #30187. 2019-06-29 21:22:15 +02:00			`<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`The time to wait when [member mode] is set to [constant YIELD_WAIT].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="YIELD_FRAME" value="1" enum="YieldMode">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`Yields during an idle frame.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="YIELD_PHYSICS_FRAME" value="2" enum="YieldMode">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`Yields during a physics frame.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="YIELD_WAIT" value="3" enum="YieldMode">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`Yields a function and waits the given time.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constant>`
			`</constants>`
			`</class>`