Document some of the VisualScript classes.

This commit is contained in:
Bojidar Marinov
2017-09-28 13:07:20 +03:00
parent 62cb43bb8d
commit 10469c1962
16 changed files with 210 additions and 3 deletions

View File

@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptConstructor" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
<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>
@@ -40,8 +42,26 @@
</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>