godot/doc/classes/Signal.xml
Rémi Verschelde 4ca1e73ff9
doc: Sync classref with current source
And move GLTF docs to its module folder.
2021-03-18 16:37:43 +01:00

130 lines
3.5 KiB
XML

<?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>
<tutorials>
</tutorials>
<methods>
<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" type="StringName">
</argument>
<description>
Creates a new [Signal] with the name [code]signal[/code] in the specified [code]object[/code].
</description>
</method>
<method name="connect">
<return type="int">
</return>
<argument index="0" name="callable" type="Callable">
</argument>
<argument index="1" name="binds" type="Array" default="[ ]">
</argument>
<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">
<return type="void">
</return>
<argument index="0" name="callable" type="Callable">
</argument>
<description>
Disconnects this signal from the specified [Callable].
</description>
</method>
<method name="emit" qualifiers="vararg const">
<return type="void">
</return>
<description>
Emits this signal to all connected objects.
</description>
</method>
<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" qualifiers="const">
<return type="StringName">
</return>
<description>
Returns the name of this signal.
</description>
</method>
<method name="get_object" qualifiers="const">
<return type="Object">
</return>
<description>
Returns the object emitting this signal.
</description>
</method>
<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" qualifiers="const">
<return type="bool">
</return>
<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" 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>
</class>