class_visualscriptlocalvarset.rst 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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 VisualScriptLocalVarSet.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptLocalVarSet:
  6. VisualScriptLocalVarSet
  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. Changes a local variable's value.
  13. Properties
  14. ----------
  15. +-----------------------------------------------------+------------------------------------------------------------------+
  16. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptLocalVarSet_property_type>` |
  17. +-----------------------------------------------------+------------------------------------------------------------------+
  18. | :ref:`String<class_String>` | :ref:`var_name<class_VisualScriptLocalVarSet_property_var_name>` |
  19. +-----------------------------------------------------+------------------------------------------------------------------+
  20. Description
  21. -----------
  22. Changes a local variable's value to the given input. The new value is also provided on an output Data port.
  23. **Input Ports:**
  24. - Sequence
  25. - Data (variant): ``set``
  26. **Output Ports:**
  27. - Sequence
  28. - Data (variant): ``get``
  29. Property Descriptions
  30. ---------------------
  31. .. _class_VisualScriptLocalVarSet_property_type:
  32. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type**
  33. +----------+---------------------+
  34. | *Setter* | set_var_type(value) |
  35. +----------+---------------------+
  36. | *Getter* | get_var_type() |
  37. +----------+---------------------+
  38. The local variable's type.
  39. ----
  40. .. _class_VisualScriptLocalVarSet_property_var_name:
  41. - :ref:`String<class_String>` **var_name**
  42. +----------+---------------------+
  43. | *Setter* | set_var_name(value) |
  44. +----------+---------------------+
  45. | *Getter* | get_var_name() |
  46. +----------+---------------------+
  47. The local variable's name.