summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptVariableSet.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2017-11-15 21:54:21 +0100
committerGitHub <noreply@github.com>2017-11-15 21:54:21 +0100
commitc7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738 (patch)
treea22a88d22bd079a8404150fbf5b870df6046240e /modules/visual_script/doc_classes/VisualScriptVariableSet.xml
parent4d08e7c4204ff3fa0e17e0de7e5a08ef03968202 (diff)
parent11e07d18bd80c0b7d8836698d98e058750e33660 (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/VisualScriptVariableSet.xml')
-rw-r--r--modules/visual_script/doc_classes/VisualScriptVariableSet.xml41
1 files changed, 41 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptVariableSet.xml b/modules/visual_script/doc_classes/VisualScriptVariableSet.xml
new file mode 100644
index 0000000000..fa3befa21d
--- /dev/null
+++ b/modules/visual_script/doc_classes/VisualScriptVariableSet.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualScriptVariableSet" inherits="VisualScriptNode" category="Core" version="3.0-alpha">
+ <brief_description>
+ Changes a variable's value.
+ </brief_description>
+ <description>
+ Changes a variable's value to the given input.
+ [b]Input Ports:[/b]
+ - Sequence
+ - Data (variant): [code]set[/code]
+ [b]Output Ports:[/b]
+ - Sequence
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_variable" qualifiers="const">
+ <return type="String">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="set_variable">
+ <return type="void">
+ </return>
+ <argument index="0" name="name" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="var_name" type="String" setter="set_variable" getter="get_variable">
+ The variable's name.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>