Files
godot-docs/classes/class_visualscriptvariableget.rst
2022-02-01 16:35:13 +01:00

59 lines
2.2 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptVariableGet.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualScriptVariableGet:
VisualScriptVariableGet
=======================
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Gets a variable's value.
Description
-----------
Returns a variable's value. "Var Name" must be supplied, with an optional type.
\ **Input Ports:**\
none
\ **Output Ports:**\
- Data (variant): ``value``
Properties
----------
+-------------------------------------+------------------------------------------------------------------+---------+
| :ref:`StringName<class_StringName>` | :ref:`var_name<class_VisualScriptVariableGet_property_var_name>` | ``&""`` |
+-------------------------------------+------------------------------------------------------------------+---------+
Property Descriptions
---------------------
.. _class_VisualScriptVariableGet_property_var_name:
- :ref:`StringName<class_StringName>` **var_name**
+-----------+---------------------+
| *Default* | ``&""`` |
+-----------+---------------------+
| *Setter* | set_variable(value) |
+-----------+---------------------+
| *Getter* | get_variable() |
+-----------+---------------------+
The 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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`