PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. UIPageLayout

UIPageLayout

Show deprecated
Hide content
  1. apireference
  2. uipagelayout

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.

Inherited from UIGridStyleLayout: Show Hide

Vector2

AbsoluteContentSize

[ReadOnly] [NotReplicated]

The absolute size of space being taken up by the grid layout.
FillDirection

FillDirection

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

HorizontalAlignment

Determines the horizontal 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.
VerticalAlignment

VerticalAlignment

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

Inherited from Instance: Show Hide

bool

Archivable

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

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

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 Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

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

FindFirstAncestor ( string name )

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

FindFirstAncestorOfClass ( string className )

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

FindFirstAncestorWhichIsA ( string className )

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

FindFirstChild ( string name , bool recursive )

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

FindFirstChildOfClass ( string className )

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

FindFirstChildWhichIsA ( string className , bool recursive )

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

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
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.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
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.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

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

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

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

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]
UIPadding UIScale