extends GuiObject
Class fields
| Field | XML type | Value |
|---|---|---|
Name | string | ScrollingFrame |
summary | string | A container object used to layout other GUI objects, and allows for scrolling. |
ExplorerOrder | string | 15 |
ExplorerImageIndex | string | 48 |
PreferredParent | string | StarterGui |
Properties
16AbsoluteWindowSize
Vector2| Field | XML type | Value |
|---|---|---|
Name | string | AbsoluteWindowSize |
summary | string | The size in pixels of the frame, without the scrollbars. |
AutomaticCanvasSize
AutomaticSize| Field | XML type | Value |
|---|---|---|
Name | string | AutomaticCanvasSize |
BottomImage
Content| Field | XML type | Value |
|---|---|---|
Name | string | BottomImage |
summary | string | The "Down" image on the vertical scrollbar. Size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the "right" image on the horizontal scroll bar. |
CanvasPosition
Vector2| Field | XML type | Value |
|---|---|---|
Name | string | CanvasPosition |
summary | string | The absolute position the scroll frame is in respect to the canvas size. The minimum this can be set to is (0,0), while the max is the absolute canvas size - AbsoluteWindowSize. |
CanvasSize
UDim2| Field | XML type | Value |
|---|---|---|
Name | string | CanvasSize |
summary | string | 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. |
ElasticBehavior
ElasticBehavior| Field | XML type | Value |
|---|---|---|
Name | string | ElasticBehavior |
HorizontalScrollBarInset
ScrollBarInset| Field | XML type | Value |
|---|---|---|
Name | string | HorizontalScrollBarInset |
MidImage
Content| Field | XML type | Value |
|---|---|---|
Name | string | MidImage |
summary | string | The "Middle" image on the vertical scrollbar. Size of this can vary in the y direction, but is always set at ScrollBarThickness in x direction. This is also used as the "mid" image on the horizontal scroll bar. |
ScrollBarImageColor3
Color3| Field | XML type | Value |
|---|---|---|
Name | string | ScrollBarImageColor3 |
ScrollBarImageTransparency
float| Field | XML type | Value |
|---|---|---|
Name | string | ScrollBarImageTransparency |
ScrollBarThickness
int| Field | XML type | Value |
|---|---|---|
Name | string | ScrollBarThickness |
summary | string | How thick the scroll bar appears. This applies to both the horizontal and vertical scroll bars. Can be set to 0 for no bars render. |
ScrollingDirection
ScrollingDirection| Field | XML type | Value |
|---|---|---|
Name | string | ScrollingDirection |
ScrollingEnabled
bool| Field | XML type | Value |
|---|---|---|
Name | string | ScrollingEnabled |
summary | string | Determines whether or not scrolling is allowed on this frame. If turned off, no scroll bars will be rendered. |
TopImage
Content| Field | XML type | Value |
|---|---|---|
Name | string | TopImage |
summary | string | The "Up" image on the vertical scrollbar. Size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the "left" image on the horizontal scroll bar. |
VerticalScrollBarInset
ScrollBarInset| Field | XML type | Value |
|---|---|---|
Name | string | VerticalScrollBarInset |
VerticalScrollBarPosition
VerticalScrollBarPosition| Field | XML type | Value |
|---|---|---|
Name | string | VerticalScrollBarPosition |
Functions
3ClearInertialScrolling
() → void| Field | XML type | Value |
|---|---|---|
Name | string | ClearInertialScrolling |
GetSampledInertialVelocity
() → Vector2| Field | XML type | Value |
|---|---|---|
Name | string | GetSampledInertialVelocity |
ScrollToTop
() → void| Field | XML type | Value |
|---|---|---|
Name | string | ScrollToTop |