Combu.Leaderboard Class Reference

Inheritance diagram for Combu.Leaderboard:

Public Member Functions
	Leaderboard (string jsonString)
virtual void	FromJson (string jsonString)
	Initialize the object from a JSON formatted string. More...
void	SetUserFilter (string[] userIDs)
	Sets the user filter. More...
void	SetGroupFilter (long groupId)
void	LoadScores (Action< bool > callback)
	Loads the scores. More...
virtual void	LoadScoresByUser (User user, eLeaderboardInterval interval, int limit, Action< Score, int, string > callback)
virtual void	LoadScoresByUser (long userId, eLeaderboardInterval interval, int limit, Action< Score, int, string > callback)
virtual void	LoadScoresByUser (string userName, eLeaderboardInterval interval, int limit, Action< Score, int, string > callback)
virtual void	LoadScoreByUser (User user, eLeaderboardInterval interval, int limit, Action< Score, int, string > callback)
	Loads the scores of a user on this leaderboard. More...
virtual void	LoadScoreByUser (long userId, eLeaderboardInterval interval, int limit, Action< Score, int, string > callback)
	Loads the scores by user id. More...
virtual void	LoadScoreByUser (string userName, eLeaderboardInterval interval, int limit, Action< Score, int, string > callback)
	Loads the scores by userName. More...

Static Public Member Functions
static void	Load (string leaderboardId, Action< Leaderboard, string > callback)
	Load the specified leaderboardId. More...
static void	Load< T > (string leaderboardId, Action< Leaderboard, string > callback)
	Load the specified leaderboardId. More...
static void	LoadScoresByUser (User user, eLeaderboardInterval interval, Action< Score[], string > callback)
	Loads the scores of a user. More...

Public Attributes
bool	highestScorePerPlayer
bool	sumScoresPerPlayer

Protected Member Functions
void	LoadScoreByUser (long userId, string userName, eLeaderboardInterval interval, int limit, Action< Score, int, string > callback)
	Loads the scores by user. More...

Properties
bool	loading [get]
string	id [get, set]
string	code [get, set]
UserScope	userScope [get, set]
Range	range [get, set]
TimeScope	timeScope [get, set]
eLeaderboardTimeScope	customTimescope [get, set]
IScore	localUserScore [get]
uint	maxRange [get]
IScore[]	scores [get]
string	title [get]
string	description [get]

Member Function Documentation

FromJson()

virtual void Combu.Leaderboard.FromJson ( string  jsonString )

virtual

Initialize the object from a JSON formatted string.

Parameters

jsonString

Json string.

Load()

static void Combu.Leaderboard.Load ( string  leaderboardId, Action< Leaderboard, string >  callback  )

static

Load the specified leaderboardId.

Parameters

leaderboardId	Leaderboard identifier.
callback	Callback.

Load< T >()

static void Combu.Leaderboard.Load< T > ( string  leaderboardId, Action< Leaderboard, string >  callback  )

static

Load the specified leaderboardId.

Parameters

leaderboardId	Leaderboard identifier.
callback	Callback.

Template Parameters

T	The 1st type parameter.

Type Constraints

T	:	Leaderboard
T	:	new()

LoadScoreByUser() [1/4]

virtual void Combu.Leaderboard.LoadScoreByUser ( long  userId, eLeaderboardInterval  interval, int  limit, Action< Score, int, string >  callback  )

virtual

Loads the scores by user id.

Parameters

userId	User identifier.
interval	Interval.
limit	Limit.
callback	Callback.

LoadScoreByUser() [2/4]

void Combu.Leaderboard.LoadScoreByUser ( long  userId, string  userName, eLeaderboardInterval  interval, int  limit, Action< Score, int, string >  callback  )

protected

Loads the scores by user.

Parameters

userId	User identifier.
userName	User name.
interval	Interval.
limit	Limit.
callback	Callback.

LoadScoreByUser() [3/4]

virtual void Combu.Leaderboard.LoadScoreByUser ( string  userName, eLeaderboardInterval  interval, int  limit, Action< Score, int, string >  callback  )

virtual

Loads the scores by userName.

Parameters

userName	User name.
interval	Interval.
limit	Limit.
callback	Callback.

LoadScoreByUser() [4/4]

virtual void Combu.Leaderboard.LoadScoreByUser ( User  user, eLeaderboardInterval  interval, int  limit, Action< Score, int, string >  callback  )

virtual

Loads the scores of a user on this leaderboard.

Parameters

user	User.
interval	Interval.
callback	Callback.

LoadScores()

void Combu.Leaderboard.LoadScores

(

Action< bool >

callback

)

Loads the scores.

Parameters

callback

Callback.

LoadScoresByUser()

static void Combu.Leaderboard.LoadScoresByUser ( User  user, eLeaderboardInterval  interval, Action< Score[], string >  callback  )

static

Loads the scores of a user.

Parameters

user	User.
interval	Interval.
callback	Callback.

SetUserFilter()

void Combu.Leaderboard.SetUserFilter

(

string[]

userIDs

)

Sets the user filter.

Parameters

userIDs

User I ds.