ScrollContainer

Inherits: Container < Control < CanvasItem < Node < Object Inherited By: EditorInspector A helper node for displaying scrollable elements such as lists.

Description

Control child. ScrollContainers will automatically create a scrollbar child (HScrollBar, VScrollBar, or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the Control.rect_min_size of the Control relative to the ScrollContainer. Works great with a Panel control. You can set EXPAND on the children’s size flags, so they will upscale to the ScrollContainer’s size if it’s larger (scroll is invisible for the chosen dimension).

Tutorials

• GUI containers

  Properties

  Methods

  Theme Properties

  Signals

• scroll_ended ( ) Emitted when scrolling stops.

• scroll_started ( ) Emitted when scrolling is started.

  Property Descriptions

• bool follow_focus true, the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.

- int scroll_deadzone

• int scroll_horizontal The current horizontal scroll value.

• bool scroll_horizontal_enabled true, enables horizontal scrolling.

• int scroll_vertical The current vertical scroll value.

• bool scroll_vertical_enabled true, enables vertical scrolling.

  Method Descriptions

• ensure_control_visible ( Control control ) control is visible (must be a direct or indirect child of the ScrollContainer). Used by follow_focus. Note: This will not work on a node that was just added during the same frame. If you want to scroll to a newly added child, you must wait until the next frame using SceneTree.idle_frame:

  add_child(child_node)yield(get_tree(), "idle_frame")ensure_control_visible(child_node)

• HScrollBar get_h_scrollbar ( ) HScrollBar of this ScrollContainer. Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the horizontal scrollbar, use scroll_horizontal_enabled. If you want to only hide it instead, use its CanvasItem.visible property.

• VScrollBar get_v_scrollbar ( ) VScrollBar of this ScrollContainer. Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the vertical scrollbar, use scroll_vertical_enabled. If you want to only hide it instead, use its CanvasItem.visible property.

  Theme Property Descriptions

• StyleBox bg StyleBox of the ScrollContainer.