2020-02-22 21:59:09 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "Signal" version= "4.0" >
<brief_description >
2020-03-04 02:21:21 +08:00
Class representing a signal defined in an object.
2020-02-22 21:59:09 +08:00
</brief_description>
<description >
</description>
<tutorials >
</tutorials>
<methods >
2020-11-10 21:16:20 +08:00
<method name= "Signal" qualifiers= "constructor" >
2021-07-30 21:28:05 +08:00
<return type= "Signal" />
2020-11-10 00:46:03 +08:00
<description >
Constructs a null [Signal] with no object nor signal name bound.
</description>
</method>
2020-11-10 21:16:20 +08:00
<method name= "Signal" qualifiers= "constructor" >
2021-07-30 21:28:05 +08:00
<return type= "Signal" />
<argument index= "0" name= "from" type= "Signal" />
2020-11-10 00:46:03 +08:00
<description >
Constructs a [Signal] as a copy of the given [Signal].
</description>
</method>
2020-11-10 21:16:20 +08:00
<method name= "Signal" qualifiers= "constructor" >
2021-07-30 21:28:05 +08:00
<return type= "Signal" />
<argument index= "0" name= "object" type= "Object" />
<argument index= "1" name= "signal" type= "StringName" />
2020-02-22 21:59:09 +08:00
<description >
2020-11-10 00:46:03 +08:00
Creates a new [Signal] with the name [code]signal[/code] in the specified [code]object[/code].
2020-02-22 21:59:09 +08:00
</description>
</method>
<method name= "connect" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
<argument index= "0" name= "callable" type= "Callable" />
2021-09-20 00:55:23 +08:00
<argument index= "1" name= "flags" type= "int" default= "0" />
2020-02-22 21:59:09 +08:00
<description >
2021-09-20 00:55:23 +08:00
Connects this signal to the specified [Callable], optionally providing connection flags. You can provide additional arguments to the connected method call by using [method Callable.bind].
[codeblock]
for button in $Buttons.get_children():
button.pressed.connect(on_pressed.bind(button))
func on_pressed(button):
print(button.name, " was pressed")
[/codeblock]
2020-02-22 21:59:09 +08:00
</description>
</method>
<method name= "disconnect" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "callable" type= "Callable" />
2020-02-22 21:59:09 +08:00
<description >
2020-03-04 02:21:21 +08:00
Disconnects this signal from the specified [Callable].
2020-02-22 21:59:09 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "emit" qualifiers= "vararg const" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2020-02-22 21:59:09 +08:00
<description >
2020-03-04 02:21:21 +08:00
Emits this signal to all connected objects.
2020-02-22 21:59:09 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_connections" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Array" />
2020-02-22 21:59:09 +08:00
<description >
2020-03-04 02:21:21 +08:00
Returns the list of [Callable]s connected to this signal.
2020-02-22 21:59:09 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_name" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "StringName" />
2020-02-22 21:59:09 +08:00
<description >
2020-03-04 02:21:21 +08:00
Returns the name of this signal.
2020-02-22 21:59:09 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_object" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Object" />
2020-02-22 21:59:09 +08:00
<description >
2020-03-04 02:21:21 +08:00
Returns the object emitting this signal.
2020-02-22 21:59:09 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "get_object_id" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2020-02-22 21:59:09 +08:00
<description >
2020-03-04 02:21:21 +08:00
Returns the ID of the object emitting this signal (see [method Object.get_instance_id]).
2020-02-22 21:59:09 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "is_connected" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "callable" type= "Callable" />
2020-02-22 21:59:09 +08:00
<description >
2020-03-04 02:21:21 +08:00
Returns [code]true[/code] if the specified [Callable] is connected to this signal.
2020-02-22 21:59:09 +08:00
</description>
</method>
2021-03-18 21:44:42 +08:00
<method name= "is_null" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2020-02-22 21:59:09 +08:00
<description >
</description>
</method>
2021-09-17 23:22:48 +08:00
<method name= "operator !=" qualifiers= "operator" >
<return type= "bool" />
<description >
</description>
</method>
2020-11-10 21:16:20 +08:00
<method name= "operator !=" qualifiers= "operator" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "right" type= "Signal" />
2020-11-10 21:16:20 +08:00
<description >
</description>
</method>
2021-09-17 23:22:48 +08:00
<method name= "operator ==" qualifiers= "operator" >
<return type= "bool" />
<description >
</description>
</method>
2020-11-10 21:16:20 +08:00
<method name= "operator ==" qualifiers= "operator" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
<argument index= "0" name= "right" type= "Signal" />
2020-11-10 21:16:20 +08:00
<description >
</description>
</method>
2020-02-22 21:59:09 +08:00
</methods>
</class>
