Files
Basalt/docs/objects/ScrollableFrame/setScrollAmount.md
Robert Jelic 2931a95c20 - Docs Update
- Updated List & ScrollbarFrame Docs
- Added setOptions for the List Object
2023-05-06 18:32:33 +02:00

687 B

setScrollAmount

Description

The setScrollAmount method allows you to set the maximum allowed scroll value. This value determines how far the content of the ScrollableFrame can be scrolled.

Parameters

  1. number The maximum scroll value

Returns

  1. object The object in use

Usage

  • Set the scrolling direction for a ScrollableFrame
local mainFrame = basalt.createFrame()
local scrollableFrame = mainFrame:addScrollableFrame()

scrollableFrame:setScrollAmount(10)

By setting the scroll amount, you can control how much the content of the ScrollableFrame can be scrolled, ensuring that the user can only view a specific range of content at a time.