GraphEdit

Conformances

• protocol CustomStringConvertible

  A type with a customized textual representation.

• protocol Equatable

  A type that can be compared for value equality.

• protocol Hashable

  A type that can be hashed into a Hasher to produce an integer hash value.

• protocol Identifiable<ID>

  A class of types whose instances hold the value of an entity with stable identity.

• protocol VariantRepresentable

  Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

• protocol VariantStorable

  Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Types

• enum PanningScheme
• class Signal1

  Signal support.

• class Signal10

  Signal support.

• class Signal2

  Signal support.

• class Signal3

  Signal support.

• class Signal4

  Signal support.

• class Signal5

  Signal support.

• class Signal6

  Signal support.

• class Signal7

  Signal support.

• class Signal8

  Signal support.

• class Signal9

  Signal support.

Type members

• class var godotClassName: StringName

Instance members

• var beginNodeMove: SimpleSignal

  Emitted at the beginning of a GraphNode movement.

• var connectionDragEnded: SimpleSignal

  Emitted at the end of a connection drag.

• var connectionDragStarted: Signal5

  Emitted at the beginning of a connection drag.

• var connectionFromEmpty: Signal4

  Emitted when user drags a connection from an input port into the empty space of the graph.

• var connectionLinesAntialiased: Bool

  If true, the lines between nodes will use antialiasing.

• var connectionLinesCurvature: Double

  The curvature of the lines between the nodes. 0 results in straight lines.

• var connectionLinesThickness: Double

  The thickness of the lines between the nodes.

• var connectionRequest: Signal1

  Emitted to the GraphEdit when the connection between the fromPort of the fromNode GraphNode and the toPort of the toNode GraphNode is attempted to be created.

• var connectionToEmpty: Signal3

  Emitted when user drags a connection from an output port into the empty space of the graph.

• var copyNodesRequest: SimpleSignal

  Emitted when the user presses [kbd]Ctrl + C[/kbd].

• var deleteNodesRequest: Signal6

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

• var disconnectionRequest: Signal2

  Emitted to the GraphEdit when the connection between fromPort of fromNode GraphNode and toPort of toNode GraphNode is attempted to be removed.

• var duplicateNodesRequest: SimpleSignal

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

• var endNodeMove: SimpleSignal

  Emitted at the end of a GraphNode movement.

• var minimapEnabled: Bool

  If true, the minimap is visible.

• var minimapOpacity: Double

  The opacity of the minimap rectangle.

• var minimapSize: Vector2

  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.

• var nodeDeselected: Signal8

  To connect to this signal, reference this property and call the

• var nodeSelected: Signal7

  Emitted when a GraphNode is selected.

• var panningScheme: GraphEdit.PanningScheme

  Defines the control scheme for panning with mouse wheel.

• var pasteNodesRequest: SimpleSignal

  Emitted when the user presses [kbd]Ctrl + V[/kbd].

• var popupRequest: Signal9

  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.

• var rightDisconnects: Bool

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

• var scrollOffset: Vector2

  The scroll offset.

• var scrollOffsetChanged: Signal10

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

• var showArrangeButton: Bool

  If true, the button to automatically arrange graph nodes is visible.

• var showGrid: Bool

  If true, the grid is visible.

• var showGridButtons: Bool

  If true, buttons that allow to configure grid and snapping options are visible.

• var showMenu: Bool

  If true, the menu toolbar is visible.

• var showMinimapButton: Bool

  If true, the button to toggle the minimap is visible.

• var showZoomButtons: Bool

  If true, buttons that allow to change and reset the zoom level are visible.

• var showZoomLabel: Bool

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

• var snappingDistance: Int32

  The snapping distance in pixels, also determines the grid line distance.

• var snappingEnabled: Bool

  If true, enables snapping.

• var zoom: Double

  The current zoom value.

• var zoomMax: Double

  The upper zoom limit.

• var zoomMin: Double

  The lower zoom limit.

• var zoomStep: Double

  The step of each zoom level.

• func addValidConnectionType(fromType: Int32, toType: Int32)

  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 setSlot(slotIndex:enableLeftPort:typeLeft:colorLeft:enableRightPort:typeRight:colorRight:customIconLeft:customIconRight:drawStylebox:) method.

• func addValidLeftDisconnectType(Int32)

  Allows to disconnect nodes when dragging from the left port of the GraphNode’s slot if it has the specified type. See also removeValidLeftDisconnectType(_:).

• func addValidRightDisconnectType(Int32)

  Allows to disconnect nodes when dragging from the right port of the GraphNode’s slot if it has the specified type. See also removeValidRightDisconnectType(_:).

• func arrangeNodes()

  Rearranges selected nodes in a layout with minimum crossings between connections and uniform horizontal and vertical gap between nodes.

• func clearConnections()

  Removes all connections between nodes.

• func connectNode(fromNode: StringName, fromPort: Int32, toNode: StringName, toPort: Int32) -> GodotError

  Create a connection between the fromPort of the fromNode GraphNode and the toPort of the toNode GraphNode. If the connection already exists, no connection is created.

• func disconnectNode(fromNode: StringName, fromPort: Int32, toNode: StringName, toPort: Int32)

  Removes the connection between the fromPort of the fromNode GraphNode and the toPort of the toNode GraphNode. If the connection does not exist, no connection is removed.

• func forceConnectionDragEnd()

  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.

• func getConnectionLine(fromNode: Vector2, toNode: Vector2) -> PackedVector2Array

  Returns the points which would make up a connection between fromNode and toNode.

• func getConnectionList() -> VariantCollection<GDictionary>

  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" }.

• func getMenuHbox() -> HBoxContainer?

  Gets the 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.

• func isNodeConnected(fromNode: StringName, fromPort: Int32, toNode: StringName, toPort: Int32) -> Bool

  Returns true if the fromPort of the fromNode GraphNode is connected to the toPort of the toNode GraphNode.

• func isValidConnectionType(fromType: Int32, toType: Int32) -> Bool

  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 setSlot(slotIndex:enableLeftPort:typeLeft:colorLeft:enableRightPort:typeRight:colorRight:customIconLeft:customIconRight:drawStylebox:) method.

• func removeValidConnectionType(fromType: Int32, toType: Int32)

  Disallows the connection between two different port types previously allowed by addValidConnectionType(fromType:toType:). The port type is defined individually for the left and the right port of each slot with the setSlot(slotIndex:enableLeftPort:typeLeft:colorLeft:enableRightPort:typeRight:colorRight:customIconLeft:customIconRight:drawStylebox:) method.

• func removeValidLeftDisconnectType(Int32)

  Disallows to disconnect nodes when dragging from the left port of the GraphNode’s slot if it has the specified type. Use this to disable disconnection previously allowed with addValidLeftDisconnectType(_:).

• func removeValidRightDisconnectType(Int32)

  Disallows to disconnect nodes when dragging from the right port of the GraphNode’s slot if it has the specified type. Use this to disable disconnection previously allowed with addValidRightDisconnectType(_:).

• func setConnectionActivity(fromNode: StringName, fromPort: Int32, toNode: StringName, toPort: Int32, amount: Double)

  Sets the coloration of the connection between fromNode’s fromPort and toNode’s toPort with the color provided in the [theme_item activity] theme property. The color is linearly interpolated between the connection color and the activity color using amount as weight.

• func setSelected(node: Node?)

  Sets the specified node as the one selected.