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 [member Control.custom_minimum_size] of the Control relative to the ScrollContainer.
$DOCS_URL/tutorials/ui/gui_containers.html
Ensures the given [param control] is visible (must be a direct or indirect child of the ScrollContainer). Used by [member follow_focus]. [b]Note:[/b] 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 [signal SceneTree.process_frame]: [codeblock] add_child(child_node) await get_tree().process_frame ensure_control_visible(child_node) [/codeblock]
Returns the horizontal scrollbar [HScrollBar] of this [ScrollContainer]. [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable or hide a scrollbar, you can use [member horizontal_scroll_mode].
Returns the vertical scrollbar [VScrollBar] of this [ScrollContainer]. [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable or hide a scrollbar, you can use [member vertical_scroll_mode].
- If [code]true[/code], the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.
- Controls whether horizontal scrollbar can be used and when it should be visible. See [enum ScrollMode] for options.
- Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive.
- The current horizontal scroll value. [b]Note:[/b] If you are setting this value in the [method Node._ready] function or earlier, it needs to be wrapped with [method Object.set_deferred], since scroll bar's [member Range.max_value] is not initialized yet. [codeblock] func _ready(): set_deferred("scroll_horizontal", 600) [/codeblock]
- Overrides the [member 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.
- The current vertical scroll value. [b]Note:[/b] Setting it early needs to be deferred, just like in [member scroll_horizontal]. [codeblock] func _ready(): set_deferred("scroll_vertical", 600) [/codeblock]
- Overrides the [member 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.
- Controls whether vertical scrollbar can be used and when it should be visible. See [enum ScrollMode] for options.
Emitted when scrolling stops.
Emitted when scrolling is started.
Scrolling disabled, scrollbar will be invisible.
Scrolling enabled, scrollbar will be visible only if necessary, i.e. container's content is bigger than the container.
Scrolling enabled, scrollbar will be always visible.
Scrolling enabled, scrollbar will be hidden.
The background [StyleBox] of the [ScrollContainer].