Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 7a86ac6a30
Branches Tags
godot-docs
/
classes
/
class_graphnode.rst

class_graphnode.rst 43 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the GraphNode.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_GraphNode:
    8. 

  8. 

  9. GraphNode
    10. 

  10. =========
    11. 

  11. 

  12. **Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. A GraphNode is a container with potentially several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. A GraphNode is a container. Each GraphNode can have several input and output slots, sometimes referred to as ports, allowing connections between GraphNodes. To add a slot to GraphNode, add any :ref:`Control<class_Control>`-derived child node to it.
    20. 

  20. 

  21. After adding at least one child to GraphNode new sections will be automatically created in the Inspector called 'Slot'. When 'Slot' is expanded you will see list with index number for each slot. You can click on each of them to expand further.
    22. 

  22. 

  23. In the Inspector you can enable (show) or disable (hide) slots. By default, all slots are disabled so you may not see any slots on your GraphNode initially. You can assign a type to each slot. Only slots of the same type will be able to connect to each other. You can also assign colors to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input connections are on the left and output connections are on the right side of GraphNode. Only enabled slots are counted as connections.
    24. 

  24. 

  25. Properties
    26. 

  26. ----------
    27. 

  27. 

  28. +----------------------------------------+--------------------------------------------------------+---------------------+
    29. 

  29. | :ref:`bool<class_bool>`                | :ref:`comment<class_GraphNode_property_comment>`       | ``false``           |
    30. 

  30. +----------------------------------------+--------------------------------------------------------+---------------------+
    31. 

  31. | :ref:`Vector2<class_Vector2>`          | :ref:`offset<class_GraphNode_property_offset>`         | ``Vector2( 0, 0 )`` |
    32. 

  32. +----------------------------------------+--------------------------------------------------------+---------------------+
    33. 

  33. | :ref:`Overlay<enum_GraphNode_Overlay>` | :ref:`overlay<class_GraphNode_property_overlay>`       | ``0``               |
    34. 

  34. +----------------------------------------+--------------------------------------------------------+---------------------+
    35. 

  35. | :ref:`bool<class_bool>`                | :ref:`resizable<class_GraphNode_property_resizable>`   | ``false``           |
    36. 

  36. +----------------------------------------+--------------------------------------------------------+---------------------+
    37. 

  37. | :ref:`bool<class_bool>`                | :ref:`selected<class_GraphNode_property_selected>`     | ``false``           |
    38. 

  38. +----------------------------------------+--------------------------------------------------------+---------------------+
    39. 

  39. | :ref:`bool<class_bool>`                | :ref:`show_close<class_GraphNode_property_show_close>` | ``false``           |
    40. 

  40. +----------------------------------------+--------------------------------------------------------+---------------------+
    41. 

  41. | :ref:`String<class_String>`            | :ref:`title<class_GraphNode_property_title>`           | ``""``              |
    42. 

  42. +----------------------------------------+--------------------------------------------------------+---------------------+
    43. 

  43. 

  44. Methods
    45. 

  45. -------
    46. 

  46. 

  47. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | void                          | :ref:`clear_all_slots<class_GraphNode_method_clear_all_slots>` **(** **)**                                                                                                                                                                                                                                                                                                                                         |
    49. 

  49. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | void                          | :ref:`clear_slot<class_GraphNode_method_clear_slot>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                                                         |
    51. 

  51. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`Color<class_Color>`     | :ref:`get_connection_input_color<class_GraphNode_method_get_connection_input_color>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                         |
    53. 

  53. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | :ref:`int<class_int>`         | :ref:`get_connection_input_count<class_GraphNode_method_get_connection_input_count>` **(** **)**                                                                                                                                                                                                                                                                                                                   |
    55. 

  55. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | :ref:`Vector2<class_Vector2>` | :ref:`get_connection_input_position<class_GraphNode_method_get_connection_input_position>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                   |
    57. 

  57. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | :ref:`int<class_int>`         | :ref:`get_connection_input_type<class_GraphNode_method_get_connection_input_type>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                           |
    59. 

  59. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | :ref:`Color<class_Color>`     | :ref:`get_connection_output_color<class_GraphNode_method_get_connection_output_color>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                       |
    61. 

  61. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | :ref:`int<class_int>`         | :ref:`get_connection_output_count<class_GraphNode_method_get_connection_output_count>` **(** **)**                                                                                                                                                                                                                                                                                                                 |
    63. 

  63. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | :ref:`Vector2<class_Vector2>` | :ref:`get_connection_output_position<class_GraphNode_method_get_connection_output_position>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                 |
    65. 

  65. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | :ref:`int<class_int>`         | :ref:`get_connection_output_type<class_GraphNode_method_get_connection_output_type>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                         |
    67. 

  67. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | :ref:`Color<class_Color>`     | :ref:`get_slot_color_left<class_GraphNode_method_get_slot_color_left>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                               |
    69. 

  69. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | :ref:`Color<class_Color>`     | :ref:`get_slot_color_right<class_GraphNode_method_get_slot_color_right>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                             |
    71. 

  71. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | :ref:`int<class_int>`         | :ref:`get_slot_type_left<class_GraphNode_method_get_slot_type_left>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                 |
    73. 

  73. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | :ref:`int<class_int>`         | :ref:`get_slot_type_right<class_GraphNode_method_get_slot_type_right>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                               |
    75. 

  75. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    76. 

  76. | :ref:`bool<class_bool>`       | :ref:`is_slot_enabled_left<class_GraphNode_method_is_slot_enabled_left>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                             |
    77. 

  77. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. | :ref:`bool<class_bool>`       | :ref:`is_slot_enabled_right<class_GraphNode_method_is_slot_enabled_right>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                           |
    79. 

  79. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    80. 

  80. | void                          | :ref:`set_slot<class_GraphNode_method_set_slot>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_Color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_Color>` color_right, :ref:`Texture<class_Texture>` custom_left=null, :ref:`Texture<class_Texture>` custom_right=null **)** |
    81. 

  81. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    82. 

  82. | void                          | :ref:`set_slot_color_left<class_GraphNode_method_set_slot_color_left>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` color_left **)**                                                                                                                                                                                                                                                                 |
    83. 

  83. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    84. 

  84. | void                          | :ref:`set_slot_color_right<class_GraphNode_method_set_slot_color_right>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` color_right **)**                                                                                                                                                                                                                                                              |
    85. 

  85. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    86. 

  86. | void                          | :ref:`set_slot_enabled_left<class_GraphNode_method_set_slot_enabled_left>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left **)**                                                                                                                                                                                                                                                              |
    87. 

  87. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    88. 

  88. | void                          | :ref:`set_slot_enabled_right<class_GraphNode_method_set_slot_enabled_right>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_right **)**                                                                                                                                                                                                                                                           |
    89. 

  89. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    90. 

  90. | void                          | :ref:`set_slot_type_left<class_GraphNode_method_set_slot_type_left>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_left **)**                                                                                                                                                                                                                                                                        |
    91. 

  91. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    92. 

  92. | void                          | :ref:`set_slot_type_right<class_GraphNode_method_set_slot_type_right>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_right **)**                                                                                                                                                                                                                                                                     |
    93. 

  93. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    94. 

  94. 

  95. Theme Properties
    96. 

  96. ----------------
    97. 

  97. 

  98. +---------------------------------+------------------------------------------------------------------+-------------------------+
    99. 

  99. | :ref:`Color<class_Color>`       | :ref:`close_color<class_GraphNode_theme_color_close_color>`      | ``Color( 0, 0, 0, 1 )`` |
    100. 

  100. +---------------------------------+------------------------------------------------------------------+-------------------------+
    101. 

  101. | :ref:`Color<class_Color>`       | :ref:`resizer_color<class_GraphNode_theme_color_resizer_color>`  | ``Color( 0, 0, 0, 1 )`` |
    102. 

  102. +---------------------------------+------------------------------------------------------------------+-------------------------+
    103. 

  103. | :ref:`Color<class_Color>`       | :ref:`title_color<class_GraphNode_theme_color_title_color>`      | ``Color( 0, 0, 0, 1 )`` |
    104. 

  104. +---------------------------------+------------------------------------------------------------------+-------------------------+
    105. 

  105. | :ref:`int<class_int>`           | :ref:`close_offset<class_GraphNode_theme_constant_close_offset>` | ``18``                  |
    106. 

  106. +---------------------------------+------------------------------------------------------------------+-------------------------+
    107. 

  107. | :ref:`int<class_int>`           | :ref:`port_offset<class_GraphNode_theme_constant_port_offset>`   | ``3``                   |
    108. 

  108. +---------------------------------+------------------------------------------------------------------+-------------------------+
    109. 

  109. | :ref:`int<class_int>`           | :ref:`separation<class_GraphNode_theme_constant_separation>`     | ``1``                   |
    110. 

  110. +---------------------------------+------------------------------------------------------------------+-------------------------+
    111. 

  111. | :ref:`int<class_int>`           | :ref:`title_offset<class_GraphNode_theme_constant_title_offset>` | ``20``                  |
    112. 

  112. +---------------------------------+------------------------------------------------------------------+-------------------------+
    113. 

  113. | :ref:`Font<class_Font>`         | :ref:`title_font<class_GraphNode_theme_font_title_font>`         |                         |
    114. 

  114. +---------------------------------+------------------------------------------------------------------+-------------------------+
    115. 

  115. | :ref:`Texture<class_Texture>`   | :ref:`close<class_GraphNode_theme_icon_close>`                   |                         |
    116. 

  116. +---------------------------------+------------------------------------------------------------------+-------------------------+
    117. 

  117. | :ref:`Texture<class_Texture>`   | :ref:`port<class_GraphNode_theme_icon_port>`                     |                         |
    118. 

  118. +---------------------------------+------------------------------------------------------------------+-------------------------+
    119. 

  119. | :ref:`Texture<class_Texture>`   | :ref:`resizer<class_GraphNode_theme_icon_resizer>`               |                         |
    120. 

  120. +---------------------------------+------------------------------------------------------------------+-------------------------+
    121. 

  121. | :ref:`StyleBox<class_StyleBox>` | :ref:`breakpoint<class_GraphNode_theme_style_breakpoint>`        |                         |
    122. 

  122. +---------------------------------+------------------------------------------------------------------+-------------------------+
    123. 

  123. | :ref:`StyleBox<class_StyleBox>` | :ref:`comment<class_GraphNode_theme_style_comment>`              |                         |
    124. 

  124. +---------------------------------+------------------------------------------------------------------+-------------------------+
    125. 

  125. | :ref:`StyleBox<class_StyleBox>` | :ref:`commentfocus<class_GraphNode_theme_style_commentfocus>`    |                         |
    126. 

  126. +---------------------------------+------------------------------------------------------------------+-------------------------+
    127. 

  127. | :ref:`StyleBox<class_StyleBox>` | :ref:`defaultfocus<class_GraphNode_theme_style_defaultfocus>`    |                         |
    128. 

  128. +---------------------------------+------------------------------------------------------------------+-------------------------+
    129. 

  129. | :ref:`StyleBox<class_StyleBox>` | :ref:`defaultframe<class_GraphNode_theme_style_defaultframe>`    |                         |
    130. 

  130. +---------------------------------+------------------------------------------------------------------+-------------------------+
    131. 

  131. | :ref:`StyleBox<class_StyleBox>` | :ref:`frame<class_GraphNode_theme_style_frame>`                  |                         |
    132. 

  132. +---------------------------------+------------------------------------------------------------------+-------------------------+
    133. 

  133. | :ref:`StyleBox<class_StyleBox>` | :ref:`position<class_GraphNode_theme_style_position>`            |                         |
    134. 

  134. +---------------------------------+------------------------------------------------------------------+-------------------------+
    135. 

  135. | :ref:`StyleBox<class_StyleBox>` | :ref:`selectedframe<class_GraphNode_theme_style_selectedframe>`  |                         |
    136. 

  136. +---------------------------------+------------------------------------------------------------------+-------------------------+
    137. 

  137. 

  138. Signals
    139. 

  139. -------
    140. 

  140. 

  141. .. _class_GraphNode_signal_close_request:
    142. 

  142. 

  143. - **close_request** **(** **)**
    144. 

  144. 

  145. Emitted when the GraphNode is requested to be closed. Happens on clicking the close button (see :ref:`show_close<class_GraphNode_property_show_close>`).
    146. 

  146. 

  147. ----
    148. 

  148. 

  149. .. _class_GraphNode_signal_dragged:
    150. 

  150. 

  151. - **dragged** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)**
    152. 

  152. 

  153. Emitted when the GraphNode is dragged.
    154. 

  154. 

  155. ----
    156. 

  156. 

  157. .. _class_GraphNode_signal_offset_changed:
    158. 

  158. 

  159. - **offset_changed** **(** **)**
    160. 

  160. 

  161. Emitted when the GraphNode is moved.
    162. 

  162. 

  163. ----
    164. 

  164. 

  165. .. _class_GraphNode_signal_raise_request:
    166. 

  166. 

  167. - **raise_request** **(** **)**
    168. 

  168. 

  169. Emitted when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
    170. 

  170. 

  171. ----
    172. 

  172. 

  173. .. _class_GraphNode_signal_resize_request:
    174. 

  174. 

  175. - **resize_request** **(** :ref:`Vector2<class_Vector2>` new_minsize **)**
    176. 

  176. 

  177. Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see :ref:`resizable<class_GraphNode_property_resizable>`).
    178. 

  178. 

  179. ----
    180. 

  180. 

  181. .. _class_GraphNode_signal_slot_updated:
    182. 

  182. 

  183. - **slot_updated** **(** :ref:`int<class_int>` idx **)**
    184. 

  184. 

  185. Emitted when any GraphNode's slot is updated.
    186. 

  186. 

  187. Enumerations
    188. 

  188. ------------
    189. 

  189. 

  190. .. _enum_GraphNode_Overlay:
    191. 

  191. 

  192. .. _class_GraphNode_constant_OVERLAY_DISABLED:
    193. 

  193. 

  194. .. _class_GraphNode_constant_OVERLAY_BREAKPOINT:
    195. 

  195. 

  196. .. _class_GraphNode_constant_OVERLAY_POSITION:
    197. 

  197. 

  198. enum **Overlay**:
    199. 

  199. 

  200. - **OVERLAY_DISABLED** = **0** --- No overlay is shown.
    201. 

  201. 

  202. - **OVERLAY_BREAKPOINT** = **1** --- Show overlay set in the ``breakpoint`` theme property.
    203. 

  203. 

  204. - **OVERLAY_POSITION** = **2** --- Show overlay set in the ``position`` theme property.
    205. 

  205. 

  206. Property Descriptions
    207. 

  207. ---------------------
    208. 

  208. 

  209. .. _class_GraphNode_property_comment:
    210. 

  210. 

  211. - :ref:`bool<class_bool>` **comment**
    212. 

  212. 

  213. +-----------+--------------------+
    214. 

  214. | *Default* | ``false``          |
    215. 

  215. +-----------+--------------------+
    216. 

  216. | *Setter*  | set_comment(value) |
    217. 

  217. +-----------+--------------------+
    218. 

  218. | *Getter*  | is_comment()       |
    219. 

  219. +-----------+--------------------+
    220. 

  220. 

  221. If ``true``, the GraphNode is a comment node.
    222. 

  222. 

  223. ----
    224. 

  224. 

  225. .. _class_GraphNode_property_offset:
    226. 

  226. 

  227. - :ref:`Vector2<class_Vector2>` **offset**
    228. 

  228. 

  229. +-----------+---------------------+
    230. 

  230. | *Default* | ``Vector2( 0, 0 )`` |
    231. 

  231. +-----------+---------------------+
    232. 

  232. | *Setter*  | set_offset(value)   |
    233. 

  233. +-----------+---------------------+
    234. 

  234. | *Getter*  | get_offset()        |
    235. 

  235. +-----------+---------------------+
    236. 

  236. 

  237. The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdit<class_GraphEdit>`.
    238. 

  238. 

  239. **Note:** You cannot use position directly, as :ref:`GraphEdit<class_GraphEdit>` is a :ref:`Container<class_Container>`.
    240. 

  240. 

  241. ----
    242. 

  242. 

  243. .. _class_GraphNode_property_overlay:
    244. 

  244. 

  245. - :ref:`Overlay<enum_GraphNode_Overlay>` **overlay**
    246. 

  246. 

  247. +-----------+--------------------+
    248. 

  248. | *Default* | ``0``              |
    249. 

  249. +-----------+--------------------+
    250. 

  250. | *Setter*  | set_overlay(value) |
    251. 

  251. +-----------+--------------------+
    252. 

  252. | *Getter*  | get_overlay()      |
    253. 

  253. +-----------+--------------------+
    254. 

  254. 

  255. Sets the overlay shown above the GraphNode. See :ref:`Overlay<enum_GraphNode_Overlay>`.
    256. 

  256. 

  257. ----
    258. 

  258. 

  259. .. _class_GraphNode_property_resizable:
    260. 

  260. 

  261. - :ref:`bool<class_bool>` **resizable**
    262. 

  262. 

  263. +-----------+----------------------+
    264. 

  264. | *Default* | ``false``            |
    265. 

  265. +-----------+----------------------+
    266. 

  266. | *Setter*  | set_resizable(value) |
    267. 

  267. +-----------+----------------------+
    268. 

  268. | *Getter*  | is_resizable()       |
    269. 

  269. +-----------+----------------------+
    270. 

  270. 

  271. If ``true``, the user can resize the GraphNode.
    272. 

  272. 

  273. **Note:** Dragging the handle will only emit the :ref:`resize_request<class_GraphNode_signal_resize_request>` signal, the GraphNode needs to be resized manually.
    274. 

  274. 

  275. ----
    276. 

  276. 

  277. .. _class_GraphNode_property_selected:
    278. 

  278. 

  279. - :ref:`bool<class_bool>` **selected**
    280. 

  280. 

  281. +-----------+---------------------+
    282. 

  282. | *Default* | ``false``           |
    283. 

  283. +-----------+---------------------+
    284. 

  284. | *Setter*  | set_selected(value) |
    285. 

  285. +-----------+---------------------+
    286. 

  286. | *Getter*  | is_selected()       |
    287. 

  287. +-----------+---------------------+
    288. 

  288. 

  289. If ``true``, the GraphNode is selected.
    290. 

  290. 

  291. ----
    292. 

  292. 

  293. .. _class_GraphNode_property_show_close:
    294. 

  294. 

  295. - :ref:`bool<class_bool>` **show_close**
    296. 

  296. 

  297. +-----------+------------------------------+
    298. 

  298. | *Default* | ``false``                    |
    299. 

  299. +-----------+------------------------------+
    300. 

  300. | *Setter*  | set_show_close_button(value) |
    301. 

  301. +-----------+------------------------------+
    302. 

  302. | *Getter*  | is_close_button_visible()    |
    303. 

  303. +-----------+------------------------------+
    304. 

  304. 

  305. If ``true``, the close button will be visible.
    306. 

  306. 

  307. **Note:** Pressing it will only emit the :ref:`close_request<class_GraphNode_signal_close_request>` signal, the GraphNode needs to be removed manually.
    308. 

  308. 

  309. ----
    310. 

  310. 

  311. .. _class_GraphNode_property_title:
    312. 

  312. 

  313. - :ref:`String<class_String>` **title**
    314. 

  314. 

  315. +-----------+------------------+
    316. 

  316. | *Default* | ``""``           |
    317. 

  317. +-----------+------------------+
    318. 

  318. | *Setter*  | set_title(value) |
    319. 

  319. +-----------+------------------+
    320. 

  320. | *Getter*  | get_title()      |
    321. 

  321. +-----------+------------------+
    322. 

  322. 

  323. The text displayed in the GraphNode's title bar.
    324. 

  324. 

  325. Method Descriptions
    326. 

  326. -------------------
    327. 

  327. 

  328. .. _class_GraphNode_method_clear_all_slots:
    329. 

  329. 

  330. - void **clear_all_slots** **(** **)**
    331. 

  331. 

  332. Disables all input and output slots of the GraphNode.
    333. 

  333. 

  334. ----
    335. 

  335. 

  336. .. _class_GraphNode_method_clear_slot:
    337. 

  337. 

  338. - void **clear_slot** **(** :ref:`int<class_int>` idx **)**
    339. 

  339. 

  340. Disables input and output slot whose index is ``idx``.
    341. 

  341. 

  342. ----
    343. 

  343. 

  344. .. _class_GraphNode_method_get_connection_input_color:
    345. 

  345. 

  346. - :ref:`Color<class_Color>` **get_connection_input_color** **(** :ref:`int<class_int>` idx **)**
    347. 

  347. 

  348. Returns the :ref:`Color<class_Color>` of the input connection ``idx``.
    349. 

  349. 

  350. ----
    351. 

  351. 

  352. .. _class_GraphNode_method_get_connection_input_count:
    353. 

  353. 

  354. - :ref:`int<class_int>` **get_connection_input_count** **(** **)**
    355. 

  355. 

  356. Returns the number of enabled input slots (connections) to the GraphNode.
    357. 

  357. 

  358. ----
    359. 

  359. 

  360. .. _class_GraphNode_method_get_connection_input_position:
    361. 

  361. 

  362. - :ref:`Vector2<class_Vector2>` **get_connection_input_position** **(** :ref:`int<class_int>` idx **)**
    363. 

  363. 

  364. Returns the position of the input connection ``idx``.
    365. 

  365. 

  366. ----
    367. 

  367. 

  368. .. _class_GraphNode_method_get_connection_input_type:
    369. 

  369. 

  370. - :ref:`int<class_int>` **get_connection_input_type** **(** :ref:`int<class_int>` idx **)**
    371. 

  371. 

  372. Returns the type of the input connection ``idx``.
    373. 

  373. 

  374. ----
    375. 

  375. 

  376. .. _class_GraphNode_method_get_connection_output_color:
    377. 

  377. 

  378. - :ref:`Color<class_Color>` **get_connection_output_color** **(** :ref:`int<class_int>` idx **)**
    379. 

  379. 

  380. Returns the :ref:`Color<class_Color>` of the output connection ``idx``.
    381. 

  381. 

  382. ----
    383. 

  383. 

  384. .. _class_GraphNode_method_get_connection_output_count:
    385. 

  385. 

  386. - :ref:`int<class_int>` **get_connection_output_count** **(** **)**
    387. 

  387. 

  388. Returns the number of enabled output slots (connections) of the GraphNode.
    389. 

  389. 

  390. ----
    391. 

  391. 

  392. .. _class_GraphNode_method_get_connection_output_position:
    393. 

  393. 

  394. - :ref:`Vector2<class_Vector2>` **get_connection_output_position** **(** :ref:`int<class_int>` idx **)**
    395. 

  395. 

  396. Returns the position of the output connection ``idx``.
    397. 

  397. 

  398. ----
    399. 

  399. 

  400. .. _class_GraphNode_method_get_connection_output_type:
    401. 

  401. 

  402. - :ref:`int<class_int>` **get_connection_output_type** **(** :ref:`int<class_int>` idx **)**
    403. 

  403. 

  404. Returns the type of the output connection ``idx``.
    405. 

  405. 

  406. ----
    407. 

  407. 

  408. .. _class_GraphNode_method_get_slot_color_left:
    409. 

  409. 

  410. - :ref:`Color<class_Color>` **get_slot_color_left** **(** :ref:`int<class_int>` idx **)** |const|
    411. 

  411. 

  412. Returns the left (input) :ref:`Color<class_Color>` of the slot ``idx``.
    413. 

  413. 

  414. ----
    415. 

  415. 

  416. .. _class_GraphNode_method_get_slot_color_right:
    417. 

  417. 

  418. - :ref:`Color<class_Color>` **get_slot_color_right** **(** :ref:`int<class_int>` idx **)** |const|
    419. 

  419. 

  420. Returns the right (output) :ref:`Color<class_Color>` of the slot ``idx``.
    421. 

  421. 

  422. ----
    423. 

  423. 

  424. .. _class_GraphNode_method_get_slot_type_left:
    425. 

  425. 

  426. - :ref:`int<class_int>` **get_slot_type_left** **(** :ref:`int<class_int>` idx **)** |const|
    427. 

  427. 

  428. Returns the left (input) type of the slot ``idx``.
    429. 

  429. 

  430. ----
    431. 

  431. 

  432. .. _class_GraphNode_method_get_slot_type_right:
    433. 

  433. 

  434. - :ref:`int<class_int>` **get_slot_type_right** **(** :ref:`int<class_int>` idx **)** |const|
    435. 

  435. 

  436. Returns the right (output) type of the slot ``idx``.
    437. 

  437. 

  438. ----
    439. 

  439. 

  440. .. _class_GraphNode_method_is_slot_enabled_left:
    441. 

  441. 

  442. - :ref:`bool<class_bool>` **is_slot_enabled_left** **(** :ref:`int<class_int>` idx **)** |const|
    443. 

  443. 

  444. Returns ``true`` if left (input) side of the slot ``idx`` is enabled.
    445. 

  445. 

  446. ----
    447. 

  447. 

  448. .. _class_GraphNode_method_is_slot_enabled_right:
    449. 

  449. 

  450. - :ref:`bool<class_bool>` **is_slot_enabled_right** **(** :ref:`int<class_int>` idx **)** |const|
    451. 

  451. 

  452. Returns ``true`` if right (output) side of the slot ``idx`` is enabled.
    453. 

  453. 

  454. ----
    455. 

  455. 

  456. .. _class_GraphNode_method_set_slot:
    457. 

  457. 

  458. - void **set_slot** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_Color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_Color>` color_right, :ref:`Texture<class_Texture>` custom_left=null, :ref:`Texture<class_Texture>` custom_right=null **)**
    459. 

  459. 

  460. Sets properties of the slot with ID ``idx``.
    461. 

  461. 

  462. If ``enable_left``/``right``, a port will appear and the slot will be able to be connected from this side.
    463. 

  463. 

  464. ``type_left``/``right`` is an arbitrary type of the port. Only ports with the same type values can be connected.
    465. 

  465. 

  466. ``color_left``/``right`` is the tint of the port's icon on this side.
    467. 

  467. 

  468. ``custom_left``/``right`` is a custom texture for this side's port.
    469. 

  469. 

  470. **Note:** This method only sets properties of the slot. To create the slot, add a :ref:`Control<class_Control>`-derived child to the GraphNode.
    471. 

  471. 

  472. Individual properties can be set using one of the ``set_slot_*`` methods. You must enable at least one side of the slot to do so.
    473. 

  473. 

  474. ----
    475. 

  475. 

  476. .. _class_GraphNode_method_set_slot_color_left:
    477. 

  477. 

  478. - void **set_slot_color_left** **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` color_left **)**
    479. 

  479. 

  480. Sets the :ref:`Color<class_Color>` of the left (input) side of the slot ``idx`` to ``color_left``.
    481. 

  481. 

  482. ----
    483. 

  483. 

  484. .. _class_GraphNode_method_set_slot_color_right:
    485. 

  485. 

  486. - void **set_slot_color_right** **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` color_right **)**
    487. 

  487. 

  488. Sets the :ref:`Color<class_Color>` of the right (output) side of the slot ``idx`` to ``color_right``.
    489. 

  489. 

  490. ----
    491. 

  491. 

  492. .. _class_GraphNode_method_set_slot_enabled_left:
    493. 

  493. 

  494. - void **set_slot_enabled_left** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left **)**
    495. 

  495. 

  496. Toggles the left (input) side of the slot ``idx``. If ``enable_left`` is ``true``, a port will appear on the left side and the slot will be able to be connected from this side.
    497. 

  497. 

  498. ----
    499. 

  499. 

  500. .. _class_GraphNode_method_set_slot_enabled_right:
    501. 

  501. 

  502. - void **set_slot_enabled_right** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_right **)**
    503. 

  503. 

  504. Toggles the right (output) side of the slot ``idx``. If ``enable_right`` is ``true``, a port will appear on the right side and the slot will be able to be connected from this side.
    505. 

  505. 

  506. ----
    507. 

  507. 

  508. .. _class_GraphNode_method_set_slot_type_left:
    509. 

  509. 

  510. - void **set_slot_type_left** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_left **)**
    511. 

  511. 

  512. Sets the left (input) type of the slot ``idx`` to ``type_left``.
    513. 

  513. 

  514. ----
    515. 

  515. 

  516. .. _class_GraphNode_method_set_slot_type_right:
    517. 

  517. 

  518. - void **set_slot_type_right** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_right **)**
    519. 

  519. 

  520. Sets the right (output) type of the slot ``idx`` to ``type_right``.
    521. 

  521. 

  522. Theme Property Descriptions
    523. 

  523. ---------------------------
    524. 

  524. 

  525. .. _class_GraphNode_theme_color_close_color:
    526. 

  526. 

  527. - :ref:`Color<class_Color>` **close_color**
    528. 

  528. 

  529. +-----------+-------------------------+
    530. 

  530. | *Default* | ``Color( 0, 0, 0, 1 )`` |
    531. 

  531. +-----------+-------------------------+
    532. 

  532. 

  533. The color modulation applied to the close button icon.
    534. 

  534. 

  535. ----
    536. 

  536. 

  537. .. _class_GraphNode_theme_color_resizer_color:
    538. 

  538. 

  539. - :ref:`Color<class_Color>` **resizer_color**
    540. 

  540. 

  541. +-----------+-------------------------+
    542. 

  542. | *Default* | ``Color( 0, 0, 0, 1 )`` |
    543. 

  543. +-----------+-------------------------+
    544. 

  544. 

  545. The color modulation applied to the resizer icon.
    546. 

  546. 

  547. ----
    548. 

  548. 

  549. .. _class_GraphNode_theme_color_title_color:
    550. 

  550. 

  551. - :ref:`Color<class_Color>` **title_color**
    552. 

  552. 

  553. +-----------+-------------------------+
    554. 

  554. | *Default* | ``Color( 0, 0, 0, 1 )`` |
    555. 

  555. +-----------+-------------------------+
    556. 

  556. 

  557. Color of the title text.
    558. 

  558. 

  559. ----
    560. 

  560. 

  561. .. _class_GraphNode_theme_constant_close_offset:
    562. 

  562. 

  563. - :ref:`int<class_int>` **close_offset**
    564. 

  564. 

  565. +-----------+--------+
    566. 

  566. | *Default* | ``18`` |
    567. 

  567. +-----------+--------+
    568. 

  568. 

  569. The vertical offset of the close button.
    570. 

  570. 

  571. ----
    572. 

  572. 

  573. .. _class_GraphNode_theme_constant_port_offset:
    574. 

  574. 

  575. - :ref:`int<class_int>` **port_offset**
    576. 

  576. 

  577. +-----------+-------+
    578. 

  578. | *Default* | ``3`` |
    579. 

  579. +-----------+-------+
    580. 

  580. 

  581. Horizontal offset for the ports.
    582. 

  582. 

  583. ----
    584. 

  584. 

  585. .. _class_GraphNode_theme_constant_separation:
    586. 

  586. 

  587. - :ref:`int<class_int>` **separation**
    588. 

  588. 

  589. +-----------+-------+
    590. 

  590. | *Default* | ``1`` |
    591. 

  591. +-----------+-------+
    592. 

  592. 

  593. The vertical distance between ports.
    594. 

  594. 

  595. ----
    596. 

  596. 

  597. .. _class_GraphNode_theme_constant_title_offset:
    598. 

  598. 

  599. - :ref:`int<class_int>` **title_offset**
    600. 

  600. 

  601. +-----------+--------+
    602. 

  602. | *Default* | ``20`` |
    603. 

  603. +-----------+--------+
    604. 

  604. 

  605. Vertical offset of the title text.
    606. 

  606. 

  607. ----
    608. 

  608. 

  609. .. _class_GraphNode_theme_font_title_font:
    610. 

  610. 

  611. - :ref:`Font<class_Font>` **title_font**
    612. 

  612. 

  613. Font used for the title text.
    614. 

  614. 

  615. ----
    616. 

  616. 

  617. .. _class_GraphNode_theme_icon_close:
    618. 

  618. 

  619. - :ref:`Texture<class_Texture>` **close**
    620. 

  620. 

  621. The icon for the close button, visible when :ref:`show_close<class_GraphNode_property_show_close>` is enabled.
    622. 

  622. 

  623. ----
    624. 

  624. 

  625. .. _class_GraphNode_theme_icon_port:
    626. 

  626. 

  627. - :ref:`Texture<class_Texture>` **port**
    628. 

  628. 

  629. The icon used for representing ports.
    630. 

  630. 

  631. ----
    632. 

  632. 

  633. .. _class_GraphNode_theme_icon_resizer:
    634. 

  634. 

  635. - :ref:`Texture<class_Texture>` **resizer**
    636. 

  636. 

  637. The icon used for resizer, visible when :ref:`resizable<class_GraphNode_property_resizable>` is enabled.
    638. 

  638. 

  639. ----
    640. 

  640. 

  641. .. _class_GraphNode_theme_style_breakpoint:
    642. 

  642. 

  643. - :ref:`StyleBox<class_StyleBox>` **breakpoint**
    644. 

  644. 

  645. The background used when :ref:`overlay<class_GraphNode_property_overlay>` is set to :ref:`OVERLAY_BREAKPOINT<class_GraphNode_constant_OVERLAY_BREAKPOINT>`.
    646. 

  646. 

  647. ----
    648. 

  648. 

  649. .. _class_GraphNode_theme_style_comment:
    650. 

  650. 

  651. - :ref:`StyleBox<class_StyleBox>` **comment**
    652. 

  652. 

  653. The :ref:`StyleBox<class_StyleBox>` used when :ref:`comment<class_GraphNode_property_comment>` is enabled.
    654. 

  654. 

  655. ----
    656. 

  656. 

  657. .. _class_GraphNode_theme_style_commentfocus:
    658. 

  658. 

  659. - :ref:`StyleBox<class_StyleBox>` **commentfocus**
    660. 

  660. 

  661. The :ref:`StyleBox<class_StyleBox>` used when :ref:`comment<class_GraphNode_property_comment>` is enabled and the ``GraphNode`` is focused.
    662. 

  662. 

  663. ----
    664. 

  664. 

  665. .. _class_GraphNode_theme_style_defaultfocus:
    666. 

  666. 

  667. - :ref:`StyleBox<class_StyleBox>` **defaultfocus**
    668. 

  668. 

  669. ----
    670. 

  670. 

  671. .. _class_GraphNode_theme_style_defaultframe:
    672. 

  672. 

  673. - :ref:`StyleBox<class_StyleBox>` **defaultframe**
    674. 

  674. 

  675. ----
    676. 

  676. 

  677. .. _class_GraphNode_theme_style_frame:
    678. 

  678. 

  679. - :ref:`StyleBox<class_StyleBox>` **frame**
    680. 

  680. 

  681. The default background for ``GraphNode``.
    682. 

  682. 

  683. ----
    684. 

  684. 

  685. .. _class_GraphNode_theme_style_position:
    686. 

  686. 

  687. - :ref:`StyleBox<class_StyleBox>` **position**
    688. 

  688. 

  689. The background used when :ref:`overlay<class_GraphNode_property_overlay>` is set to :ref:`OVERLAY_POSITION<class_GraphNode_constant_OVERLAY_POSITION>`.
    690. 

  690. 

  691. ----
    692. 

  692. 

  693. .. _class_GraphNode_theme_style_selectedframe:
    694. 

  694. 

  695. - :ref:`StyleBox<class_StyleBox>` **selectedframe**
    696. 

  696. 

  697. The background used when the ``GraphNode`` is selected.
    698. 

  698. 

  699. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    700. 

  700. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    701. 

  701. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    702. 

  702.