Rank

排行榜

 排行榜相关操作

---

函数列表

SetRankById

• 描述: 记录玩家排行榜数据。

• 范围: 服务端

参数列表:

参数	类型	说明
Index	number	排行榜id按顺序依次为1、2、3
PlayerId	number	玩家角色ID
Score	number	得分
ExtraScores	number	额外分数可不填。

Rank:SetRankById(1,Character:GetPlayerBySideAndIndex(0, 1), 100, nil)

---

DelRankById

• 描述: 删除玩家排行榜数据。

• 范围: 服务端

参数列表:

参数	类型	说明
Index	number	排行榜id按顺序依次为1、2、3
PlayerId	number	玩家ID

Rank:DelRankById(1,Character:GetPlayerBySideAndIndex(0, 1))

---

DspRankWind

• 描述: 显示排行榜。

• 范围: 客户端

Rank:DspRankWind()

---

GetPlayerRankingData

• 描述: 获取玩家排行榜数据并返回。

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
Index	number	排行榜id按顺序依次为1、2、3
PlayerId	number	玩家ID

返回字段:

返回字段	字段类型	说明
score	number	玩家排行榜得分

local score = Rank:GetPlayerRankingData(1,Character:GetPlayerBySideAndIndex(0, 1))

---

GetTheRankingData

• 描述: 获取排行指定排名数据并返回。

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
Index	number	排行榜id按顺序依次为1、2、3
RankNo	number	排行榜第几位

返回字段:

返回字段	字段类型	说明
score	number	排行榜得分

local score = Rank:GetTheRankingData(1, 1)

---

GetTheFriendsRankingData

• 描述: 获取好友排行榜指定排名数据并返回。

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
PlayerId	number	玩家角色ID
Index	number	排行榜id按顺序依次为1、2、3
RankNo	number	排行榜第几位

返回字段:

返回字段	字段类型	说明
score	number	排行榜得分

local score = Rank:GetTheFriendsRankingData(Character:GetPlayerBySideAndIndex(0, 1), 1, 1)

---

GetTheRankingPlayer

• 描述: 获取排行指定排名玩家id并返回。

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
Index	number	排行榜id按顺序依次为1、2、3
RankNo	number	排行榜第几位

返回字段:

返回字段	字段类型	说明
playerId	number	排行榜玩家ID

local playerId = Rank:GetTheRankingPlayer(1, 1)

---

GetTheFrinedsRankingPlayer

• 描述: 获取好友排行指定排名玩家id并返回。

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
PlayerId	number	玩家ID
Index	number	排行榜id按顺序依次为1、2、3
RankNo	number	排行榜第几位

返回字段:

返回字段	字段类型	说明
playerId	number	排行榜玩家ID

local playerId = Rank:GetTheFrinedsRankingPlayer(Character:GetPlayerBySideAndIndex(0, 1), 1, 1)

---

GetPlayerRankNum

• 描述: 获取排行榜中指定玩家排名。

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
Index	number	排行榜id按顺序依次为1、2、3
PlayerId	number	玩家角色ID

返回字段:

返回字段	字段类型	说明
rankNo	number	排行榜第几位

local rankNo = Rank:GetPlayerRankNum(1, Character:GetPlayerBySideAndIndex(0, 1))

---

GetPlayerFrinedsRankNum

• 描述: 获取好友排行榜中指定玩家排名。

• 范围: 服务端、客户端

参数列表:

参数	类型	说明
PlayerId	number	玩家角色ID
Index	number	排行榜id按顺序依次为1、2、3
FPlayerId	number	好友ID

返回字段:

返回字段	字段类型	说明
rankNo	number	排行榜第几位

local rankNo = Rank:GetPlayerFrinedsRankNum(Character:GetPlayerBySideAndIndex(0, 1), 1, Character:GetPlayerBySideAndIndex(0, 1))

---