godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/Signal.xml

116 lines
3.5 KiB
XML
Raw Normal View History

doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Signal" version="4.0">
<brief_description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Class representing a signal defined in an object.
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="Signal" qualifiers="constructor">
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 13:28:05 +00: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-09 16:46:03 +00:00
<description>
Constructs a null [Signal] with no object nor signal name bound.
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="Signal" qualifiers="constructor">
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 13:28:05 +00:00
<return type="Signal" />
<argument 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-09 16:46:03 +00:00
<description>
Constructs a [Signal] as a copy of the given [Signal].
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="Signal" qualifiers="constructor">
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 13:28:05 +00:00
<return type="Signal" />
<argument index="0" name="object" type="Object" />
<argument index="1" name="signal" type="StringName" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
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-09 16:46:03 +00:00
Creates a new [Signal] with the name [code]signal[/code] in the specified [code]object[/code].
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</description>
</method>
<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 13:28:05 +00:00
<return type="int" />
<argument index="0" name="callable" type="Callable" />
<argument index="1" name="binds" type="Array" default="[]" />
<argument index="2" name="flags" type="int" default="0" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Connects this signal to the specified [Callable], optionally providing binds and connection flags.
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00: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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="callable" type="Callable" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Disconnects this signal from the specified [Callable].
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00: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 13:28:05 +00:00
<return type="void" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Emits this signal to all connected objects.
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00: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 13:28:05 +00:00
<return type="Array" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Returns the list of [Callable]s connected to this signal.
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00: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 13:28:05 +00:00
<return type="StringName" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Returns the name of this signal.
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00: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 13:28:05 +00:00
<return type="Object" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Returns the object emitting this signal.
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00: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 13:28:05 +00:00
<return type="int" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00: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 13:59:09 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00: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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="callable" type="Callable" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Returns [code]true[/code] if the specified [Callable] is connected to this signal.
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</description>
</method>
doc: Sync classref with current source And move GLTF docs to its module folder.
2021-03-18 13:44:42 +00: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 13:28:05 +00:00
<return type="bool" />
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<description>
</description>
</method>
Allow comparing equality between builtin types and null
2021-09-17 15:22:48 +00:00
<method name="operator !=" qualifiers="operator">
<return type="bool" />
<description>
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="operator !=" qualifiers="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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Signal" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
</method>
Allow comparing equality between builtin types and null
2021-09-17 15:22:48 +00:00
<method name="operator ==" qualifiers="operator">
<return type="bool" />
<description>
</description>
</method>
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<method name="operator ==" qualifiers="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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="right" type="Signal" />
doc: Sync classref to add operators after #43419
2020-11-10 13:16:20 +00:00
<description>
</description>
</method>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
</methods>
<constants>
</constants>
</class>