summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptConstructor.xml
blob: 91df52e893532228858c07d28effc4838edcdd35 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptConstructor" inherits="VisualScriptNode" category="Core" version="3.0-alpha">
	<brief_description>
		A Visual Script node which calls a base type constructor.
	</brief_description>
	<description>
		A Visual Script node which calls a base type constructor. It can be used for type conversion as well.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_constructor" qualifiers="const">
			<return type="Dictionary">
			</return>
			<description>
			</description>
		</method>
		<method name="get_constructor_type" qualifiers="const">
			<return type="int" enum="Variant.Type">
			</return>
			<description>
			</description>
		</method>
		<method name="set_constructor">
			<return type="void">
			</return>
			<argument index="0" name="constructor" type="Dictionary">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_constructor_type">
			<return type="void">
			</return>
			<argument index="0" name="type" type="int" enum="Variant.Type">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="constructor" type="Dictionary" setter="set_constructor" getter="get_constructor">
			The constructor function's method info. Has roughly the following structure:
			[codeblock]
			{
				name = "string",
				args = [{
					name = "string"
					class_name = "string"
					type = TYPE_*
					hint = PROPERTY_HINT_*
					hint_string = "string"
				}]
				default_args = [] # Array of variants
				flags = METHOD_FLAG_*
				id = 0
				return = {type = TYPE_*}
			}
			[/codeblock]
		</member>
		<member name="type" type="int" setter="set_constructor_type" getter="get_constructor_type" enum="Variant.Type">
			The type to be constructed.
		</member>
	</members>
	<constants>
	</constants>
</class>