Inheritance #

GraphFrame
Table of contents

GraphFrame #

is_instantiable, Node, core, not_builtin_classes

GraphFrame is a special GraphElement that can be used to organize other GraphElements inside a GraphEdit.

GraphFrame is a special GraphElement to which other GraphElements can be attached. It can be configured to automatically resize to enclose all attached GraphElements. If the frame is moved, all the attached GraphElements inside it will be moved as well.

A GraphFrame is always kept behind the connection layer and other GraphElements inside a GraphEdit.

Members #

var autoshrink_enabled: bool = true#

If true, the frame's rect will be adjusted automatically to enclose all attached GraphElements.

var autoshrink_margin: int = 40#

The margin around the attached nodes that is used to calculate the size of the frame when autoshrink_enabled is true.

var drag_margin: int = 16#

The margin inside the frame that can be used to drag the frame.

var mouse_filter = MOUSE_FILTER_STOP#

var tint_color: Color = Color(0.3, 0.3, 0.3, 0.75)#

The color of the frame when tint_color_enabled is true.

var tint_color_enabled: bool = false#

If true, the tint color will be used to tint the frame.

var title: String = ""#

Title of the frame.

Methods #

func get_titlebar_hbox() -> HBoxContainer#

Returns the HBoxContainer used for the title bar, only containing a Label for displaying the title by default.

This can be used to add custom controls to the title bar such as option or close buttons.

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

signal autoshrink_changed()#

Emitted when autoshrink_enabled or autoshrink_margin changes.

Theme Items #

self["theme_override_colors/resizer_color"] = Color(0.875, 0.875, 0.875, 1) as Color#

The color modulation applied to the resizer icon.

self["theme_override_styles/panel"] = style as StyleBox#

The default StyleBox used for the background of the GraphFrame.

self["theme_override_styles/panel_selected"] = style as StyleBox#

The StyleBox used for the background of the GraphFrame when it is selected.

self["theme_override_styles/titlebar"] = style as StyleBox#

The StyleBox used for the title bar of the GraphFrame.

self["theme_override_styles/titlebar_selected"] = style as StyleBox#

The StyleBox used for the title bar of the GraphFrame when it is selected.

Tutorials #