Up to date

This page is up to date for Godot 4.1. If you still find outdated information, please open an issue.

VScrollBar

Inherits: ScrollBar < Range < Control < CanvasItem < Node < Object

A vertical scrollbar that goes from top (min) to bottom (max).

Description

A vertical scrollbar, typically used to navigate through content that extends beyond the visible height of a control. It is a Range-based control and goes from top (min) to bottom (max). Note that this direction is the opposite of VSlider‘s.

Properties

BitField<SizeFlags>

size_flags_horizontal

0 (overrides Control)

BitField<SizeFlags>

size_flags_vertical

1 (overrides Control)

Theme Properties

Texture2D

decrement

Texture2D

decrement_highlight

Texture2D

decrement_pressed

Texture2D

increment

Texture2D

increment_highlight

Texture2D

increment_pressed

StyleBox

grabber

StyleBox

grabber_highlight

StyleBox

grabber_pressed

StyleBox

scroll

StyleBox

scroll_focus


Theme Property Descriptions

Texture2D decrement

Icon used as a button to scroll the ScrollBar up. Supports custom step using the ScrollBar.custom_step property.


Texture2D decrement_highlight

Displayed when the mouse cursor hovers over the decrement button.


Texture2D decrement_pressed

Displayed when the decrement button is being pressed.


Texture2D increment

Icon used as a button to scroll the ScrollBar down. Supports custom step using the ScrollBar.custom_step property.


Texture2D increment_highlight

Displayed when the mouse cursor hovers over the increment button.


Texture2D increment_pressed

Displayed when the increment button is being pressed.


StyleBox grabber

Used as texture for the grabber, the draggable element representing current scroll.


StyleBox grabber_highlight

Used when the mouse hovers over the grabber.


StyleBox grabber_pressed

Used when the grabber is being dragged.


StyleBox scroll

Used as background of this ScrollBar.


StyleBox scroll_focus

Used as background when the ScrollBar has the GUI focus.