aboutsummaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml
diff options
context:
space:
mode:
authorRémi Verschelde2017-11-15 21:54:21 +0100
committerGitHub2017-11-15 21:54:21 +0100
commitc7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738 (patch)
treea22a88d22bd079a8404150fbf5b870df6046240e /modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml
parent4d08e7c4204ff3fa0e17e0de7e5a08ef03968202 (diff)
parent11e07d18bd80c0b7d8836698d98e058750e33660 (diff)
downloadgodot-c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738.tar.gz
godot-c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738.tar.zst
godot-c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738.zip
Merge pull request #12954 from akien-mga/docs
Make module docs self-contained and various improvements
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml')
-rw-r--r--modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml59
1 files changed, 59 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml b/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml
new file mode 100644
index 000000000..07b01d457
--- /dev/null
+++ b/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualScriptLocalVarSet" inherits="VisualScriptNode" category="Core" version="3.0-alpha">
+ <brief_description>
+ Changes a local variable's value.
+ </brief_description>
+ <description>
+ Changes a local variable's value to the given input. The new value is also provided on an output Data port.
+ [b]Input Ports:[/b]
+ - Sequence
+ - Data (variant): [code]set[/code]
+ [b]Output Ports:[/b]
+ - Sequence
+ - Data (variant): [code]get[/code]
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_var_name" qualifiers="const">
+ <return type="String">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_var_type" qualifiers="const">
+ <return type="int" enum="Variant.Type">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="set_var_name">
+ <return type="void">
+ </return>
+ <argument index="0" name="name" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_var_type">
+ <return type="void">
+ </return>
+ <argument index="0" name="type" type="int" enum="Variant.Type">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type">
+ The local variable's type.
+ </member>
+ <member name="var_name" type="String" setter="set_var_name" getter="get_var_name">
+ The local variable's name.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>