The Leaderboard service. This class has methods for setting a player's score on a leaderboard, getting the number of players on a leaderboard, and getting toplists of players or the neighbourhood of players around the current player. Leaderboard groups have to be defined in the admin panel first.

Example

Here's how to set a player's score in the default leaderboard of the group "score":

Example

Here's how to get the number of players in a default leaderboard:

Example

Here's how to get the top 10 players in a default leaderboard:

Example

If you know there are more than 10 players in the entire leaderboard, here's how to get the next page of 10 entries:

Example

If you want to get the rank and score of a single player, pass in the connectUserId as a filter:

Example

You can pass in multiple connectuserids to get a filtered list of only those players.For example, by passing in a list of friends of the current player, you can get a toplist for the friends. Don't forget to also pass in the connectuserid of the current player if you want his position as well:

Example

The GetTop method starts at the top of the leaderboard, but if you want to know which players are immediately surrounding the current player, use the GetNeighbourhood method. The index parameter can be either positive or negative. If you use a negative number, the results will start above the current player, with better players, player who have a lower rank than the current player, and a better score. An index of 0 means the current player, and a positive index means that you start below the current player, with worse player, players who have a higher rank, and a worse score. For example, to get the 5 players above the current player, the current player himself, and the 5 players directly below, you can do this:

Example

Finally, GetNeighbourhood also takes a list of players that you can use to filter the results, but unlike GetTop, the current player is always automatically included in the filter list. For example, if you have a long list of friends, but want to know which friend is immediately above the current player in the leaderboard, and which friend is immediately below the current player, you can do something like this:

leaderboards.count

Sets the score for a user on a leaderboard.

Arguments

leaderboards.getNeighbourhood

Gets the neighbourhood of entries of a leaderbord around the current user.

Arguments

leaderboards.getTop

Gets the top entries of a leaderbord.

Arguments

leaderboards.set

Sets the score for a user on a leaderboard.

Arguments