Files
godot-docs/classes/class_visualscriptlocalvarset.rst
2017-10-21 14:03:27 +02:00

81 lines
2.9 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptLocalVarSet.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualScriptLocalVarSet:
VisualScriptLocalVarSet
=======================
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Changes a local variable's value.
Member Functions
----------------
+------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_var_name<class_VisualScriptLocalVarSet_get_var_name>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_var_type<class_VisualScriptLocalVarSet_get_var_type>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_var_name<class_VisualScriptLocalVarSet_set_var_name>` **(** :ref:`String<class_string>` name **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_var_type<class_VisualScriptLocalVarSet_set_var_type>` **(** :ref:`int<class_int>` type **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_VisualScriptLocalVarSet_type:
- :ref:`int<class_int>` **type** - The local variable's type.
.. _class_VisualScriptLocalVarSet_var_name:
- :ref:`String<class_string>` **var_name** - The local variable's name.
Description
-----------
Changes a local variable's value to the given input. The new value is also provided on an output Data port.
**Input Ports:**
- Sequence
- Data (variant): ``set``
**Output Ports:**
- Sequence
- Data (variant): ``get``
Member Function Description
---------------------------
.. _class_VisualScriptLocalVarSet_get_var_name:
- :ref:`String<class_string>` **get_var_name** **(** **)** const
.. _class_VisualScriptLocalVarSet_get_var_type:
- :ref:`int<class_int>` **get_var_type** **(** **)** const
.. _class_VisualScriptLocalVarSet_set_var_name:
- void **set_var_name** **(** :ref:`String<class_string>` name **)**
.. _class_VisualScriptLocalVarSet_set_var_type:
- void **set_var_type** **(** :ref:`int<class_int>` type **)**