88 lines
3 KiB
ReStructuredText
88 lines
3 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/VisualScriptLocalVar.xml.
|
|
|
|
.. _class_VisualScriptLocalVar:
|
|
|
|
VisualScriptLocalVar
|
|
====================
|
|
|
|
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Gets a local variable's value.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Returns a local variable's value. "Var Name" must be supplied, with an optional type.
|
|
|
|
\ **Input Ports:**\
|
|
|
|
none
|
|
|
|
\ **Output Ports:**\
|
|
|
|
- Data (variant): ``get``
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------------------------------+---------------------------------------------------------------+-----------------+
|
|
| :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptLocalVar_property_type>` | ``0`` |
|
|
+-----------------------------------------------------+---------------------------------------------------------------+-----------------+
|
|
| :ref:`String<class_String>` | :ref:`var_name<class_VisualScriptLocalVar_property_var_name>` | ``"new_local"`` |
|
|
+-----------------------------------------------------+---------------------------------------------------------------+-----------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualScriptLocalVar_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_VisualScriptLocalVar_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.)`
|