UIPageLayout

非推奨を表示

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.

概要

プロパティ

  • 並列読み取り

    Whether or not to animate transitions between pages.

  • 並列読み取り

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

  • 読み取り専用
    複製されていません
    並列読み取り

    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.

  • 並列読み取り

    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.

  • 並列読み取り

    The length of the animation.

UIGridStyleLayout から継承した プロパティ

方法

イベント

プロパティ

Animated

並列読み取り

Whether or not to animate transitions between pages.

Circular

並列読み取り

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

CurrentPage

読み取り専用
複製されていません
並列読み取り

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

EasingDirection

並列読み取り

The easing direction to use when performing an animation.

EasingStyle

並列読み取り

The easing style to use when performing an animation.

GamepadInputEnabled

並列読み取り

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

Padding

並列読み取り

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

並列読み取り

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

TouchInputEnabled

並列読み取り

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

TweenTime

並列読み取り

The length of the animation.

方法

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.

パラメータ

page: Instance

戻り値

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.

パラメータ

index: number

戻り値

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.


戻り値

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.


戻り値

void

イベント

PageEnter

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

パラメータ

page: Instance

PageLeave

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

パラメータ

page: Instance

Stopped

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

パラメータ

currentPage: Instance