Leaderboards

Detailed Description

Rank players or any custom key by score, with optional resets and rewards.

Two leaderboard types are supported: Player Type (scores tied to player IDs — traditional rankings) and Generic Type (scores tied to custom string keys — rank UGC, teams, or any entity). Metadata can be stored alongside each score for contextual enrichment. Periodic resets can be configured in the console to clear rankings on a schedule and automatically distribute rewards to top-placed players.

See the LootLocker documentation.

Function Documentation

GetAllMemberRanks()

static void LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanks ( int  member_id, int  count, Action< LootLockerGetAllMemberRanksResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the current ranking for a member on all available leaderboards.

Parameters

member_id	The ID of the player to check
count	Amount of entries to receive
onComplete	onComplete Action for handling the response of type LootLockerGetAllMemberRanksResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetAllMemberRanksMain()

static void LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanksMain ( int  member_id, int  count, int  after, Action< LootLockerGetAllMemberRanksResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the current ranking for a member on all available leaderboards.

Parameters

member_id	The ID of the player to check
count	Amount of entries to receive
after	How many extra rows after the returned position
onComplete	onComplete Action for handling the response of type LootLockerGetAllMemberRanksResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetAllMemberRanksNext()

static void LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanksNext ( int  member_id, int  count, Action< LootLockerGetAllMemberRanksResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the next current rankings for a member on all available leaderboards.

Parameters

member_id	The ID of the player to check
count	Amount of entries to receive
onComplete	onComplete Action for handling the response of type LootLockerGetAllMemberRanksResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetAllMemberRanksOriginal()

static void LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanksOriginal ( int  member_id, int  count, int  after, Action< LootLockerGetAllMemberRanksResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the current ranking for a member on all available leaderboards.

Parameters

member_id	The ID of the player to check
count	Amount of entries to receive
after	How many extra rows after the players position
onComplete	onComplete Action for handling the response of type LootLockerGetAllMemberRanksResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetAllMemberRanksPrev()

static void LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanksPrev ( int  member_id, int  count, Action< LootLockerGetAllMemberRanksResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the previous ranking for a member on all available leaderboards.

Parameters

member_id	The ID of the player to check
count	Amount of entries to receive
onComplete	onComplete Action for handling the response of type LootLockerGetAllMemberRanksResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetByListOfMembers()

static void LootLocker.Requests.LootLockerSDKManager.GetByListOfMembers ( string[]  members, string  leaderboardKey, Action< LootLockerGetByListOfMembersResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the current ranking for several members on a specific leaderboard.

Parameters

members	List of members to get as string
leaderboardKey	Key of the leaderboard as a string
onComplete	onComplete Action for handling the response of type LootLockerGetByListOfMembersResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetLeaderboardArchive() [1/3]

static void LootLocker.Requests.LootLockerSDKManager.GetLeaderboardArchive ( string  key, Action< LootLockerLeaderboardArchiveDetailsResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the details of a Leaderboard Archive, containing past rewards, ranks, etc.

Parameters

key	Key of the json archive to read
onComplete	<onComplete Action for handling the response of type LootLockerLeaderboardArchiveDetailsResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetLeaderboardArchive() [2/3]

static void LootLocker.Requests.LootLockerSDKManager.GetLeaderboardArchive ( string  key, int  count, Action< LootLockerLeaderboardArchiveDetailsResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the details of a Leaderboard Archive, containing past rewards, ranks, etc.

Parameters

key	Key of the json archive to read
count	Amount of entries to read
onComplete	<onComplete Action for handling the response of type LootLockerLeaderboardArchiveDetailsResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetLeaderboardArchive() [3/3]

static void LootLocker.Requests.LootLockerSDKManager.GetLeaderboardArchive ( string  key, int  count, string  after, Action< LootLockerLeaderboardArchiveDetailsResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the details of a Leaderboard Archive, containing past rewards, ranks, etc.

Parameters

key	Key of the json archive to read
count	Amount of entries to read
after	Return after specified index
onComplete	<onComplete Action for handling the response of type LootLockerLeaderboardArchiveDetailsResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetLeaderboardData()

static void LootLocker.Requests.LootLockerSDKManager.GetLeaderboardData ( string  leaderboard_key, Action< LootLockerLeaderboardDetailResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get data on a leaderboard, check rewards and when it will reset and the last reset time.

Parameters

leaderboard_key	Key of the leaderboard to get data from
onComplete	onComplete Action for handling the response of type LootLockerLeaderboardDetailResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetMemberRank()

static void LootLocker.Requests.LootLockerSDKManager.GetMemberRank ( string  leaderboardKey, string  member_id, Action< LootLockerGetMemberRankResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the current ranking for a specific player on a leaderboard.

Parameters

leaderboardKey	Key of the leaderboard as a string
member_id	ID of the player as a string
onComplete	onComplete Action for handling the response of type LootLockerGetMemberRankResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetNextScoreList()

static void LootLocker.Requests.LootLockerSDKManager.GetNextScoreList ( string  leaderboardKey, int  count, Action< LootLockerGetScoreListResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the next entries for a specific leaderboard.

Can be called after GetScoreList.

Parameters

leaderboardKey	Key of the leaderboard to get entries for
count	How many entries to get
onComplete	onComplete Action for handling the response of type LootLockerGetScoreListResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetPrevScoreList()

static void LootLocker.Requests.LootLockerSDKManager.GetPrevScoreList ( string  leaderboardKey, int  count, Action< LootLockerGetScoreListResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the previous entries for a specific leaderboard.

Can be called after GetScoreList or GetNextScoreList.

Parameters

leaderboardKey	Key of the leaderboard to get entries for
count	How many entries to get
onComplete	onComplete Action for handling the response of type LootLockerGetScoreListResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetScoreList() [1/2]

static void LootLocker.Requests.LootLockerSDKManager.GetScoreList ( string  leaderboardKey, int  count, Action< LootLockerGetScoreListResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the entries for a specific leaderboard.

Parameters

leaderboardKey	Key of the leaderboard to get entries for
count	How many entries to get
onComplete	onComplete Action for handling the response of type LootLockerGetScoreListResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetScoreList() [2/2]

static void LootLocker.Requests.LootLockerSDKManager.GetScoreList ( string  leaderboardKey, int  count, int  after, Action< LootLockerGetScoreListResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the entries for a specific leaderboard.

Parameters

leaderboardKey	Key of the leaderboard to get entries for
count	How many entries to get
after	How many after the last entry to receive
onComplete	onComplete Action for handling the response of type LootLockerGetScoreListResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

IncrementScore()

static void LootLocker.Requests.LootLockerSDKManager.IncrementScore ( string  memberId, int  amount, string  leaderboardKey, Action< LootLockerSubmitScoreResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Increment an existing score on a leaderboard by the given amount.

Parameters

memberId	Can be left blank if it is a player leaderboard, otherwise this is the identifier you wish to use for this score
amount	The amount with which to increment the current score on the given leaderboard (can be positive or negative)
leaderboardKey	Key of the leaderboard to submit score to
onComplete	onComplete Action for handling the response of type LootLockerSubmitScoreResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

ListLeaderboardArchive()

static void LootLocker.Requests.LootLockerSDKManager.ListLeaderboardArchive ( string  leaderboard_key, Action< LootLockerLeaderboardArchiveResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List the archived versions of a leaderboard, containing past rewards, ranks, etc.

Parameters

leaderboard_key	Key of the Leaderboard
onComplete	onComplete Action for handling the response of type LootLockerLeaderboardArchiveResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

ListLeaderboards()

static void LootLocker.Requests.LootLockerSDKManager.ListLeaderboards ( int  count, int  after, Action< LootLockerListLeaderboardsResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List leaderboards with details on each leaderboard.

Parameters

count	How many leaderboards to get in one request
after	Return leaderboards after this specified index
onComplete	onComplete Action for handling the response of type LootLockerGetMemberRankResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

QueryScore()

static void LootLocker.Requests.LootLockerSDKManager.QueryScore ( int  score, string  leaderboardKey, Action< LootLockerSubmitScoreResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Query a leaderboard for which rank a specific score would achieve.

Does not submit the score but returns the projected rank.

Parameters

score	The score to use for the query
leaderboardKey	Key of the leaderboard to submit score to
onComplete	onComplete Action for handling the response of type LootLockerSubmitScoreResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

SubmitScore() [1/2]

static void LootLocker.Requests.LootLockerSDKManager.SubmitScore ( string  memberId, int  score, string  leaderboardKey, Action< LootLockerSubmitScoreResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Submit a score to a leaderboard.

Parameters

memberId	Can be left blank if it is a player leaderboard, otherwise an identifier for the player
score	The score to upload
leaderboardKey	Key of the leaderboard to submit score to
onComplete	onComplete Action for handling the response of type LootLockerSubmitScoreResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

SubmitScore() [2/2]

static void LootLocker.Requests.LootLockerSDKManager.SubmitScore ( string  memberId, int  score, string  leaderboardKey, string  metadata, Action< LootLockerSubmitScoreResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Submit a score to a leaderboard with additional metadata.

Parameters

memberId	Can be left blank if it is a player leaderboard, otherwise an identifier for the player
score	The score to upload
leaderboardKey	Key of the leaderboard to submit score to
metadata	Additional metadata to add to the score
onComplete	onComplete Action for handling the response of type LootLockerSubmitScoreResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

Functions
static void	LootLocker.Requests.LootLockerSDKManager.ListLeaderboards (int count, int after, Action< LootLockerListLeaderboardsResponse > onComplete, string forPlayerWithUlid=null)
	List leaderboards with details on each leaderboard.
static void	LootLocker.Requests.LootLockerSDKManager.GetMemberRank (string leaderboardKey, string member_id, Action< LootLockerGetMemberRankResponse > onComplete, string forPlayerWithUlid=null)
	Get the current ranking for a specific player on a leaderboard.
static void	LootLocker.Requests.LootLockerSDKManager.GetByListOfMembers (string[] members, string leaderboardKey, Action< LootLockerGetByListOfMembersResponse > onComplete, string forPlayerWithUlid=null)
	Get the current ranking for several members on a specific leaderboard.
static void	LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanksMain (int member_id, int count, int after, Action< LootLockerGetAllMemberRanksResponse > onComplete, string forPlayerWithUlid=null)
	Get the current ranking for a member on all available leaderboards.
static void	LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanks (int member_id, int count, Action< LootLockerGetAllMemberRanksResponse > onComplete, string forPlayerWithUlid=null)
	Get the current ranking for a member on all available leaderboards.
static void	LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanksNext (int member_id, int count, Action< LootLockerGetAllMemberRanksResponse > onComplete, string forPlayerWithUlid=null)
	Get the next current rankings for a member on all available leaderboards.
static void	LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanksPrev (int member_id, int count, Action< LootLockerGetAllMemberRanksResponse > onComplete, string forPlayerWithUlid=null)
	Get the previous ranking for a member on all available leaderboards.
static void	LootLocker.Requests.LootLockerSDKManager.ResetAllMemberRanksCalls ()
	Reset the calls for getting all member ranks.
static void	LootLocker.Requests.LootLockerSDKManager.GetAllMemberRanksOriginal (int member_id, int count, int after, Action< LootLockerGetAllMemberRanksResponse > onComplete, string forPlayerWithUlid=null)
	Get the current ranking for a member on all available leaderboards.
static void	LootLocker.Requests.LootLockerSDKManager.GetScoreList (string leaderboardKey, int count, int after, Action< LootLockerGetScoreListResponse > onComplete, string forPlayerWithUlid=null)
	Get the entries for a specific leaderboard.
static void	LootLocker.Requests.LootLockerSDKManager.GetScoreList (string leaderboardKey, int count, Action< LootLockerGetScoreListResponse > onComplete, string forPlayerWithUlid=null)
	Get the entries for a specific leaderboard.
static void	LootLocker.Requests.LootLockerSDKManager.GetNextScoreList (string leaderboardKey, int count, Action< LootLockerGetScoreListResponse > onComplete, string forPlayerWithUlid=null)
	Get the next entries for a specific leaderboard.
static void	LootLocker.Requests.LootLockerSDKManager.GetPrevScoreList (string leaderboardKey, int count, Action< LootLockerGetScoreListResponse > onComplete, string forPlayerWithUlid=null)
	Get the previous entries for a specific leaderboard.
static void	LootLocker.Requests.LootLockerSDKManager.ResetScoreCalls ()
	Reset the next and previous cursors for the GetScoreList and GetNextScoreList methods.
static void	LootLocker.Requests.LootLockerSDKManager.SubmitScore (string memberId, int score, string leaderboardKey, Action< LootLockerSubmitScoreResponse > onComplete, string forPlayerWithUlid=null)
	Submit a score to a leaderboard.
static void	LootLocker.Requests.LootLockerSDKManager.SubmitScore (string memberId, int score, string leaderboardKey, string metadata, Action< LootLockerSubmitScoreResponse > onComplete, string forPlayerWithUlid=null)
	Submit a score to a leaderboard with additional metadata.
static void	LootLocker.Requests.LootLockerSDKManager.QueryScore (int score, string leaderboardKey, Action< LootLockerSubmitScoreResponse > onComplete, string forPlayerWithUlid=null)
	Query a leaderboard for which rank a specific score would achieve.
static void	LootLocker.Requests.LootLockerSDKManager.IncrementScore (string memberId, int amount, string leaderboardKey, Action< LootLockerSubmitScoreResponse > onComplete, string forPlayerWithUlid=null)
	Increment an existing score on a leaderboard by the given amount.
static void	LootLocker.Requests.LootLockerSDKManager.ListLeaderboardArchive (string leaderboard_key, Action< LootLockerLeaderboardArchiveResponse > onComplete, string forPlayerWithUlid=null)
	List the archived versions of a leaderboard, containing past rewards, ranks, etc.
static void	LootLocker.Requests.LootLockerSDKManager.GetLeaderboardArchive (string key, Action< LootLockerLeaderboardArchiveDetailsResponse > onComplete, string forPlayerWithUlid=null)
	Get the details of a Leaderboard Archive, containing past rewards, ranks, etc.
static void	LootLocker.Requests.LootLockerSDKManager.GetLeaderboardArchive (string key, int count, Action< LootLockerLeaderboardArchiveDetailsResponse > onComplete, string forPlayerWithUlid=null)
	Get the details of a Leaderboard Archive, containing past rewards, ranks, etc.
static void	LootLocker.Requests.LootLockerSDKManager.GetLeaderboardArchive (string key, int count, string after, Action< LootLockerLeaderboardArchiveDetailsResponse > onComplete, string forPlayerWithUlid=null)
	Get the details of a Leaderboard Archive, containing past rewards, ranks, etc.
static void	LootLocker.Requests.LootLockerSDKManager.GetLeaderboardData (string leaderboard_key, Action< LootLockerLeaderboardDetailResponse > onComplete, string forPlayerWithUlid=null)
	Get data on a leaderboard, check rewards and when it will reset and the last reset time.