blob: e778a6423ab3f2df09077211d73704d2f10d3e4b (
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GraphEdit" inherits="Control" category="Core" version="3.1">
<brief_description>
GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them.
</brief_description>
<description>
GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default.
It is greatly advised to enable low processor usage mode (see [method OS.set_low_processor_usage_mode]) when using GraphEdits.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="add_valid_connection_type">
<return type="void">
</return>
<argument index="0" name="from_type" type="int">
</argument>
<argument index="1" name="to_type" type="int">
</argument>
<description>
Makes possible the connection between two different slot types. The type is defined with the [method GraphNode.set_slot] method.
</description>
</method>
<method name="add_valid_left_disconnect_type">
<return type="void">
</return>
<argument index="0" name="type" type="int">
</argument>
<description>
Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type.
</description>
</method>
<method name="add_valid_right_disconnect_type">
<return type="void">
</return>
<argument index="0" name="type" type="int">
</argument>
<description>
Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type.
</description>
</method>
<method name="clear_connections">
<return type="void">
</return>
<description>
Remove all connections between nodes.
</description>
</method>
<method name="connect_node">
<return type="int" enum="Error">
</return>
<argument index="0" name="from" type="String">
</argument>
<argument index="1" name="from_port" type="int">
</argument>
<argument index="2" name="to" type="String">
</argument>
<argument index="3" name="to_port" type="int">
</argument>
<description>
Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created.
</description>
</method>
<method name="disconnect_node">
<return type="void">
</return>
<argument index="0" name="from" type="String">
</argument>
<argument index="1" name="from_port" type="int">
</argument>
<argument index="2" name="to" type="String">
</argument>
<argument index="3" name="to_port" type="int">
</argument>
<description>
Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists.
</description>
</method>
<method name="get_connection_list" qualifiers="const">
<return type="Array">
</return>
<description>
Return an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" }
</description>
</method>
<method name="get_zoom_hbox">
<return type="HBoxContainer">
</return>
<description>
</description>
</method>
<method name="is_node_connected">
<return type="bool">
</return>
<argument index="0" name="from" type="String">
</argument>
<argument index="1" name="from_port" type="int">
</argument>
<argument index="2" name="to" type="String">
</argument>
<argument index="3" name="to_port" type="int">
</argument>
<description>
Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode.
</description>
</method>
<method name="is_valid_connection_type" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="from_type" type="int">
</argument>
<argument index="1" name="to_type" type="int">
</argument>
<description>
Returns whether it's possible to connect slots of the specified types.
</description>
</method>
<method name="remove_valid_connection_type">
<return type="void">
</return>
<argument index="0" name="from_type" type="int">
</argument>
<argument index="1" name="to_type" type="int">
</argument>
<description>
Makes it not possible to connect between two different slot types. The type is defined with the [method GraphNode.set_slot] method.
</description>
</method>
<method name="remove_valid_left_disconnect_type">
<return type="void">
</return>
<argument index="0" name="type" type="int">
</argument>
<description>
Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type.
</description>
</method>
<method name="remove_valid_right_disconnect_type">
<return type="void">
</return>
<argument index="0" name="type" type="int">
</argument>
<description>
Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type.
</description>
</method>
<method name="set_connection_activity">
<return type="void">
</return>
<argument index="0" name="from" type="String">
</argument>
<argument index="1" name="from_port" type="int">
</argument>
<argument index="2" name="to" type="String">
</argument>
<argument index="3" name="to_port" type="int">
</argument>
<argument index="4" name="amount" type="float">
</argument>
<description>
</description>
</method>
<method name="set_selected">
<return type="void">
</return>
<argument index="0" name="node" type="Node">
</argument>
<description>
Sets the specified [code]node[/code] as the one selected.
</description>
</method>
</methods>
<members>
<member name="right_disconnects" type="bool" setter="set_right_disconnects" getter="is_right_disconnects_enabled">
If [code]true[/code], enables disconnection of existing connections in the GraphEdit by dragging the right end.
</member>
<member name="scroll_offset" type="Vector2" setter="set_scroll_ofs" getter="get_scroll_ofs">
The scroll offset.
</member>
<member name="snap_distance" type="int" setter="set_snap" getter="get_snap">
The snapping distance in pixels.
</member>
<member name="use_snap" type="bool" setter="set_use_snap" getter="is_using_snap">
If [code]true[/code], enables snapping.
</member>
<member name="zoom" type="float" setter="set_zoom" getter="get_zoom">
The current zoom value.
</member>
</members>
<signals>
<signal name="_begin_node_move">
<description>
Signal sent at the beginning of a GraphNode movement.
</description>
</signal>
<signal name="_end_node_move">
<description>
Signal sent at the end of a GraphNode movement.
</description>
</signal>
<signal name="connection_request">
<argument index="0" name="from" type="String">
</argument>
<argument index="1" name="from_slot" type="int">
</argument>
<argument index="2" name="to" type="String">
</argument>
<argument index="3" name="to_slot" type="int">
</argument>
<description>
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created.
</description>
</signal>
<signal name="connection_to_empty">
<argument index="0" name="from" type="String">
</argument>
<argument index="1" name="from_slot" type="int">
</argument>
<argument index="2" name="release_position" type="Vector2">
</argument>
<description>
</description>
</signal>
<signal name="delete_nodes_request">
<description>
Signal sent when a GraphNode is attempted to be removed from the GraphEdit.
</description>
</signal>
<signal name="disconnection_request">
<argument index="0" name="from" type="String">
</argument>
<argument index="1" name="from_slot" type="int">
</argument>
<argument index="2" name="to" type="String">
</argument>
<argument index="3" name="to_slot" type="int">
</argument>
<description>
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed.
</description>
</signal>
<signal name="duplicate_nodes_request">
<description>
Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit.
</description>
</signal>
<signal name="node_selected">
<argument index="0" name="node" type="Node">
</argument>
<description>
Emitted when a GraphNode is selected.
</description>
</signal>
<signal name="popup_request">
<argument index="0" name="position" type="Vector2">
</argument>
<description>
Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent.
</description>
</signal>
<signal name="scroll_offset_changed">
<argument index="0" name="ofs" type="Vector2">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
</constants>
<theme_items>
<theme_item name="activity" type="Color">
</theme_item>
<theme_item name="bezier_len_neg" type="int">
</theme_item>
<theme_item name="bezier_len_pos" type="int">
</theme_item>
<theme_item name="bg" type="StyleBox">
</theme_item>
<theme_item name="grid_major" type="Color">
</theme_item>
<theme_item name="grid_minor" type="Color">
</theme_item>
<theme_item name="minus" type="Texture">
</theme_item>
<theme_item name="more" type="Texture">
</theme_item>
<theme_item name="port_grab_distance_horizontal" type="int">
</theme_item>
<theme_item name="port_grab_distance_vertical" type="int">
</theme_item>
<theme_item name="reset" type="Texture">
</theme_item>
<theme_item name="snap" type="Texture">
</theme_item>
</theme_items>
</class>
|