ScrollingFrame
Memory category | Gui |
---|
Member index 24
Removed member index 2
History | Member | |
---|---|---|
290 | AutoSizeCanvas: bool | |
290 | AutoSizeCanvasPadding: UDim2 |
Description
The ScrollingFrame is a special Frame that handles all scrolling for you, with a range of different ways to customize how the scrolling works.
History 114
- 645 Change ValueType of TopImage from Content to ContentId
- 645 Change ValueType of MidImage from Content to ContentId
- 645 Change ValueType of BottomImage from Content to ContentId
- 573 Change ReturnType of ScrollToTop from void to null
- 573 Change ReturnType of ClearInertialScrolling from void to null
- 553 Change Default of VerticalScrollBarPosition from to Right
- 553 Change Default of VerticalScrollBarInset from to None
- 553 Change Default of from to Rect(0, 0, 0, 0)
- 553 Change Default of TopImage from to ContentId(rbxasset://textures/ui/Scroll/scroll-top.png)
- 553 Change Default of ScrollingEnabled from to true
- 553 Change Default of ScrollingDirection from to XY
- 553 Change Default of from to Vector2(0, 0)
- 553 Change Default of ScrollBarThickness from to 12
- 553 Change Default of ScrollBarImageTransparency from to 0
- 553 Change Default of ScrollBarImageColor3 from to Color3(1, 1, 1)
- 553 Change Default of MidImage from to ContentId(rbxasset://textures/ui/Scroll/scroll-middle.png)
- 553 Change Default of from to Vector2(0, 0)
- 553 Change Default of HorizontalScrollBarInset from to None
- 553 Change Default of from to Rect(0, 0, 0, 0)
- 553 Change Default of ElasticBehavior from to WhenScrollable
- 553 Change Default of CanvasSize from to UDim2({0, 0}, {2, 0})
- 553 Change Default of CanvasPosition from to Vector2(0, 0)
- 553 Change Default of BottomImage from to ContentId(rbxasset://textures/ui/Scroll/scroll-bottom.png)
- 553 Change Default of AutomaticCanvasSize from to None
- 553 Change Default of AbsoluteWindowSize from to Vector2(0, 0)
- 553 Change Default of AbsoluteCanvasSize from to Vector2(0, 0)
- 501 Add
- 496 Change ThreadSafety of AbsoluteCanvasSize from ReadSafe to Unsafe
- 496 Change Tags of AbsoluteCanvasSize from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
- 496 Change ReadSecurity of AbsoluteCanvasSize from RobloxScriptSecurity to None
- 496 Change Category of AbsoluteCanvasSize from Debugging to Scrolling
- 496 Change CanSave of AbsoluteCanvasSize from false to true
- 496 Change WriteSecurity of AbsoluteCanvasSize from RobloxScriptSecurity to None
- 486 Change ThreadSafety of VerticalScrollBarPosition from ReadOnly to ReadSafe
- 486 Change ThreadSafety of VerticalScrollBarInset from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of TopImage from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ScrollingEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ScrollingDirection from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ScrollBarThickness from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ScrollBarImageTransparency from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ScrollBarImageColor3 from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MidImage from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of HorizontalScrollBarInset from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ElasticBehavior from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CanvasSize from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CanvasPosition from ReadOnly to ReadSafe
- 486 Change ThreadSafety of BottomImage from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AutomaticCanvasSize from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AbsoluteCanvasSize from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ScrollToTop from to Unsafe
- 462 Change ThreadSafety of GetSampledInertialVelocity from to Unsafe
- 462 Change ThreadSafety of ClearInertialScrolling from to Unsafe
- 462 Change ThreadSafety of VerticalScrollBarPosition from to ReadOnly
- 462 Change ThreadSafety of VerticalScrollBarInset from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of TopImage from to ReadOnly
- 462 Change ThreadSafety of ScrollingEnabled from to ReadOnly
- 462 Change ThreadSafety of ScrollingDirection from to ReadOnly
- 462 Change ThreadSafety of ScrollBarThickness from to ReadOnly
- 462 Change ThreadSafety of ScrollBarImageTransparency from to ReadOnly
- 462 Change ThreadSafety of ScrollBarImageColor3 from to ReadOnly
- 462 Change ThreadSafety of MidImage from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of HorizontalScrollBarInset from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of ElasticBehavior from to ReadOnly
- 462 Change ThreadSafety of CanvasSize from to ReadOnly
- 462 Change ThreadSafety of CanvasPosition from to ReadOnly
- 462 Change ThreadSafety of BottomImage from to ReadOnly
- 462 Change ThreadSafety of AutomaticCanvasSize from to ReadOnly
- 462 Change ThreadSafety of AbsoluteWindowSize from to Unsafe
- 462 Change ThreadSafety of AbsoluteCanvasSize from to ReadOnly
- 454 Change MemoryCategory of ScrollingFrame from Instances to Gui
- 452 Change MemoryCategory of ScrollingFrame from Gui to Instances
- 453 Change MemoryCategory of ScrollingFrame from Instances to Gui
- 452 Add
- 452 Add
- 452 Add
- 452 Add AbsoluteCanvasSize
- 449 Add AutomaticCanvasSize
- 392 Add GetSampledInertialVelocity
- 392 Add ClearInertialScrolling
- 348 Add ScrollBarImageTransparency
- 348 Add ScrollBarImageColor3
- 329 Add ScrollingDirection
- 329 Add ElasticBehavior
- 325 Add ScrollToTop
- 299 Add VerticalScrollBarPosition
- 299 Add VerticalScrollBarInset
- 299 Add HorizontalScrollBarInset
- 290 Remove AutoSizeCanvasPadding
- 290 Remove AutoSizeCanvas
- 287 Add AutoSizeCanvasPadding
- 287 Add AutoSizeCanvas
- 285 Remove AutoSizeCanvasPadding
- 285 Remove AutoSizeCanvas
- 286 Add AutoSizeCanvasPadding
- 286 Add AutoSizeCanvas
- 285 Remove AutoSizeCanvasPadding
- 285 Remove AutoSizeCanvas
- 286 Add AutoSizeCanvasPadding
- 286 Add AutoSizeCanvas
- 149 Add TopImage
- 149 Add ScrollingEnabled
- 149 Add ScrollBarThickness
- 149 Add MidImage
- 149 Add CanvasSize
- 149 Add CanvasPosition
- 149 Add BottomImage
- 149 Add AbsoluteWindowSize
- 149 Add ScrollingFrame
Members 24
AbsoluteCanvasSize
Type | Default | |
---|---|---|
Vector2 | 0, 0 |
The size in offsets of the area that is scrollable. This property is set to the maximum of the CanvasSize property and the size of the children if AutomaticCanvasSize is set to something other than AutomaticSize.None.
Thread safety | Unsafe |
---|---|
Category | Scrolling |
Loaded/Saved | false/true |
History 10
- 553 Change Default of AbsoluteCanvasSize from to Vector2(0, 0)
- 496 Change ThreadSafety of AbsoluteCanvasSize from ReadSafe to Unsafe
- 496 Change Tags of AbsoluteCanvasSize from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
- 496 Change ReadSecurity of AbsoluteCanvasSize from RobloxScriptSecurity to None
- 496 Change Category of AbsoluteCanvasSize from Debugging to Scrolling
- 496 Change CanSave of AbsoluteCanvasSize from false to true
- 496 Change WriteSecurity of AbsoluteCanvasSize from RobloxScriptSecurity to None
- 486 Change ThreadSafety of AbsoluteCanvasSize from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AbsoluteCanvasSize from to ReadOnly
- 452 Add AbsoluteCanvasSize
AbsoluteWindowSize
Type | Default | |
---|---|---|
Vector2 | 0, 0 |
The size in offsets of the frame, without the scrollbars.
Thread safety | Unsafe |
---|---|
Category | Scrolling |
Loaded/Saved | false/true |
History 3
- 553 Change Default of AbsoluteWindowSize from to Vector2(0, 0)
- 462 Change ThreadSafety of AbsoluteWindowSize from to Unsafe
- 149 Add AbsoluteWindowSize
AutomaticCanvasSize
Type | Default | |
---|---|---|
AutomaticSize | None |
This property is used to automatically size parent UI objects based on the size of its descendants. Developers can use this property to dynamically add text and other content to a UI object at edit or run time, and the size will adjust to fit that content.
When this property is set to an AutomaticSize value other than None, AbsoluteCanvasSize may resize depending on its child content.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of AutomaticCanvasSize from to None
- 486 Change ThreadSafety of AutomaticCanvasSize from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AutomaticCanvasSize from to ReadOnly
- 449 Add AutomaticCanvasSize
BottomImage
Type | Default | |
---|---|---|
ContentId | rbxasset://textures/ui/Scroll/scroll-bottom.png |
The Down image on the vertical scrollbar. Size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the image on the horizontal scroll bar.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 5
- 645 Change ValueType of BottomImage from Content to ContentId
- 553 Change Default of BottomImage from to ContentId(rbxasset://textures/ui/Scroll/scroll-bottom.png)
- 486 Change ThreadSafety of BottomImage from ReadOnly to ReadSafe
- 462 Change ThreadSafety of BottomImage from to ReadOnly
- 149 Add BottomImage
CanvasPosition
Type | Default | |
---|---|---|
Vector2 | 0, 0 |
The location within the canvas, in offsets, that should be drawn at the top left of the scroll frame
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of CanvasPosition from to Vector2(0, 0)
- 486 Change ThreadSafety of CanvasPosition from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CanvasPosition from to ReadOnly
- 149 Add CanvasPosition
CanvasSize
Type | Default | |
---|---|---|
UDim2 | {0, 0}, {2, 0} |
Determines the size of the area that is scrollable. The UDim2 is calculated using the parent gui's size, similar to the regular Size property on gui objects.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of CanvasSize from to UDim2({0, 0}, {2, 0})
- 486 Change ThreadSafety of CanvasSize from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CanvasSize from to ReadOnly
- 149 Add CanvasSize
ClearInertialScrolling
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 573 Change ReturnType of ClearInertialScrolling from void to null
- 462 Change ThreadSafety of ClearInertialScrolling from to Unsafe
- 392 Add ClearInertialScrolling
ElasticBehavior
Type | Default | |
---|---|---|
ElasticBehavior | WhenScrollable |
This property determines if and when the ScrollingFrame canvas is elastic. Defaults to WhenScrollable.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of ElasticBehavior from to WhenScrollable
- 486 Change ThreadSafety of ElasticBehavior from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ElasticBehavior from to ReadOnly
- 329 Add ElasticBehavior
GetSampledInertialVelocity
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Vector2 |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetSampledInertialVelocity from to Unsafe
- 392 Add GetSampledInertialVelocity
HorizontalScrollBarInset
Type | Default | |
---|---|---|
ScrollBarInset | None |
Indicates the inset behavior of the horizontal scrolling bar.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of HorizontalScrollBarInset from to None
- 486 Change ThreadSafety of HorizontalScrollBarInset from ReadOnly to ReadSafe
- 462 Change ThreadSafety of HorizontalScrollBarInset from to ReadOnly
- 299 Add HorizontalScrollBarInset
MidImage
Type | Default | |
---|---|---|
ContentId | rbxasset://textures/ui/Scroll/scroll-middle.png |
The middle image on the vertical scrollbar. The size of this can vary in the y direction, but is always set as ScrollingFrame.ScrollBarThickness in the x direction. This is also used as the middle image on the horizontal scroll bar.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
ScrollBarImageColor3
Type | Default | |
---|---|---|
Color3 | 1, 1, 1 |
Determines how a scrolling bar image is colorized. When set to white, no colorization occurs. This property is very useful for reusing image assets: If the source image is completely white with transparency, you can set the entire color of the image at once with this property.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of ScrollBarImageColor3 from to Color3(1, 1, 1)
- 486 Change ThreadSafety of ScrollBarImageColor3 from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ScrollBarImageColor3 from to ReadOnly
- 348 Add ScrollBarImageColor3
ScrollBarImageTransparency
Type | Default | |
---|---|---|
float | 0 |
Determines the alpha of a scroll bar's rendered image. A value of 0 is completely opaque, and a value of 1 is completely transparent (invisible). This property behaves similarly to GuiObject.BackgroundTransparency or BasePart.Transparency.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of ScrollBarImageTransparency from to 0
- 486 Change ThreadSafety of ScrollBarImageTransparency from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ScrollBarImageTransparency from to ReadOnly
- 348 Add ScrollBarImageTransparency
ScrollBarThickness
Type | Default | |
---|---|---|
int | 12 |
How thick the scroll bar appears. This applies to both the horizontal and vertical scroll bars. If set to 0, no scroll bars are rendered.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of ScrollBarThickness from to 12
- 486 Change ThreadSafety of ScrollBarThickness from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ScrollBarThickness from to ReadOnly
- 149 Add ScrollBarThickness
ScrollToTop
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 3
- 573 Change ReturnType of ScrollToTop from void to null
- 462 Change ThreadSafety of ScrollToTop from to Unsafe
- 325 Add ScrollToTop
ScrollingDirection
Type | Default | |
---|---|---|
ScrollingDirection | XY |
This property determines the direction scrolling is allowed. If scrolling is disallowed in a direction, the scrollbar will not appear. Defaults to XY.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of ScrollingDirection from to XY
- 486 Change ThreadSafety of ScrollingDirection from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ScrollingDirection from to ReadOnly
- 329 Add ScrollingDirection
ScrollingEnabled
Type | Default | |
---|---|---|
bool | true |
Determines whether or not scrolling is allowed on the frame. If false, no scroll bars will be rendered.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of ScrollingEnabled from to true
- 486 Change ThreadSafety of ScrollingEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ScrollingEnabled from to ReadOnly
- 149 Add ScrollingEnabled
TopImage
Type | Default | |
---|---|---|
ContentId | rbxasset://textures/ui/Scroll/scroll-top.png |
The Up image on the vertical scrollbar. The size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the left image on the horizontal scroll bar.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
VerticalScrollBarInset
Type | Default | |
---|---|---|
ScrollBarInset | None |
Indicates the inset behavior of the vertical scrolling bar.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of VerticalScrollBarInset from to None
- 486 Change ThreadSafety of VerticalScrollBarInset from ReadOnly to ReadSafe
- 462 Change ThreadSafety of VerticalScrollBarInset from to ReadOnly
- 299 Add VerticalScrollBarInset
VerticalScrollBarPosition
Type | Default | |
---|---|---|
VerticalScrollBarPosition | Right |
Indicates the side that the vertical scrollbar will be located at.
Thread safety | ReadSafe |
---|---|
Category | Scrolling |
Loaded/Saved | true |
History 4
- 553 Change Default of VerticalScrollBarPosition from to Right
- 486 Change ThreadSafety of VerticalScrollBarPosition from ReadOnly to ReadSafe
- 462 Change ThreadSafety of VerticalScrollBarPosition from to ReadOnly
- 299 Add VerticalScrollBarPosition
Removed members 2
AutoSizeCanvas
Type | Default | |
---|---|---|
bool |
Category | |
---|---|
Loaded/Saved | false |
History 6
- 290 Remove AutoSizeCanvas
- 287 Add AutoSizeCanvas
- 285 Remove AutoSizeCanvas
- 286 Add AutoSizeCanvas
- 285 Remove AutoSizeCanvas
- 286 Add AutoSizeCanvas
AutoSizeCanvasPadding
Type | Default | |
---|---|---|
UDim2 |
Category | |
---|---|
Loaded/Saved | false |
History 6
- 290 Remove AutoSizeCanvasPadding
- 287 Add AutoSizeCanvasPadding
- 285 Remove AutoSizeCanvasPadding
- 286 Add AutoSizeCanvasPadding
- 285 Remove AutoSizeCanvasPadding
- 286 Add AutoSizeCanvasPadding