virtualx-engine-docs/_sources/classes/class_visualscriptlocalvarset.rst.txt
2024-10-23 09:41:33 -07:00

92 lines
3.1 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml.
.. _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.
.. rst-class:: classref-introduction-group
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``
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-----------------------------------------------------+------------------------------------------------------------------+-----------------+
| :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"`` |
+-----------------------------------------------------+------------------------------------------------------------------+-----------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualScriptLocalVarSet_property_type:
.. rst-class:: classref-property
:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type** = ``0``
.. rst-class:: classref-property-setget
- void **set_var_type** **(** :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` value **)**
- :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **get_var_type** **(** **)**
The local variable's type.
.. rst-class:: classref-item-separator
----
.. _class_VisualScriptLocalVarSet_property_var_name:
.. rst-class:: classref-property
:ref:`String<class_String>` **var_name** = ``"new_local"``
.. rst-class:: classref-property-setget
- void **set_var_name** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`