Combu  2.1.14
Unity API Documentation
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
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 LoadScores (System.Action< bool > callback)
 Loads the scores. More...
 
virtual void LoadScoresByUser (User user, eLeaderboardInterval interval, int limit, System.Action< Score, int, string > callback)
 Loads the scores by user. More...
 

Static Public Member Functions

static void Load (string leaderboardId, System.Action< Leaderboard, string > callback)
 Load the specified leaderboardId. More...
 
static void Load< T > (string leaderboardId, System.Action< Leaderboard, string > callback)
 Load the specified leaderboardId. More...
 

Public Attributes

bool highestScorePerPlayer
 
bool sumScoresPerPlayer
 

Properties

bool loading [get]
 
string id [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

virtual void Combu.Leaderboard.FromJson ( string  jsonString)
virtual

Initialize the object from a JSON formatted string.

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

Load the specified leaderboardId.

Parameters
leaderboardIdLeaderboard identifier.
callbackCallback.
static void Combu.Leaderboard.Load< T > ( string  leaderboardId,
System.Action< Leaderboard, string >  callback 
)
static

Load the specified leaderboardId.

Parameters
leaderboardIdLeaderboard identifier.
callbackCallback.
Template Parameters
TThe 1st type parameter.
Type Constraints
T :Leaderboard 
T :new() 
void Combu.Leaderboard.LoadScores ( System.Action< bool >  callback)

Loads the scores.

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

Loads the scores by user.

Parameters
userUser.
intervalInterval.
callbackCallback.
void Combu.Leaderboard.SetUserFilter ( string[]  userIDs)

Sets the user filter.

Parameters
userIDsUser I ds.

The documentation for this class was generated from the following file: