ILeaderboard

The leaderboard contains the scores of all players for a particular game.

Each game can have multiple leaderboards with different scores. A leaderboard object can be customized to perform a particular query. The leaderboard ID defines which leaderboard is being queried and there are filters to narrow down the results, UserScope, TimeScope, Range and SetUserFilter. Use Social.CreateLeaderboard to create an instance of this object.

Variables
id

Unique identifier for this leaderboard.

userScope

The users scope searched by this leaderboard.

range

The rank range this leaderboard returns.

timeScope

The time period/scope searched by this leaderboard.

loading

The leaderboad is in the process of loading scores.

localUserScore

The leaderboard score of the logged in user.

maxRange

The total amount of scores the leaderboard contains.

scores

The leaderboard scores returned by a query.

title

The human readable title of this leaderboard.

Functions
SetUserFilter

Only search for these user IDs.

LoadScores

Load scores according to the filters set on this leaderboard.