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

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptFunctionState" inherits="Reference" version="3.4">
	<brief_description>
		A Visual Script node representing a function state.
	</brief_description>
	<description>
		[VisualScriptFunctionState] is returned from [VisualScriptYield] and can be used to resume a paused function call.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="connect_to_signal">
			<return type="void">
			</return>
			<argument index="0" name="obj" type="Object">
			</argument>
			<argument index="1" name="signals" type="String">
			</argument>
			<argument index="2" name="args" type="Array">
			</argument>
			<description>
				Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted.
			</description>
		</method>
		<method name="is_valid" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns whether the function state is valid.
			</description>
		</method>
		<method name="resume">
			<return type="Variant">
			</return>
			<argument index="0" name="args" type="Array" default="null">
			</argument>
			<description>
				Resumes the function to run from the point it was yielded.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>