A container with connection ports, representing a node in a [GraphEdit].
[GraphNode] allows to create nodes for a [GraphEdit] graph with customizable content based on its child controls. [GraphNode] is derived from [Container] and it is responsible for placing its children on screen. This works similar to [VBoxContainer]. Children, in turn, provide [GraphNode] with so-called slots, each of which can have a connection port on either side. Each [GraphNode] slot is defined by its index and can provide the node with up to two ports: one on the left, and one on the right. By convention the left port is also referred to as the [b]input port[/b] and the right port is referred to as the [b]output port[/b]. Each port can be enabled and configured individually, using different type and color. The type is an arbitrary value that you can define using your own considerations. The parent [GraphEdit] will receive this information on each connect and disconnect request. Slots can be configured in the Inspector dock once you add at least one child [Control]. The properties are grouped by each slot's index in the "Slot" section. [b]Note:[/b] While GraphNode is set up using slots and slot indices, connections are made between the ports which are enabled. Because of that, [GraphEdit] uses the port's index and not the slot's index. You can use [method get_connection_input_slot] and [method get_connection_output_slot] to get the slot index from the port index.
Disables all input and output slots of the GraphNode.
Disables input and output slot whose index is [param slot_index].
Returns the [Color] of the input connection [param port].
Returns the number of enabled input slots (connections) to the GraphNode.
Returns the height of the input connection [param port].
Returns the position of the input connection [param port].
Returns the corresponding slot index of the input connection [param port].
Returns the type of the input connection [param port].
Returns the [Color] of the output connection [param port].
Returns the number of enabled output slots (connections) of the GraphNode.
Returns the height of the output connection [param port].
Returns the position of the output connection [param port].
Returns the corresponding slot index of the output connection [param port].
Returns the type of the output connection [param port].
Returns the left (input) [Color] of the slot [param slot_index].
Returns the right (output) [Color] of the slot [param slot_index].
Returns the left (input) type of the slot [param slot_index].
Returns the right (output) type of the slot [param slot_index].
Returns true if the background [StyleBox] of the slot [param slot_index] is drawn.
Returns [code]true[/code] if left (input) side of the slot [param slot_index] is enabled.
Returns [code]true[/code] if right (output) side of the slot [param slot_index] is enabled.
Sets properties of the slot with the [param slot_index] index. If [param enable_left_port]/[param enable_right_port] is [code]true[/code], a port will appear and the slot will be able to be connected from this side. With [param type_left]/[param type_right] an arbitrary type can be assigned to each port. Two ports can be connected if they share the same type, or if the connection between their types is allowed in the parent [GraphEdit] (see [method GraphEdit.add_valid_connection_type]). Keep in mind that the [GraphEdit] has the final say in accepting the connection. Type compatibility simply allows the [signal GraphEdit.connection_request] signal to be emitted. Ports can be further customized using [param color_left]/[param color_right] and [param custom_icon_left]/[param custom_icon_right]. The color parameter adds a tint to the icon. The custom icon can be used to override the default port dot. Additionally, [param draw_stylebox] can be used to enable or disable drawing of the background stylebox for each slot. See [theme_item slot]. Individual properties can also be set using one of the [code]set_slot_*[/code] methods. [b]Note:[/b] This method only sets properties of the slot. To create the slot itself, add a [Control]-derived child to the GraphNode.
Sets the [Color] of the left (input) side of the slot [param slot_index] to [param color].
Sets the [Color] of the right (output) side of the slot [param slot_index] to [param color].
Toggles the background [StyleBox] of the slot [param slot_index].
Toggles the left (input) side of the slot [param slot_index]. If [param enable] is [code]true[/code], a port will appear on the left side and the slot will be able to be connected from this side.
Toggles the right (output) side of the slot [param slot_index]. If [param enable] is [code]true[/code], a port will appear on the right side and the slot will be able to be connected from this side.
Sets the left (input) type of the slot [param slot_index] to [param type]. If the value is negative, all connections will be disallowed to be created via user inputs.
Sets the right (output) type of the slot [param slot_index] to [param type]. If the value is negative, all connections will be disallowed to be created via user inputs.
- If [code]true[/code], the user can drag the GraphNode.
- Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
- Sets the overlay shown above the GraphNode. See [enum Overlay].
- The offset of the GraphNode, relative to the scroll offset of the [GraphEdit]. [b]Note:[/b] You cannot use position offset directly, as [GraphEdit] is a [Container].
- If [code]true[/code], the user can resize the GraphNode. [b]Note:[/b] Dragging the handle will only emit the [signal resize_request] signal, the GraphNode needs to be resized manually.
- If [code]true[/code], the user can select the GraphNode.
- If [code]true[/code], the GraphNode is selected.
- If [code]true[/code], the close button will be visible. [b]Note:[/b] Pressing it will only emit the [signal close_request] signal, the GraphNode needs to be removed manually.
- Base text writing direction.
- The text displayed in the GraphNode's title bar.
Emitted when the GraphNode is requested to be closed. Happens on clicking the close button (see [member show_close]).
Emitted when the GraphNode is dragged.
Emitted when the GraphNode is deselected.
Emitted when the GraphNode is selected.
Emitted when the GraphNode is moved.
Emitted when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]).
Emitted when any GraphNode's slot is updated.
No overlay is shown.
Show overlay set in the [theme_item breakpoint] theme property.
Show overlay set in the [theme_item position] theme property.
The color modulation applied to the close button icon.
The color modulation applied to the resizer icon.
Color of the title text.
The vertical offset of the close button.
Horizontal offset for the ports.
The vertical distance between ports.
Horizontal offset of the title text.
Vertical offset of the title text.
Font used for the title text.
The icon for the close button, visible when [member show_close] is enabled.
The icon used for representing ports.
The icon used for resizer, visible when [member resizable] is enabled.
The background used when [member overlay] is set to [constant OVERLAY_BREAKPOINT].
The default background for [GraphNode].
The background used when [member overlay] is set to [constant OVERLAY_POSITION].
The background used when the [GraphNode] is selected.
The [StyleBox] used for each slot of the [GraphNode].