virtualx-engine/modules/visual_script/doc_classes/VisualScriptLocalVar.xml
2017-11-15 21:29:33 +01:00

57 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptLocalVar" inherits="VisualScriptNode" category="Core" version="3.0-alpha">
<brief_description>
Gets a local variable's value.
</brief_description>
<description>
Returns a local variable's value. "Var Name" must be supplied, with an optional type.
[b]Input Ports:[/b]
none
[b]Output Ports:[/b]
- 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>