class_visualscriptvariableget.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualScriptVariableGet.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptVariableGet:
  6. VisualScriptVariableGet
  7. =======================
  8. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Gets a variable's value.
  10. Description
  11. -----------
  12. Returns a variable's value. "Var Name" must be supplied, with an optional type.
  13. **Input Ports:**
  14. none
  15. **Output Ports:**
  16. - Data (variant): ``value``
  17. Properties
  18. ----------
  19. +-----------------------------+------------------------------------------------------------------+--------+
  20. | :ref:`String<class_String>` | :ref:`var_name<class_VisualScriptVariableGet_property_var_name>` | ``""`` |
  21. +-----------------------------+------------------------------------------------------------------+--------+
  22. Property Descriptions
  23. ---------------------
  24. .. _class_VisualScriptVariableGet_property_var_name:
  25. - :ref:`String<class_String>` **var_name**
  26. +-----------+---------------------+
  27. | *Default* | ``""`` |
  28. +-----------+---------------------+
  29. | *Setter* | set_variable(value) |
  30. +-----------+---------------------+
  31. | *Getter* | get_variable() |
  32. +-----------+---------------------+
  33. The variable's name.
  34. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  35. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  36. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`