Version: 2021.1
LanguageEnglish
  • C#

ILeaderboard

interface in UnityEngine.SocialPlatforms

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

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.

Properties

idUnique identifier for this leaderboard.
loadingThe leaderboad is in the process of loading scores.
localUserScoreThe leaderboard score of the logged in user.
maxRangeThe total amount of scores the leaderboard contains.
rangeThe rank range this leaderboard returns.
scoresThe leaderboard scores returned by a query.
timeScopeThe time period/scope searched by this leaderboard.
titleThe human readable title of this leaderboard.
userScopeThe users scope searched by this leaderboard.

Public Methods

LoadScoresLoad scores according to the filters set on this leaderboard.
SetUserFilterOnly search for these user IDs.