Essential Kit
Loading...
Searching...
No Matches
ILeaderboard

Provides interface to read data from a leaderboard stored on game server. More...

Public Member Functions

void ReportScore (long score, CompletionCallback callback, string tag=null)
 Reports the score to game server.
 
void LoadTopScores (EventCallback< LeaderboardLoadScoresResult > callback)
 Loads the top set of scores.
 
void LoadPlayerCenteredScores (EventCallback< LeaderboardLoadScoresResult > callback)
 Loads player-centered set of scores.
 
void LoadNext (EventCallback< LeaderboardLoadScoresResult > callback)
 Loads next set of scores.
 
void LoadPrevious (EventCallback< LeaderboardLoadScoresResult > callback)
 Loads previous set of scores.
 
void LoadImage (EventCallback< TextureData > callback)
 Loads the image.
 

Properties

string Id [get]
 An unique string used to identify the leaderboard across all the supported platforms. (read-only)
 
string PlatformId [get]
 An unique used to identify the leaderboard in the current platform. (read-only)
 
string Title [get]
 A localized title for the leaderboard. (read-only)
 
LeaderboardPlayerScope PlayerScope [get, set]
 A filter used to restrict the search to a subset of the players on game server.
 
LeaderboardTimeScope TimeScope [get, set]
 A filter used to restrict the search to scores that were posted within a specific period of time.
 
int LoadScoresQuerySize [get, set]
 The value indicates maximum entries that has to be fetched from search.
 
ILeaderboardScore LocalPlayerScore [get]
 Returns the IScore earned by the local player. (read-only)
 

Detailed Description

Remarks
Your game must authenticate the local user before using any features.

Member Function Documentation

◆ ReportScore()

void ReportScore ( long score,
CompletionCallback callback,
string tag = null )
Parameters
scoreThe score value.
callbackCallback method that will be invoked after operation is completed.
tagThe tag used to identify the score (optional). This needs to be of max length 8 characters in ascii characters.

Referenced by GameServices.ReportScore().

◆ LoadTopScores()

void LoadTopScores ( EventCallback< LeaderboardLoadScoresResult > callback)
Parameters
callbackCallback method that will be invoked after operation is completed.

◆ LoadPlayerCenteredScores()

void LoadPlayerCenteredScores ( EventCallback< LeaderboardLoadScoresResult > callback)
Parameters
callbackCallback method that will be invoked after operation is completed.

◆ LoadNext()

void LoadNext ( EventCallback< LeaderboardLoadScoresResult > callback)
Parameters
callbackCallback method that will be invoked after operation is completed.

◆ LoadPrevious()

void LoadPrevious ( EventCallback< LeaderboardLoadScoresResult > callback)
Parameters
callbackCallback method that will be invoked after operation is completed.

◆ LoadImage()

void LoadImage ( EventCallback< TextureData > callback)
Parameters
callbackCallback method that will be invoked after operation is completed.

Property Documentation

◆ LocalPlayerScore

ILeaderboardScore LocalPlayerScore
get
Note
This property is invalid until a call to load scores is completed.