diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2017-11-15 21:54:21 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-11-15 21:54:21 +0100 |
| commit | c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738 (patch) | |
| tree | a22a88d22bd079a8404150fbf5b870df6046240e /modules/visual_script/doc_classes/VisualScriptConstant.xml | |
| parent | 4d08e7c4204ff3fa0e17e0de7e5a08ef03968202 (diff) | |
| parent | 11e07d18bd80c0b7d8836698d98e058750e33660 (diff) | |
Merge pull request #12954 from akien-mga/docs
Make module docs self-contained and various improvements
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptConstant.xml')
| -rw-r--r-- | modules/visual_script/doc_classes/VisualScriptConstant.xml | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptConstant.xml b/modules/visual_script/doc_classes/VisualScriptConstant.xml new file mode 100644 index 0000000000..51c6d19238 --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptConstant.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptConstant" inherits="VisualScriptNode" category="Core" version="3.0-alpha"> + <brief_description> + Gets a contant's value. + </brief_description> + <description> + This node returns a constant's value. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_constant_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="get_constant_value" qualifiers="const"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="set_constant_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + <method name="set_constant_value"> + <return type="void"> + </return> + <argument index="0" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="type" type="int" setter="set_constant_type" getter="get_constant_type" enum="Variant.Type"> + The constant's type. + </member> + <member name="value" type="Variant" setter="set_constant_value" getter="get_constant_value"> + The constant's value. + </member> + </members> + <constants> + </constants> +</class> |