summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptNode.xml
blob: d080d9eac1caf2afcd7c38ce6e3a0d848bf72fea (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptNode" inherits="Resource" version="4.0">
	<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>
	<methods>
		<method name="get_default_input_value" qualifiers="const">
			<return type="Variant" />
			<argument index="0" name="port_idx" type="int" />
			<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" />
			<description>
				Returns the [VisualScript] instance the node is bound to.
			</description>
		</method>
		<method name="ports_changed_notify">
			<return type="void" />
			<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" />
			<argument index="0" name="port_idx" type="int" />
			<argument index="1" name="value" type="Variant" />
			<description>
				Change the default value of a given port.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="ports_changed">
			<description>
				Emitted when the available input/output ports are changed.
			</description>
		</signal>
	</signals>
</class>