class_visualscriptlocalvar.rst 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualScriptLocalVar.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptLocalVar:
  6. VisualScriptLocalVar
  7. ====================
  8. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Gets a local variable's value.
  13. Properties
  14. ----------
  15. +-----------------------------------------------------+---------------------------------------------------------------+
  16. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptLocalVar_property_type>` |
  17. +-----------------------------------------------------+---------------------------------------------------------------+
  18. | :ref:`String<class_String>` | :ref:`var_name<class_VisualScriptLocalVar_property_var_name>` |
  19. +-----------------------------------------------------+---------------------------------------------------------------+
  20. Description
  21. -----------
  22. Returns a local variable's value. "Var Name" must be supplied, with an optional type.
  23. **Input Ports:**
  24. none
  25. **Output Ports:**
  26. - Data (variant): ``get``
  27. Property Descriptions
  28. ---------------------
  29. .. _class_VisualScriptLocalVar_property_type:
  30. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type**
  31. +----------+---------------------+
  32. | *Setter* | set_var_type(value) |
  33. +----------+---------------------+
  34. | *Getter* | get_var_type() |
  35. +----------+---------------------+
  36. The local variable's type.
  37. ----
  38. .. _class_VisualScriptLocalVar_property_var_name:
  39. - :ref:`String<class_String>` **var_name**
  40. +----------+---------------------+
  41. | *Setter* | set_var_name(value) |
  42. +----------+---------------------+
  43. | *Getter* | get_var_name() |
  44. +----------+---------------------+
  45. The local variable's name.