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/VisualScriptClassConstant.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/VisualScriptClassConstant.xml')
| -rw-r--r-- | modules/visual_script/doc_classes/VisualScriptClassConstant.xml | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptClassConstant.xml b/modules/visual_script/doc_classes/VisualScriptClassConstant.xml new file mode 100644 index 0000000000..e6498e92ad --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptClassConstant.xml @@ -0,0 +1,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> |