summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptFunctionState.xml
blob: ef09c9d4a0064792c25896a9678982572c0e7a09 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptFunctionState" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<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" />
			<argument index="0" name="obj" type="Object" />
			<argument index="1" name="signals" type="String" />
			<argument index="2" name="args" type="Array" />
			<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" />
			<description>
				Returns whether the function state is valid.
			</description>
		</method>
		<method name="resume">
			<return type="Variant" />
			<argument index="0" name="args" type="Array" default="[]" />
			<description>
				Resumes the function to run from the point it was yielded.
			</description>
		</method>
	</methods>
</class>