class_visualscriptlocalvarset.rst 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.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:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Changes a local variable's value.
  10. Description
  11. -----------
  12. Changes a local variable's value to the given input. The new value is also provided on an output Data port.
  13. \ **Input Ports:**\
  14. - Sequence
  15. - Data (variant): ``set``\
  16. \ **Output Ports:**\
  17. - Sequence
  18. - Data (variant): ``get``
  19. Properties
  20. ----------
  21. +-----------------------------------------------------+------------------------------------------------------------------+------------------+
  22. | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`type<class_VisualScriptLocalVarSet_property_type>` | ``0`` |
  23. +-----------------------------------------------------+------------------------------------------------------------------+------------------+
  24. | :ref:`StringName<class_StringName>` | :ref:`var_name<class_VisualScriptLocalVarSet_property_var_name>` | ``&"new_local"`` |
  25. +-----------------------------------------------------+------------------------------------------------------------------+------------------+
  26. Property Descriptions
  27. ---------------------
  28. .. _class_VisualScriptLocalVarSet_property_type:
  29. - :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **type**
  30. +-----------+---------------------+
  31. | *Default* | ``0`` |
  32. +-----------+---------------------+
  33. | *Setter* | set_var_type(value) |
  34. +-----------+---------------------+
  35. | *Getter* | get_var_type() |
  36. +-----------+---------------------+
  37. The local variable's type.
  38. ----
  39. .. _class_VisualScriptLocalVarSet_property_var_name:
  40. - :ref:`StringName<class_StringName>` **var_name**
  41. +-----------+---------------------+
  42. | *Default* | ``&"new_local"`` |
  43. +-----------+---------------------+
  44. | *Setter* | set_var_name(value) |
  45. +-----------+---------------------+
  46. | *Getter* | get_var_name() |
  47. +-----------+---------------------+
  48. The local variable's name.
  49. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  50. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  51. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  52. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  53. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  54. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`