summaryrefslogtreecommitdiff
path: root/doc/classes/VisualScriptReturn.xml
blob: ad18e96230c7f98f51d74c92f807b57247468e4f (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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptReturn" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Exits a function and returns an optional value.
	</brief_description>
	<description>
		Ends the execution of a function and returns control to the calling function. Optionally, it can return a [Variant] value.
		[b]Input Ports:[/b]
		- Sequence
		- Data (variant): [code]result[/code] (optional)
		[b]Output Ports:[/b]
		none
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_return_type" qualifiers="const">
			<return type="int" enum="Variant.Type">
			</return>
			<description>
			</description>
		</method>
		<method name="is_return_value_enabled" qualifiers="const">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="set_enable_return_value">
			<return type="void">
			</return>
			<argument index="0" name="enable" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_return_type">
			<return type="void">
			</return>
			<argument index="0" name="type" type="int" enum="Variant.Type">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="return_enabled" type="bool" setter="set_enable_return_value" getter="is_return_value_enabled">
			If [code]true[/code] the [code]return[/code] input port is available.
		</member>
		<member name="return_type" type="int" setter="set_return_type" getter="get_return_type" enum="Variant.Type">
			The return value's data type.
		</member>
	</members>
	<constants>
	</constants>
</class>