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

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptYieldSignal" 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 yielding for a signal.
	</brief_description>
	<description>
		[VisualScriptYieldSignal] will pause the function execution until the provided signal is emitted.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
			The base type to be used when [member call_mode] is set to [constant CALL_MODE_INSTANCE].
		</member>
		<member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptYieldSignal.CallMode" default="0">
			[code]call_mode[/code] determines the target object to wait for the signal emission. See [enum CallMode] for options.
		</member>
		<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
			The node path to use when [member call_mode] is set to [constant CALL_MODE_NODE_PATH].
		</member>
		<member name="signal" type="String" setter="set_signal" getter="get_signal" default="&quot;&quot;">
			The signal name to be waited for.
		</member>
	</members>
	<constants>
		<constant name="CALL_MODE_SELF" value="0" enum="CallMode">
			A signal from this [Object] will be used.
		</constant>
		<constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode">
			A signal from the given [Node] in the scene tree will be used.
		</constant>
		<constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode">
			A signal from an instanced node with the given type will be used.
		</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="VisualScriptYieldSignal" 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 yielding for a signal.`
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			`[VisualScriptYieldSignal] will pause the function execution until the provided signal is emitted.`
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="base_type" type="String" setter="set_base_type" getter="get_base_type" default=""Object"">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`The base type to be used when [member call_mode] is set to [constant CALL_MODE_INSTANCE].`
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>`
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="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptYieldSignal.CallMode" default="0">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`[code]call_mode[/code] determines the target object to wait for the signal emission. See [enum CallMode] for options.`
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>`
doc: Remove null default values that can't be determined Applying #30187. 2019-06-29 21:22:15 +02:00			`<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`The node path to use when [member call_mode] is set to [constant CALL_MODE_NODE_PATH].`
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>`
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="signal" type="String" setter="set_signal" getter="get_signal" default="""">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`The signal name to be waited for.`
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="CALL_MODE_SELF" value="0" enum="CallMode">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`A signal from this [Object] will be used.`
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="CALL_MODE_NODE_PATH" value="1" enum="CallMode">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`A signal from the given [Node] in the scene tree will be used.`
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="CALL_MODE_INSTANCE" value="2" enum="CallMode">`
Document remaining Visual Script classes (cherry picked from commit 105495646191f2758779256589cac1aa5c583cdc) 2020-10-12 19:37:50 +02:00			`A signal from an instanced node with the given type will be used.`
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>`