diff options
Diffstat (limited to 'doc/classes/Signal.xml')
| -rw-r--r-- | doc/classes/Signal.xml | 54 |
1 files changed, 43 insertions, 11 deletions
diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml index 1a05c02b60..84efc974c0 100644 --- a/doc/classes/Signal.xml +++ b/doc/classes/Signal.xml @@ -8,15 +8,31 @@ <tutorials> </tutorials> <methods> - <method name="Signal"> + <method name="Signal" qualifiers="constructor"> + <return type="Signal"> + </return> + <description> + Constructs a null [Signal] with no object nor signal name bound. + </description> + </method> + <method name="Signal" qualifiers="constructor"> + <return type="Signal"> + </return> + <argument index="0" name="from" type="Signal"> + </argument> + <description> + Constructs a [Signal] as a copy of the given [Signal]. + </description> + </method> + <method name="Signal" qualifiers="constructor"> <return type="Signal"> </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="signal_name" type="StringName"> + <argument index="1" name="signal" type="StringName"> </argument> <description> - Creates a new signal named [code]signal_name[/code] in the given object. + Creates a new [Signal] with the name [code]signal[/code] in the specified [code]object[/code]. </description> </method> <method name="connect"> @@ -33,7 +49,7 @@ </description> </method> <method name="disconnect"> - <return type="Variant"> + <return type="void"> </return> <argument index="0" name="callable" type="Callable"> </argument> @@ -41,42 +57,42 @@ Disconnects this signal from the specified [Callable]. </description> </method> - <method name="emit" qualifiers="vararg"> + <method name="emit" qualifiers="vararg const"> <return type="void"> </return> <description> Emits this signal to all connected objects. </description> </method> - <method name="get_connections"> + <method name="get_connections" qualifiers="const"> <return type="Array"> </return> <description> Returns the list of [Callable]s connected to this signal. </description> </method> - <method name="get_name"> + <method name="get_name" qualifiers="const"> <return type="StringName"> </return> <description> Returns the name of this signal. </description> </method> - <method name="get_object"> + <method name="get_object" qualifiers="const"> <return type="Object"> </return> <description> Returns the object emitting this signal. </description> </method> - <method name="get_object_id"> + <method name="get_object_id" qualifiers="const"> <return type="int"> </return> <description> Returns the ID of the object emitting this signal (see [method Object.get_instance_id]). </description> </method> - <method name="is_connected"> + <method name="is_connected" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="callable" type="Callable"> @@ -85,12 +101,28 @@ Returns [code]true[/code] if the specified [Callable] is connected to this signal. </description> </method> - <method name="is_null"> + <method name="is_null" qualifiers="const"> <return type="bool"> </return> <description> </description> </method> + <method name="operator !=" qualifiers="operator"> + <return type="bool"> + </return> + <argument index="0" name="right" type="Signal"> + </argument> + <description> + </description> + </method> + <method name="operator ==" qualifiers="operator"> + <return type="bool"> + </return> + <argument index="0" name="right" type="Signal"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> |