PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

UIPageLayout

Show deprecated

UIPageLayout

Show deprecated

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

bool

Animated

Whether or not to animate transitions between pages.

bool

Circular

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

GuiObject

CurrentPage

[ReadOnly] [NotReplicated]

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

EasingDirection

EasingDirection

The easing direction to use when performing an animation.

EasingStyle

EasingStyle

The easing style to use when performing an animation.

bool

GamepadInputEnabled

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

UDim

Padding

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

bool

ScrollWheelInputEnabled

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

bool

TouchInputEnabled

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

float

TweenTime

The length of the animation.

Functions

void

JumpTo ( Instance page )

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

JumpToIndex ( int index )

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

Next ( )

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

Previous ( )

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

RBXScriptSignal

PageEnter ( Instance page )

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

RBXScriptSignal

PageLeave ( Instance page )

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

RBXScriptSignal

Stopped ( Instance currentPage )

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