A control used to show a set of internal [TreeItem]s in a hierarchical structure.
A control used to show a set of internal [TreeItem]s in a hierarchical structure. The tree items can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like [LineEdit]s, buttons and popups. It can be useful for structured displays and interactions. Trees are built via code, using [TreeItem] objects to create the structure. They have a single root, but multiple roots can be simulated with [member hide_root]: [codeblocks] [gdscript] func _ready(): var tree = Tree.new() var root = tree.create_item() tree.hide_root = true var child1 = tree.create_item(root) var child2 = tree.create_item(root) var subchild1 = tree.create_item(child1) subchild1.set_text(0, "Subchild1") [/gdscript] [csharp] public override void _Ready() { var tree = new Tree(); TreeItem root = tree.CreateItem(); tree.HideRoot = true; TreeItem child1 = tree.CreateItem(root); TreeItem child2 = tree.CreateItem(root); TreeItem subchild1 = tree.CreateItem(child1); subchild1.SetText(0, "Subchild1"); } [/csharp] [/codeblocks] To iterate over all the [TreeItem] objects in a [Tree] object, use [method TreeItem.get_next] and [method TreeItem.get_first_child] after getting the root through [method get_root]. You can use [method Object.free] on a [TreeItem] to remove it from the [Tree]. [b]Incremental search:[/b] Like [ItemList] and [PopupMenu], [Tree] supports searching within the list while the control is focused. Press a key that matches the first letter of an item's name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing [member ProjectSettings.gui/timers/incremental_search_max_interval_msec].
Clears the tree. This removes all items.
Creates an item in the tree and adds it as a child of [param parent], which can be either a valid [TreeItem] or [code]null[/code]. If [param parent] is [code]null[/code], the root item will be the parent, or the new item will be the root itself if the tree is empty. The new item will be the [param index]-th child of parent, or it will be the last child if there are not enough siblings.
Deselects all tree items (rows and columns). In [constant SELECT_MULTI] mode also removes selection cursor.
Edits the selected tree item as if it was clicked. Either the item must be set editable with [method TreeItem.set_editable] or [param force_edit] must be [code]true[/code]. Returns [code]true[/code] if the item could be edited. Fails if no item is selected.
Makes the currently focused cell visible. This will scroll the tree if necessary. In [constant SELECT_ROW] mode, this will not do horizontal scrolling, as all the cells in the selected row is focused logically. [b]Note:[/b] Despite the name of this method, the focus cursor itself is only visible in [constant SELECT_MULTI] mode.
Returns the button ID at [param position], or -1 if no button is there.
Returns the column index at [param position], or -1 if no item is there.
Returns the expand ratio assigned to the column.
Returns the column's title.
Returns the column title alignment.
Returns column title base writing direction.
Returns column title language code.
Returns the column's width in pixels.
Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode].
Returns the drop section at [param position], or -100 if no item is there. Values -1, 0, or 1 will be returned for the "above item", "on item", and "below item" drop sections, respectively. See [enum DropModeFlags] for a description of each drop section. To get the item which the returned drop section is relative to, use [method get_item_at_position].
Returns the currently edited item. Can be used with [signal item_edited] to get the item that was modified. [codeblocks] [gdscript] func _ready(): $Tree.item_edited.connect(on_Tree_item_edited)

func on_Tree_item_edited(): print($Tree.get_edited()) # This item just got edited (e.g. checked). [/gdscript] [csharp] public override void _Ready() { GetNode<Tree>("Tree").ItemEdited += OnTreeItemEdited; }

public void OnTreeItemEdited() { GD.Print(GetNode<Tree>("Tree").GetEdited()); // This item just got edited (e.g. checked). } [/csharp] [/codeblocks]
Returns the column for the currently edited item.
Returns the rectangle area for the specified [TreeItem]. If [param column] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. If a button index is specified, the rectangle of that button will be returned.
Returns the tree item at the specified position (relative to the tree origin position).
Returns the next selected [TreeItem] after the given one, or [code]null[/code] if the end is reached. If [param from] is [code]null[/code], this returns the first selected item.
Returns the last pressed button's index.
Returns the tree's root item, or [code]null[/code] if the tree is empty.
Returns the current scrolling position.
Returns the currently focused item, or [code]null[/code] if no item is focused. In [constant SELECT_ROW] and [constant SELECT_SINGLE] modes, the focused item is same as the selected item. In [constant SELECT_MULTI] mode, the focused item is the item under the focus cursor, not necessarily selected. To get the currently selected item(s), use [method get_next_selected].
Returns the currently focused column, or -1 if no column is focused. In [constant SELECT_SINGLE] mode, the focused column is the selected column. In [constant SELECT_ROW] mode, the focused column is always 0 if any item is selected. In [constant SELECT_MULTI] mode, the focused column is the column under the focus cursor, and there are not necessarily any column selected. To tell whether a column of an item is selected, use [method TreeItem.is_selected].
Returns [code]true[/code] if the column has enabled clipping (see [method set_column_clip_content]).
Returns [code]true[/code] if the column has enabled expanding (see [method set_column_expand]).
Causes the [Tree] to jump to the specified [TreeItem].
Allows to enable clipping for column's content, making the content size ignored.
Overrides the calculated minimum width of a column. It can be set to [code]0[/code] to restore the default behavior. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to [member Control.size_flags_stretch_ratio].
If [code]true[/code], the column will have the "Expand" flag of [Control]. Columns that have the "Expand" flag will use their expand ratio in a similar fashion to [member Control.size_flags_stretch_ratio] (see [method set_column_expand_ratio]).
Sets the relative expand ratio for a column. See [method set_column_expand].
Sets the title of a column.
Sets the column title alignment. Note that [constant @GlobalScope.HORIZONTAL_ALIGNMENT_FILL] is not supported for column titles.
Sets column title base writing direction.
Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Selects the specified [TreeItem] and column.
- If [code]true[/code], the currently selected cell may be selected again.
- If [code]true[/code], a right mouse button click can select items.
- If [code]true[/code], allows navigating the [Tree] with letter keys through incremental search.
- If [code]true[/code], tree items with no tooltip assigned display their text as their tooltip. See also [method TreeItem.get_tooltip_text] and [method TreeItem.get_button_tooltip_text].
- If [code]true[/code], column titles are visible.
- The number of columns.
- The drop mode as an OR combination of flags. See [enum DropModeFlags] constants. Once dropping is done, reverts to [constant DROP_MODE_DISABLED]. Setting this during [method Control._can_drop_data] is recommended. This controls the drop sections, i.e. the decision and drawing of possible drop locations based on the mouse position.
- If [code]true[/code], recursive folding is enabled for this [Tree]. Holding down [kbd]Shift[/kbd] while clicking the fold arrow or using [code]ui_right[/code]/[code]ui_left[/code] shortcuts collapses or uncollapses the [TreeItem] and all its descendants.
- If [code]true[/code], the folding arrow is hidden.
- If [code]true[/code], the tree's root is hidden.
- If [code]true[/code], enables horizontal scrolling.
- If [code]true[/code], enables vertical scrolling.
- Allows single or multiple selection. See the [enum SelectMode] constants.
Emitted when a button on the tree was pressed (see [method TreeItem.add_button]).
Emitted when a cell is selected.
Emitted when [method TreeItem.propagate_check] is called. Connect to this signal to process the items that are affected when [method TreeItem.propagate_check] is invoked. The order that the items affected will be processed is as follows: the item that invoked the method, children of that item, and finally parents of that item.
Emitted when a column's title is clicked with either [constant MOUSE_BUTTON_LEFT] or [constant MOUSE_BUTTON_RIGHT].
Emitted when an item with [constant TreeItem.CELL_MODE_CUSTOM] is clicked with a mouse button.
Emitted when a cell with the [constant TreeItem.CELL_MODE_CUSTOM] is clicked to be edited.
Emitted when a mouse button is clicked in the empty space of the tree.
Emitted when an item is double-clicked, or selected with a [code]ui_accept[/code] input event (e.g. using [kbd]Enter[/kbd] or [kbd]Space[/kbd] on the keyboard).
Emitted when an item is collapsed by a click on the folding arrow.
Emitted when an item is edited.
Emitted when an item's icon is double-clicked. For a signal that emits when any part of the item is double-clicked, see [signal item_activated].
Emitted when an item is selected with a mouse button.
Emitted when an item is selected.
Emitted instead of [signal item_selected] if [member select_mode] is set to [constant SELECT_MULTI].
Emitted when a left mouse button click does not select any item.
Allows selection of a single cell at a time. From the perspective of items, only a single item is allowed to be selected. And there is only one column selected in the selected item. The focus cursor is always hidden in this mode, but it is positioned at the current selection, making the currently selected item the currently focused item.
Allows selection of a single row at a time. From the perspective of items, only a single items is allowed to be selected. And all the columns are selected in the selected item. The focus cursor is always hidden in this mode, but it is positioned at the first column of the current selection, making the currently selected item the currently focused item.
Allows selection of multiple cells at the same time. From the perspective of items, multiple items are allowed to be selected. And there can be multiple columns selected in each selected item. The focus cursor is visible in this mode, the item or column under the cursor is not necessarily selected.
Disables all drop sections, but still allows to detect the "on item" drop section by [method get_drop_section_at_position]. [b]Note:[/b] This is the default flag, it has no effect when combined with other flags.
Enables the "on item" drop section. This drop section covers the entire item. When combined with [constant DROP_MODE_INBETWEEN], this drop section halves the height and stays centered vertically.
Enables "above item" and "below item" drop sections. The "above item" drop section covers the top half of the item, and the "below item" drop section covers the bottom half. When combined with [constant DROP_MODE_ON_ITEM], these drop sections halves the height and stays on top / bottom accordingly.
The [Color] of the relationship lines between the selected [TreeItem] and its children.
Text [Color] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when it's hovered.
[Color] used to draw possible drop locations. See [enum DropModeFlags] constants for further description of drop locations.
Default text [Color] of the item.
Text [Color] for a [constant TreeItem.CELL_MODE_CHECK] mode cell when it's non-editable (see [method TreeItem.set_editable]).
Text [Color] used when the item is hovered.
Text [Color] used when the item is hovered, while a button of the same item is hovered as the same time.
The tint of text outline of the item.
Text [Color] used when the item is selected.
[Color] of the guideline.
The [Color] of the relationship lines between the selected [TreeItem] and its parents.
The default [Color] of the relationship lines.
Default text [Color] of the title button.
The horizontal space between each button in a cell.
The width of the relationship lines between the selected [TreeItem] and its children.
Draws the guidelines if not zero, this acts as a boolean. The guideline is a horizontal line drawn at the bottom of each item.
Draws the relationship lines if not zero, this acts as a boolean. Relationship lines are drawn at the start of child items to show hierarchy.
The horizontal space between item cells. This is also used as the margin at the start of an item when folding is disabled.
The maximum allowed width of the icon in item's cells. This limit is applied on top of the default size of the icon, but before the value set with [method TreeItem.set_icon_max_width]. The height is adjusted according to the icon's ratio.
The inner bottom margin of a cell.
The inner left margin of a cell.
The inner right margin of a cell.
The inner top margin of a cell.
The horizontal margin at the start of an item. This is used when folding is enabled for the item.
The size of the text outline. [b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
The space between the parent relationship lines for the selected [TreeItem] and the relationship lines to its siblings that are not selected.
The width of the relationship lines between the selected [TreeItem] and its parents.
The default width of the relationship lines.
The maximum distance between the mouse cursor and the control's border to trigger border scrolling when dragging.
The speed of border scrolling.
The horizontal separation of tree content and scrollbar.
The bottom margin of the scrollbars. When negative, uses [theme_item panel] bottom margin.
The left margin of the horizontal scrollbar. When negative, uses [theme_item panel] left margin.
The right margin of the scrollbars. When negative, uses [theme_item panel] right margin.
The top margin of the vertical scrollbar. When negative, uses [theme_item panel] top margin.
The vertical separation of tree content and scrollbar.
The vertical padding inside each item, i.e. the distance between the item's content and top/bottom border.
[Font] of the item's text.
[Font] of the title button's text.
Font size of the item's text.
Font size of the title button's text.
The arrow icon used when a foldable item is not collapsed.
The arrow icon used when a foldable item is collapsed (for left-to-right layouts).
The arrow icon used when a foldable item is collapsed (for right-to-left layouts).
The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is checked and editable (see [method TreeItem.set_editable]).
The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is checked and non-editable (see [method TreeItem.set_editable]).
The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is indeterminate and editable (see [method TreeItem.set_editable]).
The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is indeterminate and non-editable (see [method TreeItem.set_editable]).
The arrow icon to display for the [constant TreeItem.CELL_MODE_RANGE] mode cell.
The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is unchecked and editable (see [method TreeItem.set_editable]).
The check icon to display when the [constant TreeItem.CELL_MODE_CHECK] mode cell is unchecked and non-editable (see [method TreeItem.set_editable]).
The updown arrow icon to display for the [constant TreeItem.CELL_MODE_RANGE] mode cell.
[StyleBox] used when a button in the tree is hovered.
[StyleBox] used when a button in the tree is pressed.
[StyleBox] used for the cursor, when the [Tree] is being focused.
[StyleBox] used for the cursor, when the [Tree] is not being focused.
Default [StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode cell when button is enabled with [method TreeItem.set_custom_as_button].
[StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode button cell when it's hovered.
[StyleBox] for a [constant TreeItem.CELL_MODE_CUSTOM] mode button cell when it's pressed.
The focused style for the [Tree], drawn on top of everything.
[StyleBox] for the item being hovered.
[StyleBox] for the item being hovered, while a button of the same item is hovered as the same time.
The background style for the [Tree].
[StyleBox] for the selected items, used when the [Tree] is not being focused.
[StyleBox] for the selected items, used when the [Tree] is being focused.
[StyleBox] used when the title button is being hovered.
Default [StyleBox] for the title button.
[StyleBox] used when the title button is being pressed.