UIPageLayout

Mostrar obsoleto

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.

Resumo

Propriedades

  • ler parallel

    Whether or not to animate transitions between pages.

  • ler parallel

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

  • somente leitura
    não replicado
    ler parallel

    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.

  • The easing style to use when performing an animation.

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

  • ler parallel

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

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

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

  • ler parallel

    The length of the animation.

Propriedades herdados de UIGridStyleLayout

Métodos

Eventos

Propriedades

Animated

ler parallel

Whether or not to animate transitions between pages.

Circular

ler parallel

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

CurrentPage

somente leitura
não replicado
ler parallel

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

EasingDirection

ler parallel

The easing direction to use when performing an animation.

EasingStyle

ler parallel

The easing style to use when performing an animation.

GamepadInputEnabled

ler parallel

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

Padding

ler parallel

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

ler parallel

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

TouchInputEnabled

ler parallel

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

TweenTime

ler parallel

The length of the animation.

Métodos

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.

Parâmetros

page: Instance

Devolução

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.

Parâmetros

index: number

Devolução

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.


Devolução

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.


Devolução

void

Eventos

PageEnter

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

Parâmetros

page: Instance

PageLeave

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

Parâmetros

page: Instance

Stopped

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

Parâmetros

currentPage: Instance