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.
If true, focus is drawn when the ScrollContainer or one of its descendant nodes is focused.
If true, the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.
The way which scroll hints (indicators that show that the content can still be scrolled in a certain direction) will be shown.
Note: Hints won't be shown if the content can be scrolled both vertically and horizontally.
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)If true, the mouse wheel scrolls the view horizontally, and holding Shift scrolls vertically.
If false (default), the mouse wheel scrolls the view vertically, and holding Shift scrolls horizontally.
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.
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)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.
If true, the scroll hint texture will be tiled instead of stretched. See scroll_hint_mode.
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)Returns the horizontal 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 or hide a scrollbar, you can use horizontal_scroll_mode.
Returns the vertical 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 or hide a scrollbar, you can use vertical_scroll_mode.
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.
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.
SCROLL_MODE_DISABLED = 0Scrolling disabled, scrollbar will be invisible.
SCROLL_MODE_AUTO = 1Scrolling enabled, scrollbar will be visible only if necessary, i.e. container's content is bigger than the container.
SCROLL_MODE_SHOW_ALWAYS = 2Scrolling enabled, scrollbar will be always visible.
SCROLL_MODE_SHOW_NEVER = 3Scrolling enabled, scrollbar will be hidden.
SCROLL_MODE_RESERVE = 4Combines 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.
SCROLL_MODE_MAXIMIZE_FIRST = 5Behaves like SCROLL_MODE_AUTO, but makes the ScrollContainer report a minimum size based on its content (limited by Control.custom_maximum_size when set on the corresponding axis). This allows it to grow first and only start scrolling once constrained.
SCROLL_HINT_MODE_DISABLED = 0Scroll hints will never be shown.
SCROLL_HINT_MODE_ALL = 1Scroll hints will be shown at the top and bottom (if vertical), or left and right (if horizontal).
SCROLL_HINT_MODE_TOP_AND_LEFT = 2Scroll hints will be shown at the top (if vertical), or the left (if horizontal).
SCROLL_HINT_MODE_BOTTOM_AND_RIGHT = 3Scroll hints will be shown at the bottom (if horizontal), or the right (if horizontal).