class_visualscriptlocalvarset.rst 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml.
  6. .. _class_VisualScriptLocalVarSet:
  7. VisualScriptLocalVarSet
  8. =======================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. Changes a local variable's value.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Changes a local variable's value to the given input. The new value is also provided on an output Data port.
  15. \ **Input Ports:**\
  16. - Sequence
  17. - Data (variant): ``set``\
  18. \ **Output Ports:**\
  19. - Sequence
  20. - Data (variant): ``get``
  21. .. rst-class:: classref-reftable-group
  22. Properties
  23. ----------
  24. .. table::
  25. :widths: auto
  26. +-----------------------------------------------------+------------------------------------------------------------------+-----------------+
  27. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptLocalVarSet_property_type>` | ``0`` |
  28. +-----------------------------------------------------+------------------------------------------------------------------+-----------------+
  29. | :ref:`String<class_String>` | :ref:`var_name<class_VisualScriptLocalVarSet_property_var_name>` | ``"new_local"`` |
  30. +-----------------------------------------------------+------------------------------------------------------------------+-----------------+
  31. .. rst-class:: classref-section-separator
  32. ----
  33. .. rst-class:: classref-descriptions-group
  34. Property Descriptions
  35. ---------------------
  36. .. _class_VisualScriptLocalVarSet_property_type:
  37. .. rst-class:: classref-property
  38. :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type** = ``0``
  39. .. rst-class:: classref-property-setget
  40. - void **set_var_type** **(** :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` value **)**
  41. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **get_var_type** **(** **)**
  42. The local variable's type.
  43. .. rst-class:: classref-item-separator
  44. ----
  45. .. _class_VisualScriptLocalVarSet_property_var_name:
  46. .. rst-class:: classref-property
  47. :ref:`String<class_String>` **var_name** = ``"new_local"``
  48. .. rst-class:: classref-property-setget
  49. - void **set_var_name** **(** :ref:`String<class_String>` value **)**
  50. - :ref:`String<class_String>` **get_var_name** **(** **)**
  51. The local variable's name.
  52. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  53. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  54. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  55. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`