Documentation

Class: LeaderboardScoreDesc

LeaderboardScoreDesc

new LeaderboardScoreDesc()

  • Class Leaderboard which considers bigger score should be given better rank.
rank score
1 150
2 100
3 50
4 10

Extends

Members

redis

getter for _redis.

Inherited From:

lbname

getter for _lbname.

Inherited From:

scripts

getter for _scripts. Generally only private functions would care of this.

Inherited From:

Methods

<protected> onGetLuaScripts()

onGetLuaScripts callback.

Overrides:
Returns:

script object which considers bigger score should be given better rank.

Type
Object

clear()

clear.

Inherited From:
Returns:
Type
Promise

count()

count.

Inherited From:
Returns:
Type
Promise

remove(name)

remove.

Parameters:
Name Type Description
name string

player name
Inherited From:
Returns:
Type
Promise

setScore(name, score)

setScore.

Parameters:
Name Type Description
name string

player name
score number

score
Inherited From:
Returns:
Type
Promise

modifyScore(name, delta)

modifyScore.

Parameters:
Name Type Description
name string

player name
delta number

delta to modify the score
Inherited From:
Returns:
Type
Promise

getScoreAndRank(score)

  • getScoreAndRank will provide you name's score and rank.
  • The result would be an object contains
     {
     name: string,
     score: number,
     rank number
 }
Parameters:
Name Type Description
score number

player name
Inherited From:
Returns:
  • return Promise({Object. see above description});
Type
Promise.<Object>

getNeighbors(name, count)

  • getNeighbors will pick up players (name's rank - count <= players <= name's rank + count).
  • The result would be an object contains
     {
     list: [
         {name: string, score: number, rank: number},
         {name: string, score: number, rank: number},
         {name: string, score: number, rank: number},
         ...,
     ]
 }
Parameters:
Name Type Description
name string

player name
count number

player counts to be picked.
Inherited From:
Returns:
  • return Promise({Object. see above description});
Type
Promise.<Object>

getList(number, size)

  • You can get the list by using this function.
  • The result would be an object contains
     {
     page: page number starting from 1.
     maxPage: max page number.
     total: total player numbers in the board.
     list: [
         {name: string, score: number, rank: number},
         {name: string, score: number, rank: number},
         {name: string, score: number, rank: number},
         ...,
     ]
 }
Parameters:
Name Type Description
number number

page index starting from 1.
size number

page size. The numbers of players in a page.
Inherited From:
Returns:
  • return Promise({Object. see above description});
Type
Promise.<Object>