new Pages(title, …contents)
创建一个Pages
用于一段需要分页的文字
ps: 知道为什么叫Pages而不是Page吗？因为不止一个页！
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
title | string | 页的标题 | |
contents | string | <repeatable> | 页的内容，每一项就是一页 |
- Source
Members
title :string
页标题
Type:
- string
- Source
contents :Array.<string>
每页内容
Type:
- Array.<string>
- Source
page :number
当前页码
Type:
- number
- Source
handler
事件监听器
- Source
title :string
页标题
Type:
- string
- Source
contents :Array.<string>
每页内容
Type:
- Array.<string>
- Source
page :number
当前页码
Type:
- number
- Source
handler
事件监听器
- Source
Methods
(async) open(entity) → {boolean}
打开当前页面
会自动根据玩家的选择来切换到上一页/下一页并打开
Parameters:
| Name | Type | Description |
|---|---|---|
entity | Box3PlayerEntity | 要打开该页的玩家 |
- Source
Returns:
是否完成了该页。如果关闭了该页，返回false；否则返回true
- Type:
- boolean
onOpen(handler) → {Pages}
当该页被打开时执行的操作
Parameters:
| Name | Type | Description |
|---|---|---|
handler | dialogCallBack | 当该页被打开时执行的操作。 |
- Source
Returns:
自身
- Type:
- Pages
onClose(handler) → {Pages}
当该页被关闭时执行的操作
Parameters:
| Name | Type | Description |
|---|---|---|
handler | dialogCallBack | 当该页被关闭时执行的操作。 |
- Source
Returns:
自身
- Type:
- Pages
(async) open(entity) → {boolean}
打开当前页面
会自动根据玩家的选择来切换到上一页/下一页并打开
Parameters:
| Name | Type | Description |
|---|---|---|
entity | Box3PlayerEntity | 要打开该页的玩家 |
- Source
Returns:
是否完成了该页。如果关闭了该页，返回false；否则返回true
- Type:
- boolean
onOpen(handler) → {Pages}
当该页被打开时执行的操作
Parameters:
| Name | Type | Description |
|---|---|---|
handler | dialogCallBack | 当该页被打开时执行的操作。 |
- Source
Returns:
自身
- Type:
- Pages
onClose(handler) → {Pages}
当该页被关闭时执行的操作
Parameters:
| Name | Type | Description |
|---|---|---|
handler | dialogCallBack | 当该页被关闭时执行的操作。 |
- Source
Returns:
自身
- Type:
- Pages