Reference API Roblox

Engine API

Website

Related

Reference API Roblox

UIPageLayout

Memory categoryInstances

Member index 17

HistoryMember
553Animated: bool
553Circular: bool
553CurrentPage: GuiObject
553EasingDirection: EasingDirection
553EasingStyle: EasingStyle
553GamepadInputEnabled: bool
553Padding: UDim
553ScrollWheelInputEnabled: bool
553TouchInputEnabled: bool
553TweenTime: float
573JumpTo(page: Instance): null
573JumpToIndex(index: int): null
573Next(): null
573Previous(): null
462PageEnter(page: Instance)
462PageLeave(page: Instance)
462Stopped(currentPage: Instance)
inherited from UIGridStyleLayout
553AbsoluteContentSize: Vector2
553FillDirection: FillDirection
647HorizontalAlignment: HorizontalAlignment
553SortOrder: SortOrder
647VerticalAlignment: VerticalAlignment
573ApplyLayout(): null
573SetCustomSortFunction(function: Function = nil): null
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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.

History 61

Members 17

Animated

TypeDefault
booltrue

Whether or not to animate transitions between pages.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

Circular

TypeDefault
boolfalse

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

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

CurrentPage

TypeDefault
GuiObject

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 6

Tags: [ReadOnly, NotReplicated]

EasingDirection

TypeDefault
EasingDirectionOut

The easing direction to use when performing an animation.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

EasingStyle

TypeDefault
EasingStyleBack

The easing style to use when performing an animation.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

GamepadInputEnabled

TypeDefault
booltrue

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

Thread safetyReadSafe
CategoryInput
Loaded/Savedtrue

History 4

JumpTo

Parameters (1)
pageInstance
Returns (1)
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, it will take the shortest path to this page.

Thread safetyUnsafe

History 3

JumpToIndex

Parameters (1)
indexint
Returns (1)
null

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.

Thread safetyUnsafe

History 3

Next

Parameters (0)
No parameters.
Returns (1)
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.

Thread safetyUnsafe

History 3

Padding

TypeDefault
UDim0, 0

Determines the amount that pages are separated from each other by. Can be set either using scale (Percentage of parent's size in the current direction) or offset (a static spacing value, similar to pixel size).

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

PageEnter

Parameters (1)
pageInstance

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

Thread safetyUnsafe

History 2

PageLeave

Parameters (1)
pageInstance

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

Thread safetyUnsafe

History 2

Previous

Parameters (0)
No parameters.
Returns (1)
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.

Thread safetyUnsafe

History 3

ScrollWheelInputEnabled

TypeDefault
booltrue

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

Thread safetyReadSafe
CategoryInput
Loaded/Savedtrue

History 4

Stopped

Parameters (1)
currentPageInstance

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

Thread safetyUnsafe

History 2

TouchInputEnabled

TypeDefault
booltrue

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

Thread safetyReadSafe
CategoryInput
Loaded/Savedtrue

History 4

TweenTime

TypeDefault
float1

The length of the animation.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

Settings