godot/doc/classes/Signal.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Signal" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Class representing a signal defined in an object.
	</brief_description>
	<description>
	</description>
	<tutorials>
		<link title="Using Signals">$DOCS_URL/getting_started/step_by_step/signals.html</link>
		<link title="GDScript Basics">$DOCS_URL/tutorials/scripting/gdscript/gdscript_basics.html#signals</link>
	</tutorials>
	<constructors>
		<constructor name="Signal">
			<return type="Signal" />
			<description>
				Constructs a null [Signal] with no object nor signal name bound.
			</description>
		</constructor>
		<constructor name="Signal">
			<return type="Signal" />
			<param index="0" name="from" type="Signal" />
			<description>
				Constructs a [Signal] as a copy of the given [Signal].
			</description>
		</constructor>
		<constructor name="Signal">
			<return type="Signal" />
			<param index="0" name="object" type="Object" />
			<param index="1" name="signal" type="StringName" />
			<description>
				Creates a new [Signal] with the name [param signal] in the specified [param object].
			</description>
		</constructor>
	</constructors>
	<methods>
		<method name="connect">
			<return type="int" />
			<param index="0" name="callable" type="Callable" />
			<param index="1" name="flags" type="int" default="0" />
			<description>
				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]
			</description>
		</method>
		<method name="disconnect">
			<return type="void" />
			<param index="0" name="callable" type="Callable" />
			<description>
				Disconnects this signal from the specified [Callable].
			</description>
		</method>
		<method name="emit" qualifiers="vararg const">
			<return type="void" />
			<description>
				Emits this signal to all connected objects.
			</description>
		</method>
		<method name="get_connections" qualifiers="const">
			<return type="Array" />
			<description>
				Returns the list of [Callable]s connected to this signal.
			</description>
		</method>
		<method name="get_name" qualifiers="const">
			<return type="StringName" />
			<description>
				Returns the name of this signal.
			</description>
		</method>
		<method name="get_object" qualifiers="const">
			<return type="Object" />
			<description>
				Returns the object emitting this signal.
			</description>
		</method>
		<method name="get_object_id" qualifiers="const">
			<return type="int" />
			<description>
				Returns the ID of the object emitting this signal (see [method Object.get_instance_id]).
			</description>
		</method>
		<method name="is_connected" qualifiers="const">
			<return type="bool" />
			<param index="0" name="callable" type="Callable" />
			<description>
				Returns [code]true[/code] if the specified [Callable] is connected to this signal.
			</description>
		</method>
		<method name="is_null" qualifiers="const">
			<return type="bool" />
			<description>
			</description>
		</method>
	</methods>
	<operators>
		<operator name="operator !=">
			<return type="bool" />
			<param index="0" name="right" type="Signal" />
			<description>
			</description>
		</operator>
		<operator name="operator ==">
			<return type="bool" />
			<param index="0" name="right" type="Signal" />
			<description>
			</description>
		</operator>
	</operators>
</class>
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 21:18:53 +08:00			`<class name="Signal" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<brief_description>`
Add LOTS of missing docs 2020-03-04 02:21:21 +08:00			`Class representing a signal defined in an object.`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</brief_description>`
			`<description>`
			`</description>`
			`<tutorials>`
Add tutorial links to Signal's documentation 2022-04-08 22:25:45 +08:00			`<link title="Using Signals">$DOCS_URL/getting_started/step_by_step/signals.html</link>`
			`<link title="GDScript Basics">$DOCS_URL/tutorials/scripting/gdscript/gdscript_basics.html#signals</link>`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</tutorials>`
Move the docs for constructors and operators out of methods section 2021-09-21 10:49:02 +08:00			`<constructors>`
			`<constructor name="Signal">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="Signal" />`
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors. 2020-11-10 00:46:03 +08:00			`<description>`
			`Constructs a null [Signal] with no object nor signal name bound.`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 10:49:02 +08:00			`</constructor>`
			`<constructor name="Signal">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="Signal" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="from" type="Signal" />`
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors. 2020-11-10 00:46:03 +08:00			`<description>`
			`Constructs a [Signal] as a copy of the given [Signal].`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 10:49:02 +08:00			`</constructor>`
			`<constructor name="Signal">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="Signal" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="object" type="Object" />`
			`<param index="1" name="signal" type="StringName" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
[doc] Use "param" instead of "code" to refer to parameters #3 2022-08-10 10:00:19 +08:00			`Creates a new [Signal] with the name [param signal] in the specified [param object].`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 10:49:02 +08:00			`</constructor>`
			`</constructors>`
			`<methods>`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<method name="connect">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="int" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="callable" type="Callable" />`
			`<param index="1" name="flags" type="int" default="0" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
Remove binds from Signal.connect 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]`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</description>`
			`</method>`
			`<method name="disconnect">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="callable" type="Callable" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
Add LOTS of missing docs 2020-03-04 02:21:21 +08:00			`Disconnects this signal from the specified [Callable].`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source And move GLTF docs to its module folder. 2021-03-18 21:44:42 +08:00			`<method name="emit" qualifiers="vararg const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
Add LOTS of missing docs 2020-03-04 02:21:21 +08:00			`Emits this signal to all connected objects.`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source And move GLTF docs to its module folder. 2021-03-18 21:44:42 +08:00			`<method name="get_connections" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="Array" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
Add LOTS of missing docs 2020-03-04 02:21:21 +08:00			`Returns the list of [Callable]s connected to this signal.`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source And move GLTF docs to its module folder. 2021-03-18 21:44:42 +08:00			`<method name="get_name" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="StringName" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
Add LOTS of missing docs 2020-03-04 02:21:21 +08:00			`Returns the name of this signal.`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source And move GLTF docs to its module folder. 2021-03-18 21:44:42 +08:00			`<method name="get_object" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="Object" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
Add LOTS of missing docs 2020-03-04 02:21:21 +08:00			`Returns the object emitting this signal.`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source And move GLTF docs to its module folder. 2021-03-18 21:44:42 +08:00			`<method name="get_object_id" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="int" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
Add LOTS of missing docs 2020-03-04 02:21:21 +08:00			`Returns the ID of the object emitting this signal (see [method Object.get_instance_id]).`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source And move GLTF docs to its module folder. 2021-03-18 21:44:42 +08:00			`<method name="is_connected" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="callable" type="Callable" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
Add LOTS of missing docs 2020-03-04 02:21:21 +08:00			`Returns [code]true[/code] if the specified [Callable] is connected to this signal.`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source And move GLTF docs to its module folder. 2021-03-18 21:44:42 +08:00			`<method name="is_null" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="bool" />`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`<description>`
			`</description>`
			`</method>`
Move the docs for constructors and operators out of methods section 2021-09-21 10:49:02 +08:00			`</methods>`
			`<operators>`
			`<operator name="operator !=">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="right" type="Signal" />`
doc: Sync classref to add operators after #43419 2020-11-10 21:16:20 +08:00			`<description>`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 10:49:02 +08:00			`</operator>`
			`<operator name="operator ==">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="right" type="Signal" />`
doc: Sync classref to add operators after #43419 2020-11-10 21:16:20 +08:00			`<description>`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 10:49:02 +08:00			`</operator>`
			`</operators>`
doc: Sync classref with StringName/Callable changes 2020-02-22 21:59:09 +08:00			`</class>`