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.

Typedef Documentation

FLootLockerGetAllMemberRanksResponseDelegate

typedef void(* FLootLockerGetAllMemberRanksResponseDelegate) (FLootLockerGetAllMemberRanksResponse)

C++ response callback delegate; receives an FLootLockerGetAllMemberRanksResponse result.

FLootLockerGetByListOfMembersResponseDelegate

typedef void(* FLootLockerGetByListOfMembersResponseDelegate) (FLootLockerGetByListOfMembersResponse)

C++ response callback delegate; receives an FLootLockerGetByListOfMembersResponse result.

FLootLockerGetMemberRankResponseDelegate

typedef void(* FLootLockerGetMemberRankResponseDelegate) (FLootLockerGetMemberRankResponse)

C++ response callback delegate; receives an FLootLockerGetMemberRankResponse result.

FLootLockerGetScoreListResponseDelegate

typedef void(* FLootLockerGetScoreListResponseDelegate) (FLootLockerGetScoreListResponse)

C++ response callback delegate; receives an FLootLockerGetScoreListResponse result.

FLootLockerLeaderboardArchiveDetailResponseDelegate

typedef void(* FLootLockerLeaderboardArchiveDetailResponseDelegate) (FLootLockerLeaderboardArchiveDetailsResponse)

C++ response callback delegate; receives an FLootLockerLeaderboardArchiveDetailsResponse result.

FLootLockerLeaderboardArchiveResponseDelegate

typedef void(* FLootLockerLeaderboardArchiveResponseDelegate) (FLootLockerLeaderboardArchiveResponse)

C++ response callback delegate; receives an FLootLockerLeaderboardArchiveResponse result.

FLootLockerLeaderboardDetailsResponseDelegate

typedef void(* FLootLockerLeaderboardDetailsResponseDelegate) (FLootLockerLeaderboardDetailsResponse)

C++ response callback delegate; receives an FLootLockerLeaderboardDetailsResponse result.

FLootLockerListLeaderboardsResponseDelegate

typedef void(* FLootLockerListLeaderboardsResponseDelegate) (FLootLockerListLeaderboardsResponse)

C++ response callback delegate; receives an FLootLockerListLeaderboardsResponse result.

FLootLockerSubmitScoreResponseDelegate

typedef void(* FLootLockerSubmitScoreResponseDelegate) (FLootLockerSubmitScoreResponse)

C++ response callback delegate; receives an FLootLockerSubmitScoreResponse result.

Enumeration Type Documentation

ELootLockerLeaderboardRewardEntityKind

enum class ELootLockerLeaderboardRewardEntityKind : uint8

strong

Entity kinds that can be given as leaderboard rewards.

Enumerator
Asset
Currency
Progression_Points
Progression_Reset
Group

Function Documentation

GetAllMemberRanks()

static FString ULootLockerSDKManager::GetAllMemberRanks ( FString  MemberId, const int  Count, const int  After, const FLootLockerGetAllMemberRanksResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List all leaderboards with this member's rank/score (and player info for player leaderboards).

Metadata included if enabled.

Parameters

MemberId	Member/player id
Count	Members per page
After	Pagination cursor
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetByListOfMembers()

static FString ULootLockerSDKManager::GetByListOfMembers ( TArray< FString >  Members, FString  LeaderboardKey, const FLootLockerGetByListOfMembersResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get ranks for multiple members.

If the leaderboard is player type, player info is included.

Parameters

Members	Member/player ids to query
LeaderboardKey	Leaderboard key
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetLeaderboardArchive() [1/2]

static FString ULootLockerSDKManager::GetLeaderboardArchive ( const FString &  Key, const FLootLockerLeaderboardArchiveDetailResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

inlinestatic

Get a leaderboard archive (all entries).

Parameters

Key	Leaderboard key
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetLeaderboardArchive() [2/2]

static FString ULootLockerSDKManager::GetLeaderboardArchive ( const FString &  Key, int  Count, const FString &  After, const FLootLockerLeaderboardArchiveDetailResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get a leaderboard archive (paginated entries with ranks, scores, rewards).

Parameters

Key	Leaderboard key
Count	Optional: Entry count
After	Optional: Pagination cursor
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetLeaderboardDetails()

static FString ULootLockerSDKManager::GetLeaderboardDetails ( const FString &  LeaderboardKey, const FLootLockerLeaderboardDetailsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get leaderboard details (schedule, rewards, reward details).

Parameters

LeaderboardKey	Leaderboard key
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetMemberRank()

static FString ULootLockerSDKManager::GetMemberRank ( FString  LeaderboardKey, FString  MemberId, const FLootLockerGetMemberRankResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get rank for a single member.

If the leaderboard is player type, player info is included.

Parameters

LeaderboardKey	Leaderboard key
MemberId	Member/player id
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetScoreList()

static FString ULootLockerSDKManager::GetScoreList ( FString  LeaderboardKey, int  Count, int  After, const FLootLockerGetScoreListResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List ranked members (paginated).

Max 2000 per request. Player info included for player leaderboards.

Parameters

LeaderboardKey	Leaderboard key
Count	Members per page
After	Pagination cursor
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

GetScoreListInitial()

static FString ULootLockerSDKManager::GetScoreListInitial ( FString  LeaderboardKey, int  Count, const FLootLockerGetScoreListResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List ranked members starting from top (initial page).

Max 2000. Player info included for player leaderboards.

Parameters

LeaderboardKey	Leaderboard key
Count	Members to return
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

IncrementScore()

static FString ULootLockerSDKManager::IncrementScore ( FString  MemberId, const FString  LeaderboardKey, const int  Amount, const FLootLockerSubmitScoreResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Increment an existing score by an amount (positive or negative).

Parameters

MemberId	Member/player id (blank for player leaderboard default)
LeaderboardKey	Leaderboard key
Amount	Amount to add (or subtract if negative)
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListLeaderboardArchive()

static FString ULootLockerSDKManager::ListLeaderboardArchive ( const FString &  LeaderboardKey, const FLootLockerLeaderboardArchiveResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List archived versions of a leaderboard.

Parameters

LeaderboardKey	Leaderboard key
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListLeaderboards() [1/2]

static FString ULootLockerSDKManager::ListLeaderboards ( const FLootLockerListLeaderboardsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

inlinestatic

List leaderboards with their details.

Parameters

OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

ListLeaderboards() [2/2]

static FString ULootLockerSDKManager::ListLeaderboards ( int  Count, int  After, const FLootLockerListLeaderboardsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List leaderboards (paginated) with details.

Parameters

Count	Optional: Number of items to retrieve
After	Optional: Pagination cursor id to start after
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

QueryScore()

static FString ULootLockerSDKManager::QueryScore ( const FString  LeaderboardKey, const int  Score, const FLootLockerSubmitScoreResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Query the projected rank for a hypothetical score (does not submit).

Parameters

LeaderboardKey	Leaderboard key
Score	Score value to evaluate
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

SubmitScore()

static FString ULootLockerSDKManager::SubmitScore ( FString  MemberId, const FString  LeaderboardKey, const int  Score, FString  Metadata, const FLootLockerSubmitScoreResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Submit a score for a member.

Parameters

MemberId	Member/player id (blank for player leaderboard to use default)
LeaderboardKey	Leaderboard key
Score	Score value
Metadata	Optional: Metadata (if enabled for leaderboard)
OnCompletedRequest	Delegate for handling the server response
ForPlayerWithUlid	Optional: Execute for the specified player ULID (default player if empty)

Returns

A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

Typedefs
typedef void(*	FLootLockerLeaderboardArchiveResponseDelegate) (FLootLockerLeaderboardArchiveResponse)
	C++ response callback delegate; receives an FLootLockerLeaderboardArchiveResponse result.
typedef void(*	FLootLockerLeaderboardArchiveDetailResponseDelegate) (FLootLockerLeaderboardArchiveDetailsResponse)
	C++ response callback delegate; receives an FLootLockerLeaderboardArchiveDetailsResponse result.
typedef void(*	FLootLockerListLeaderboardsResponseDelegate) (FLootLockerListLeaderboardsResponse)
	C++ response callback delegate; receives an FLootLockerListLeaderboardsResponse result.
typedef void(*	FLootLockerGetMemberRankResponseDelegate) (FLootLockerGetMemberRankResponse)
	C++ response callback delegate; receives an FLootLockerGetMemberRankResponse result.
typedef void(*	FLootLockerGetByListOfMembersResponseDelegate) (FLootLockerGetByListOfMembersResponse)
	C++ response callback delegate; receives an FLootLockerGetByListOfMembersResponse result.
typedef void(*	FLootLockerGetScoreListResponseDelegate) (FLootLockerGetScoreListResponse)
	C++ response callback delegate; receives an FLootLockerGetScoreListResponse result.
typedef void(*	FLootLockerSubmitScoreResponseDelegate) (FLootLockerSubmitScoreResponse)
	C++ response callback delegate; receives an FLootLockerSubmitScoreResponse result.
typedef void(*	FLootLockerGetAllMemberRanksResponseDelegate) (FLootLockerGetAllMemberRanksResponse)
	C++ response callback delegate; receives an FLootLockerGetAllMemberRanksResponse result.
typedef void(*	FLootLockerLeaderboardDetailsResponseDelegate) (FLootLockerLeaderboardDetailsResponse)
	C++ response callback delegate; receives an FLootLockerLeaderboardDetailsResponse result.

Enumerations
enum class	ELootLockerLeaderboardRewardEntityKind : uint8 {   ELootLockerLeaderboardRewardEntityKind::Asset = 0 , ELootLockerLeaderboardRewardEntityKind::Currency = 1 , ELootLockerLeaderboardRewardEntityKind::Progression_Points = 2 , ELootLockerLeaderboardRewardEntityKind::Progression_Reset = 3 ,   ELootLockerLeaderboardRewardEntityKind::Group = 4 }
	Entity kinds that can be given as leaderboard rewards. More...

Functions
static FString	ULootLockerSDKManager::ListLeaderboards (const FLootLockerListLeaderboardsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List leaderboards with their details.
static FString	ULootLockerSDKManager::ListLeaderboards (int Count, int After, const FLootLockerListLeaderboardsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List leaderboards (paginated) with details.
static FString	ULootLockerSDKManager::GetMemberRank (FString LeaderboardKey, FString MemberId, const FLootLockerGetMemberRankResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get rank for a single member.
static FString	ULootLockerSDKManager::GetByListOfMembers (TArray< FString > Members, FString LeaderboardKey, const FLootLockerGetByListOfMembersResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get ranks for multiple members.
static FString	ULootLockerSDKManager::GetScoreList (FString LeaderboardKey, int Count, int After, const FLootLockerGetScoreListResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List ranked members (paginated).
static FString	ULootLockerSDKManager::GetScoreListInitial (FString LeaderboardKey, int Count, const FLootLockerGetScoreListResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List ranked members starting from top (initial page).
static FString	ULootLockerSDKManager::SubmitScore (FString MemberId, const FString LeaderboardKey, const int Score, FString Metadata, const FLootLockerSubmitScoreResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Submit a score for a member.
static FString	ULootLockerSDKManager::QueryScore (const FString LeaderboardKey, const int Score, const FLootLockerSubmitScoreResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Query the projected rank for a hypothetical score (does not submit).
static FString	ULootLockerSDKManager::IncrementScore (FString MemberId, const FString LeaderboardKey, const int Amount, const FLootLockerSubmitScoreResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Increment an existing score by an amount (positive or negative).
static FString	ULootLockerSDKManager::GetAllMemberRanks (FString MemberId, const int Count, const int After, const FLootLockerGetAllMemberRanksResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List all leaderboards with this member's rank/score (and player info for player leaderboards).
static FString	ULootLockerSDKManager::ListLeaderboardArchive (const FString &LeaderboardKey, const FLootLockerLeaderboardArchiveResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List archived versions of a leaderboard.
static FString	ULootLockerSDKManager::GetLeaderboardArchive (const FString &Key, int Count, const FString &After, const FLootLockerLeaderboardArchiveDetailResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get a leaderboard archive (paginated entries with ranks, scores, rewards).
static FString	ULootLockerSDKManager::GetLeaderboardArchive (const FString &Key, const FLootLockerLeaderboardArchiveDetailResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get a leaderboard archive (all entries).
static FString	ULootLockerSDKManager::GetLeaderboardDetails (const FString &LeaderboardKey, const FLootLockerLeaderboardDetailsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get leaderboard details (schedule, rewards, reward details).