Class reference

ScrollContainer

Inherits Container

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

Description

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.

Properties

bool clip_contents = true

bool draw_focus_border = false

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

bool follow_focus = false

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

int horizontal_scroll_mode = 1

Controls whether horizontal scrollbar can be used and when it should be visible.

int scroll_deadzone = 0

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

int scroll_horizontal = 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)
			

float scroll_horizontal_custom_step = -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.

int scroll_vertical = 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)
			

float scroll_vertical_custom_step = -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.

int vertical_scroll_mode = 1

Controls whether vertical scrollbar can be used and when it should be visible.

Methods

void ensure_control_visible(Control control)

Ensures the given 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.process_frame:

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

Signals

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.

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.

Constants

SCROLL_MODE_DISABLED = 0

Enum: ScrollMode

Scrolling disabled, scrollbar will be invisible.

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.

SCROLL_MODE_SHOW_ALWAYS = 2

Enum: ScrollMode

Scrolling enabled, scrollbar will be always visible.

SCROLL_MODE_SHOW_NEVER = 3

Enum: ScrollMode

Scrolling enabled, scrollbar will be hidden.

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.

Theme properties

Tutorials

Source revision 5592dc3a7a61
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.