summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml
blob: f04c8621744d713129f8ffd0081ba071151c3ef9 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptCustomNodes" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		Manages custom nodes for the Visual Script editor.
	</brief_description>
	<description>
		This singleton can be used to manage (i.e., add or remove) custom nodes for the Visual Script editor.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_custom_node">
			<return type="void" />
			<argument index="0" name="name" type="String" />
			<argument index="1" name="category" type="String" />
			<argument index="2" name="script" type="Script" />
			<description>
				Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter.
			</description>
		</method>
		<method name="remove_custom_node">
			<return type="void" />
			<argument index="0" name="name" type="String" />
			<argument index="1" name="category" type="String" />
			<description>
				Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="custom_nodes_updated">
			<description>
				Emitted when a custom Visual Script node is added or removed.
			</description>
		</signal>
	</signals>
</class>