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.
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. |
LoadScores | Load scores according to the filters set on this leaderboard. |
SetUserFilter | Only search for these user IDs. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.