class_visualscriptlocalvarset.rst 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the VisualScriptLocalVarSet.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_VisualScriptLocalVarSet:
  5. VisualScriptLocalVarSet
  6. =======================
  7. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Changes a local variable's value.
  12. Properties
  13. ----------
  14. +-----------------------------------------------------+---------------------------------------------------------+
  15. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptLocalVarSet_type>` |
  16. +-----------------------------------------------------+---------------------------------------------------------+
  17. | :ref:`String<class_String>` | :ref:`var_name<class_VisualScriptLocalVarSet_var_name>` |
  18. +-----------------------------------------------------+---------------------------------------------------------+
  19. Description
  20. -----------
  21. Changes a local variable's value to the given input. The new value is also provided on an output Data port.
  22. **Input Ports:**
  23. - Sequence
  24. - Data (variant): ``set``
  25. **Output Ports:**
  26. - Sequence
  27. - Data (variant): ``get``
  28. Property Descriptions
  29. ---------------------
  30. .. _class_VisualScriptLocalVarSet_type:
  31. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type**
  32. +----------+---------------------+
  33. | *Setter* | set_var_type(value) |
  34. +----------+---------------------+
  35. | *Getter* | get_var_type() |
  36. +----------+---------------------+
  37. The local variable's type.
  38. .. _class_VisualScriptLocalVarSet_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.