ScrollingFrame
A scrollable GUI container with shared text-layout properties.
Behavior
ScrollingFrame displays children inside a scrollable canvas. Its text-layout
fields are available when the frame carries text content.
Summary
The resolved top-left position of this interface element in pixels.
The resolved rotation of this interface element in degrees, including ancestor rotation.
The resolved width and height of this interface element in pixels.
Whether this interface accepts and consumes input.
The normalized point within the element used as the origin for Position.
The dimensions that resize to fit the element's content.
The color used to fill the element's background.
The background transparency, from 0 for opaque to 1 for invisible.
The color of the element's border.
Whether the border is drawn outside, across, or inside the element's bounds.
The border thickness in pixels.
The scroll offset within the canvas, in pixels.
The dimensions of the scrollable or surface-rendered canvas.
Whether descendant rendering is clipped to this element's bounds.
The corner radius used for the element's rounded background.
The individual corner radii used for the element's rounded background.
Whether pointer dragging can move the element.
The share of remaining main-axis space assigned to this child in flow layout.
The element's current idle, hover, pressed, or non-interactable state.
Which input events this element consumes before they reach elements behind it.
Whether the element accepts interaction.
Whether children use flow layout or their explicit positions.
The numeric order of this element when a parent layout sorts by layout order.
The interface element selected when navigating down from this element.
The interface element selected when navigating left from this element.
The interface element selected when navigating right from this element.
The interface element selected when navigating up from this element.
The opacity multiplier applied to this element and its descendants.
The element position relative to its parent.
The interface rotation in degrees.
The color used to draw the scroll bar.
The opacity of the scroll bar.
The scroll bar width in pixels.
Whether the user can scroll the canvas.
Whether interface navigation can select this element.
The interface element used to draw the selection indicator.
The numeric order used for interface selection traversal.
The element size relative to its parent.
The parent axes used to resolve relative interface size.
Whether this interface element is rendered.
The element's draw-order index.
Gives keyboard focus to this interface element.
Returns this instance if it is an ExecutionGroup.
Removes keyboard focus from this interface element.
Fires when pointer dragging of the element begins.
Fires when pointer dragging of the element ends.
Fires when input begins over or is dispatched to this interface element.
Fires when input dispatched to this element changes.
Fires when input dispatched to this element ends.
Fires when the mouse wheel scrolls backward over this element.
Fires when the mouse wheel scrolls forward over this element.
Fires when a pointer moves onto the frame.
Fires when a pointer moves off the frame.
Fires when the pointer moves across the frame.
Fires when interface navigation selects this element.
Fires when this element loses interface selection.
Properties
AbsolutePosition
ScrollingFrame.AbsolutePosition: Vector2 = Vector2.new(0, 0)The resolved top-left position of this interface element in pixels.
AbsoluteRotation
ScrollingFrame.AbsoluteRotation: number = 0The resolved rotation of this interface element in degrees, including ancestor rotation.
AbsoluteSize
ScrollingFrame.AbsoluteSize: Vector2 = Vector2.new(0, 0)The resolved width and height of this interface element in pixels.
Active
ScrollingFrame.Active: boolean = trueWhether this interface accepts and consumes input.
AnchorPoint
ScrollingFrame.AnchorPoint: Vector2 = Vector2.new(0, 0)The normalized point within the element used as the origin for Position. (0, 0) is the top-left corner; (0.5, 0.5) is the center.
AutomaticSize
ScrollingFrame.AutomaticSize: Enum.AutomaticSize = Enum.AutomaticSize.NoneThe dimensions that resize to fit the element's content.
BackgroundColor3
ScrollingFrame.BackgroundColor3: Color3 = Color3.new(0.6392157, 0.63529414, 0.64705884)The color used to fill the element's background.
BackgroundTransparency
ScrollingFrame.BackgroundTransparency: number = 0The background transparency, from 0 for opaque to 1 for invisible.
BorderColor3
ScrollingFrame.BorderColor3: Color3 = Color3.new(0.105882354, 0.16470589, 0.20784314)The color of the element's border.
BorderMode
ScrollingFrame.BorderMode: Enum.BorderMode = Enum.BorderMode.OutlineWhether the border is drawn outside, across, or inside the element's bounds.
BorderSizePixel
ScrollingFrame.BorderSizePixel: number = 1The border thickness in pixels.
CanvasPosition
ScrollingFrame.CanvasPosition: Vector2 = Vector2.new(0, 0)The scroll offset within the canvas, in pixels.
CanvasSize
The dimensions of the scrollable or surface-rendered canvas.
ClipsDescendants
ScrollingFrame.ClipsDescendants: boolean = falseWhether descendant rendering is clipped to this element's bounds.
CornerRadius
ScrollingFrame.CornerRadius: number = 0The corner radius used for the element's rounded background.
Corners
ScrollingFrame.Corners: { number } = {}The individual corner radii used for the element's rounded background.
Draggable
ScrollingFrame.Draggable: boolean = falseWhether pointer dragging can move the element.
Grow
ScrollingFrame.Grow: number = 0The share of remaining main-axis space assigned to this child in flow layout.
GuiState
ScrollingFrame.GuiState: Enum.GuiState = Enum.GuiState.IdleThe element's current idle, hover, pressed, or non-interactable state.
InputSink
ScrollingFrame.InputSink: Enum.InputSink = Enum.InputSink.NoneWhich input events this element consumes before they reach elements behind it.
Interactable
ScrollingFrame.Interactable: boolean = trueWhether the element accepts interaction.
Layout
ScrollingFrame.Layout: Enum.Layout = Enum.Layout.FlowWhether children use flow layout or their explicit positions.
LayoutOrder
ScrollingFrame.LayoutOrder: number = 0The numeric order of this element when a parent layout sorts by layout order.
NextSelectionDown
ScrollingFrame.NextSelectionDown: GuiObject? = nilThe interface element selected when navigating down from this element.
NextSelectionLeft
ScrollingFrame.NextSelectionLeft: GuiObject? = nilThe interface element selected when navigating left from this element.
NextSelectionRight
ScrollingFrame.NextSelectionRight: GuiObject? = nilThe interface element selected when navigating right from this element.
NextSelectionUp
ScrollingFrame.NextSelectionUp: GuiObject? = nilThe interface element selected when navigating up from this element.
Opacity
ScrollingFrame.Opacity: number = 1The opacity multiplier applied to this element and its descendants.
Position
The element position relative to its parent. Scale components use the parent size; offsets are in pixels.
Rotation
ScrollingFrame.Rotation: number = 0The interface rotation in degrees.
ScrollBarColor
ScrollingFrame.ScrollBarColor: Color3The color used to draw the scroll bar.
ScrollBarOpacity
ScrollingFrame.ScrollBarOpacity: numberThe opacity of the scroll bar.
ScrollBarThickness
ScrollingFrame.ScrollBarThickness: number = 12The scroll bar width in pixels.
ScrollingEnabled
ScrollingFrame.ScrollingEnabled: boolean = trueWhether the user can scroll the canvas.
Selectable
ScrollingFrame.Selectable: boolean = falseWhether interface navigation can select this element.
SelectionImageObject
ScrollingFrame.SelectionImageObject: GuiObject? = nilThe interface element used to draw the selection indicator.
SelectionOrder
ScrollingFrame.SelectionOrder: number = 0The numeric order used for interface selection traversal.
Size
The element size relative to its parent. Scale components use the parent size; offsets are in pixels.
SizeConstraint
ScrollingFrame.SizeConstraint: Enum.SizeConstraint = Enum.SizeConstraint.RelativeXYThe parent axes used to resolve relative interface size.
Visible
ScrollingFrame.Visible: boolean = trueWhether this interface element is rendered.
ZIndex
ScrollingFrame.ZIndex: number = 1The element's draw-order index. Interpretation depends on the root's ZIndexBehavior.
Methods
CaptureFocus
ScrollingFrame:CaptureFocus(): ()Gives keyboard focus to this interface element.
GetExecutionGroup
ScrollingFrame:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
ReleaseFocus
ScrollingFrame:ReleaseFocus(): ()Removes keyboard focus from this interface element.
Events
DragBegin
ScrollingFrame.DragBegin: RBXScriptSignalFires when pointer dragging of the element begins.
DragStopped
ScrollingFrame.DragStopped: RBXScriptSignalFires when pointer dragging of the element ends.
InputBegan
ScrollingFrame.InputBegan: RBXScriptSignalFires when input begins over or is dispatched to this interface element.
InputChanged
ScrollingFrame.InputChanged: RBXScriptSignalFires when input dispatched to this element changes.
InputEnded
ScrollingFrame.InputEnded: RBXScriptSignalFires when input dispatched to this element ends.
MouseWheelBackward
ScrollingFrame.MouseWheelBackward: RBXScriptSignalFires when the mouse wheel scrolls backward over this element.
MouseWheelForward
ScrollingFrame.MouseWheelForward: RBXScriptSignalFires when the mouse wheel scrolls forward over this element.
PointerEntered
ScrollingFrame.PointerEntered: RBXScriptSignalFires when a pointer moves onto the frame.
PointerExited
ScrollingFrame.PointerExited: RBXScriptSignalFires when a pointer moves off the frame.
PointerMoved
ScrollingFrame.PointerMoved: RBXScriptSignalFires when the pointer moves across the frame.
SelectionGained
ScrollingFrame.SelectionGained: RBXScriptSignalFires when interface navigation selects this element.
SelectionLost
ScrollingFrame.SelectionLost: RBXScriptSignalFires when this element loses interface selection.
Inherited members
- Properties
- CatchesPointer
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying
Example
local list = Instance.new("ScrollingFrame")
list.CanvasSize = UDim2.new(0, 0, 0, 600)
list.Parent = game:GetService("Players").LocalPlayer.PlayerGuiRelated APIs
Frame · UIListLayout · UDim2