godot-docs/classes/class_graphnode.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GraphNode.xml.

.. _class_GraphNode:

GraphNode
=========

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

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

.. rst-class:: classref-introduction-group

Description
-----------

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.

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.

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.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +----------------------------------------+--------------------------------------------------------+---------------------+
   | :ref:`bool<class_bool>`                | :ref:`comment<class_GraphNode_property_comment>`       | ``false``           |
   +----------------------------------------+--------------------------------------------------------+---------------------+
   | :ref:`Vector2<class_Vector2>`          | :ref:`offset<class_GraphNode_property_offset>`         | ``Vector2( 0, 0 )`` |
   +----------------------------------------+--------------------------------------------------------+---------------------+
   | :ref:`Overlay<enum_GraphNode_Overlay>` | :ref:`overlay<class_GraphNode_property_overlay>`       | ``0``               |
   +----------------------------------------+--------------------------------------------------------+---------------------+
   | :ref:`bool<class_bool>`                | :ref:`resizable<class_GraphNode_property_resizable>`   | ``false``           |
   +----------------------------------------+--------------------------------------------------------+---------------------+
   | :ref:`bool<class_bool>`                | :ref:`selected<class_GraphNode_property_selected>`     | ``false``           |
   +----------------------------------------+--------------------------------------------------------+---------------------+
   | :ref:`bool<class_bool>`                | :ref:`show_close<class_GraphNode_property_show_close>` | ``false``           |
   +----------------------------------------+--------------------------------------------------------+---------------------+
   | :ref:`String<class_String>`            | :ref:`title<class_GraphNode_property_title>`           | ``""``              |
   +----------------------------------------+--------------------------------------------------------+---------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                          | :ref:`clear_all_slots<class_GraphNode_method_clear_all_slots>` **(** **)**                                                                                                                                                                                                                                                                                                                                         |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                          | :ref:`clear_slot<class_GraphNode_method_clear_slot>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                                                         |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`     | :ref:`get_connection_input_color<class_GraphNode_method_get_connection_input_color>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                         |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`         | :ref:`get_connection_input_count<class_GraphNode_method_get_connection_input_count>` **(** **)**                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>` | :ref:`get_connection_input_position<class_GraphNode_method_get_connection_input_position>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                   |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`         | :ref:`get_connection_input_type<class_GraphNode_method_get_connection_input_type>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                           |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`     | :ref:`get_connection_output_color<class_GraphNode_method_get_connection_output_color>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                       |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`         | :ref:`get_connection_output_count<class_GraphNode_method_get_connection_output_count>` **(** **)**                                                                                                                                                                                                                                                                                                                 |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>` | :ref:`get_connection_output_position<class_GraphNode_method_get_connection_output_position>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                 |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`         | :ref:`get_connection_output_type<class_GraphNode_method_get_connection_output_type>` **(** :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                         |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`     | :ref:`get_slot_color_left<class_GraphNode_method_get_slot_color_left>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                               |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`     | :ref:`get_slot_color_right<class_GraphNode_method_get_slot_color_right>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                             |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`         | :ref:`get_slot_type_left<class_GraphNode_method_get_slot_type_left>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                 |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`         | :ref:`get_slot_type_right<class_GraphNode_method_get_slot_type_right>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                               |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`       | :ref:`is_slot_enabled_left<class_GraphNode_method_is_slot_enabled_left>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                             |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`       | :ref:`is_slot_enabled_right<class_GraphNode_method_is_slot_enabled_right>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                           |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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 **)** |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                          | :ref:`set_slot_color_left<class_GraphNode_method_set_slot_color_left>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` color_left **)**                                                                                                                                                                                                                                                                 |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                          | :ref:`set_slot_color_right<class_GraphNode_method_set_slot_color_right>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` color_right **)**                                                                                                                                                                                                                                                              |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                          | :ref:`set_slot_enabled_left<class_GraphNode_method_set_slot_enabled_left>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left **)**                                                                                                                                                                                                                                                              |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                          | :ref:`set_slot_enabled_right<class_GraphNode_method_set_slot_enabled_right>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_right **)**                                                                                                                                                                                                                                                           |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                          | :ref:`set_slot_type_left<class_GraphNode_method_set_slot_type_left>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_left **)**                                                                                                                                                                                                                                                                        |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                          | :ref:`set_slot_type_right<class_GraphNode_method_set_slot_type_right>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_right **)**                                                                                                                                                                                                                                                                     |
   +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-reftable-group

Theme Properties
----------------

.. table::
   :widths: auto

   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`Color<class_Color>`       | :ref:`close_color<class_GraphNode_theme_color_close_color>`      | ``Color( 0, 0, 0, 1 )`` |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`Color<class_Color>`       | :ref:`resizer_color<class_GraphNode_theme_color_resizer_color>`  | ``Color( 0, 0, 0, 1 )`` |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`Color<class_Color>`       | :ref:`title_color<class_GraphNode_theme_color_title_color>`      | ``Color( 0, 0, 0, 1 )`` |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`int<class_int>`           | :ref:`close_offset<class_GraphNode_theme_constant_close_offset>` | ``18``                  |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`int<class_int>`           | :ref:`port_offset<class_GraphNode_theme_constant_port_offset>`   | ``3``                   |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`int<class_int>`           | :ref:`separation<class_GraphNode_theme_constant_separation>`     | ``1``                   |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`int<class_int>`           | :ref:`title_offset<class_GraphNode_theme_constant_title_offset>` | ``20``                  |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`Font<class_Font>`         | :ref:`title_font<class_GraphNode_theme_font_title_font>`         |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`close<class_GraphNode_theme_icon_close>`                   |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`port<class_GraphNode_theme_icon_port>`                     |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`resizer<class_GraphNode_theme_icon_resizer>`               |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`breakpoint<class_GraphNode_theme_style_breakpoint>`        |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`comment<class_GraphNode_theme_style_comment>`              |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`commentfocus<class_GraphNode_theme_style_commentfocus>`    |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`defaultfocus<class_GraphNode_theme_style_defaultfocus>`    |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`defaultframe<class_GraphNode_theme_style_defaultframe>`    |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`frame<class_GraphNode_theme_style_frame>`                  |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`position<class_GraphNode_theme_style_position>`            |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`selectedframe<class_GraphNode_theme_style_selectedframe>`  |                         |
   +---------------------------------+------------------------------------------------------------------+-------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_GraphNode_signal_close_request:

.. rst-class:: classref-signal

**close_request** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_signal_dragged:

.. rst-class:: classref-signal

**dragged** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)**

Emitted when the GraphNode is dragged.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_signal_offset_changed:

.. rst-class:: classref-signal

**offset_changed** **(** **)**

Emitted when the GraphNode is moved.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_signal_raise_request:

.. rst-class:: classref-signal

**raise_request** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_signal_resize_request:

.. rst-class:: classref-signal

**resize_request** **(** :ref:`Vector2<class_Vector2>` new_minsize **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_signal_selected:

.. rst-class:: classref-signal

**selected** **(** **)**

Emitted when the GraphNode is selected.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_signal_slot_updated:

.. rst-class:: classref-signal

**slot_updated** **(** :ref:`int<class_int>` idx **)**

Emitted when any GraphNode's slot is updated.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_signal_unselected:

.. rst-class:: classref-signal

**unselected** **(** **)**

Emitted when the GraphNode is unselected.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

.. _enum_GraphNode_Overlay:

.. rst-class:: classref-enumeration

enum **Overlay**:

.. _class_GraphNode_constant_OVERLAY_DISABLED:

.. rst-class:: classref-enumeration-constant

:ref:`Overlay<enum_GraphNode_Overlay>` **OVERLAY_DISABLED** = ``0``

No overlay is shown.

.. _class_GraphNode_constant_OVERLAY_BREAKPOINT:

.. rst-class:: classref-enumeration-constant

:ref:`Overlay<enum_GraphNode_Overlay>` **OVERLAY_BREAKPOINT** = ``1``

Show overlay set in the ``breakpoint`` theme property.

.. _class_GraphNode_constant_OVERLAY_POSITION:

.. rst-class:: classref-enumeration-constant

:ref:`Overlay<enum_GraphNode_Overlay>` **OVERLAY_POSITION** = ``2``

Show overlay set in the ``position`` theme property.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_GraphNode_property_comment:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **comment** = ``false``

.. rst-class:: classref-property-setget

- void **set_comment** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_comment** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_property_offset:

.. rst-class:: classref-property

:ref:`Vector2<class_Vector2>` **offset** = ``Vector2( 0, 0 )``

.. rst-class:: classref-property-setget

- void **set_offset** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_offset** **(** **)**

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

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_property_overlay:

.. rst-class:: classref-property

:ref:`Overlay<enum_GraphNode_Overlay>` **overlay** = ``0``

.. rst-class:: classref-property-setget

- void **set_overlay** **(** :ref:`Overlay<enum_GraphNode_Overlay>` value **)**
- :ref:`Overlay<enum_GraphNode_Overlay>` **get_overlay** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_property_resizable:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **resizable** = ``false``

.. rst-class:: classref-property-setget

- void **set_resizable** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_resizable** **(** **)**

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

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_property_selected:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **selected** = ``false``

.. rst-class:: classref-property-setget

- void **set_selected** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_selected** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_property_show_close:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **show_close** = ``false``

.. rst-class:: classref-property-setget

- void **set_show_close_button** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_close_button_visible** **(** **)**

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

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_property_title:

.. rst-class:: classref-property

:ref:`String<class_String>` **title** = ``""``

.. rst-class:: classref-property-setget

- void **set_title** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_title** **(** **)**

The text displayed in the GraphNode's title bar.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_GraphNode_method_clear_all_slots:

.. rst-class:: classref-method

void **clear_all_slots** **(** **)**

Disables all input and output slots of the GraphNode.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_clear_slot:

.. rst-class:: classref-method

void **clear_slot** **(** :ref:`int<class_int>` idx **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_connection_input_color:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_connection_input_color** **(** :ref:`int<class_int>` idx **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_connection_input_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_connection_input_count** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_connection_input_position:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_connection_input_position** **(** :ref:`int<class_int>` idx **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_connection_input_type:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_connection_input_type** **(** :ref:`int<class_int>` idx **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_connection_output_color:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_connection_output_color** **(** :ref:`int<class_int>` idx **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_connection_output_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_connection_output_count** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_connection_output_position:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_connection_output_position** **(** :ref:`int<class_int>` idx **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_connection_output_type:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_connection_output_type** **(** :ref:`int<class_int>` idx **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_slot_color_left:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_slot_color_right:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_slot_type_left:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_slot_type_left** **(** :ref:`int<class_int>` idx **)** |const|

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_get_slot_type_right:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_slot_type_right** **(** :ref:`int<class_int>` idx **)** |const|

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_is_slot_enabled_left:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_is_slot_enabled_right:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_set_slot:

.. rst-class:: classref-method

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 **)**

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

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

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

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

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

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

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.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_set_slot_color_left:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_set_slot_color_right:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_set_slot_enabled_left:

.. rst-class:: classref-method

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

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.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_set_slot_enabled_right:

.. rst-class:: classref-method

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

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.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_set_slot_type_left:

.. rst-class:: classref-method

void **set_slot_type_left** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_left **)**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_method_set_slot_type_right:

.. rst-class:: classref-method

void **set_slot_type_right** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` type_right **)**

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

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Theme Property Descriptions
---------------------------

.. _class_GraphNode_theme_color_close_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **close_color** = ``Color( 0, 0, 0, 1 )``

The color modulation applied to the close button icon.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_color_resizer_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **resizer_color** = ``Color( 0, 0, 0, 1 )``

The color modulation applied to the resizer icon.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_color_title_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **title_color** = ``Color( 0, 0, 0, 1 )``

Color of the title text.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_constant_close_offset:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **close_offset** = ``18``

The vertical offset of the close button.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_constant_port_offset:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **port_offset** = ``3``

Horizontal offset for the ports.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_constant_separation:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **separation** = ``1``

The vertical distance between ports.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_constant_title_offset:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **title_offset** = ``20``

Vertical offset of the title text.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_font_title_font:

.. rst-class:: classref-themeproperty

:ref:`Font<class_Font>` **title_font**

Font used for the title text.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_icon_close:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **close**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_icon_port:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **port**

The icon used for representing ports.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_icon_resizer:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **resizer**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_style_breakpoint:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **breakpoint**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_style_comment:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **comment**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_style_commentfocus:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **commentfocus**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_style_defaultfocus:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **defaultfocus**

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_style_defaultframe:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **defaultframe**

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_style_frame:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **frame**

The default background for **GraphNode**.

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_style_position:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **position**

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

.. rst-class:: classref-item-separator

----

.. _class_GraphNode_theme_style_selectedframe:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **selectedframe**

The background used when the **GraphNode** is selected.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`