API
Return to top
LeaderboardModuleBaseS<T>
编辑

拓展 / LeaderboardModuleBaseS

LeaderboardModuleBaseS<T> Class
​

排行榜模块-服务端

Type parameters ​

Textends LeaderboardModuleTypeC

Hierarchy ​

  • ModuleS<T, any>

    ↳ LeaderboardModuleBaseS

Table of contents ​

Accessors
​

click

Accessors
​

currentData(): S
调用服务器方法的玩家的DataOwner
currentPlayer(): Player server
调用服务器方法的玩家
currentPlayerId(): number server
获取调用服务器方法的玩家ID

Methods
​

addPlayer(player: number Player, data: Object): boolean server
向排行榜添加一个玩家
clear(): void server
清除排行榜
removePlayer(player: number Player): boolean server
从排行榜移除一个玩家
setPlayerValue(player: number Player, fieldId: number, value: string number): void server
设置玩家的一个字段值
click

Methods
​

getAllClient(): T server
获取"全部客户端"调用对象
getClient(player: number Player): T server
根据玩家获取"单客户端"调用对象
getPlayerData(player: string number Player): S server
获取指定玩家的本模块数据
onAwake(): void server
生命周期方法-创建模块时调用
onDestroy(): void server
生命周期方法-销毁模块调用
onExecute(type: number, ...params: any[]): void server
外部调用本模块的某个操作
onPlayerEnterGame(player: Player): void server
生命周期方法-玩家进入游戏(客户端已就绪，数据就绪，前后端可正常通信)
onPlayerJoined(player: Player): void server
生命周期方法-玩家进入房间(玩家刚刚连进服务器，数据和前后端通信都还没有就绪)
onPlayerLeft(player: Player): void server
生命周期方法-玩家离开房间
onStart(): void server
生命周期方法-启动模块时调用
onUpdate(dt: number): void server
生命周期方法-刷新模块调用

Accessors ​

Methods ​

addPlayer
​

• Protected addPlayer(player, data): boolean server

向排行榜添加一个玩家

Parameters ​

player number Player玩家对象玩家id
data Object玩家数据

Returns ​

boolean是否成功

clear
​

• Protected clear(): void server

清除排行榜

removePlayer
​

• Protected removePlayer(player): boolean server

从排行榜移除一个玩家

Parameters ​

player number Player玩家对象玩家id

Returns ​

boolean是否成功

setPlayerValue
​

• Protected setPlayerValue(player, fieldId, value): void server

设置玩家的一个字段值

Parameters ​

player number Player玩家对象玩家id
range: 根据 ID 长度而定
fieldId number字段ID
range: 根据 ID 长度而定 type:整数
value string number字段的值
range: 不做限制，一个玩家一个数据 type:整数