UIPageLayout¶
Not yet Class
Positions sibling UI elements as full-size pages in a single row or column that users can scroll or animate through one page at a time.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 30 modern Roblox members not implemented yet
Description¶
Creates a paged viewing window, like the home screen of a mobile device. You can use a UIPageLayout by parenting it to a GuiObject. The UIPageLayout will then apply itself to all of its GuiObject siblings.
Inheritance¶
Object → Instance → UIBase → UIComponent → UILayout → UIGridStyleLayout → UIPageLayout
Properties¶
| Member | Signature | Summary |
|---|---|---|
Animated |
Animated: bool |
Whether or not to animate transitions between pages. |
Circular |
Circular: bool |
Whether or not the page layout wraps around at the ends. |
CurrentPage |
CurrentPage: GuiObject |
The page that is either currently being displayed or is the target of the current animation. |
EasingDirection |
EasingDirection: EasingDirection |
The easing direction to use when performing an animation. |
EasingStyle |
EasingStyle: EasingStyle |
The easing style to use when performing an animation. |
GamepadInputEnabled |
GamepadInputEnabled: bool |
Controls the overrides of NextSelection{Up, Down, Left, Right}. Defaults to true. |
Padding |
Padding: UDim |
Determines the amount that pages are separated from each other by. |
ScrollWheelInputEnabled |
ScrollWheelInputEnabled: bool |
Controls the use of scroll wheel, in case that it is intended for something else. Defaults to true. |
TouchInputEnabled |
TouchInputEnabled: bool |
Controls touch scrolling, in case this is a non-interactive layout. Defaults to true. |
TweenTime |
TweenTime: float |
The length of the animation. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
JumpTo |
UIPageLayout:JumpTo(page: Instance): null |
If the page is in the UIPageLayout, then it sets UIPageLayout.CurrentPage to it and animates to it. If the circular layout is enabled, i… |
JumpToIndex |
UIPageLayout:JumpToIndex(index: int): null |
If the index is >= 0 and less than the size of the layout, this method acts like UIPageLayout.JumpTo(). Out-of-bounds indices are wrapped mod… |
Next |
UIPageLayout:Next(): null |
Sets UIPageLayout.CurrentPage to the page after the current page and animates to it, or does nothing if there isn't a next page. |
Previous |
UIPageLayout:Previous(): null |
Sets UIPageLayout.CurrentPage to the page before the current page and animates to it, or does nothing if there isn't a previous page. |
Events¶
| Member | Signature | Summary |
|---|---|---|
PageEnter |
PageEnter(page: Instance) |
Fires when a page comes into view, and is going to be rendered. |
PageLeave |
PageLeave(page: Instance) |
Fires when a page leaves view, and will not be rendered. |
Stopped |
Stopped(currentPage: Instance) |
Fires when an animation to UIPageLayout.CurrentPage is completed without being canceled, and the view stops scrolling. |
Roblox reference: UIPageLayout
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.