拓展 / LeaderboardModule
LeaderboardModule Class
Instance
编辑器内置排行榜
Table of contents
Methods
addField(fieldId : number , fieldName : string , valueStyle? : string ): typeof LeaderboardModule client |
---|
添加一个字段 |
addPlayer(player : number Player , data? : any ): void server |
向排行榜添加一个玩家 |
clear(): void server |
清除排行榜 |
hidePanel(): void client |
隐藏UI |
removePlayer(player : number Player ): void server |
从排行榜移除一个玩家 |
setPlayerValue(player : number Player , fieldId : number , value : string number ): void server |
设置一个玩家的一个字段值 |
setSortFields(...fieldIds : number []): typeof LeaderboardModule client |
设置排序字段 |
setSortMethod(fn : (dataList : LeaderboardPlayerData []) => LeaderboardPlayerData []): typeof LeaderboardModule client |
设置排序的方法 |
setStyle(title : string , fieldsAutoLayout : boolean , showPlayerNum : number , itemSpacing : number ): typeof LeaderboardModule client |
设置样式 |
showPanel(hideCallback? : () => void ): void client |
显示 UI |
showRankField(fieldName : string , valueStyle? : string , notListed? : string ): typeof LeaderboardModule client |
显示排名 |
Methods
addField
• Static
addField(fieldId
, fieldName
, valueStyle?
): typeof LeaderboardModule
client
添加一个字段
Parameters
fieldId number | 字段 ID range: 依据 ID 长度而定 type: |
---|---|
fieldName string | 字段名 range:不做限制 |
valueStyle? string | 显示内容样式(例:{0} 分) default: null range:不做限制 |
Returns
typeof LeaderboardModule | 返回自己,可用于链式调用 |
---|
addPlayer
• Static
addPlayer(player
, data?
): void
server
向排行榜添加一个玩家
Parameters
player number Player | 玩家对象玩家id range: 根据 ID 长度而定 |
---|---|
data? any | 玩家数据 default: {} |
clear
• Static
clear(): void
server
清除排行榜
hidePanel
• Static
hidePanel(): void
client
隐藏UI
removePlayer
• Static
removePlayer(player
): void
server
从排行榜移除一个玩家
Parameters
player number Player | 玩家对象玩家id range: 根据 ID 长度而定 |
---|
setPlayerValue
• Static
setPlayerValue(player
, fieldId
, value
): void
server
设置一个玩家的一个字段值
Parameters
player number Player | 玩家对象玩家id range: 根据 ID 长度而定 |
---|---|
fieldId number | 字段的ID range: 根据 ID 长度而定 type:整数 |
value string number | 字段的值 range: 不做限制,一个玩家一个数据 type:整数 |
setSortFields
• Static
setSortFields(...fieldIds
): typeof LeaderboardModule
client
设置排序字段
Parameters
...fieldIds number [] | 排序字段 range: 长度不做限制 |
---|
Returns
typeof LeaderboardModule | 返回自己,可用于链式调用 |
---|
可以设置多字段排序,只支持从大到小排序。
setSortMethod
• Static
setSortMethod(fn
): typeof LeaderboardModule
client
设置排序的方法
Parameters
fn (dataList : LeaderboardPlayerData []) => LeaderboardPlayerData [] | 方法 |
---|
Returns
typeof LeaderboardModule | 返回自己,可用于链式调用 |
---|
setStyle
• Static
setStyle(title
, fieldsAutoLayout
, showPlayerNum
, itemSpacing
): typeof LeaderboardModule
client
设置样式
Parameters
title string | 界面标题 range: UI 标题信息 |
---|---|
fieldsAutoLayout boolean | 字段是否自动布局,均匀分布 |
showPlayerNum number | 最多显示的玩家数量 range:合理即可 type: 整数 |
itemSpacing number | 每条数据的间距 range:合理即可 type: 整数 |
Returns
typeof LeaderboardModule | 返回自己,可用于链式调用 |
---|
showPanel
• Static
showPanel(hideCallback?
): void
client
显示 UI
Parameters
hideCallback? () => void | Panel关闭的回调 default: null |
---|
showRankField
• Static
showRankField(fieldName
, valueStyle?
, notListed?
): typeof LeaderboardModule
client
显示排名
Parameters
fieldName string | 字段名 range: 依据 ID 长度而定 type: |
---|---|
valueStyle? string | 字段值样式 default: null range:不做限制 |
notListed? string | 未上榜(如果未上榜也显示名次请填写null) default: null range:不做限制 |
Returns
typeof LeaderboardModule | 返回自己,可用于链式调用 |
---|