summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptNode.xml
blob: f6f2867172d3b7936364ea225ab232a56db944d4 (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
59
60
61
62
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptNode" inherits="Resource" category="Core" version="3.0-alpha">
	<brief_description>
		A node which is part of a [VisualScript].
	</brief_description>
	<description>
		A node which is part of a [VisualScript]. Not to be confused with [Node], which is a part of a [SceneTree].
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_default_input_value" qualifiers="const">
			<return type="Variant">
			</return>
			<argument index="0" name="port_idx" type="int">
			</argument>
			<description>
				Returns the default value of a given port. The default value is used when nothing is connected to the port.
			</description>
		</method>
		<method name="get_visual_script" qualifiers="const">
			<return type="VisualScript">
			</return>
			<description>
				Returns the [VisualScript] instance the node is bound to.
			</description>
		</method>
		<method name="ports_changed_notify">
			<return type="void">
			</return>
			<description>
				Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] .
			</description>
		</method>
		<method name="set_default_input_value">
			<return type="void">
			</return>
			<argument index="0" name="port_idx" type="int">
			</argument>
			<argument index="1" name="value" type="Variant">
			</argument>
			<description>
				Change the default value of a given port.
			</description>
		</method>
	</methods>
	<members>
		<member name="_default_input_values" type="Array" setter="_set_default_input_values" getter="_get_default_input_values">
		</member>
	</members>
	<signals>
		<signal name="ports_changed">
			<description>
				Emitted when the available input/output ports are changed.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>