blob: 6b581771e0c1b9405510226c6b4bb69c4871a0ff (
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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GraphNode" inherits="Container" category="Core" version="3.1-dev">
<brief_description>
A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types.
</brief_description>
<description>
A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="clear_all_slots">
<return type="void">
</return>
<description>
Disable all input and output slots of the GraphNode.
</description>
</method>
<method name="clear_slot">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Disable input and output slot whose index is 'idx'.
</description>
</method>
<method name="get_connection_input_color">
<return type="Color">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the color of the input connection 'idx'.
</description>
</method>
<method name="get_connection_input_count">
<return type="int">
</return>
<description>
Return the number of enabled input slots (connections) to the GraphNode.
</description>
</method>
<method name="get_connection_input_position">
<return type="Vector2">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the position of the input connection 'idx'.
</description>
</method>
<method name="get_connection_input_type">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the type of the input connection 'idx'.
</description>
</method>
<method name="get_connection_output_color">
<return type="Color">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the color of the output connection 'idx'.
</description>
</method>
<method name="get_connection_output_count">
<return type="int">
</return>
<description>
Return the number of enabled output slots (connections) of the GraphNode.
</description>
</method>
<method name="get_connection_output_position">
<return type="Vector2">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the position of the output connection 'idx'.
</description>
</method>
<method name="get_connection_output_type">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the type of the output connection 'idx'.
</description>
</method>
<method name="get_slot_color_left" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the color set to 'idx' left (input) slot.
</description>
</method>
<method name="get_slot_color_right" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the color set to 'idx' right (output) slot.
</description>
</method>
<method name="get_slot_type_left" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the (integer) type of left (input) 'idx' slot.
</description>
</method>
<method name="get_slot_type_right" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the (integer) type of right (output) 'idx' slot.
</description>
</method>
<method name="is_slot_enabled_left" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return true if left (input) slot 'idx' is enabled. False otherwise.
</description>
</method>
<method name="is_slot_enabled_right" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return true if right (output) slot 'idx' is enabled. False otherwise.
</description>
</method>
<method name="set_slot">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="enable_left" type="bool">
</argument>
<argument index="2" name="type_left" type="int">
</argument>
<argument index="3" name="color_left" type="Color">
</argument>
<argument index="4" name="enable_right" type="bool">
</argument>
<argument index="5" name="type_right" type="int">
</argument>
<argument index="6" name="color_right" type="Color">
</argument>
<argument index="7" name="custom_left" type="Texture" default="null">
</argument>
<argument index="8" name="custom_right" type="Texture" default="null">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="comment" type="bool" setter="set_comment" getter="is_comment">
</member>
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
The offset of the GraphNode, relative to the scroll offset of the [GraphEdit]. Note that you cannot use position directly, as [GraphEdit] is a [Container].
</member>
<member name="overlay" type="int" setter="set_overlay" getter="get_overlay" enum="GraphNode.Overlay">
</member>
<member name="resizable" type="bool" setter="set_resizable" getter="is_resizable">
</member>
<member name="selected" type="bool" setter="set_selected" getter="is_selected">
</member>
<member name="show_close" type="bool" setter="set_show_close_button" getter="is_close_button_visible">
</member>
<member name="title" type="String" setter="set_title" getter="get_title">
</member>
</members>
<signals>
<signal name="close_request">
<description>
Signal sent on closing the GraphNode.
</description>
</signal>
<signal name="dragged">
<argument index="0" name="from" type="Vector2">
</argument>
<argument index="1" name="to" type="Vector2">
</argument>
<description>
Signal sent when the GraphNode is dragged.
</description>
</signal>
<signal name="offset_changed">
<description>
Signal sent when the GraphNode is moved.
</description>
</signal>
<signal name="raise_request">
<description>
Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
</description>
</signal>
<signal name="resize_request">
<argument index="0" name="new_minsize" type="Vector2">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
<constant name="OVERLAY_DISABLED" value="0" enum="Overlay">
</constant>
<constant name="OVERLAY_BREAKPOINT" value="1" enum="Overlay">
</constant>
<constant name="OVERLAY_POSITION" value="2" enum="Overlay">
</constant>
</constants>
<theme_items>
<theme_item name="breakpoint" type="StyleBox">
</theme_item>
<theme_item name="close" type="Texture">
</theme_item>
<theme_item name="close_offset" type="int">
</theme_item>
<theme_item name="comment" type="StyleBox">
</theme_item>
<theme_item name="commentfocus" type="StyleBox">
</theme_item>
<theme_item name="defaultfocus" type="StyleBox">
</theme_item>
<theme_item name="defaultframe" type="StyleBox">
</theme_item>
<theme_item name="frame" type="StyleBox">
</theme_item>
<theme_item name="port" type="Texture">
</theme_item>
<theme_item name="port_offset" type="int">
</theme_item>
<theme_item name="position" type="StyleBox">
</theme_item>
<theme_item name="resizer" type="Texture">
</theme_item>
<theme_item name="selectedframe" type="StyleBox">
</theme_item>
<theme_item name="separation" type="int">
</theme_item>
<theme_item name="title_color" type="Color">
</theme_item>
<theme_item name="title_font" type="Font">
</theme_item>
<theme_item name="title_offset" type="int">
</theme_item>
</theme_items>
</class>
|