diff options
Diffstat (limited to 'doc/classes/Signal.xml')
-rw-r--r-- | doc/classes/Signal.xml | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml new file mode 100644 index 0000000000..51490caf6f --- /dev/null +++ b/doc/classes/Signal.xml @@ -0,0 +1,97 @@ +<?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"> + <return type="Signal"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <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"> + <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"> + <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"> + <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"> + <return type="bool"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> |