pandemonium_engine_docs/classes/class_visualscriptemitsignal.rst

56 lines
1.7 KiB
ReStructuredText
Raw Normal View History

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptEmitSignal.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualScriptEmitSignal:
VisualScriptEmitSignal
======================
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Emits a specified signal.
Description
-----------
Emits a specified signal when it is executed.
**Input Ports:**
- Sequence: ``emit``
**Output Ports:**
- Sequence
Properties
----------
+-----------------------------+-------------------------------------------------------------+--------+
| :ref:`String<class_String>` | :ref:`signal<class_VisualScriptEmitSignal_property_signal>` | ``""`` |
+-----------------------------+-------------------------------------------------------------+--------+
Property Descriptions
---------------------
.. _class_VisualScriptEmitSignal_property_signal:
- :ref:`String<class_String>` **signal**
+-----------+-------------------+
| *Default* | ``""`` |
+-----------+-------------------+
| *Setter* | set_signal(value) |
+-----------+-------------------+
| *Getter* | get_signal() |
+-----------+-------------------+
The signal to emit.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`