.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_GraphNode: GraphNode ========= **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. Member Functions ---------------- +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_all_slots` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_slot` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_input_count` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_connection_input_pos` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_output_count` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_connection_output_pos` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_offset` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_overlay` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_title` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_close_button_visible` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_comment` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_resizeable` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_comment` **(** :ref:`bool` comment **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_overlay` **(** :ref:`int` overlay **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_resizeable` **(** :ref:`bool` resizeable **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_selected` **(** :ref:`bool` selected **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_show_close_button` **(** :ref:`bool` show **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_title` **(** :ref:`String` title **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **close_request** **(** **)** Signal sent on closing the GraphNode. - **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** Signal sent when the GraphNode is dragged. - **offset_changed** **(** **)** Signal sent when the GraphNode is moved. - **raise_request** **(** **)** Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. Description ----------- A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. Member Function Description --------------------------- .. _class_GraphNode_clear_all_slots: - void **clear_all_slots** **(** **)** Disable all input and output slots of the GraphNode. .. _class_GraphNode_clear_slot: - void **clear_slot** **(** :ref:`int` idx **)** Disable input and output slot whose index is 'idx'. .. _class_GraphNode_get_connection_input_color: - :ref:`Color` **get_connection_input_color** **(** :ref:`int` idx **)** Return the color of the input connection 'idx'. .. _class_GraphNode_get_connection_input_count: - :ref:`int` **get_connection_input_count** **(** **)** Return the number of enabled input slots (connections) to the GraphNode. .. _class_GraphNode_get_connection_input_pos: - :ref:`Vector2` **get_connection_input_pos** **(** :ref:`int` idx **)** Return the position of the input connection 'idx'. .. _class_GraphNode_get_connection_input_type: - :ref:`int` **get_connection_input_type** **(** :ref:`int` idx **)** Return the type of the input connection 'idx'. .. _class_GraphNode_get_connection_output_color: - :ref:`Color` **get_connection_output_color** **(** :ref:`int` idx **)** Return the color of the output connection 'idx'. .. _class_GraphNode_get_connection_output_count: - :ref:`int` **get_connection_output_count** **(** **)** Return the number of enabled output slots (connections) of the GraphNode. .. _class_GraphNode_get_connection_output_pos: - :ref:`Vector2` **get_connection_output_pos** **(** :ref:`int` idx **)** Return the position of the output connection 'idx'. .. _class_GraphNode_get_connection_output_type: - :ref:`int` **get_connection_output_type** **(** :ref:`int` idx **)** Return the type of the output connection 'idx'. .. _class_GraphNode_get_offset: - :ref:`Vector2` **get_offset** **(** **)** const Return the offset of the GraphNode. .. _class_GraphNode_get_overlay: - :ref:`int` **get_overlay** **(** **)** const .. _class_GraphNode_get_slot_color_left: - :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** const Return the color set to 'idx' left (input) slot. .. _class_GraphNode_get_slot_color_right: - :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const Return the color set to 'idx' right (output) slot. .. _class_GraphNode_get_slot_type_left: - :ref:`int` **get_slot_type_left** **(** :ref:`int` idx **)** const Return the (integer) type of left (input) 'idx' slot. .. _class_GraphNode_get_slot_type_right: - :ref:`int` **get_slot_type_right** **(** :ref:`int` idx **)** const Return the (integer) type of right (output) 'idx' slot. .. _class_GraphNode_get_title: - :ref:`String` **get_title** **(** **)** const Return the title of the GraphNode. .. _class_GraphNode_is_close_button_visible: - :ref:`bool` **is_close_button_visible** **(** **)** const Returns true if the close button is shown. False otherwise. .. _class_GraphNode_is_comment: - :ref:`bool` **is_comment** **(** **)** const .. _class_GraphNode_is_resizeable: - :ref:`bool` **is_resizeable** **(** **)** const .. _class_GraphNode_is_selected: - :ref:`bool` **is_selected** **(** **)** .. _class_GraphNode_is_slot_enabled_left: - :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const Return true if left (input) slot 'idx' is enabled. False otherwise. .. _class_GraphNode_is_slot_enabled_right: - :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** const Return true if right (output) slot 'idx' is enabled. False otherwise. .. _class_GraphNode_set_comment: - void **set_comment** **(** :ref:`bool` comment **)** .. _class_GraphNode_set_offset: - void **set_offset** **(** :ref:`Vector2` offset **)** Set the offset of the GraphNode. .. _class_GraphNode_set_overlay: - void **set_overlay** **(** :ref:`int` overlay **)** .. _class_GraphNode_set_resizeable: - void **set_resizeable** **(** :ref:`bool` resizeable **)** .. _class_GraphNode_set_selected: - void **set_selected** **(** :ref:`bool` selected **)** .. _class_GraphNode_set_show_close_button: - void **set_show_close_button** **(** :ref:`bool` show **)** Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. .. _class_GraphNode_set_slot: - void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** .. _class_GraphNode_set_title: - void **set_title** **(** :ref:`String` title **)** Set the title of the GraphNode.