summaryrefslogtreecommitdiff
path: root/doc/classes/VisualScriptComment.xml
blob: 69126052d0fe3639e30931904e356a7e717f4c42 (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
63
64
65
66
67
68
69
70
71
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		A Visual Script node used to annotate the script.
	</brief_description>
	<description>
		A Visual Script node used to display annotations in the script, so that code may be documented.
		Comment nodes can be resized so they encompass a group of nodes.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_description" qualifiers="const">
			<return type="String">
			</return>
			<description>
			</description>
		</method>
		<method name="get_size" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
			</description>
		</method>
		<method name="get_title" qualifiers="const">
			<return type="String">
			</return>
			<description>
			</description>
		</method>
		<method name="set_description">
			<return type="void">
			</return>
			<argument index="0" name="description" type="String">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_size">
			<return type="void">
			</return>
			<argument index="0" name="size" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_title">
			<return type="void">
			</return>
			<argument index="0" name="title" type="String">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="description" type="String" setter="set_description" getter="get_description">
			The text inside the comment node.
		</member>
		<member name="size" type="Vector2" setter="set_size" getter="get_size">
			The comment node's size (in pixels).
		</member>
		<member name="title" type="String" setter="set_title" getter="get_title">
			The comment node's title.
		</member>
	</members>
	<constants>
	</constants>
</class>