Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: a9ccac82ea
Branches Tags
godot-docs
/
classes
/
class_visualscriptlocalvar.rst

class_visualscriptlocalvar.rst 2.0 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the VisualScriptLocalVar.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_VisualScriptLocalVar:
    6. 

  6. 

  7. VisualScriptLocalVar
    8. 

  8. ====================
    9. 

  9. 

  10. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Gets a local variable's value.
    18. 

  18. 

  19. Properties
    20. 

  20. ----------
    21. 

  21. 

  22. +-----------------------------------------------------+---------------------------------------------------------------+
    23. 

  23. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptLocalVar_property_type>`         |
    24. 

  24. +-----------------------------------------------------+---------------------------------------------------------------+
    25. 

  25. | :ref:`String<class_String>`                         | :ref:`var_name<class_VisualScriptLocalVar_property_var_name>` |
    26. 

  26. +-----------------------------------------------------+---------------------------------------------------------------+
    27. 

  27. 

  28. Description
    29. 

  29. -----------
    30. 

  30. 

  31. Returns a local variable's value. "Var Name" must be supplied, with an optional type.
    32. 

  32. 

  33. **Input Ports:**
    34. 

  34. 

  35. none
    36. 

  36. 

  37. **Output Ports:**
    38. 

  38. 

  39. - Data (variant): ``get``
    40. 

  40. 

  41. Property Descriptions
    42. 

  42. ---------------------
    43. 

  43. 

  44. .. _class_VisualScriptLocalVar_property_type:
    45. 

  45. 

  46. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type**
    47. 

  47. 

  48. +----------+---------------------+
    49. 

  49. | *Setter* | set_var_type(value) |
    50. 

  50. +----------+---------------------+
    51. 

  51. | *Getter* | get_var_type()      |
    52. 

  52. +----------+---------------------+
    53. 

  53. 

  54. The local variable's type.
    55. 

  55. 

  56. .. _class_VisualScriptLocalVar_property_var_name:
    57. 

  57. 

  58. - :ref:`String<class_String>` **var_name**
    59. 

  59. 

  60. +----------+---------------------+
    61. 

  61. | *Setter* | set_var_name(value) |
    62. 

  62. +----------+---------------------+
    63. 

  63. | *Getter* | get_var_name()      |
    64. 

  64. +----------+---------------------+
    65. 

  65. 

  66. The local variable's name.
    67. 

  67.