UIPageLayout

Afficher les obsolètes

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.

Résumé

Propriétés

  • lecture parallèle

    Whether or not to animate transitions between pages.

  • lecture parallèle

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

  • lecture uniquement
    non répliqué
    lecture parallèle

    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.

  • lecture parallèle

    The easing style to use when performing an animation.

  • lecture parallèle

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

  • lecture parallèle

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

  • lecture parallèle

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

  • lecture parallèle

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

  • lecture parallèle

    The length of the animation.

Propriétés hérités de UIGridStyleLayout

Méthodes

Évènements

Propriétés

Animated

lecture parallèle

Whether or not to animate transitions between pages.

Circular

lecture parallèle

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

CurrentPage

lecture uniquement
non répliqué
lecture parallèle

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

EasingDirection

lecture parallèle

The easing direction to use when performing an animation.

EasingStyle

lecture parallèle

The easing style to use when performing an animation.

GamepadInputEnabled

lecture parallèle

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

Padding

lecture parallèle

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

lecture parallèle

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

TouchInputEnabled

lecture parallèle

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

TweenTime

lecture parallèle

The length of the animation.

Méthodes

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.

Paramètres

page: Instance

Retours

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.

Paramètres

index: number

Retours

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.


Retours

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.


Retours

void

Évènements

PageEnter

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

Paramètres

page: Instance

PageLeave

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

Paramètres

page: Instance

Stopped

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

Paramètres

currentPage: Instance