summaryrefslogtreecommitdiff
path: root/doc/classes/Signal.xml
blob: 11107c093d9ff6a10ee6b45d19143c1bf16bb269 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<?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" />
			<description>
				Constructs a null [Signal] with no object nor signal name bound.
			</description>
		</method>
		<method name="Signal" qualifiers="constructor">
			<return type="Signal" />
			<argument index="0" name="from" type="Signal" />
			<description>
				Constructs a [Signal] as a copy of the given [Signal].
			</description>
		</method>
		<method name="Signal" qualifiers="constructor">
			<return type="Signal" />
			<argument index="0" name="object" type="Object" />
			<argument index="1" name="signal" type="StringName" />
			<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" />
			<argument index="0" name="callable" type="Callable" />
			<argument index="1" name="binds" type="Array" default="[]" />
			<argument index="2" name="flags" type="int" default="0" />
			<description>
				Connects this signal to the specified [Callable], optionally providing binds and connection flags.
			</description>
		</method>
		<method name="disconnect">
			<return type="void" />
			<argument index="0" name="callable" type="Callable" />
			<description>
				Disconnects this signal from the specified [Callable].
			</description>
		</method>
		<method name="emit" qualifiers="vararg const">
			<return type="void" />
			<description>
				Emits this signal to all connected objects.
			</description>
		</method>
		<method name="get_connections" qualifiers="const">
			<return type="Array" />
			<description>
				Returns the list of [Callable]s connected to this signal.
			</description>
		</method>
		<method name="get_name" qualifiers="const">
			<return type="StringName" />
			<description>
				Returns the name of this signal.
			</description>
		</method>
		<method name="get_object" qualifiers="const">
			<return type="Object" />
			<description>
				Returns the object emitting this signal.
			</description>
		</method>
		<method name="get_object_id" qualifiers="const">
			<return type="int" />
			<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" />
			<argument index="0" name="callable" type="Callable" />
			<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" />
			<description>
			</description>
		</method>
		<method name="operator !=" qualifiers="operator">
			<return type="bool" />
			<description>
			</description>
		</method>
		<method name="operator !=" qualifiers="operator">
			<return type="bool" />
			<argument index="0" name="right" type="Signal" />
			<description>
			</description>
		</method>
		<method name="operator ==" qualifiers="operator">
			<return type="bool" />
			<description>
			</description>
		</method>
		<method name="operator ==" qualifiers="operator">
			<return type="bool" />
			<argument index="0" name="right" type="Signal" />
			<description>
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>