class_visualscriptvariableget.rst 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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:`RefCounted<class_RefCounted>` **<** :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:`StringName<class_StringName>` | :ref:`var_name<class_VisualScriptVariableGet_property_var_name>` | ``&""`` |
  21. +-------------------------------------+------------------------------------------------------------------+---------+
  22. Property Descriptions
  23. ---------------------
  24. .. _class_VisualScriptVariableGet_property_var_name:
  25. - :ref:`StringName<class_StringName>` **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.)`
  37. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  38. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  39. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`