API拓展 / LeaderboardMainPanelBase
LeaderboardMainPanelBase<T> Class
排行榜主界面
Type parameters
T | extends ILeaderboardPanelView |
|---|
Hierarchy
BasePanel<T>↳
LeaderboardMainPanelBase
Table of contents
Properties
onClose: Action |
|---|
| 当关闭的时候调用的事件 |
Accessors
Methods
addField(fieldId: number, fieldName: string, valueStyle?: string): LeaderboardMainPanelBase<T> client |
|---|
| 添加一个字段 |
creatItem(): LeaderboardItemPanelBase<{ mContent: [Canvas](mw.Canvas.md) } & UIScript> client |
| 创建用于显示一条排行信息的item子UI |
onHide(): void client |
| 当UI隐藏调用 |
onSelfFieldSet(rankIndex: number, fieldId: number, fieldValue: string number, textBlockIndex: number, textBlock: TextBlock): void client |
| 设置自己(界面最下面那一行)的字段内容后调用，需要请复写 |
onShow(playerDataList: LeaderboardPlayerData[]): void client |
| 当UI显示调用 |
onSort(dataList: LeaderboardPlayerData[]): LeaderboardPlayerData[] client |
| 排序的时候调用，需要请重写 |
setSortFields(...fieldIds: number[]): LeaderboardMainPanelBase<T> client |
| 设置排序字段ID，可以设置多字段排序，只支持从大到小排序 |
setStyle(title: string, fieldsAutoLayout: boolean, showPlayerNum: number, itemSpacing: number): LeaderboardMainPanelBase<T> client |
| 设置排行榜样式 |
showRankField(fieldName: string, valueStyle?: string, notListed?: string): LeaderboardMainPanelBase<T> client |
| 显示"名次"字段，并进行设置，默认不显示 |
click
Methods
onAdded(): void client |
|---|
| 生命周期-被添加到父节点时候触发，可能会多次调用 |
onAwake(): void client |
| 生命周期方法-构建面板自动触发，只会调用一次 |
Properties
onClose
• Readonly onClose: Action
当关闭的时候调用的事件
Accessors
Methods
addField
• addField(fieldId, fieldName, valueStyle?): LeaderboardMainPanelBase<T> client
添加一个字段
Parameters
fieldId number | 字段 ID range: 依据 ID 长度而定 type: |
|---|---|
fieldName string | 字段的标题 range: |
valueStyle? string | 字段值的展示样式 (例：{0}分) default: null range:不做限制 |
Returns
LeaderboardMainPanelBase<T> | 返回自己，可用于链式调用 |
|---|
creatItem
• Protected Abstract creatItem(): LeaderboardItemPanelBase<{ mContent: [Canvas](mw.Canvas.md) } & UIScript> client
创建用于显示一条排行信息的item子UI
Returns
LeaderboardItemPanelBase<{ mContent: [Canvas](mw.Canvas.md) } & UIScript> | 一条排行信息的item子UI |
|---|
onHide
• Protected onHide(): void client
当UI隐藏调用
Precautions
如果要复写此方法，记得调用super.onHide()
onSelfFieldSet
• Protected onSelfFieldSet(rankIndex, fieldId, fieldValue, textBlockIndex, textBlock): void client
设置自己(界面最下面那一行)的字段内容后调用，需要请复写
Parameters
rankIndex number | 名次索引(0开始) range: 合理即可，不做限制 type: 整形 |
|---|---|
fieldId number | 字段索引 (如果是排行字段，此参数为mull) range: 合理即可，不做限制 type: 整形 |
fieldValue string number | 字段显示内容 range: 合理即可，不做限制 type: 整形 |
textBlockIndex number | 文本控件索引 range: 合理即可，不做限制 type: 整形 |
textBlock TextBlock | 文本控件 |
onShow
• Protected onShow(playerDataList): void client
当UI显示调用
Parameters
playerDataList LeaderboardPlayerData[] | 玩家数据列表 |
|---|
Precautions
如果要复写此方法，记得调用super.onShow()
onSort
• Protected onSort(dataList): LeaderboardPlayerData[] client
排序的时候调用，需要请重写
Parameters
dataList LeaderboardPlayerData[] | 排行数据数组 |
|---|
Returns
LeaderboardPlayerData[] | 排序后的数据队列 |
|---|
setSortFields
• setSortFields(...fieldIds): LeaderboardMainPanelBase<T> client
设置排序字段ID，可以设置多字段排序，只支持从大到小排序
Parameters
...fieldIds number[] | 排序字段 |
|---|
Returns
LeaderboardMainPanelBase<T> | 返回自己，可用于链式调用 |
|---|
setStyle
• setStyle(title, fieldsAutoLayout, showPlayerNum, itemSpacing): LeaderboardMainPanelBase<T> client
设置排行榜样式
Parameters
title string | UI 标题 range: UI 标题信息 |
|---|---|
fieldsAutoLayout boolean | 字段是否自动布局(true-均匀分布, false-所摆即所得） |
showPlayerNum number | 最多显示的玩家数量 range:合理即可 type: 整形 |
itemSpacing number | 每条数据的间距 range:合理即可 type: 整形 |
Returns
LeaderboardMainPanelBase<T> | 返回自己，可用于链式调用 |
|---|
showRankField
• showRankField(fieldName, valueStyle?, notListed?): LeaderboardMainPanelBase<T> client
显示"名次"字段，并进行设置，默认不显示
Parameters
fieldName string | 字段标题 range: 依据 ID 长度而定 type: |
|---|---|
valueStyle? string | 字段值样式 default: null range:不做限制 |
notListed? string | 未上榜(如果未上榜也显示"名次"请填写null) default: null range:不做限制 |
Returns
LeaderboardMainPanelBase<T> | 返回自己，可用于链式调用 |
|---|