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

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptYieldSignal" inherits="VisualScriptNode" version="3.6" 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>