summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptClassConstant.xml
blob: e6498e92adedd1c3d6e129f8748e88849b545fa1 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptClassConstant" inherits="VisualScriptNode" category="Core" version="3.0-alpha">
	<brief_description>
		Gets a constant from a given class.
	</brief_description>
	<description>
		This node returns a constant from a given class, such as [@GlobalScope.TYPE_INT]. See the given class' documentation for available constants.
		[b]Input Ports:[/b]
		none
		[b]Output Ports:[/b]
		- Data (variant): [code]value[/code]
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_base_type">
			<return type="String">
			</return>
			<description>
			</description>
		</method>
		<method name="get_class_constant">
			<return type="String">
			</return>
			<description>
			</description>
		</method>
		<method name="set_base_type">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_class_constant">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="base_type" type="String" setter="set_base_type" getter="get_base_type">
			The constant's parent class.
		</member>
		<member name="constant" type="String" setter="set_class_constant" getter="get_class_constant">
			The constant to return. See the given class for its available constants.
		</member>
	</members>
	<constants>
	</constants>
</class>