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/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GraphNode.xml.

.. _class_GraphNode:

GraphNode
=========

**Experimental:** This class may be changed or removed in future versions.

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

A container with connection ports, representing a node in a :ref:`GraphEdit<class_GraphEdit>`.

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

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

**GraphNode** allows to create nodes for a :ref:`GraphEdit<class_GraphEdit>` graph with customizable content based on its child controls. **GraphNode** is derived from :ref:`Container<class_Container>` and it is responsible for placing its children on screen. This works similar to :ref:`VBoxContainer<class_VBoxContainer>`. Children, in turn, provide **GraphNode** with so-called slots, each of which can have a connection port on either side.

Each **GraphNode** slot is defined by its index and can provide the node with up to two ports: one on the left, and one on the right. By convention the left port is also referred to as the **input port** and the right port is referred to as the **output port**. Each port can be enabled and configured individually, using different type and color. The type is an arbitrary value that you can define using your own considerations. The parent :ref:`GraphEdit<class_GraphEdit>` will receive this information on each connect and disconnect request.

Slots can be configured in the Inspector dock once you add at least one child :ref:`Control<class_Control>`. The properties are grouped by each slot's index in the "Slot" section.

\ **Note:** While GraphNode is set up using slots and slot indices, connections are made between the ports which are enabled. Because of that :ref:`GraphEdit<class_GraphEdit>` uses the port's index and not the slot's index. You can use :ref:`get_input_port_slot<class_GraphNode_method_get_input_port_slot>` and :ref:`get_output_port_slot<class_GraphNode_method_get_output_port_slot>` to get the slot index from the port index.

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

Properties
----------

.. table::
   :widths: auto

   +----------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------+
   | :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter                                 | ``0`` (overrides :ref:`Control<class_Control_property_mouse_filter>`) |
   +----------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------+
   | :ref:`String<class_String>`                  | :ref:`title<class_GraphNode_property_title>` | ``""``                                                                |
   +----------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------+

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

Methods
-------

.. table::
   :widths: auto

   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`_draw_port<class_GraphNode_private_method__draw_port>` **(** :ref:`int<class_int>` slot_index, :ref:`Vector2i<class_Vector2i>` position, :ref:`bool<class_bool>` left, :ref:`Color<class_Color>` color **)** |virtual|                                                                                                                                                                                                                                                                      |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`clear_all_slots<class_GraphNode_method_clear_all_slots>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`clear_slot<class_GraphNode_method_clear_slot>` **(** :ref:`int<class_int>` slot_index **)**                                                                                                                                                                                                                                                                                                                                                                                                 |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                 | :ref:`get_input_port_color<class_GraphNode_method_get_input_port_color>` **(** :ref:`int<class_int>` port_idx **)**                                                                                                                                                                                                                                                                                                                                                                               |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                     | :ref:`get_input_port_count<class_GraphNode_method_get_input_port_count>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`             | :ref:`get_input_port_position<class_GraphNode_method_get_input_port_position>` **(** :ref:`int<class_int>` port_idx **)**                                                                                                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                     | :ref:`get_input_port_slot<class_GraphNode_method_get_input_port_slot>` **(** :ref:`int<class_int>` port_idx **)**                                                                                                                                                                                                                                                                                                                                                                                 |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                     | :ref:`get_input_port_type<class_GraphNode_method_get_input_port_type>` **(** :ref:`int<class_int>` port_idx **)**                                                                                                                                                                                                                                                                                                                                                                                 |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                 | :ref:`get_output_port_color<class_GraphNode_method_get_output_port_color>` **(** :ref:`int<class_int>` port_idx **)**                                                                                                                                                                                                                                                                                                                                                                             |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                     | :ref:`get_output_port_count<class_GraphNode_method_get_output_port_count>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`             | :ref:`get_output_port_position<class_GraphNode_method_get_output_port_position>` **(** :ref:`int<class_int>` port_idx **)**                                                                                                                                                                                                                                                                                                                                                                       |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                     | :ref:`get_output_port_slot<class_GraphNode_method_get_output_port_slot>` **(** :ref:`int<class_int>` port_idx **)**                                                                                                                                                                                                                                                                                                                                                                               |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                     | :ref:`get_output_port_type<class_GraphNode_method_get_output_port_type>` **(** :ref:`int<class_int>` port_idx **)**                                                                                                                                                                                                                                                                                                                                                                               |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                 | :ref:`get_slot_color_left<class_GraphNode_method_get_slot_color_left>` **(** :ref:`int<class_int>` slot_index **)** |const|                                                                                                                                                                                                                                                                                                                                                                       |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                 | :ref:`get_slot_color_right<class_GraphNode_method_get_slot_color_right>` **(** :ref:`int<class_int>` slot_index **)** |const|                                                                                                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Texture2D<class_Texture2D>`         | :ref:`get_slot_custom_icon_left<class_GraphNode_method_get_slot_custom_icon_left>` **(** :ref:`int<class_int>` slot_index **)** |const|                                                                                                                                                                                                                                                                                                                                                           |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Texture2D<class_Texture2D>`         | :ref:`get_slot_custom_icon_right<class_GraphNode_method_get_slot_custom_icon_right>` **(** :ref:`int<class_int>` slot_index **)** |const|                                                                                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                     | :ref:`get_slot_type_left<class_GraphNode_method_get_slot_type_left>` **(** :ref:`int<class_int>` slot_index **)** |const|                                                                                                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                     | :ref:`get_slot_type_right<class_GraphNode_method_get_slot_type_right>` **(** :ref:`int<class_int>` slot_index **)** |const|                                                                                                                                                                                                                                                                                                                                                                       |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`HBoxContainer<class_HBoxContainer>` | :ref:`get_titlebar_hbox<class_GraphNode_method_get_titlebar_hbox>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                   | :ref:`is_slot_draw_stylebox<class_GraphNode_method_is_slot_draw_stylebox>` **(** :ref:`int<class_int>` slot_index **)** |const|                                                                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                   | :ref:`is_slot_enabled_left<class_GraphNode_method_is_slot_enabled_left>` **(** :ref:`int<class_int>` slot_index **)** |const|                                                                                                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                   | :ref:`is_slot_enabled_right<class_GraphNode_method_is_slot_enabled_right>` **(** :ref:`int<class_int>` slot_index **)** |const|                                                                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot<class_GraphNode_method_set_slot>` **(** :ref:`int<class_int>` slot_index, :ref:`bool<class_bool>` enable_left_port, :ref:`int<class_int>` type_left, :ref:`Color<class_Color>` color_left, :ref:`bool<class_bool>` enable_right_port, :ref:`int<class_int>` type_right, :ref:`Color<class_Color>` color_right, :ref:`Texture2D<class_Texture2D>` custom_icon_left=null, :ref:`Texture2D<class_Texture2D>` custom_icon_right=null, :ref:`bool<class_bool>` draw_stylebox=true **)** |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot_color_left<class_GraphNode_method_set_slot_color_left>` **(** :ref:`int<class_int>` slot_index, :ref:`Color<class_Color>` color **)**                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot_color_right<class_GraphNode_method_set_slot_color_right>` **(** :ref:`int<class_int>` slot_index, :ref:`Color<class_Color>` color **)**                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot_custom_icon_left<class_GraphNode_method_set_slot_custom_icon_left>` **(** :ref:`int<class_int>` slot_index, :ref:`Texture2D<class_Texture2D>` custom_icon **)**                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot_custom_icon_right<class_GraphNode_method_set_slot_custom_icon_right>` **(** :ref:`int<class_int>` slot_index, :ref:`Texture2D<class_Texture2D>` custom_icon **)**                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot_draw_stylebox<class_GraphNode_method_set_slot_draw_stylebox>` **(** :ref:`int<class_int>` slot_index, :ref:`bool<class_bool>` enable **)**                                                                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot_enabled_left<class_GraphNode_method_set_slot_enabled_left>` **(** :ref:`int<class_int>` slot_index, :ref:`bool<class_bool>` enable **)**                                                                                                                                                                                                                                                                                                                                           |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot_enabled_right<class_GraphNode_method_set_slot_enabled_right>` **(** :ref:`int<class_int>` slot_index, :ref:`bool<class_bool>` enable **)**                                                                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot_type_left<class_GraphNode_method_set_slot_type_left>` **(** :ref:`int<class_int>` slot_index, :ref:`int<class_int>` type **)**                                                                                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_slot_type_right<class_GraphNode_method_set_slot_type_right>` **(** :ref:`int<class_int>` slot_index, :ref:`int<class_int>` type **)**                                                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

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

.. table::
   :widths: auto

   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`resizer_color<class_GraphNode_theme_color_resizer_color>`         | ``Color(0.875, 0.875, 0.875, 1)`` |
   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`port_h_offset<class_GraphNode_theme_constant_port_h_offset>`      | ``0``                             |
   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`separation<class_GraphNode_theme_constant_separation>`            | ``2``                             |
   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`port<class_GraphNode_theme_icon_port>`                            |                                   |
   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+
   | :ref:`StyleBox<class_StyleBox>`   | :ref:`panel<class_GraphNode_theme_style_panel>`                         |                                   |
   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+
   | :ref:`StyleBox<class_StyleBox>`   | :ref:`panel_selected<class_GraphNode_theme_style_panel_selected>`       |                                   |
   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+
   | :ref:`StyleBox<class_StyleBox>`   | :ref:`slot<class_GraphNode_theme_style_slot>`                           |                                   |
   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+
   | :ref:`StyleBox<class_StyleBox>`   | :ref:`titlebar<class_GraphNode_theme_style_titlebar>`                   |                                   |
   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+
   | :ref:`StyleBox<class_StyleBox>`   | :ref:`titlebar_selected<class_GraphNode_theme_style_titlebar_selected>` |                                   |
   +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+

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

----

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

Signals
-------

.. _class_GraphNode_signal_slot_updated:

.. rst-class:: classref-signal

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

Emitted when any GraphNode's slot is updated.

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

----

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

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

.. _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_private_method__draw_port:

.. rst-class:: classref-method

void **_draw_port** **(** :ref:`int<class_int>` slot_index, :ref:`Vector2i<class_Vector2i>` position, :ref:`bool<class_bool>` left, :ref:`Color<class_Color>` color **)** |virtual|

.. container:: contribute

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

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

----

.. _class_GraphNode_method_clear_all_slots:

.. rst-class:: classref-method

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

Disables all slots of the GraphNode. This will remove all input/output ports from the GraphNode.

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

----

.. _class_GraphNode_method_clear_slot:

.. rst-class:: classref-method

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

Disables the slot with the given ``slot_index``. This will remove the corresponding input and output port from the GraphNode.

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

----

.. _class_GraphNode_method_get_input_port_color:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_input_port_color** **(** :ref:`int<class_int>` port_idx **)**

Returns the :ref:`Color<class_Color>` of the input port with the given ``port_idx``.

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

----

.. _class_GraphNode_method_get_input_port_count:

.. rst-class:: classref-method

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

Returns the number of slots with an enabled input port.

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

----

.. _class_GraphNode_method_get_input_port_position:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_input_port_position** **(** :ref:`int<class_int>` port_idx **)**

Returns the position of the input port with the given ``port_idx``.

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

----

.. _class_GraphNode_method_get_input_port_slot:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_input_port_slot** **(** :ref:`int<class_int>` port_idx **)**

Returns the corresponding slot index of the input port with the given ``port_idx``.

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

----

.. _class_GraphNode_method_get_input_port_type:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_input_port_type** **(** :ref:`int<class_int>` port_idx **)**

Returns the type of the input port with the given ``port_idx``.

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

----

.. _class_GraphNode_method_get_output_port_color:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_output_port_color** **(** :ref:`int<class_int>` port_idx **)**

Returns the :ref:`Color<class_Color>` of the output port with the given ``port_idx``.

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

----

.. _class_GraphNode_method_get_output_port_count:

.. rst-class:: classref-method

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

Returns the number of slots with an enabled output port.

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

----

.. _class_GraphNode_method_get_output_port_position:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_output_port_position** **(** :ref:`int<class_int>` port_idx **)**

Returns the position of the output port with the given ``port_idx``.

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

----

.. _class_GraphNode_method_get_output_port_slot:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_output_port_slot** **(** :ref:`int<class_int>` port_idx **)**

Returns the corresponding slot index of the output port with the given ``port_idx``.

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

----

.. _class_GraphNode_method_get_output_port_type:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_output_port_type** **(** :ref:`int<class_int>` port_idx **)**

Returns the type of the output port with the given ``port_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>` slot_index **)** |const|

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

.. 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>` slot_index **)** |const|

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

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

----

.. _class_GraphNode_method_get_slot_custom_icon_left:

.. rst-class:: classref-method

:ref:`Texture2D<class_Texture2D>` **get_slot_custom_icon_left** **(** :ref:`int<class_int>` slot_index **)** |const|

Returns the left (input) custom :ref:`Texture2D<class_Texture2D>` of the slot with the given ``slot_index``.

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

----

.. _class_GraphNode_method_get_slot_custom_icon_right:

.. rst-class:: classref-method

:ref:`Texture2D<class_Texture2D>` **get_slot_custom_icon_right** **(** :ref:`int<class_int>` slot_index **)** |const|

Returns the right (output) custom :ref:`Texture2D<class_Texture2D>` of the slot with the given ``slot_index``.

.. 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>` slot_index **)** |const|

Returns the left (input) type of the slot with the given ``slot_index``.

.. 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>` slot_index **)** |const|

Returns the right (output) type of the slot with the given ``slot_index``.

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

----

.. _class_GraphNode_method_get_titlebar_hbox:

.. rst-class:: classref-method

:ref:`HBoxContainer<class_HBoxContainer>` **get_titlebar_hbox** **(** **)**

Returns the :ref:`HBoxContainer<class_HBoxContainer>` used for the title bar, only containing a :ref:`Label<class_Label>` for displaying the title by default. This can be used to add custom controls to the title bar such as option or close buttons.

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

----

.. _class_GraphNode_method_is_slot_draw_stylebox:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_slot_draw_stylebox** **(** :ref:`int<class_int>` slot_index **)** |const|

Returns true if the background :ref:`StyleBox<class_StyleBox>` of the slot with the given ``slot_index`` is drawn.

.. 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>` slot_index **)** |const|

Returns ``true`` if left (input) side of the slot with the given ``slot_index`` 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>` slot_index **)** |const|

Returns ``true`` if right (output) side of the slot with the given ``slot_index`` is enabled.

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

----

.. _class_GraphNode_method_set_slot:

.. rst-class:: classref-method

void **set_slot** **(** :ref:`int<class_int>` slot_index, :ref:`bool<class_bool>` enable_left_port, :ref:`int<class_int>` type_left, :ref:`Color<class_Color>` color_left, :ref:`bool<class_bool>` enable_right_port, :ref:`int<class_int>` type_right, :ref:`Color<class_Color>` color_right, :ref:`Texture2D<class_Texture2D>` custom_icon_left=null, :ref:`Texture2D<class_Texture2D>` custom_icon_right=null, :ref:`bool<class_bool>` draw_stylebox=true **)**

Sets properties of the slot with the given ``slot_index``.

If ``enable_left_port``/``enable_right_port`` is ``true``, a port will appear and the slot will be able to be connected from this side.

With ``type_left``/``type_right`` an arbitrary type can be assigned to each port. Two ports can be connected if they share the same type, or if the connection between their types is allowed in the parent :ref:`GraphEdit<class_GraphEdit>` (see :ref:`GraphEdit.add_valid_connection_type<class_GraphEdit_method_add_valid_connection_type>`). Keep in mind that the :ref:`GraphEdit<class_GraphEdit>` has the final say in accepting the connection. Type compatibility simply allows the :ref:`GraphEdit.connection_request<class_GraphEdit_signal_connection_request>` signal to be emitted.

Ports can be further customized using ``color_left``/``color_right`` and ``custom_icon_left``/``custom_icon_right``. The color parameter adds a tint to the icon. The custom icon can be used to override the default port dot.

Additionally, ``draw_stylebox`` can be used to enable or disable drawing of the background stylebox for each slot. See :ref:`slot<class_GraphNode_theme_style_slot>`.

Individual properties can also be set using one of the ``set_slot_*`` methods.

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

.. 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>` slot_index, :ref:`Color<class_Color>` color **)**

Sets the :ref:`Color<class_Color>` of the left (input) side of the slot with the given ``slot_index`` to ``color``.

.. 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>` slot_index, :ref:`Color<class_Color>` color **)**

Sets the :ref:`Color<class_Color>` of the right (output) side of the slot with the given ``slot_index`` to ``color``.

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

----

.. _class_GraphNode_method_set_slot_custom_icon_left:

.. rst-class:: classref-method

void **set_slot_custom_icon_left** **(** :ref:`int<class_int>` slot_index, :ref:`Texture2D<class_Texture2D>` custom_icon **)**

Sets the custom :ref:`Texture2D<class_Texture2D>` of the left (input) side of the slot with the given ``slot_index`` to ``custom_icon``.

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

----

.. _class_GraphNode_method_set_slot_custom_icon_right:

.. rst-class:: classref-method

void **set_slot_custom_icon_right** **(** :ref:`int<class_int>` slot_index, :ref:`Texture2D<class_Texture2D>` custom_icon **)**

Sets the custom :ref:`Texture2D<class_Texture2D>` of the right (output) side of the slot with the given ``slot_index`` to ``custom_icon``.

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

----

.. _class_GraphNode_method_set_slot_draw_stylebox:

.. rst-class:: classref-method

void **set_slot_draw_stylebox** **(** :ref:`int<class_int>` slot_index, :ref:`bool<class_bool>` enable **)**

Toggles the background :ref:`StyleBox<class_StyleBox>` of the slot with the given ``slot_index``.

.. 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>` slot_index, :ref:`bool<class_bool>` enable **)**

Toggles the left (input) side of the slot with the given ``slot_index``. If ``enable`` 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>` slot_index, :ref:`bool<class_bool>` enable **)**

Toggles the right (output) side of the slot with the given ``slot_index``. If ``enable`` 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>` slot_index, :ref:`int<class_int>` type **)**

Sets the left (input) type of the slot with the given ``slot_index`` to ``type``. If the value is negative, all connections will be disallowed to be created via user inputs.

.. 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>` slot_index, :ref:`int<class_int>` type **)**

Sets the right (output) type of the slot with the given ``slot_index`` to ``type``. If the value is negative, all connections will be disallowed to be created via user inputs.

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

----

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

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

.. _class_GraphNode_theme_color_resizer_color:

.. rst-class:: classref-themeproperty

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

The color modulation applied to the resizer icon.

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

----

.. _class_GraphNode_theme_constant_port_h_offset:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **port_h_offset** = ``0``

Horizontal offset for the ports.

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

----

.. _class_GraphNode_theme_constant_separation:

.. rst-class:: classref-themeproperty

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

The vertical distance between ports.

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

----

.. _class_GraphNode_theme_icon_port:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **port**

The icon used for representing ports.

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

----

.. _class_GraphNode_theme_style_panel:

.. rst-class:: classref-themeproperty

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

The default background for the slot area of the **GraphNode**.

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

----

.. _class_GraphNode_theme_style_panel_selected:

.. rst-class:: classref-themeproperty

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

The :ref:`StyleBox<class_StyleBox>` used for the slot area when selected.

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

----

.. _class_GraphNode_theme_style_slot:

.. rst-class:: classref-themeproperty

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

The :ref:`StyleBox<class_StyleBox>` used for each slot of the **GraphNode**.

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

----

.. _class_GraphNode_theme_style_titlebar:

.. rst-class:: classref-themeproperty

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

The :ref:`StyleBox<class_StyleBox>` used for the title bar of the **GraphNode**.

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

----

.. _class_GraphNode_theme_style_titlebar_selected:

.. rst-class:: classref-themeproperty

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

The :ref:`StyleBox<class_StyleBox>` used for the title bar of the **GraphNode** when it 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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`