Scrollbar

A scrollbar to help making a scroll view.

Authors and contributors to this experimental extension: D8H, Jurfix, Alios.

Warning

This is an extension made by a community member and it only got through a light review by the GDevelop extension team. As such, we can't guarantee it meets all the quality standards of fully reviewed extensions.

A scrollbar to help making a scroll view.

An example of scroll view can be found in the multiplayer custom lobbies extension.

Tip

Learn how to install new extensions by following a step-by-step guide.

Scrollbar

A scrollbar to help making a scroll view.

Object properties

Min thumb length (🔢 Number, Distance). Default value is 40.
Hide the bar when the content is too small (🔘 Boolean). Default value is true.

See internal technical details

Min thumb length is stored as ThumbLengthMin (Number). Unit is Pixel. Default value is 40.
Hide the bar when the content is too small is stored as ShouldHideWhenUseless (Boolean). Default value is true.

Object actions

Content length
Change the content length of the object. The length of the content to scroll. The scroll bar don't actually scroll the content. You have to do it yourself with camera actions.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Scrollbar::Scrollbar::SetContentLength.

Scroll bottom position
Change the bottom position of the displayed part.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Scrollbar::Scrollbar::SetScrollBottom.

Scroll center position
Change the center position of the displayed part.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Scrollbar::Scrollbar::SetScrollCenter.

Scroll top position
Change the top position of the displayed part.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Operator
Parameter 2 (🔢 Number): Value

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this action internal type (in GDevelop JSON) is Scrollbar::Scrollbar::SetScrollPosition.

Object conditions

Content length
Compare the content length of the object. The length of the content to scroll. The scroll bar don't actually scroll the content. You have to do it yourself with camera actions.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is Scrollbar::Scrollbar::ContentLength.

Scrolling is required
Check if the content is big enough to require scrolling.

See parameters & details

Parameter 0: 👾 Object

Technical note: parameter 1 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is Scrollbar::Scrollbar::IsScrollingRequired.

Thumb is dragged
Check if the thumb of the scrollbar is dragged.

See parameters & details

Parameter 0: 👾 Object

Technical note: parameter 1 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is Scrollbar::Scrollbar::IsThumbDragged.

Scroll bottom position
Compare the bottom position of the displayed part.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is Scrollbar::Scrollbar::ScrollBottom.

Scroll center position
Compare the center position of the displayed part.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is Scrollbar::Scrollbar::ScrollCenter.

Scroll top position
Compare the top position of the displayed part.

See parameters & details

Parameter 0: 👾 Object
Parameter 1: 🟰 Relational operator
Parameter 2 (🔢 Number): Value to compare

Technical note: parameter 3 is an internal parameter handled by GDevelop.

Technical note: this condition internal type (in GDevelop JSON) is Scrollbar::Scrollbar::ScrollTop.

Object expressions

Expression	Description
`Object.ContentLength()`	Return the content length of the object. The length of the content to scroll. The scroll bar don't actually scroll the content. You have to do it yourself with camera actions.
`Object.ScrollBottom()`	Return the bottom position of the displayed part.
`Object.ScrollCenter()`	Return the center position of the displayed part.
`Object.ScrollTop()`	Return the top position of the displayed part.

This page is an auto-generated reference page about the Scrollbar extension for GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone. Learn more about all GDevelop extensions here.