diff options
author | RĂ©mi Verschelde <rverschelde@gmail.com> | 2020-03-13 17:02:07 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-03-13 17:02:07 +0100 |
commit | 0ed8d05314c9c1deeb6f45da3960b31aef7deed7 (patch) | |
tree | 1bf685c73ef05b90b3342869dae1785f72aa9cd5 /doc/classes/Signal.xml | |
parent | 88dd5d374fd4f9653b37b93a08df6ddac035f0ea (diff) | |
parent | e103f21a40ef157cd263b60cf0d9c5750156ec98 (diff) |
Merge pull request #36773 from KoBeWi/thats_a_lotta_docs
Add LOTS of missing docs
Diffstat (limited to 'doc/classes/Signal.xml')
-rw-r--r-- | doc/classes/Signal.xml | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml index 350ab40c0e..51490caf6f 100644 --- a/doc/classes/Signal.xml +++ b/doc/classes/Signal.xml @@ -1,6 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Signal" version="4.0"> <brief_description> + Class representing a signal defined in an object. </brief_description> <description> </description> @@ -15,6 +16,7 @@ <argument index="1" name="signal_name" type="StringName"> </argument> <description> + Creates a new signal named [code]signal_name[/code] in the given object. </description> </method> <method name="connect"> @@ -27,6 +29,7 @@ <argument index="2" name="flags" type="int" default="0"> </argument> <description> + Connects this signal to the specified [Callable], optionally providing binds and connection flags. </description> </method> <method name="disconnect"> @@ -35,36 +38,42 @@ <argument index="0" name="callable" type="Callable"> </argument> <description> + Disconnects this signal from the specified [Callable]. </description> </method> <method name="emit" qualifiers="vararg"> <return type="void"> </return> <description> + Emits this signal to all connected objects. </description> </method> <method name="get_connections"> <return type="Array"> </return> <description> + Returns the list of [Callable]s connected to this signal. </description> </method> <method name="get_name"> <return type="StringName"> </return> <description> + Returns the name of this signal. </description> </method> <method name="get_object"> <return type="Object"> </return> <description> + Returns the object emitting this signal. </description> </method> <method name="get_object_id"> <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"> @@ -73,6 +82,7 @@ <argument index="0" name="callable" type="Callable"> </argument> <description> + Returns [code]true[/code] if the specified [Callable] is connected to this signal. </description> </method> <method name="is_null"> |