class_visualscriptemitsignal.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml.
  6. .. _class_VisualScriptEmitSignal:
  7. VisualScriptEmitSignal
  8. ======================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Emits a specified signal.
  11. Description
  12. -----------
  13. Emits a specified signal when it is executed.
  14. \ **Input Ports:**\
  15. - Sequence: ``emit``\
  16. \ **Output Ports:**\
  17. - Sequence
  18. Properties
  19. ----------
  20. +-------------------------------------+-------------------------------------------------------------+---------+
  21. | :ref:`StringName<class_StringName>` | :ref:`signal<class_VisualScriptEmitSignal_property_signal>` | ``&""`` |
  22. +-------------------------------------+-------------------------------------------------------------+---------+
  23. Property Descriptions
  24. ---------------------
  25. .. _class_VisualScriptEmitSignal_property_signal:
  26. - :ref:`StringName<class_StringName>` **signal**
  27. +-----------+-------------------+
  28. | *Default* | ``&""`` |
  29. +-----------+-------------------+
  30. | *Setter* | set_signal(value) |
  31. +-----------+-------------------+
  32. | *Getter* | get_signal() |
  33. +-----------+-------------------+
  34. The signal to emit.
  35. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  36. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  37. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  38. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  39. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  40. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`