godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (705b7a0)

Browse Source
This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
classes/class_graphedit.rst
View File

@@ -214,7 +214,7 @@ Signals
.. rst-class:: classref-signal
**begin_node_move**\ (\ )
**begin_node_move**\ (\ ) :ref:`🔗<class_GraphEdit_signal_begin_node_move>`
Emitted at the beginning of a :ref:`GraphElement<class_GraphElement>`'s movement.
@@ -226,7 +226,7 @@ Emitted at the beginning of a :ref:`GraphElement<class_GraphElement>`'s movement
.. rst-class:: classref-signal
**connection_drag_ended**\ (\ )
**connection_drag_ended**\ (\ ) :ref:`🔗<class_GraphEdit_signal_connection_drag_ended>`
Emitted at the end of a connection drag.
@@ -238,7 +238,7 @@ Emitted at the end of a connection drag.
.. rst-class:: classref-signal
**connection_drag_started**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, is_output\: :ref:`bool<class_bool>`\ )
**connection_drag_started**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, is_output\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_GraphEdit_signal_connection_drag_started>`
Emitted at the beginning of a connection drag.
@@ -250,7 +250,7 @@ Emitted at the beginning of a connection drag.
.. rst-class:: classref-signal
**connection_from_empty**\ (\ to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`, release_position\: :ref:`Vector2<class_Vector2>`\ )
**connection_from_empty**\ (\ to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`, release_position\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_GraphEdit_signal_connection_from_empty>`
Emitted when user drags a connection from an input port into the empty space of the graph.
@@ -262,7 +262,7 @@ Emitted when user drags a connection from an input port into the empty space of
.. rst-class:: classref-signal
**connection_request**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ )
**connection_request**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_signal_connection_request>`
Emitted to the GraphEdit when the connection between the ``from_port`` of the ``from_node`` :ref:`GraphNode<class_GraphNode>` and the ``to_port`` of the ``to_node`` :ref:`GraphNode<class_GraphNode>` is attempted to be created.
@@ -274,7 +274,7 @@ Emitted to the GraphEdit when the connection between the ``from_port`` of the ``
.. rst-class:: classref-signal
**connection_to_empty**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, release_position\: :ref:`Vector2<class_Vector2>`\ )
**connection_to_empty**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, release_position\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_GraphEdit_signal_connection_to_empty>`
Emitted when user drags a connection from an output port into the empty space of the graph.
@@ -286,7 +286,7 @@ Emitted when user drags a connection from an output port into the empty space of
.. rst-class:: classref-signal
**copy_nodes_request**\ (\ )
**copy_nodes_request**\ (\ ) :ref:`🔗<class_GraphEdit_signal_copy_nodes_request>`
Emitted when this **GraphEdit** captures a ``ui_copy`` action (:kbd:`Ctrl + C` by default). In general, this signal indicates that the selected :ref:`GraphElement<class_GraphElement>`\ s should be copied.
@@ -298,7 +298,7 @@ Emitted when this **GraphEdit** captures a ``ui_copy`` action (:kbd:`Ctrl + C` b
.. rst-class:: classref-signal
**delete_nodes_request**\ (\ nodes\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\]\ )
**delete_nodes_request**\ (\ nodes\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\]\ ) :ref:`🔗<class_GraphEdit_signal_delete_nodes_request>`
Emitted when this **GraphEdit** captures a ``ui_graph_delete`` action (:kbd:`Delete` by default).
@@ -312,7 +312,7 @@ Emitted when this **GraphEdit** captures a ``ui_graph_delete`` action (:kbd:`Del
.. rst-class:: classref-signal
**disconnection_request**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ )
**disconnection_request**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_signal_disconnection_request>`
Emitted to the GraphEdit when the connection between ``from_port`` of ``from_node`` :ref:`GraphNode<class_GraphNode>` and ``to_port`` of ``to_node`` :ref:`GraphNode<class_GraphNode>` is attempted to be removed.
@@ -324,7 +324,7 @@ Emitted to the GraphEdit when the connection between ``from_port`` of ``from_nod
.. rst-class:: classref-signal
**duplicate_nodes_request**\ (\ )
**duplicate_nodes_request**\ (\ ) :ref:`🔗<class_GraphEdit_signal_duplicate_nodes_request>`
Emitted when this **GraphEdit** captures a ``ui_graph_duplicate`` action (:kbd:`Ctrl + D` by default). In general, this signal indicates that the selected :ref:`GraphElement<class_GraphElement>`\ s should be duplicated.
@@ -336,7 +336,7 @@ Emitted when this **GraphEdit** captures a ``ui_graph_duplicate`` action (:kbd:`
.. rst-class:: classref-signal
**end_node_move**\ (\ )
**end_node_move**\ (\ ) :ref:`🔗<class_GraphEdit_signal_end_node_move>`
Emitted at the end of a :ref:`GraphElement<class_GraphElement>`'s movement.
@@ -348,7 +348,7 @@ Emitted at the end of a :ref:`GraphElement<class_GraphElement>`'s movement.
.. rst-class:: classref-signal
**frame_rect_changed**\ (\ frame\: :ref:`GraphFrame<class_GraphFrame>`, new_rect\: :ref:`Vector2<class_Vector2>`\ )
**frame_rect_changed**\ (\ frame\: :ref:`GraphFrame<class_GraphFrame>`, new_rect\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_GraphEdit_signal_frame_rect_changed>`
Emitted when the :ref:`GraphFrame<class_GraphFrame>` ``frame`` is resized to ``new_rect``.
@@ -360,7 +360,7 @@ Emitted when the :ref:`GraphFrame<class_GraphFrame>` ``frame`` is resized to ``n
.. rst-class:: classref-signal
**graph_elements_linked_to_frame_request**\ (\ elements\: :ref:`Array<class_Array>`, frame\: :ref:`StringName<class_StringName>`\ )
**graph_elements_linked_to_frame_request**\ (\ elements\: :ref:`Array<class_Array>`, frame\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_GraphEdit_signal_graph_elements_linked_to_frame_request>`
Emitted when one or more :ref:`GraphElement<class_GraphElement>`\ s are dropped onto the :ref:`GraphFrame<class_GraphFrame>` named ``frame``, when they were not previously attached to any other one.
@@ -374,7 +374,7 @@ Emitted when one or more :ref:`GraphElement<class_GraphElement>`\ s are dropped
.. rst-class:: classref-signal
**node_deselected**\ (\ node\: :ref:`Node<class_Node>`\ )
**node_deselected**\ (\ node\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_GraphEdit_signal_node_deselected>`
Emitted when the given :ref:`GraphElement<class_GraphElement>` node is deselected.
@@ -386,7 +386,7 @@ Emitted when the given :ref:`GraphElement<class_GraphElement>` node is deselecte
.. rst-class:: classref-signal
**node_selected**\ (\ node\: :ref:`Node<class_Node>`\ )
**node_selected**\ (\ node\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_GraphEdit_signal_node_selected>`
Emitted when the given :ref:`GraphElement<class_GraphElement>` node is selected.
@@ -398,7 +398,7 @@ Emitted when the given :ref:`GraphElement<class_GraphElement>` node is selected.
.. rst-class:: classref-signal
**paste_nodes_request**\ (\ )
**paste_nodes_request**\ (\ ) :ref:`🔗<class_GraphEdit_signal_paste_nodes_request>`
Emitted when this **GraphEdit** captures a ``ui_paste`` action (:kbd:`Ctrl + V` by default). In general, this signal indicates that previously copied :ref:`GraphElement<class_GraphElement>`\ s should be pasted.
@@ -410,7 +410,7 @@ Emitted when this **GraphEdit** captures a ``ui_paste`` action (:kbd:`Ctrl + V`
.. rst-class:: classref-signal
**popup_request**\ (\ at_position\: :ref:`Vector2<class_Vector2>`\ )
**popup_request**\ (\ at_position\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_GraphEdit_signal_popup_request>`
Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. ``at_position`` is the position of the mouse pointer when the signal is sent.
@@ -422,7 +422,7 @@ Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. `
.. rst-class:: classref-signal
**scroll_offset_changed**\ (\ offset\: :ref:`Vector2<class_Vector2>`\ )
**scroll_offset_changed**\ (\ offset\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_GraphEdit_signal_scroll_offset_changed>`
Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code.
@@ -439,7 +439,7 @@ Enumerations
.. rst-class:: classref-enumeration
enum **PanningScheme**:
enum **PanningScheme**: :ref:`🔗<enum_GraphEdit_PanningScheme>`
.. _class_GraphEdit_constant_SCROLL_ZOOMS:
@@ -465,7 +465,7 @@ enum **PanningScheme**:
.. rst-class:: classref-enumeration
enum **GridPattern**:
enum **GridPattern**: :ref:`🔗<enum_GraphEdit_GridPattern>`
.. _class_GraphEdit_constant_GRID_PATTERN_LINES:
@@ -496,7 +496,7 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`bool<class_bool>` **connection_lines_antialiased** = ``true``
:ref:`bool<class_bool>` **connection_lines_antialiased** = ``true`` :ref:`🔗<class_GraphEdit_property_connection_lines_antialiased>`
.. rst-class:: classref-property-setget
@@ -513,7 +513,7 @@ If ``true``, the lines between nodes will use antialiasing.
.. rst-class:: classref-property
:ref:`float<class_float>` **connection_lines_curvature** = ``0.5``
:ref:`float<class_float>` **connection_lines_curvature** = ``0.5`` :ref:`🔗<class_GraphEdit_property_connection_lines_curvature>`
.. rst-class:: classref-property-setget
@@ -530,7 +530,7 @@ The curvature of the lines between the nodes. 0 results in straight lines.
.. rst-class:: classref-property
:ref:`float<class_float>` **connection_lines_thickness** = ``4.0``
:ref:`float<class_float>` **connection_lines_thickness** = ``4.0`` :ref:`🔗<class_GraphEdit_property_connection_lines_thickness>`
.. rst-class:: classref-property-setget
@@ -547,7 +547,7 @@ The thickness of the lines between the nodes.
.. rst-class:: classref-property
:ref:`GridPattern<enum_GraphEdit_GridPattern>` **grid_pattern** = ``0``
:ref:`GridPattern<enum_GraphEdit_GridPattern>` **grid_pattern** = ``0`` :ref:`🔗<class_GraphEdit_property_grid_pattern>`
.. rst-class:: classref-property-setget
@@ -564,7 +564,7 @@ The pattern used for drawing the grid.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **minimap_enabled** = ``true``
:ref:`bool<class_bool>` **minimap_enabled** = ``true`` :ref:`🔗<class_GraphEdit_property_minimap_enabled>`
.. rst-class:: classref-property-setget
@@ -581,7 +581,7 @@ If ``true``, the minimap is visible.
.. rst-class:: classref-property
:ref:`float<class_float>` **minimap_opacity** = ``0.65``
:ref:`float<class_float>` **minimap_opacity** = ``0.65`` :ref:`🔗<class_GraphEdit_property_minimap_opacity>`
.. rst-class:: classref-property-setget
@@ -598,7 +598,7 @@ The opacity of the minimap rectangle.
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **minimap_size** = ``Vector2(240, 160)``
:ref:`Vector2<class_Vector2>` **minimap_size** = ``Vector2(240, 160)`` :ref:`🔗<class_GraphEdit_property_minimap_size>`
.. rst-class:: classref-property-setget
@@ -615,7 +615,7 @@ The size of the minimap rectangle. The map itself is based on the size of the gr
.. rst-class:: classref-property
:ref:`PanningScheme<enum_GraphEdit_PanningScheme>` **panning_scheme** = ``0``
:ref:`PanningScheme<enum_GraphEdit_PanningScheme>` **panning_scheme** = ``0`` :ref:`🔗<class_GraphEdit_property_panning_scheme>`
.. rst-class:: classref-property-setget
@@ -632,7 +632,7 @@ Defines the control scheme for panning with mouse wheel.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **right_disconnects** = ``false``
:ref:`bool<class_bool>` **right_disconnects** = ``false`` :ref:`🔗<class_GraphEdit_property_right_disconnects>`
.. rst-class:: classref-property-setget
@@ -649,7 +649,7 @@ If ``true``, enables disconnection of existing connections in the GraphEdit by d
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **scroll_offset** = ``Vector2(0, 0)``
:ref:`Vector2<class_Vector2>` **scroll_offset** = ``Vector2(0, 0)`` :ref:`🔗<class_GraphEdit_property_scroll_offset>`
.. rst-class:: classref-property-setget
@@ -666,7 +666,7 @@ The scroll offset.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_arrange_button** = ``true``
:ref:`bool<class_bool>` **show_arrange_button** = ``true`` :ref:`🔗<class_GraphEdit_property_show_arrange_button>`
.. rst-class:: classref-property-setget
@@ -683,7 +683,7 @@ If ``true``, the button to automatically arrange graph nodes is visible.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_grid** = ``true``
:ref:`bool<class_bool>` **show_grid** = ``true`` :ref:`🔗<class_GraphEdit_property_show_grid>`
.. rst-class:: classref-property-setget
@@ -700,7 +700,7 @@ If ``true``, the grid is visible.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_grid_buttons** = ``true``
:ref:`bool<class_bool>` **show_grid_buttons** = ``true`` :ref:`🔗<class_GraphEdit_property_show_grid_buttons>`
.. rst-class:: classref-property-setget
@@ -717,7 +717,7 @@ If ``true``, buttons that allow to configure grid and snapping options are visib
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_menu** = ``true``
:ref:`bool<class_bool>` **show_menu** = ``true`` :ref:`🔗<class_GraphEdit_property_show_menu>`
.. rst-class:: classref-property-setget
@@ -734,7 +734,7 @@ If ``true``, the menu toolbar is visible.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_minimap_button** = ``true``
:ref:`bool<class_bool>` **show_minimap_button** = ``true`` :ref:`🔗<class_GraphEdit_property_show_minimap_button>`
.. rst-class:: classref-property-setget
@@ -751,7 +751,7 @@ If ``true``, the button to toggle the minimap is visible.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_zoom_buttons** = ``true``
:ref:`bool<class_bool>` **show_zoom_buttons** = ``true`` :ref:`🔗<class_GraphEdit_property_show_zoom_buttons>`
.. rst-class:: classref-property-setget
@@ -768,7 +768,7 @@ If ``true``, buttons that allow to change and reset the zoom level are visible.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_zoom_label** = ``false``
:ref:`bool<class_bool>` **show_zoom_label** = ``false`` :ref:`🔗<class_GraphEdit_property_show_zoom_label>`
.. rst-class:: classref-property-setget
@@ -785,7 +785,7 @@ If ``true``, the label with the current zoom level is visible. The zoom level is
.. rst-class:: classref-property
:ref:`int<class_int>` **snapping_distance** = ``20``
:ref:`int<class_int>` **snapping_distance** = ``20`` :ref:`🔗<class_GraphEdit_property_snapping_distance>`
.. rst-class:: classref-property-setget
@@ -802,7 +802,7 @@ The snapping distance in pixels, also determines the grid line distance.
.. rst-class:: classref-property
:ref:`bool<class_bool>` **snapping_enabled** = ``true``
:ref:`bool<class_bool>` **snapping_enabled** = ``true`` :ref:`🔗<class_GraphEdit_property_snapping_enabled>`
.. rst-class:: classref-property-setget
@@ -819,7 +819,7 @@ If ``true``, enables snapping.
.. rst-class:: classref-property
:ref:`float<class_float>` **zoom** = ``1.0``
:ref:`float<class_float>` **zoom** = ``1.0`` :ref:`🔗<class_GraphEdit_property_zoom>`
.. rst-class:: classref-property-setget
@@ -836,7 +836,7 @@ The current zoom value.
.. rst-class:: classref-property
:ref:`float<class_float>` **zoom_max** = ``2.0736``
:ref:`float<class_float>` **zoom_max** = ``2.0736`` :ref:`🔗<class_GraphEdit_property_zoom_max>`
.. rst-class:: classref-property-setget
@@ -853,7 +853,7 @@ The upper zoom limit.
.. rst-class:: classref-property
:ref:`float<class_float>` **zoom_min** = ``0.232568``
:ref:`float<class_float>` **zoom_min** = ``0.232568`` :ref:`🔗<class_GraphEdit_property_zoom_min>`
.. rst-class:: classref-property-setget
@@ -870,7 +870,7 @@ The lower zoom limit.
.. rst-class:: classref-property
:ref:`float<class_float>` **zoom_step** = ``1.2``
:ref:`float<class_float>` **zoom_step** = ``1.2`` :ref:`🔗<class_GraphEdit_property_zoom_step>`
.. rst-class:: classref-property-setget
@@ -892,7 +892,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` **_get_connection_line**\ (\ from_position\: :ref:`Vector2<class_Vector2>`, to_position\: :ref:`Vector2<class_Vector2>`\ ) |virtual| |const|
:ref:`PackedVector2Array<class_PackedVector2Array>` **_get_connection_line**\ (\ from_position\: :ref:`Vector2<class_Vector2>`, to_position\: :ref:`Vector2<class_Vector2>`\ ) |virtual| |const| :ref:`🔗<class_GraphEdit_private_method__get_connection_line>`
Virtual method which can be overridden to customize how connections are drawn.
@@ -904,7 +904,7 @@ Virtual method which can be overridden to customize how connections are drawn.
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_is_in_input_hotzone**\ (\ in_node\: :ref:`Object<class_Object>`, in_port\: :ref:`int<class_int>`, mouse_position\: :ref:`Vector2<class_Vector2>`\ ) |virtual|
:ref:`bool<class_bool>` **_is_in_input_hotzone**\ (\ in_node\: :ref:`Object<class_Object>`, in_port\: :ref:`int<class_int>`, mouse_position\: :ref:`Vector2<class_Vector2>`\ ) |virtual| :ref:`🔗<class_GraphEdit_private_method__is_in_input_hotzone>`
Returns whether the ``mouse_position`` is in the input hot zone.
@@ -929,7 +929,7 @@ Below is a sample code to help get started:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_is_in_output_hotzone**\ (\ in_node\: :ref:`Object<class_Object>`, in_port\: :ref:`int<class_int>`, mouse_position\: :ref:`Vector2<class_Vector2>`\ ) |virtual|
:ref:`bool<class_bool>` **_is_in_output_hotzone**\ (\ in_node\: :ref:`Object<class_Object>`, in_port\: :ref:`int<class_int>`, mouse_position\: :ref:`Vector2<class_Vector2>`\ ) |virtual| :ref:`🔗<class_GraphEdit_private_method__is_in_output_hotzone>`
Returns whether the ``mouse_position`` is in the output hot zone. For more information on hot zones, see :ref:`_is_in_input_hotzone<class_GraphEdit_private_method__is_in_input_hotzone>`.
@@ -952,7 +952,7 @@ Below is a sample code to help get started:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_is_node_hover_valid**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ ) |virtual|
:ref:`bool<class_bool>` **_is_node_hover_valid**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ ) |virtual| :ref:`🔗<class_GraphEdit_private_method__is_node_hover_valid>`
This virtual method can be used to insert additional error detection while the user is dragging a connection over a valid port.
@@ -985,7 +985,7 @@ In this example a connection to same node is suppressed:
.. rst-class:: classref-method
|void| **add_valid_connection_type**\ (\ from_type\: :ref:`int<class_int>`, to_type\: :ref:`int<class_int>`\ )
|void| **add_valid_connection_type**\ (\ from_type\: :ref:`int<class_int>`, to_type\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_method_add_valid_connection_type>`
Allows the connection between two different port types. The port type is defined individually for the left and the right port of each slot with the :ref:`GraphNode.set_slot<class_GraphNode_method_set_slot>` method.
@@ -999,7 +999,7 @@ See also :ref:`is_valid_connection_type<class_GraphEdit_method_is_valid_connecti
.. rst-class:: classref-method
|void| **add_valid_left_disconnect_type**\ (\ type\: :ref:`int<class_int>`\ )
|void| **add_valid_left_disconnect_type**\ (\ type\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_method_add_valid_left_disconnect_type>`
Allows to disconnect nodes when dragging from the left port of the :ref:`GraphNode<class_GraphNode>`'s slot if it has the specified type. See also :ref:`remove_valid_left_disconnect_type<class_GraphEdit_method_remove_valid_left_disconnect_type>`.
@@ -1011,7 +1011,7 @@ Allows to disconnect nodes when dragging from the left port of the :ref:`GraphNo
.. rst-class:: classref-method
|void| **add_valid_right_disconnect_type**\ (\ type\: :ref:`int<class_int>`\ )
|void| **add_valid_right_disconnect_type**\ (\ type\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_method_add_valid_right_disconnect_type>`
Allows to disconnect nodes when dragging from the right port of the :ref:`GraphNode<class_GraphNode>`'s slot if it has the specified type. See also :ref:`remove_valid_right_disconnect_type<class_GraphEdit_method_remove_valid_right_disconnect_type>`.
@@ -1023,7 +1023,7 @@ Allows to disconnect nodes when dragging from the right port of the :ref:`GraphN
.. rst-class:: classref-method
|void| **arrange_nodes**\ (\ )
|void| **arrange_nodes**\ (\ ) :ref:`🔗<class_GraphEdit_method_arrange_nodes>`
Rearranges selected nodes in a layout with minimum crossings between connections and uniform horizontal and vertical gap between nodes.
@@ -1035,7 +1035,7 @@ Rearranges selected nodes in a layout with minimum crossings between connections
.. rst-class:: classref-method
|void| **attach_graph_element_to_frame**\ (\ element\: :ref:`StringName<class_StringName>`, frame\: :ref:`StringName<class_StringName>`\ )
|void| **attach_graph_element_to_frame**\ (\ element\: :ref:`StringName<class_StringName>`, frame\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_GraphEdit_method_attach_graph_element_to_frame>`
Attaches the ``element`` :ref:`GraphElement<class_GraphElement>` to the ``frame`` :ref:`GraphFrame<class_GraphFrame>`.
@@ -1047,7 +1047,7 @@ Attaches the ``element`` :ref:`GraphElement<class_GraphElement>` to the ``frame`
.. rst-class:: classref-method
|void| **clear_connections**\ (\ )
|void| **clear_connections**\ (\ ) :ref:`🔗<class_GraphEdit_method_clear_connections>`
Removes all connections between nodes.
@@ -1059,7 +1059,7 @@ Removes all connections between nodes.
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **connect_node**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ )
:ref:`Error<enum_@GlobalScope_Error>` **connect_node**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_method_connect_node>`
Create a connection between the ``from_port`` of the ``from_node`` :ref:`GraphNode<class_GraphNode>` and the ``to_port`` of the ``to_node`` :ref:`GraphNode<class_GraphNode>`. If the connection already exists, no connection is created.
@@ -1071,7 +1071,7 @@ Create a connection between the ``from_port`` of the ``from_node`` :ref:`GraphNo
.. rst-class:: classref-method
|void| **detach_graph_element_from_frame**\ (\ element\: :ref:`StringName<class_StringName>`\ )
|void| **detach_graph_element_from_frame**\ (\ element\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_GraphEdit_method_detach_graph_element_from_frame>`
Detaches the ``element`` :ref:`GraphElement<class_GraphElement>` from the :ref:`GraphFrame<class_GraphFrame>` it is currently attached to.
@@ -1083,7 +1083,7 @@ Detaches the ``element`` :ref:`GraphElement<class_GraphElement>` from the :ref:`
.. rst-class:: classref-method
|void| **disconnect_node**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ )
|void| **disconnect_node**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_method_disconnect_node>`
Removes the connection between the ``from_port`` of the ``from_node`` :ref:`GraphNode<class_GraphNode>` and the ``to_port`` of the ``to_node`` :ref:`GraphNode<class_GraphNode>`. If the connection does not exist, no connection is removed.
@@ -1095,7 +1095,7 @@ Removes the connection between the ``from_port`` of the ``from_node`` :ref:`Grap
.. rst-class:: classref-method
|void| **force_connection_drag_end**\ (\ )
|void| **force_connection_drag_end**\ (\ ) :ref:`🔗<class_GraphEdit_method_force_connection_drag_end>`
Ends the creation of the current connection. In other words, if you are dragging a connection you can use this method to abort the process and remove the line that followed your cursor.
@@ -1111,7 +1111,7 @@ This is best used together with :ref:`connection_drag_started<class_GraphEdit_si
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] **get_attached_nodes_of_frame**\ (\ frame\: :ref:`StringName<class_StringName>`\ )
:ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] **get_attached_nodes_of_frame**\ (\ frame\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_GraphEdit_method_get_attached_nodes_of_frame>`
Returns an array of node names that are attached to the :ref:`GraphFrame<class_GraphFrame>` with the given name.
@@ -1123,7 +1123,7 @@ Returns an array of node names that are attached to the :ref:`GraphFrame<class_G
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_closest_connection_at_point**\ (\ point\: :ref:`Vector2<class_Vector2>`, max_distance\: :ref:`float<class_float>` = 4.0\ ) |const|
:ref:`Dictionary<class_Dictionary>` **get_closest_connection_at_point**\ (\ point\: :ref:`Vector2<class_Vector2>`, max_distance\: :ref:`float<class_float>` = 4.0\ ) |const| :ref:`🔗<class_GraphEdit_method_get_closest_connection_at_point>`
Returns the closest connection to the given point in screen space. If no connection is found within ``max_distance`` pixels, an empty :ref:`Dictionary<class_Dictionary>` is returned.
@@ -1148,7 +1148,7 @@ For example, getting a connection at a given mouse position can be achieved like
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` **get_connection_line**\ (\ from_node\: :ref:`Vector2<class_Vector2>`, to_node\: :ref:`Vector2<class_Vector2>`\ ) |const|
:ref:`PackedVector2Array<class_PackedVector2Array>` **get_connection_line**\ (\ from_node\: :ref:`Vector2<class_Vector2>`, to_node\: :ref:`Vector2<class_Vector2>`\ ) |const| :ref:`🔗<class_GraphEdit_method_get_connection_line>`
Returns the points which would make up a connection between ``from_node`` and ``to_node``.
@@ -1160,7 +1160,7 @@ Returns the points which would make up a connection between ``from_node`` and ``
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_connection_list**\ (\ ) |const|
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_connection_list**\ (\ ) |const| :ref:`🔗<class_GraphEdit_method_get_connection_list>`
Returns an :ref:`Array<class_Array>` containing the list of connections. A connection consists in a structure of the form ``{ from_port: 0, from_node: "GraphNode name 0", to_port: 1, to_node: "GraphNode name 1" }``.
@@ -1172,7 +1172,7 @@ Returns an :ref:`Array<class_Array>` containing the list of connections. A conne
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_connections_intersecting_with_rect**\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const|
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_connections_intersecting_with_rect**\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const| :ref:`🔗<class_GraphEdit_method_get_connections_intersecting_with_rect>`
Returns an :ref:`Array<class_Array>` containing the list of connections that intersect with the given :ref:`Rect2<class_Rect2>`. A connection consists in a structure of the form ``{ from_port: 0, from_node: "GraphNode name 0", to_port: 1, to_node: "GraphNode name 1" }``.
@@ -1184,7 +1184,7 @@ Returns an :ref:`Array<class_Array>` containing the list of connections that int
.. rst-class:: classref-method
:ref:`GraphFrame<class_GraphFrame>` **get_element_frame**\ (\ element\: :ref:`StringName<class_StringName>`\ )
:ref:`GraphFrame<class_GraphFrame>` **get_element_frame**\ (\ element\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_GraphEdit_method_get_element_frame>`
Returns the :ref:`GraphFrame<class_GraphFrame>` that contains the :ref:`GraphElement<class_GraphElement>` with the given name.
@@ -1196,7 +1196,7 @@ Returns the :ref:`GraphFrame<class_GraphFrame>` that contains the :ref:`GraphEle
.. rst-class:: classref-method
:ref:`HBoxContainer<class_HBoxContainer>` **get_menu_hbox**\ (\ )
:ref:`HBoxContainer<class_HBoxContainer>` **get_menu_hbox**\ (\ ) :ref:`🔗<class_GraphEdit_method_get_menu_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.
@@ -1210,7 +1210,7 @@ Gets the :ref:`HBoxContainer<class_HBoxContainer>` that contains the zooming and
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_node_connected**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ )
:ref:`bool<class_bool>` **is_node_connected**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_method_is_node_connected>`
Returns ``true`` if the ``from_port`` of the ``from_node`` :ref:`GraphNode<class_GraphNode>` is connected to the ``to_port`` of the ``to_node`` :ref:`GraphNode<class_GraphNode>`.
@@ -1222,7 +1222,7 @@ Returns ``true`` if the ``from_port`` of the ``from_node`` :ref:`GraphNode<class
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_valid_connection_type**\ (\ from_type\: :ref:`int<class_int>`, to_type\: :ref:`int<class_int>`\ ) |const|
:ref:`bool<class_bool>` **is_valid_connection_type**\ (\ from_type\: :ref:`int<class_int>`, to_type\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_GraphEdit_method_is_valid_connection_type>`
Returns whether it's possible to make a connection between two different port types. The port type is defined individually for the left and the right port of each slot with the :ref:`GraphNode.set_slot<class_GraphNode_method_set_slot>` method.
@@ -1236,7 +1236,7 @@ See also :ref:`add_valid_connection_type<class_GraphEdit_method_add_valid_connec
.. rst-class:: classref-method
|void| **remove_valid_connection_type**\ (\ from_type\: :ref:`int<class_int>`, to_type\: :ref:`int<class_int>`\ )
|void| **remove_valid_connection_type**\ (\ from_type\: :ref:`int<class_int>`, to_type\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_method_remove_valid_connection_type>`
Disallows the connection between two different port types previously allowed by :ref:`add_valid_connection_type<class_GraphEdit_method_add_valid_connection_type>`. The port type is defined individually for the left and the right port of each slot with the :ref:`GraphNode.set_slot<class_GraphNode_method_set_slot>` method.
@@ -1250,7 +1250,7 @@ See also :ref:`is_valid_connection_type<class_GraphEdit_method_is_valid_connecti
.. rst-class:: classref-method
|void| **remove_valid_left_disconnect_type**\ (\ type\: :ref:`int<class_int>`\ )
|void| **remove_valid_left_disconnect_type**\ (\ type\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_method_remove_valid_left_disconnect_type>`
Disallows to disconnect nodes when dragging from the left port of the :ref:`GraphNode<class_GraphNode>`'s slot if it has the specified type. Use this to disable disconnection previously allowed with :ref:`add_valid_left_disconnect_type<class_GraphEdit_method_add_valid_left_disconnect_type>`.
@@ -1262,7 +1262,7 @@ Disallows to disconnect nodes when dragging from the left port of the :ref:`Grap
.. rst-class:: classref-method
|void| **remove_valid_right_disconnect_type**\ (\ type\: :ref:`int<class_int>`\ )
|void| **remove_valid_right_disconnect_type**\ (\ type\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GraphEdit_method_remove_valid_right_disconnect_type>`
Disallows to disconnect nodes when dragging from the right port of the :ref:`GraphNode<class_GraphNode>`'s slot if it has the specified type. Use this to disable disconnection previously allowed with :ref:`add_valid_right_disconnect_type<class_GraphEdit_method_add_valid_right_disconnect_type>`.
@@ -1274,7 +1274,7 @@ Disallows to disconnect nodes when dragging from the right port of the :ref:`Gra
.. rst-class:: classref-method
|void| **set_connection_activity**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`, amount\: :ref:`float<class_float>`\ )
|void| **set_connection_activity**\ (\ from_node\: :ref:`StringName<class_StringName>`, from_port\: :ref:`int<class_int>`, to_node\: :ref:`StringName<class_StringName>`, to_port\: :ref:`int<class_int>`, amount\: :ref:`float<class_float>`\ ) :ref:`🔗<class_GraphEdit_method_set_connection_activity>`
Sets the coloration of the connection between ``from_node``'s ``from_port`` and ``to_node``'s ``to_port`` with the color provided in the :ref:`activity<class_GraphEdit_theme_color_activity>` theme property. The color is linearly interpolated between the connection color and the activity color using ``amount`` as weight.
@@ -1286,7 +1286,7 @@ Sets the coloration of the connection between ``from_node``'s ``from_port`` and
.. rst-class:: classref-method
|void| **set_selected**\ (\ node\: :ref:`Node<class_Node>`\ )
|void| **set_selected**\ (\ node\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_GraphEdit_method_set_selected>`
Sets the specified ``node`` as the one selected.
@@ -1303,7 +1303,7 @@ Theme Property Descriptions
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **activity** = ``Color(1, 1, 1, 1)``
:ref:`Color<class_Color>` **activity** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_GraphEdit_theme_color_activity>`
Color the connection line is interpolated to based on the activity value of a connection (see :ref:`set_connection_activity<class_GraphEdit_method_set_connection_activity>`).
@@ -1315,7 +1315,7 @@ Color the connection line is interpolated to based on the activity value of a co
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **connection_hover_tint_color** = ``Color(0, 0, 0, 0.3)``
:ref:`Color<class_Color>` **connection_hover_tint_color** = ``Color(0, 0, 0, 0.3)`` :ref:`🔗<class_GraphEdit_theme_color_connection_hover_tint_color>`
Color which is blended with the connection line when the mouse is hovering over it.
@@ -1327,7 +1327,7 @@ Color which is blended with the connection line when the mouse is hovering over
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **connection_rim_color** = ``Color(0.1, 0.1, 0.1, 0.6)``
:ref:`Color<class_Color>` **connection_rim_color** = ``Color(0.1, 0.1, 0.1, 0.6)`` :ref:`🔗<class_GraphEdit_theme_color_connection_rim_color>`
Color of the rim around each connection line used for making intersecting lines more distinguishable.
@@ -1339,7 +1339,7 @@ Color of the rim around each connection line used for making intersecting lines
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **connection_valid_target_tint_color** = ``Color(1, 1, 1, 0.4)``
:ref:`Color<class_Color>` **connection_valid_target_tint_color** = ``Color(1, 1, 1, 0.4)`` :ref:`🔗<class_GraphEdit_theme_color_connection_valid_target_tint_color>`
Color which is blended with the connection line when the currently dragged connection is hovering over a valid target port.
@@ -1351,7 +1351,7 @@ Color which is blended with the connection line when the currently dragged conne
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **grid_major** = ``Color(1, 1, 1, 0.2)``
:ref:`Color<class_Color>` **grid_major** = ``Color(1, 1, 1, 0.2)`` :ref:`🔗<class_GraphEdit_theme_color_grid_major>`
Color of major grid lines/dots.
@@ -1363,7 +1363,7 @@ Color of major grid lines/dots.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **grid_minor** = ``Color(1, 1, 1, 0.05)``
:ref:`Color<class_Color>` **grid_minor** = ``Color(1, 1, 1, 0.05)`` :ref:`🔗<class_GraphEdit_theme_color_grid_minor>`
Color of minor grid lines/dots.
@@ -1375,7 +1375,7 @@ Color of minor grid lines/dots.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **selection_fill** = ``Color(1, 1, 1, 0.3)``
:ref:`Color<class_Color>` **selection_fill** = ``Color(1, 1, 1, 0.3)`` :ref:`🔗<class_GraphEdit_theme_color_selection_fill>`
The fill color of the selection rectangle.
@@ -1387,7 +1387,7 @@ The fill color of the selection rectangle.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **selection_stroke** = ``Color(1, 1, 1, 0.8)``
:ref:`Color<class_Color>` **selection_stroke** = ``Color(1, 1, 1, 0.8)`` :ref:`🔗<class_GraphEdit_theme_color_selection_stroke>`
The outline color of the selection rectangle.
@@ -1399,7 +1399,7 @@ The outline color of the selection rectangle.
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **port_hotzone_inner_extent** = ``22``
:ref:`int<class_int>` **port_hotzone_inner_extent** = ``22`` :ref:`🔗<class_GraphEdit_theme_constant_port_hotzone_inner_extent>`
The horizontal range within which a port can be grabbed (inner side).
@@ -1411,7 +1411,7 @@ The horizontal range within which a port can be grabbed (inner side).
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **port_hotzone_outer_extent** = ``26``
:ref:`int<class_int>` **port_hotzone_outer_extent** = ``26`` :ref:`🔗<class_GraphEdit_theme_constant_port_hotzone_outer_extent>`
The horizontal range within which a port can be grabbed (outer side).
@@ -1423,7 +1423,7 @@ The horizontal range within which a port can be grabbed (outer side).
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **grid_toggle**
:ref:`Texture2D<class_Texture2D>` **grid_toggle** :ref:`🔗<class_GraphEdit_theme_icon_grid_toggle>`
The icon for the grid toggle button.
@@ -1435,7 +1435,7 @@ The icon for the grid toggle button.
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **layout**
:ref:`Texture2D<class_Texture2D>` **layout** :ref:`🔗<class_GraphEdit_theme_icon_layout>`
The icon for the layout button for auto-arranging the graph.
@@ -1447,7 +1447,7 @@ The icon for the layout button for auto-arranging the graph.
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **minimap_toggle**
:ref:`Texture2D<class_Texture2D>` **minimap_toggle** :ref:`🔗<class_GraphEdit_theme_icon_minimap_toggle>`
The icon for the minimap toggle button.
@@ -1459,7 +1459,7 @@ The icon for the minimap toggle button.
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **snapping_toggle**
:ref:`Texture2D<class_Texture2D>` **snapping_toggle** :ref:`🔗<class_GraphEdit_theme_icon_snapping_toggle>`
The icon for the snapping toggle button.
@@ -1471,7 +1471,7 @@ The icon for the snapping toggle button.
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **zoom_in**
:ref:`Texture2D<class_Texture2D>` **zoom_in** :ref:`🔗<class_GraphEdit_theme_icon_zoom_in>`
The icon for the zoom in button.
@@ -1483,7 +1483,7 @@ The icon for the zoom in button.
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **zoom_out**
:ref:`Texture2D<class_Texture2D>` **zoom_out** :ref:`🔗<class_GraphEdit_theme_icon_zoom_out>`
The icon for the zoom out button.
@@ -1495,7 +1495,7 @@ The icon for the zoom out button.
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **zoom_reset**
:ref:`Texture2D<class_Texture2D>` **zoom_reset** :ref:`🔗<class_GraphEdit_theme_icon_zoom_reset>`
The icon for the zoom reset button.
@@ -1507,7 +1507,7 @@ The icon for the zoom reset button.
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **menu_panel**
:ref:`StyleBox<class_StyleBox>` **menu_panel** :ref:`🔗<class_GraphEdit_theme_style_menu_panel>`
.. container:: contribute
@@ -1521,7 +1521,7 @@ The icon for the zoom reset button.
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **panel**
:ref:`StyleBox<class_StyleBox>` **panel** :ref:`🔗<class_GraphEdit_theme_style_panel>`
The background drawn under the grid.