UIPageLayout

Visualizza obsoleti

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.

Sommario

Proprietà

  • lettura parallela

    Whether or not to animate transitions between pages.

  • lettura parallela

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

  • sola lettura
    non replicato
    lettura parallela

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

  • The easing direction to use when performing an animation.

  • lettura parallela

    The easing style to use when performing an animation.

  • lettura parallela

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

  • lettura parallela

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

  • lettura parallela

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

  • lettura parallela

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

  • lettura parallela

    The length of the animation.

Proprietà inherited from UIGridStyleLayout

Metodi

Eventi

Proprietà

Animated

lettura parallela

Whether or not to animate transitions between pages.

Circular

lettura parallela

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

CurrentPage

sola lettura
non replicato
lettura parallela

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

EasingDirection

lettura parallela

The easing direction to use when performing an animation.

EasingStyle

lettura parallela

The easing style to use when performing an animation.

GamepadInputEnabled

lettura parallela

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

Padding

lettura parallela

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).

ScrollWheelInputEnabled

lettura parallela

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

TouchInputEnabled

lettura parallela

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

TweenTime

lettura parallela

The length of the animation.

Metodi

JumpTo

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.

Parametri

page: Instance

Restituzioni

void

JumpToIndex

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.

Parametri

index: number

Restituzioni

void

Next

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.


Restituzioni

void

Previous

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.


Restituzioni

void

Eventi

PageEnter

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

Parametri

page: Instance

PageLeave

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

Parametri

page: Instance

Stopped

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

Parametri

currentPage: Instance