Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
Inherited By: EditorInspector
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.
get_h_scroll_bar ( )
get_v_scroll_bar ( )
scroll_ended ( )
Emitted when scrolling stops.
scroll_started ( )
Emitted when scrolling is started.
ScrollMode SCROLL_MODE_DISABLED =
Scrolling disabled, scrollbar will be invisible.
ScrollMode SCROLL_MODE_AUTO =
Scrolling enabled, scrollbar will be visible only if necessary, i.e. container's content is bigger than the container.
ScrollMode SCROLL_MODE_SHOW_ALWAYS =
Scrolling enabled, scrollbar will be always visible.
ScrollMode SCROLL_MODE_SHOW_NEVER =
Scrolling enabled, scrollbar will be hidden.
bool follow_focus =
true, the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.
ScrollMode horizontal_scroll_mode =
Controls whether horizontal scrollbar can be used and when it should be visible. See ScrollMode for options.
int scroll_deadzone =
Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive.
int scroll_horizontal =
The current horizontal scroll value.
func _ready(): set_deferred("scroll_horizontal", 600)
float scroll_horizontal_custom_step =
int scroll_vertical =
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 =
ScrollMode vertical_scroll_mode =
Controls whether vertical scrollbar can be used and when it should be visible. See ScrollMode for options.
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)
HScrollBar get_h_scroll_bar ( )
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.
VScrollBar get_v_scroll_bar ( )
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.
Theme Property Descriptions¶
The background StyleBox of the ScrollContainer.