File: VisualScriptFunctionState.xml

package info (click to toggle)
godot 3.6%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 270,588 kB
  • sloc: cpp: 971,579; ansic: 617,953; xml: 80,302; asm: 17,498; cs: 14,559; python: 11,744; java: 9,681; javascript: 4,654; pascal: 1,176; sh: 896; objc: 529; makefile: 176
file content (37 lines) | stat: -rw-r--r-- 1,341 bytes parent folder | download | duplicates (2)
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
36
37
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptFunctionState" inherits="Reference" version="3.6" 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="null" />
			<description>
				Resumes the function to run from the point it was yielded.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>