We use cookies on this site to enhance your user experience

UIPageLayout

UIPageLayout

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.


Properties

Name Type Description
bool

Whether or not to animate transitions between pages.

bool

Whether or not the page layout wraps around at the ends.

GuiObject

The page that is either currently being displayed or is the target of the current animation.

EasingDirection

The easing direction to use when performing an animation.

EasingStyle

The easing style to use when performing an animation.

bool

Controls the overrides of NextSelection{Up, Down, Left, Right}. Defaults to true.

UDim

Determines the amount that pages are separated from each other by.

bool

Controls the use of scroll wheel, in case that it is intended for something else. Defaults to true.

bool

Controls touch scrolling, in case this is a non-interactive layout. Defaults to true.

float

The length of the animation.

Inherited from Instance , UIBase , UIComponent , UILayout , UIGridStyleLayout

Archivable ClassName DataCost Name Parent RobloxLocked AbsoluteContentSize FillDirection HorizontalAlignment SortOrder VerticalAlignment

Functions

Name Type Description
void

If the page is in the UIPageLayout, then it sets UIPageLayout/CurrentPage to it and animates to it. If the circular layout is enabled, it will take the shortest path to this page.

void

If the index is >= 0 and less than the size of the layout, this method acts like UIPageLayout/JumpTo. If it’s out of bounds and circular is set, it will animate the full distance between the in-bounds index of UIPageLayout/CurrentPage and the new index.

void

Sets UIPageLayout/CurrentPage to the page after the current page and animates to it, or does nothing if there isn’t a next page.

void

Sets UIPageLayout/CurrentPage to the page before the current page and animates to it, or does nothing if there isn’t a previous page.

Inherited from Instance , UIBase , UIComponent , UILayout , UIGridStyleLayout

ClearAllChildren Clone Destroy FindFirstAncestor FindFirstAncestorOfClass FindFirstAncestorWhichIsA FindFirstChild FindFirstChildOfClass FindFirstChildWhichIsA GetChildren GetDebugId GetDescendants GetFullName GetPropertyChangedSignal IsA IsAncestorOf IsDescendantOf WaitForChild ApplyLayout

Events

Name Type Description

Fires when a page comes into view, and is going to be rendered.

Fires when a page leaves view, and will not be rendered.

Fires when an animation to UIPageLayout/CurrentPage is completed without being canceled, and the view stops scrolling.

Inherited from Instance , UIBase , UIComponent , UILayout , UIGridStyleLayout

AncestryChanged Changed ChildAdded ChildRemoved DescendantAdded DescendantRemoving