ILeaderboard
The leaderboard contains the scores of all players for a particular game.
Read time 1 minuteLast updated 9 days ago
Definition
- Type: Interface
- Namespace: UnityEngine.SocialPlatforms
- Assembly: UnityEngine.GameCenterModule
Warning
Deprecated. ILeaderboard is deprecated and will be removed in a future release.
public interface ILeaderboard
Remarks
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.
Properties
Property | Description |
|---|---|
| id | Unique identifier for 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. |
| range | The rank range this leaderboard returns. |
| scores | The leaderboard scores returned by a query. |
| timeScope | The time period/scope searched by this leaderboard. |
| title | The human readable title of this leaderboard. |
| userScope | The users scope searched by this leaderboard. |
Methods
Method | Description |
|---|---|
| LoadScores | Load scores according to the filters set on this leaderboard. |
| SetUserFilter | Only search for these user IDs. |