:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Signal.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Signal:

Signal
======

Class representing a signal defined in an object.

Methods
-------

+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Signal<class_Signal>`         | :ref:`Signal<class_Signal_method_Signal>` **(** :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` signal_name **)**                             |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`connect<class_Signal_method_connect>` **(** :ref:`Callable<class_Callable>` callable, :ref:`Array<class_Array>` binds=[  ], :ref:`int<class_int>` flags=0 **)** |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>`       | :ref:`disconnect<class_Signal_method_disconnect>` **(** :ref:`Callable<class_Callable>` callable **)**                                                                |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                | :ref:`emit<class_Signal_method_emit>` **(** ... **)** vararg                                                                                                          |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`           | :ref:`get_connections<class_Signal_method_get_connections>` **(** **)**                                                                                               |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | :ref:`get_name<class_Signal_method_get_name>` **(** **)**                                                                                                             |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_Object>`         | :ref:`get_object<class_Signal_method_get_object>` **(** **)**                                                                                                         |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_object_id<class_Signal_method_get_object_id>` **(** **)**                                                                                                   |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`             | :ref:`is_connected<class_Signal_method_is_connected>` **(** :ref:`Callable<class_Callable>` callable **)**                                                            |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`             | :ref:`is_null<class_Signal_method_is_null>` **(** **)**                                                                                                               |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Method Descriptions
-------------------

.. _class_Signal_method_Signal:

- :ref:`Signal<class_Signal>` **Signal** **(** :ref:`Object<class_Object>` object, :ref:`StringName<class_StringName>` signal_name **)**

Creates a new signal named ``signal_name`` in the given object.

----

.. _class_Signal_method_connect:

- :ref:`int<class_int>` **connect** **(** :ref:`Callable<class_Callable>` callable, :ref:`Array<class_Array>` binds=[  ], :ref:`int<class_int>` flags=0 **)**

Connects this signal to the specified :ref:`Callable<class_Callable>`, optionally providing binds and connection flags.

----

.. _class_Signal_method_disconnect:

- :ref:`Variant<class_Variant>` **disconnect** **(** :ref:`Callable<class_Callable>` callable **)**

Disconnects this signal from the specified :ref:`Callable<class_Callable>`.

----

.. _class_Signal_method_emit:

- void **emit** **(** ... **)** vararg

Emits this signal to all connected objects.

----

.. _class_Signal_method_get_connections:

- :ref:`Array<class_Array>` **get_connections** **(** **)**

Returns the list of :ref:`Callable<class_Callable>`\ s connected to this signal.

----

.. _class_Signal_method_get_name:

- :ref:`StringName<class_StringName>` **get_name** **(** **)**

Returns the name of this signal.

----

.. _class_Signal_method_get_object:

- :ref:`Object<class_Object>` **get_object** **(** **)**

Returns the object emitting this signal.

----

.. _class_Signal_method_get_object_id:

- :ref:`int<class_int>` **get_object_id** **(** **)**

Returns the ID of the object emitting this signal (see :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`).

----

.. _class_Signal_method_is_connected:

- :ref:`bool<class_bool>` **is_connected** **(** :ref:`Callable<class_Callable>` callable **)**

Returns ``true`` if the specified :ref:`Callable<class_Callable>` is connected to this signal.

----

.. _class_Signal_method_is_null:

- :ref:`bool<class_bool>` **is_null** **(** **)**