godot-docs/classes/class_graphedit.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/GraphEdit.xml.

.. _class_GraphEdit:

GraphEdit
=========

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

GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them.

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

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

GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNode slots is disabled by default.

It is greatly advised to enable low-processor usage mode (see :ref:`OS.low_processor_usage_mode<class_OS_property_low_processor_usage_mode>`) when using GraphEdits.

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

Properties
----------

.. table::
   :widths: auto

   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode                                                           | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`)           |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                  | :ref:`minimap_enabled<class_GraphEdit_property_minimap_enabled>`     | ``true``                                                                      |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                | :ref:`minimap_opacity<class_GraphEdit_property_minimap_opacity>`     | ``0.65``                                                                      |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`            | :ref:`minimap_size<class_GraphEdit_property_minimap_size>`           | ``Vector2( 240, 160 )``                                                       |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                  | rect_clip_content                                                    | ``true`` (overrides :ref:`Control<class_Control_property_rect_clip_content>`) |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                  | :ref:`right_disconnects<class_GraphEdit_property_right_disconnects>` | ``false``                                                                     |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`            | :ref:`scroll_offset<class_GraphEdit_property_scroll_offset>`         | ``Vector2( 0, 0 )``                                                           |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                  | :ref:`show_zoom_label<class_GraphEdit_property_show_zoom_label>`     | ``false``                                                                     |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                    | :ref:`snap_distance<class_GraphEdit_property_snap_distance>`         | ``20``                                                                        |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                  | :ref:`use_snap<class_GraphEdit_property_use_snap>`                   | ``true``                                                                      |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                | :ref:`zoom<class_GraphEdit_property_zoom>`                           | ``1.0``                                                                       |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                | :ref:`zoom_max<class_GraphEdit_property_zoom_max>`                   | ``2.0736``                                                                    |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                | :ref:`zoom_min<class_GraphEdit_property_zoom_min>`                   | ``0.232568``                                                                  |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                | :ref:`zoom_step<class_GraphEdit_property_zoom_step>`                 | ``1.2``                                                                       |
   +------------------------------------------+----------------------------------------------------------------------+-------------------------------------------------------------------------------+

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

Methods
-------

.. table::
   :widths: auto

   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`add_valid_connection_type<class_GraphEdit_method_add_valid_connection_type>` **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)**                                                                                                 |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`add_valid_left_disconnect_type<class_GraphEdit_method_add_valid_left_disconnect_type>` **(** :ref:`int<class_int>` type **)**                                                                                                                           |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`add_valid_right_disconnect_type<class_GraphEdit_method_add_valid_right_disconnect_type>` **(** :ref:`int<class_int>` type **)**                                                                                                                         |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`clear_connections<class_GraphEdit_method_clear_connections>` **(** **)**                                                                                                                                                                                |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`connect_node<class_GraphEdit_method_connect_node>` **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_port, :ref:`String<class_String>` to, :ref:`int<class_int>` to_port **)**                                                         |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`disconnect_node<class_GraphEdit_method_disconnect_node>` **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_port, :ref:`String<class_String>` to, :ref:`int<class_int>` to_port **)**                                                   |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`                 | :ref:`get_connection_list<class_GraphEdit_method_get_connection_list>` **(** **)** |const|                                                                                                                                                                    |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`HBoxContainer<class_HBoxContainer>` | :ref:`get_zoom_hbox<class_GraphEdit_method_get_zoom_hbox>` **(** **)**                                                                                                                                                                                        |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                   | :ref:`is_node_connected<class_GraphEdit_method_is_node_connected>` **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_port, :ref:`String<class_String>` to, :ref:`int<class_int>` to_port **)**                                               |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                   | :ref:`is_valid_connection_type<class_GraphEdit_method_is_valid_connection_type>` **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)** |const|                                                                                           |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`remove_valid_connection_type<class_GraphEdit_method_remove_valid_connection_type>` **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)**                                                                                           |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`remove_valid_left_disconnect_type<class_GraphEdit_method_remove_valid_left_disconnect_type>` **(** :ref:`int<class_int>` type **)**                                                                                                                     |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`remove_valid_right_disconnect_type<class_GraphEdit_method_remove_valid_right_disconnect_type>` **(** :ref:`int<class_int>` type **)**                                                                                                                   |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_connection_activity<class_GraphEdit_method_set_connection_activity>` **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_port, :ref:`String<class_String>` to, :ref:`int<class_int>` to_port, :ref:`float<class_float>` amount **)** |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                      | :ref:`set_selected<class_GraphEdit_method_set_selected>` **(** :ref:`Node<class_Node>` node **)**                                                                                                                                                             |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

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

.. table::
   :widths: auto

   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Color<class_Color>`       | :ref:`activity<class_GraphEdit_theme_color_activity>`                                              | ``Color( 1, 1, 1, 1 )``    |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Color<class_Color>`       | :ref:`grid_major<class_GraphEdit_theme_color_grid_major>`                                          | ``Color( 1, 1, 1, 0.2 )``  |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Color<class_Color>`       | :ref:`grid_minor<class_GraphEdit_theme_color_grid_minor>`                                          | ``Color( 1, 1, 1, 0.05 )`` |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Color<class_Color>`       | :ref:`selection_fill<class_GraphEdit_theme_color_selection_fill>`                                  | ``Color( 1, 1, 1, 0.3 )``  |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Color<class_Color>`       | :ref:`selection_stroke<class_GraphEdit_theme_color_selection_stroke>`                              | ``Color( 1, 1, 1, 0.8 )``  |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`int<class_int>`           | :ref:`bezier_len_neg<class_GraphEdit_theme_constant_bezier_len_neg>`                               | ``160``                    |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`int<class_int>`           | :ref:`bezier_len_pos<class_GraphEdit_theme_constant_bezier_len_pos>`                               | ``80``                     |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`int<class_int>`           | :ref:`port_grab_distance_horizontal<class_GraphEdit_theme_constant_port_grab_distance_horizontal>` | ``24``                     |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`int<class_int>`           | :ref:`port_grab_distance_vertical<class_GraphEdit_theme_constant_port_grab_distance_vertical>`     | ``26``                     |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`minimap<class_GraphEdit_theme_icon_minimap>`                                                 |                            |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`minus<class_GraphEdit_theme_icon_minus>`                                                     |                            |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`more<class_GraphEdit_theme_icon_more>`                                                       |                            |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`reset<class_GraphEdit_theme_icon_reset>`                                                     |                            |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`snap<class_GraphEdit_theme_icon_snap>`                                                       |                            |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`bg<class_GraphEdit_theme_style_bg>`                                                          |                            |
   +---------------------------------+----------------------------------------------------------------------------------------------------+----------------------------+

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

----

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

Signals
-------

.. _class_GraphEdit_signal__begin_node_move:

.. rst-class:: classref-signal

**_begin_node_move** **(** **)**

Emitted at the beginning of a GraphNode movement.

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

----

.. _class_GraphEdit_signal__end_node_move:

.. rst-class:: classref-signal

**_end_node_move** **(** **)**

Emitted at the end of a GraphNode movement.

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

----

.. _class_GraphEdit_signal_connection_from_empty:

.. rst-class:: classref-signal

**connection_from_empty** **(** :ref:`String<class_String>` to, :ref:`int<class_int>` to_slot, :ref:`Vector2<class_Vector2>` release_position **)**

Emitted when user dragging connection from input port into empty space of the graph.

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

----

.. _class_GraphEdit_signal_connection_request:

.. rst-class:: classref-signal

**connection_request** **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_String>` to, :ref:`int<class_int>` to_slot **)**

Emitted to the GraphEdit when the connection between the ``from_slot`` slot of the ``from`` GraphNode and the ``to_slot`` slot of the ``to`` GraphNode is attempted to be created.

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

----

.. _class_GraphEdit_signal_connection_to_empty:

.. rst-class:: classref-signal

**connection_to_empty** **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_slot, :ref:`Vector2<class_Vector2>` release_position **)**

Emitted when user dragging connection from output port into empty space of the graph.

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

----

.. _class_GraphEdit_signal_copy_nodes_request:

.. rst-class:: classref-signal

**copy_nodes_request** **(** **)**

Emitted when the user presses :kbd:`Ctrl + C`.

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

----

.. _class_GraphEdit_signal_delete_nodes_request:

.. rst-class:: classref-signal

**delete_nodes_request** **(** :ref:`Array<class_Array>` nodes **)**

Emitted when a GraphNode is attempted to be removed from the GraphEdit. Provides a list of node names to be removed (all selected nodes, excluding nodes without closing button).

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

----

.. _class_GraphEdit_signal_disconnection_request:

.. rst-class:: classref-signal

**disconnection_request** **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_String>` to, :ref:`int<class_int>` to_slot **)**

Emitted to the GraphEdit when the connection between ``from_slot`` slot of ``from`` GraphNode and ``to_slot`` slot of ``to`` GraphNode is attempted to be removed.

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

----

.. _class_GraphEdit_signal_duplicate_nodes_request:

.. rst-class:: classref-signal

**duplicate_nodes_request** **(** **)**

Emitted when a GraphNode is attempted to be duplicated in the GraphEdit.

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

----

.. _class_GraphEdit_signal_node_selected:

.. rst-class:: classref-signal

**node_selected** **(** :ref:`Node<class_Node>` node **)**

Emitted when a GraphNode is selected.

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

----

.. _class_GraphEdit_signal_node_unselected:

.. rst-class:: classref-signal

**node_unselected** **(** :ref:`Node<class_Node>` node **)**

.. container:: contribute

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

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

----

.. _class_GraphEdit_signal_paste_nodes_request:

.. rst-class:: classref-signal

**paste_nodes_request** **(** **)**

Emitted when the user presses :kbd:`Ctrl + V`.

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

----

.. _class_GraphEdit_signal_popup_request:

.. rst-class:: classref-signal

**popup_request** **(** :ref:`Vector2<class_Vector2>` position **)**

Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. ``position`` is the position of the mouse pointer when the signal is sent.

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

----

.. _class_GraphEdit_signal_scroll_offset_changed:

.. rst-class:: classref-signal

**scroll_offset_changed** **(** :ref:`Vector2<class_Vector2>` ofs **)**

Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code.

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

----

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

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

.. _class_GraphEdit_property_minimap_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **minimap_enabled** = ``true``

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

- void **set_minimap_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_minimap_enabled** **(** **)**

If ``true``, the minimap is visible.

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

----

.. _class_GraphEdit_property_minimap_opacity:

.. rst-class:: classref-property

:ref:`float<class_float>` **minimap_opacity** = ``0.65``

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

- void **set_minimap_opacity** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_minimap_opacity** **(** **)**

The opacity of the minimap rectangle.

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

----

.. _class_GraphEdit_property_minimap_size:

.. rst-class:: classref-property

:ref:`Vector2<class_Vector2>` **minimap_size** = ``Vector2( 240, 160 )``

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

- void **set_minimap_size** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_minimap_size** **(** **)**

The size of the minimap rectangle. The map itself is based on the size of the grid area and is scaled to fit this rectangle.

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

----

.. _class_GraphEdit_property_right_disconnects:

.. rst-class:: classref-property

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

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

- void **set_right_disconnects** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_right_disconnects_enabled** **(** **)**

If ``true``, enables disconnection of existing connections in the GraphEdit by dragging the right end.

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

----

.. _class_GraphEdit_property_scroll_offset:

.. rst-class:: classref-property

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

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

- void **set_scroll_ofs** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_scroll_ofs** **(** **)**

The scroll offset.

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

----

.. _class_GraphEdit_property_show_zoom_label:

.. rst-class:: classref-property

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

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

- void **set_show_zoom_label** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_showing_zoom_label** **(** **)**

If ``true``, makes a label with the current zoom level visible. The zoom value is displayed in percents.

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

----

.. _class_GraphEdit_property_snap_distance:

.. rst-class:: classref-property

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

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

- void **set_snap** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_snap** **(** **)**

The snapping distance in pixels.

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

----

.. _class_GraphEdit_property_use_snap:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **use_snap** = ``true``

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

- void **set_use_snap** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_using_snap** **(** **)**

If ``true``, enables snapping.

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

----

.. _class_GraphEdit_property_zoom:

.. rst-class:: classref-property

:ref:`float<class_float>` **zoom** = ``1.0``

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

- void **set_zoom** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_zoom** **(** **)**

The current zoom value.

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

----

.. _class_GraphEdit_property_zoom_max:

.. rst-class:: classref-property

:ref:`float<class_float>` **zoom_max** = ``2.0736``

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

- void **set_zoom_max** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_zoom_max** **(** **)**

The upper zoom limit.

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

----

.. _class_GraphEdit_property_zoom_min:

.. rst-class:: classref-property

:ref:`float<class_float>` **zoom_min** = ``0.232568``

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

- void **set_zoom_min** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_zoom_min** **(** **)**

The lower zoom limit.

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

----

.. _class_GraphEdit_property_zoom_step:

.. rst-class:: classref-property

:ref:`float<class_float>` **zoom_step** = ``1.2``

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

- void **set_zoom_step** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_zoom_step** **(** **)**

The step of each zoom level.

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

----

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

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

.. _class_GraphEdit_method_add_valid_connection_type:

.. rst-class:: classref-method

void **add_valid_connection_type** **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)**

Makes possible the connection between two different slot types. The type is defined with the :ref:`GraphNode.set_slot<class_GraphNode_method_set_slot>` method.

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

----

.. _class_GraphEdit_method_add_valid_left_disconnect_type:

.. rst-class:: classref-method

void **add_valid_left_disconnect_type** **(** :ref:`int<class_int>` type **)**

Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type.

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

----

.. _class_GraphEdit_method_add_valid_right_disconnect_type:

.. rst-class:: classref-method

void **add_valid_right_disconnect_type** **(** :ref:`int<class_int>` type **)**

Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type.

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

----

.. _class_GraphEdit_method_clear_connections:

.. rst-class:: classref-method

void **clear_connections** **(** **)**

Removes all connections between nodes.

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

----

.. _class_GraphEdit_method_connect_node:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **connect_node** **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_port, :ref:`String<class_String>` to, :ref:`int<class_int>` to_port **)**

Create a connection between the ``from_port`` slot of the ``from`` GraphNode and the ``to_port`` slot of the ``to`` GraphNode. If the connection already exists, no connection is created.

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

----

.. _class_GraphEdit_method_disconnect_node:

.. rst-class:: classref-method

void **disconnect_node** **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_port, :ref:`String<class_String>` to, :ref:`int<class_int>` to_port **)**

Removes the connection between the ``from_port`` slot of the ``from`` GraphNode and the ``to_port`` slot of the ``to`` GraphNode. If the connection does not exist, no connection is removed.

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

----

.. _class_GraphEdit_method_get_connection_list:

.. rst-class:: classref-method

:ref:`Array<class_Array>` **get_connection_list** **(** **)** |const|

Returns an Array containing the list of connections. A connection consists in a structure of the form ``{ from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" }``.

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

----

.. _class_GraphEdit_method_get_zoom_hbox:

.. rst-class:: classref-method

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

Gets the :ref:`HBoxContainer<class_HBoxContainer>` that contains the zooming and grid snap controls in the top left of the graph. You can use this method to reposition the toolbar or to add your own custom controls to it.

\ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.

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

----

.. _class_GraphEdit_method_is_node_connected:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_node_connected** **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_port, :ref:`String<class_String>` to, :ref:`int<class_int>` to_port **)**

Returns ``true`` if the ``from_port`` slot of the ``from`` GraphNode is connected to the ``to_port`` slot of the ``to`` GraphNode.

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

----

.. _class_GraphEdit_method_is_valid_connection_type:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_valid_connection_type** **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)** |const|

Returns whether it's possible to connect slots of the specified types.

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

----

.. _class_GraphEdit_method_remove_valid_connection_type:

.. rst-class:: classref-method

void **remove_valid_connection_type** **(** :ref:`int<class_int>` from_type, :ref:`int<class_int>` to_type **)**

Makes it not possible to connect between two different slot types. The type is defined with the :ref:`GraphNode.set_slot<class_GraphNode_method_set_slot>` method.

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

----

.. _class_GraphEdit_method_remove_valid_left_disconnect_type:

.. rst-class:: classref-method

void **remove_valid_left_disconnect_type** **(** :ref:`int<class_int>` type **)**

Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type.

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

----

.. _class_GraphEdit_method_remove_valid_right_disconnect_type:

.. rst-class:: classref-method

void **remove_valid_right_disconnect_type** **(** :ref:`int<class_int>` type **)**

Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type.

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

----

.. _class_GraphEdit_method_set_connection_activity:

.. rst-class:: classref-method

void **set_connection_activity** **(** :ref:`String<class_String>` from, :ref:`int<class_int>` from_port, :ref:`String<class_String>` to, :ref:`int<class_int>` to_port, :ref:`float<class_float>` amount **)**

Sets the coloration of the connection between ``from``'s ``from_port`` and ``to``'s ``to_port`` with the color provided in the ``activity`` theme property.

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

----

.. _class_GraphEdit_method_set_selected:

.. rst-class:: classref-method

void **set_selected** **(** :ref:`Node<class_Node>` node **)**

Sets the specified ``node`` as the one selected.

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

----

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

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

.. _class_GraphEdit_theme_color_activity:

.. rst-class:: classref-themeproperty

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

.. 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_GraphEdit_theme_color_grid_major:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **grid_major** = ``Color( 1, 1, 1, 0.2 )``

Color of major grid lines.

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

----

.. _class_GraphEdit_theme_color_grid_minor:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **grid_minor** = ``Color( 1, 1, 1, 0.05 )``

Color of minor grid lines.

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

----

.. _class_GraphEdit_theme_color_selection_fill:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **selection_fill** = ``Color( 1, 1, 1, 0.3 )``

The fill color of the selection rectangle.

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

----

.. _class_GraphEdit_theme_color_selection_stroke:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **selection_stroke** = ``Color( 1, 1, 1, 0.8 )``

The outline color of the selection rectangle.

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

----

.. _class_GraphEdit_theme_constant_bezier_len_neg:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **bezier_len_neg** = ``160``

.. 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_GraphEdit_theme_constant_bezier_len_pos:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **bezier_len_pos** = ``80``

.. 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_GraphEdit_theme_constant_port_grab_distance_horizontal:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **port_grab_distance_horizontal** = ``24``

The horizontal range within which a port can be grabbed (on both sides).

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

----

.. _class_GraphEdit_theme_constant_port_grab_distance_vertical:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **port_grab_distance_vertical** = ``26``

The vertical range within which a port can be grabbed (on both sides).

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

----

.. _class_GraphEdit_theme_icon_minimap:

.. rst-class:: classref-themeproperty

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

.. 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_GraphEdit_theme_icon_minus:

.. rst-class:: classref-themeproperty

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

The icon for the zoom out button.

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

----

.. _class_GraphEdit_theme_icon_more:

.. rst-class:: classref-themeproperty

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

The icon for the zoom in button.

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

----

.. _class_GraphEdit_theme_icon_reset:

.. rst-class:: classref-themeproperty

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

The icon for the zoom reset button.

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

----

.. _class_GraphEdit_theme_icon_snap:

.. rst-class:: classref-themeproperty

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

The icon for the snap toggle button.

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

----

.. _class_GraphEdit_theme_style_bg:

.. rst-class:: classref-themeproperty

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

The background drawn under the grid.

.. |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.)`