ScrollingFrame
The ScrollingFrame is a special Frame that handles all scrolling for you, with a range of different ways to customize how the scrolling works.
概要
プロパティ
- 読み取り専用複製されていません
The size in offsets of the area that is scrollable.
- 読み取り専用複製されていません
The size in offsets of the frame, without the scrollbars.
Determines whether ScrollingFrame.CanvasSize is resized based on child content.
- 並列読み取り
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.
- 並列読み取り
The location within the canvas, in offsets, that should be drawn at the top left of the scroll frame.
- 並列読み取り
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.
Determines when elastic scrolling is allowed.
Indicates the inset behavior of the horizontal scrolling bar.
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.
- 並列読み取り
Determines how a rendered scroll bar image will be colorized.
Determines the transparency of the rendered scroll bar image.
- 並列読み取り
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.
Determines the direction scrolling is allowed in this scrolling frame.
- 並列読み取り
Determines whether or not scrolling is allowed on the frame. If false, no scroll bars will be rendered.
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.
Indicates the inset behavior of the vertical scrolling bar.
Indicates the side that the vertical scrollbar will be located at.
Determines whether a UI element sinks input.
- 並列読み取り
Determines the origin point of a GuiObject, relative to its absolute size.
Determines whether resizing occurs based on child content.
- 並列読み取り
Determines the GuiObject background color.
- 並列読み取り
Determines the transparency of the GuiObject background and border.
- 並列読み取り
Determines the color of the GuiObject border.
- 並列読み取り
Determines in what manner the GuiObject border is laid out relative to its dimensions.
- 並列読み取り
Determines the pixel width of a GuiObject border.
- 並列読み取り
Determines if descendant GUIs outside of the bounds of a parent GUI element should render.
- 読み取り専用複製されていません並列読み取り
- 並列読み取り
- 並列読み取り
Controls the sort order of a GUI when used with a UIGridStyleLayout.
- 並列読み取り
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
- 並列読み取り
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
- 並列読み取り
Sets the GUI which will be selected when the Enum.Gamepad selector is moved in this direction.
- 並列読み取り
Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction.
Determines the pixel and scalar position of the GuiObject.
Determines the number of degrees by which a UI element is rotated.
- 並列読み取り
Determine whether the GUI can be selected by a gamepad.
Overrides the default selection adornment used for gamepads.
- 並列読み取り
The order of GuiObjects selected by the gamepad UI selection.
Determine the pixel and scalar size of a GUI.
Selects the GuiObject.Size axes that a GUI will be based relative to the size of its parent.
- 非表示複製されていません並列読み取り非推奨
A mixed property of BackgroundTransparency and TextTransparency.
Determines whether a GuiObject.GUI and its descendants will be rendered.
Determines the order in which a GUI renders relative to other GUIs.
- 読み取り専用複製されていません
Describes the actual screen position of a UI element, in pixels.
- 読み取り専用複製されていません
Describes the actual screen rotation of a UI element, in degrees.
- 読み取り専用複製されていません
Describes the actual screen size of a UI element, in pixels.
- 並列読み取り
When set to true, localization will be applied to this GuiBase2d and its descendants based on the GuiBase2d.RootLocalizationTable specified for this GuiBase2d.
A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.
Customizes gamepad selection behavior in the down direction.
Customizes gamepad selection behavior in the left direction.
Customizes gamepad selection behavior in the right direction.
Customizes gamepad selection behavior in the up direction.
- 並列読み取り
Allows customization of gamepad selection movement.
方法
GuiObject から継承した 方法- TweenPosition(endPosition : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : bool,callback : function):bool
Smoothly moves a GUI to a new UDim2.
- TweenSize(endSize : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : bool,callback : function):bool
Smoothly resizes a GUI to a new UDim2.
- TweenSizeAndPosition(endSize : UDim2,endPosition : UDim2,easingDirection : Enum.EasingDirection,easingStyle : Enum.EasingStyle,time : number,override : bool,callback : function):bool
Smoothly moves a GUI to a new size and position.
イベント
GuiObject から継承した イベントFired when a user begins interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
Fired when a user changes how they're interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
Fired when a user stops interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).
Fires when a user moves their mouse into a GUI element.
Fires when a user moves their mouse out of a GUI element.
Fires whenever a user moves their mouse while it is inside a GUI element.
Fires when a user scrolls their mouse wheel back when the mouse is over a GUI element.
Fires when a user scrolls their mouse wheel forward when the mouse is over a GUI element.
Fired when the GuiObject is being focused on with the Gamepad selector.
Fired when the Gamepad selector stops focusing on the GuiObject.
Fires when the player starts, continues and stops long-pressing the UI element.
- TouchPan(touchPositions : Array,totalTranslation : Vector2,velocity : Vector2,state : Enum.UserInputState):RBXScriptSignal
Fires when the player moves their finger on the UI element.
- TouchPinch(touchPositions : Array,scale : number,velocity : number,state : Enum.UserInputState):RBXScriptSignal
Fires when the player performs a pinch or pull gesture using two fingers on the UI element.
- TouchRotate(touchPositions : Array,rotation : number,velocity : number,state : Enum.UserInputState):RBXScriptSignal
Fires when the player performs a rotation gesture using two fingers on the UI element.
Fires when the player performs a swipe gesture on the UI element.
Fires when the player performs a tap gesture on the UI element.
- SelectionChanged(amISelected : bool,previousSelection : GuiObject,newSelection : GuiObject):RBXScriptSignal
Fires when the gamepad selection moves to, leaves, or changes within the connected GuiBase2d or any descendent GuiObjects.
プロパティ
AbsoluteCanvasSize
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 Enum.AutomaticSize.None.
AutomaticCanvasSize
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 Enum.AutomaticSize value other than None, AbsoluteCanvasSize may resize depending on its child content.
BottomImage
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.
CanvasPosition
The location within the canvas, in offsets, that should be drawn at the top left of the scroll frame
CanvasSize
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
This property determines if and when the ScrollingFrame canvas is elastic. Defaults to WhenScrollable.
HorizontalScrollBarInset
Indicates the inset behavior of the horizontal scrolling bar.
MidImage
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.
ScrollBarImageColor3
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.
ScrollBarImageTransparency
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.
ScrollBarThickness
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.
ScrollingDirection
This property determines the direction scrolling is allowed. If scrolling is disallowed in a direction, the scrollbar will not appear. Defaults to XY.
ScrollingEnabled
Determines whether or not scrolling is allowed on the frame. If false, no scroll bars will be rendered.
TopImage
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.
VerticalScrollBarInset
Indicates the inset behavior of the vertical scrolling bar.
VerticalScrollBarPosition
Indicates the side that the vertical scrollbar will be located at.