Files
godot-docs/classes/class_visualscriptlocalvarset.rst
2020-09-15 15:09:00 +02:00

78 lines
2.6 KiB
ReStructuredText

:github_url: hide
.. 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>`
Changes a local variable's value.
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``
Properties
----------
+-----------------------------------------------------+------------------------------------------------------------------+-----------------+
| :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptLocalVarSet_property_type>` | ``0`` |
+-----------------------------------------------------+------------------------------------------------------------------+-----------------+
| :ref:`String<class_String>` | :ref:`var_name<class_VisualScriptLocalVarSet_property_var_name>` | ``"new_local"`` |
+-----------------------------------------------------+------------------------------------------------------------------+-----------------+
Property Descriptions
---------------------
.. _class_VisualScriptLocalVarSet_property_type:
- :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type**
+-----------+---------------------+
| *Default* | ``0`` |
+-----------+---------------------+
| *Setter* | set_var_type(value) |
+-----------+---------------------+
| *Getter* | get_var_type() |
+-----------+---------------------+
The local variable's type.
----
.. _class_VisualScriptLocalVarSet_property_var_name:
- :ref:`String<class_String>` **var_name**
+-----------+---------------------+
| *Default* | ``"new_local"`` |
+-----------+---------------------+
| *Setter* | set_var_name(value) |
+-----------+---------------------+
| *Getter* | get_var_name() |
+-----------+---------------------+
The local variable's name.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`