summaryrefslogtreecommitdiff
path: root/doc/classes/Signal.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-11-22 21:37:05 +0100
committerRémi Verschelde <rverschelde@gmail.com>2022-11-22 21:37:05 +0100
commitad20007970767106c7812391ae2d8cc3eac9f736 (patch)
tree7204aa3ed5d7f2fcb14e274c6935aa87fdbb4e23 /doc/classes/Signal.xml
parent95a4906bb4dcffdb29598852feeddcdf69246811 (diff)
parenta23f6d0aa649d15a7b7453143d3247e4e02706b1 (diff)
Merge pull request #68948 from KoBeWi/eeny_meeny_miny_moe
Fill random docs
Diffstat (limited to 'doc/classes/Signal.xml')
-rw-r--r--doc/classes/Signal.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml
index d99477ee95..3c98a0a0e1 100644
--- a/doc/classes/Signal.xml
+++ b/doc/classes/Signal.xml
@@ -4,6 +4,8 @@
Class representing a signal defined in an object.
</brief_description>
<description>
+ Signals can be connected to [Callable]s and emitted. When a signal is emitted, all connected callables are called.
+ Usually signals are accessed as properties of objects, but it's also possible to assign them to variables and pass them around, allowing for more dynamic connections.
</description>
<tutorials>
<link title="Using Signals">$DOCS_URL/getting_started/step_by_step/signals.html</link>
@@ -95,6 +97,7 @@
<method name="is_null" qualifiers="const">
<return type="bool" />
<description>
+ Returns [code]true[/code] if either object or signal name are not valid.
</description>
</method>
</methods>
@@ -103,12 +106,14 @@
<return type="bool" />
<param index="0" name="right" type="Signal" />
<description>
+ Returns [code]true[/code] if two signals are not equal.
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
<param index="0" name="right" type="Signal" />
<description>
+ Returns [code]true[/code] if two signals are equal, i.e. their object and name are the same.
</description>
</operator>
</operators>