Inheritance #

ScrollContainer #

is_instantiable, Node, core, not_builtin_classes

A container used to provide scrollbars to a child control when needed.

A container used to provide a child control with scrollbars when needed. 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.custom_minimum_size of the Control relative to the ScrollContainer.

Members #

var clip_contents: bool = true#

var draw_focus_border: bool = false#

If true, focus is drawn when the ScrollContainer or one of its descendant nodes is focused.

var follow_focus: bool = false#

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

var horizontal_scroll_mode = SCROLL_MODE_AUTO#

Controls whether horizontal scrollbar can be used and when it should be visible. See ScrollMode for options.

var scroll_deadzone: int = 0#

Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive.

var scroll_horizontal: int = 0#

The current horizontal scroll value.

Note: If you are setting this value in the Node._ready function or earlier, it needs to be wrapped with Object.set_deferred, since scroll bar's Range.max_value is not initialized yet.

func _ready():
    set_deferred("scroll_horizontal", 600)

var scroll_horizontal_custom_step: float = -1.0#

Overrides the ScrollBar.custom_step used when clicking the internal scroll bar's horizontal increment and decrement buttons or when using arrow keys when the ScrollBar is focused.

var scroll_vertical: int = 0#

The current vertical scroll value.

Note: Setting it early needs to be deferred, just like in scroll_horizontal.

func _ready():
    set_deferred("scroll_vertical", 600)

var scroll_vertical_custom_step: float = -1.0#

Overrides the ScrollBar.custom_step used when clicking the internal scroll bar's vertical increment and decrement buttons or when using arrow keys when the ScrollBar is focused.

var vertical_scroll_mode = SCROLL_MODE_AUTO#

Controls whether vertical scrollbar can be used and when it should be visible. See ScrollMode for options.

Methods #

add_child(child_node)
await get_tree().process_frame
ensure_control_visible(child_node)

Annotations #

Constants #

const SCROLL_MODE_DISABLED = 0 enum ScrollMode#

Scrolling disabled, scrollbar will be invisible.

const SCROLL_MODE_AUTO = 1 enum ScrollMode#

Scrolling enabled, scrollbar will be visible only if necessary, i.e. container's content is bigger than the container.

const SCROLL_MODE_SHOW_ALWAYS = 2 enum ScrollMode#

Scrolling enabled, scrollbar will be always visible.

const SCROLL_MODE_SHOW_NEVER = 3 enum ScrollMode#

Scrolling enabled, scrollbar will be hidden.

const SCROLL_MODE_RESERVE = 4 enum ScrollMode#

Combines SCROLL_MODE_AUTO and SCROLL_MODE_SHOW_ALWAYS. The scrollbar is only visible if necessary, but the content size is adjusted as if it was always visible. It's useful for ensuring that content size stays the same regardless if the scrollbar is visible.

Constructors #

Enums #

ScrollMode#

Operators #

Signals #

signal scroll_ended()#

Emitted when scrolling stops when dragging the scrollable area with a touch event. This signal is not emitted when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.

Note: This signal is only emitted on Android or iOS, or on desktop/web platforms when ProjectSettings.input_devices/pointing/emulate_touch_from_mouse is enabled.

signal scroll_started()#

Emitted when scrolling starts when dragging the scrollable area with a touch event. This signal is not emitted when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.

Note: This signal is only emitted on Android or iOS, or on desktop/web platforms when ProjectSettings.input_devices/pointing/emulate_touch_from_mouse is enabled.

Theme Items #

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

The focus border StyleBox of the ScrollContainer. Only used if draw_focus_border is true.

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

The background StyleBox of the ScrollContainer.

Tutorials #