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

UIPageLayout

Deprecated

UIPageLayout

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.

Inherited from UIGridStyleLayout: Show Hide

VerticalAlignment

VerticalAlignment

Determines the vertical alignment of UI elements within the parent element.
SortOrder

SortOrder

Determines the manner in which the next UI element is chosen when being laid out.
HorizontalAlignment

HorizontalAlignment

Determines the horizontal alignment of UI elements within the parent element.
FillDirection

FillDirection

Determines the axis in which UI elements are laid out.
Vector2

AbsoluteContentSize

[ReadOnly] [NotReplicated]
The absolute size of space being taken up by the grid layout.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

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.

Inherited from UIGridStyleLayout: Show Hide

void

ApplyLayout ( )

Force re-layout of subling UI elements.

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

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.

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.