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.

Resumen

Propiedades

  • leer paralelo

    Whether or not to animate transitions between pages.

  • leer paralelo

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

  • solo lectura
    no replicado
    leer paralelo

    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.

  • leer paralelo

    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.

  • leer paralelo

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

  • leer paralelo

    The length of the animation.

Propiedades heredados de UIGridStyleLayout

Métodos

Eventos

Propiedades

Animated

leer paralelo

Whether or not to animate transitions between pages.

Circular

leer paralelo

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

CurrentPage

solo lectura
no replicado
leer paralelo

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

EasingDirection

leer paralelo

The easing direction to use when performing an animation.

EasingStyle

leer paralelo

The easing style to use when performing an animation.

GamepadInputEnabled

leer paralelo

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

Padding

leer paralelo

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

leer paralelo

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

TouchInputEnabled

leer paralelo

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

TweenTime

leer paralelo

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

Devuelve

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

Devuelve

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.


Devuelve

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.


Devuelve

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