> For the complete documentation index, see [llms.txt](https://docs.overdare.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.overdare.com/korean/development/api-reference/classes/uipagelayout.md).

# UIPageLayout

UIPageLayout : `UIGridStyleLayout`

## Overview

형제 UI 요소들을 각각 하나의 페이지로 보고, 한 번에 한 페이지씩 보여주며 페이지 사이를 전환하는 레이아웃입니다.

각 페이지는 FillDirection 방향으로 부모 UI 영역의 크기만큼 간격을 두고 나란히 배치되며, 현재 페이지가 부모 UI 영역에 맞춰 표시됩니다. 페이지의 순서는 SortOrder에 따라 결정되고, JumpTo, JumpToIndex, Next, Previous 함수로 다른 페이지로 이동할 수 있습니다.

UIPageLayout은 **클라이언트 환경**에서만 제어할 수 있습니다.

## Properties

### Animated

`boolean`

페이지를 전환할 때 애니메이션을 재생할지 여부를 지정하는 속성입니다.

true이면 TweenTime, EasingStyle, EasingDirection 설정에 따라 페이지가 이동하는 애니메이션이 재생되고, false이면 즉시 대상 페이지로 전환됩니다. 기본값은 true입니다.

#### Code Samples

### Circular

`boolean`

페이지 이동이 처음과 끝에서 순환되도록 할지 여부를 지정하는 속성입니다.

true이면 마지막 페이지에서 Next를 호출할 때 첫 번째 페이지로, 첫 번째 페이지에서 Previous를 호출할 때 마지막 페이지로 이동합니다. false이면 끝 페이지에서는 해당 방향으로 더 이동하지 않습니다. 기본값은 false입니다.

#### Code Samples

### CurrentPage

`GuiObject`

현재 표시 중인 페이지(UI 요소)를 반환하는 읽기 전용 속성입니다.

페이지가 하나도 없으면 nil이며, 현재 페이지가 제거되는 등 유효하지 않게 되면 첫 번째 페이지로 다시 지정됩니다. 페이지 전환을 시작하면 이 값은 애니메이션이 끝나기 전에 즉시 대상 페이지로 변경됩니다.

#### Code Samples

### EasingDirection

`Enum.EasingDirection`

페이지 전환 애니메이션에 적용할 이징 방향을 지정하는 속성입니다.

Animated가 true일 때만 적용됩니다. 기본값은 Out입니다.

#### Code Samples

### EasingStyle

`Enum.EasingStyle`

페이지 전환 애니메이션에 적용할 이징 스타일을 지정하는 속성입니다.

Animated가 true일 때만 적용됩니다. 기본값은 Back입니다.

#### Code Samples

### Padding

`UDim`

페이지와 페이지 사이의 간격을 지정하는 속성입니다.

`Scale`은 FillDirection 방향의 부모 UI 영역 크기에 대한 비율, `Offset`은 픽셀 단위의 값을 의미합니다. 기본값은 `UDim.new(0, 0)`입니다.

#### Code Samples

### ScrollWheelInputEnabled

`boolean`

마우스 휠로 페이지를 전환할 수 있는지 여부를 지정하는 속성입니다.

true이면 페이지 영역 위에서 마우스 휠을 아래로 굴릴 때 다음 페이지로, 위로 굴릴 때 이전 페이지로 한 페이지씩 이동합니다. 기본값은 true입니다.

#### Code Samples

### TouchInputEnabled

`boolean`

터치 스와이프로 페이지를 전환할 수 있는지 여부를 지정하는 속성입니다.

true이면 페이지 영역에서 FillDirection 방향으로 스와이프할 때 한 페이지씩 이동합니다. 손을 뗀 시점에 FillDirection 방향으로 48픽셀 이상 이동했고, 그 이동 거리가 반대 축 방향 이동 거리보다 클 때만 전환되며, 탭이나 반대 축 방향의 드래그로는 전환되지 않습니다. 기본값은 true입니다.

#### Code Samples

### TweenTime

`number`

페이지 전환 애니메이션이 재생되는 시간을 초 단위로 지정하는 속성입니다.

최솟값은 0.01이며, 기본값은 1입니다.

#### Code Samples

## Methods

### JumpTo

지정한 페이지로 이동합니다.

Page는 이 레이아웃이 배치하는 페이지(형제 UI 요소) 중 하나여야 하며, 그렇지 않거나 이미 현재 페이지인 경우에는 아무 동작도 하지 않습니다.

이동을 시작하면 이전 페이지에 대해 PageLeave 이벤트가 발생하고, 전환이 완료되면 PageEnter 이벤트와 Stopped 이벤트가 차례로 발생합니다.

#### Parameters

| `Instance` Page | 이동할 대상 페이지(UI 요소)입니다. |
| --------------- | --------------------- |

#### Return

| `void` |   |
| ------ | - |

#### Code Samples

### JumpToIndex

지정한 인덱스의 페이지로 이동합니다.

인덱스는 0부터 시작하며, 페이지 개수를 벗어난 값(음수 포함)은 페이지 개수로 나눈 나머지에 해당하는 페이지로 처리됩니다. 대상이 이미 현재 페이지인 경우에는 아무 동작도 하지 않습니다.

이벤트 발생 순서는 JumpTo와 같습니다.

#### Parameters

| `number` Index | 이동할 페이지의 인덱스입니다. 첫 번째 페이지가 0입니다. |
| -------------- | -------------------------------- |

#### Return

| `void` |   |
| ------ | - |

#### Code Samples

### Next

현재 페이지의 다음 페이지로 이동합니다.

현재 페이지가 마지막 페이지인 경우, Circular가 true이면 첫 번째 페이지로 이동하고 false이면 아무 동작도 하지 않습니다.

#### Parameters

#### Return

| `void` |   |
| ------ | - |

#### Code Samples

### Previous

현재 페이지의 이전 페이지로 이동합니다.

현재 페이지가 첫 번째 페이지인 경우, Circular가 true이면 마지막 페이지로 이동하고 false이면 아무 동작도 하지 않습니다.

#### Parameters

#### Return

| `void` |   |
| ------ | - |

#### Code Samples

## Events

### PageEnter

페이지 전환이 완료되어 새 페이지가 현재 페이지가 되었을 때 발생하는 이벤트입니다.

Animated가 false이면 페이지 이동 함수를 호출한 즉시 발생합니다.

#### Parameters

| `Instance` page | 새로 현재 페이지가 된 UI 요소입니다. |
| --------------- | ---------------------- |

#### Code Samples

### PageLeave

페이지 전환이 시작되어 기존 페이지가 현재 페이지에서 벗어날 때 발생하는 이벤트입니다.

#### Parameters

| `Instance` page | 현재 페이지에서 벗어난 UI 요소입니다. |
| --------------- | ---------------------- |

#### Code Samples

### Stopped

페이지 전환이 완료되었을 때 발생하는 이벤트입니다.

PageEnter 이벤트 직후에 발생하며, Animated가 false이면 페이지 이동 함수를 호출한 즉시 발생합니다.

#### Parameters

| `Instance` currentPage | 전환이 완료된 시점의 현재 페이지 UI 요소입니다. |
| ---------------------- | ---------------------------- |

#### Code Samples
