Leaderboards

Detailed Description

Submit and read leaderboard scores from the server.

Two leaderboard types are supported: Player Type (scores tied to player IDs — traditional rankings) and Generic Type (scores tied to any string key — rank teams, UGC, or any entity). Submitting from the server prevents score manipulation. Periodic resets can be configured in the console to distribute rewards to top-placed players.

See the LootLocker documentation.

Function Documentation

CreateLeaderboard()

static FString ULootLockerServerForCpp::CreateLeaderboard ( FString  LeaderboardKey, FString  Name, ELootLockerServerLeaderboardType  Type, bool  HasMetadata, ELootLockerServerLeaderboardDirection  DirectionMethod, bool  EnableGameApiWrites, bool  OverwriteScoreOnSubmit, const FLootLockerServerCreateLeaderboardResponseDelegate &  OnCompletedRequest  )

static

Create a new leaderboard with the provided details.

Parameters

LeaderboardKey	Unique key for the leaderboard
Name	Name of the leaderboard
Type	Type of the leaderboard
HasMetadata	Whether the leaderboard has metadata
DirectionMethod	Sort order (Ascending or Descending), based on whether highest rank is lowest or highest number
EnableGameApiWrites	Whether the Game API is permitted to write to this leaderboard
OverwriteScoreOnSubmit	Submitting a new score for member will always overwrite their existing score on leaderboard
OnCompletedRequest	Delegate for handling the response

Returns

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

CreateLeaderboardSchedule()

static FString ULootLockerServerForCpp::CreateLeaderboardSchedule ( const FString &  LeaderboardKey, const FString &  CronExpression, const FLootLockerServerGetLeaderboardScheduleResponseDelegate &  OnCompletedRequest  )

static

Set the provided schedule for the specified leaderboard NOTE: Cron expressions are used for setting up the schedule.

These expressions follow the traditional cron spec. See crontab.guru for a good resource in exploring cron expressions. Additionally, we do support non-standard descriptors as follows:

• @hourly: every hour at minute 00.
• @daily: everyday, at midnight UTC.
• @weekly: on Sunday, at midnight UTC.
• @monthly: on the first day of the month, at midnight UTC.
• @yearly: on the first day of the year, at midnight UTC.

  Parameters

  Key	The Key of the leaderboard for which to set the schedule
  CronExpression	The cron expression describing the schedule to set
  OnCompletedRequest	Delegate for handling the server response

  Returns

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

DeleteLeaderboard()

static FString ULootLockerServerForCpp::DeleteLeaderboard ( FString  LeaderboardKey, const FLootLockerServerDeleteLeaderboardResponseDelegate &  OnCompletedRequest  )

static

Delete an existing leaderboard.

Parameters

LeaderboardKey	The key of the leaderboard to delete
OnCompletedRequest	Delegate for handling the response

Returns

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

DeleteLeaderboardSchedule()

static FString ULootLockerServerForCpp::DeleteLeaderboardSchedule ( const FString &  LeaderboardKey, const FLootLockerServerDeleteLeaderboardScheduleResponseDelegate &  OnCompletedRequest  )

static

Remove the schedule (if any) from the specified leadeboard.

Parameters

Key	the Key of the leaderboard for which to remove the schedule
OnCompletedRequest	Delegate for handling the server response

Returns

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

GetAllMemberRanks()

static FString ULootLockerServerForCpp::GetAllMemberRanks ( FString  MemberID, const FLootLockerServerGetAllMemberRanksResponseDelegate &  OnCompletedRequest  )

static

For all leaderboards that this member has scores on, get the score, member information, rank, score, and metadata (if metadata is enabled on that leaderboard), as well as player information if the leaderboard is of type player.

Parameters

MemberID	The ID of the member to submit the score for
OnCompletedRequest	Delegate for handling the response

Returns

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

GetLeaderboard()

static FString ULootLockerServerForCpp::GetLeaderboard ( const FString &  LeaderboardKey, const FLootLockerServerGetLeaderboardResponseDelegate &  OnCompletedRequest  )

static

Get information about a given leaderboard.

Parameters

LeaderboardKey	The key of the leaderboard to get information for
OnCompletedRequest	Delegate for handling the response

Returns

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

GetLeaderboardArchive()

static FString ULootLockerServerForCpp::GetLeaderboardArchive ( const FString &  Key, int  Count, const FString &  After, const FLootLockerServerLeaderboardArchiveDetailResponseDelegate &  OnCompletedRequest  )

static

Get the specified Archive which includes details such as ranks, scores and rewards.

Parameters

Key	the Key of the leaderboard archive entry you want to fetch details for
Count	Optional: the count of how many archive entries you want
After	Optional: cursor for pagination
OnCompletedRequest	Delegate for handling the server response

Returns

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

GetLeaderboardSchedule()

static FString ULootLockerServerForCpp::GetLeaderboardSchedule ( const FString &  LeaderboardKey, const FLootLockerServerGetLeaderboardScheduleResponseDelegate &  OnCompletedRequest  )

static

Get the schedule for the specified leaderboard.

Parameters

LeaderboardKey	the Key of the leaderboard for which to fetch the schedule
OnCompletedRequest	Delegate for handling the server response

Returns

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

GetPaginatedAllMemberRanks()

static FString ULootLockerServerForCpp::GetPaginatedAllMemberRanks ( FString  MemberID, const int  Count, const int  After, const FLootLockerServerGetAllMemberRanksResponseDelegate &  OnCompletedRequest  )

static

For all leaderboards that this member has scores on, get the score, member information, rank, score, and metadata (if metadata is enabled on that leaderboard), as well as player information if the leaderboard is of type player, using pagination settings.

Parameters

MemberID	The ID of the member to get the scores for. For player type leaderboards this is the PlayerID, for Generic type leaderboards it can be any string so you need to know what/who you want to submit for.
Count	Number of members returned per page
After	Cursor for pagination, a cursor will be returned in the response
OnCompletedRequest	Delegate for handling the response

Returns

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

GetPaginatedScoresFromLeaderboard()

static FString ULootLockerServerForCpp::GetPaginatedScoresFromLeaderboard ( FString  LeaderboardKey, int  Count, int  After, const FLootLockerServerGetScoresFromLeaderboardResponseDelegate &  OnCompletedRequest  )

static

From the requested leaderboard get <count> number of scores.

The list of scores has member information, rank, score, and metadata (if metadata is enabled on that leaderboard) for the given leaderboard. If leaderboard is of type player a player will also be in the response, using pagination settings. Results are sorted in ascending order. Maximum allowed scores to query for at a time is currently 2000.

Parameters

LeaderboardKey	the key of the leaderboard you want to connect to.
Count	Number of scores returned per page
After	Cursor for pagination, a cursor will be returned in the response
OnCompletedRequest	Delegate for handling the server response

Returns

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

GetScoresFromLeaderboard()

static FString ULootLockerServerForCpp::GetScoresFromLeaderboard ( FString  LeaderboardKey, const FLootLockerServerGetScoresFromLeaderboardResponseDelegate &  OnCompletedRequest  )

static

From the requested leaderboard get <count> number of scores.

The list of scores has member information, rank, score, and metadata (if metadata is enabled on that leaderboard) for the given leaderboard. If leaderboard is of type player a player will also be in the response. Results are sorted in ascending order. Maximum allowed members to query for at a time is currently 2000.

Parameters

LeaderboardKey	the key of the leaderboard you want to connect to.
OnCompletedRequest	Delegate for handling the server response

Returns

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

IncrementScore()

static FString ULootLockerServerForCpp::IncrementScore ( FString  LeaderboardKey, FString  MemberID, int  Amount, const FLootLockerServerLeaderboardIncrementScoreResponseDelegate &  OnCompletedRequest  )

static

Increment a member's score on the given leaderboard by the specified amount.

Parameters

LeaderboardKey	The key of the leaderboard to increment the score on
MemberID	The ID of the member whose score to increment. For player type leaderboards this is the PlayerID, for generic type leaderboards it can be any string.
Amount	The amount to increment the score by
OnCompletedRequest	Delegate for handling the response

Returns

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

ListAssets()

static FString ULootLockerServerForCpp::ListAssets ( const FLootLockerServerListAssetsRequest &  Request, int  PerPage, int  Page, const FLootLockerServerListAssetsResponseDelegate &  OnCompletedRequest  )

static

List assets with configurable response data.

Use this to limit the fields returned in the response and improve performance. Lightweight alternative for retrieving assets where only selected data is needed

Parameters

Request	Request payload specifying includes/excludes/filters
PerPage	Optional: page size (ignored if 0 or negative)
Page	Optional: page index (ignored if 0 or negative)
OnCompletedRequest	Delegate for handling the server response

Returns

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

ListAssetsWithDefaultParameters()

static FString ULootLockerServerForCpp::ListAssetsWithDefaultParameters ( const FLootLockerServerListAssetsResponseDelegate &  OnCompletedRequest )

static

List assets with default parameters (no filters, first page, default page size) Lightweight alternative for retrieving assets where only selected data is needed.

Parameters

OnCompletedRequest

Delegate for handling the server response

Returns

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

ListContexts()

static FString ULootLockerServerForCpp::ListContexts ( int  PerPage, int  Page, const FLootLockerServerListContextsResponseDelegate &  OnCompletedRequest  )

static

List contexts with pagination support.

Parameters

PerPage	Optional: page size (ignored if 0 or negative)
Page	Optional: page index (ignored if 0 or negative)
OnCompletedRequest	Delegate for handling the server response

Returns

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

ListLeaderboardArchive()

static FString ULootLockerServerForCpp::ListLeaderboardArchive ( const FString &  LeaderboardKey, const FLootLockerServerLeaderboardArchiveResponseDelegate &  OnCompletedRequest  )

static

List the archive of a specific Leaderboard,.

Parameters

LeaderboardKey	the Key of the Leaderboard you want the list of archives
OnCompletedRequest	Delegate for handling the server response

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 ULootLockerServerForCpp::ListLeaderboards ( const FLootLockerServerListLeaderboardsResponseDelegate &  OnCompletedRequest )

static

List information about all leaderboards in the game.

Parameters

OnCompletedRequest

Delegate for handling the response

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 ULootLockerServerForCpp::ListLeaderboards ( int32  Count, int32  After, const FLootLockerServerListLeaderboardsResponseDelegate &  OnCompletedRequest  )

static

List information about all leaderboards in the game.

Parameters

Count	Optional: The count of items you want to retrieve.
After	Optional: Used for pagination, id from which the pagination starts from.
OnCompletedRequest	Delegate for handling the response

Returns

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

SubmitScore()

static FString ULootLockerServerForCpp::SubmitScore ( FString  LeaderboardKey, FString  MemberID, int  Score, FString  Metadata, const FLootLockerServerLeaderboardSubmitScoreResponseDelegate &  OnCompletedRequest  )

static

Submit a score to the given leaderboard.

Parameters

LeaderboardKey	The key of the leaderboard to submit scores to
MemberID	The ID of the member to submit the score for
Score	The score to submit
Metadata	Metadata to add to the score (will only be used if the leaderboard has metadata enabled)
OnCompletedRequest	Delegate for handling the response

Returns

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

UpdateLeaderboard()

static FString ULootLockerServerForCpp::UpdateLeaderboard ( FString  LeaderboardKey, FString  NewLeaderboardKey, FString  Name, ELootLockerServerLeaderboardDirection  DirectionMethod, bool  EnableGameApiWrites, bool  OverwriteScoreOnSubmit, const FLootLockerServerUpdateLeaderboardResponseDelegate &  OnCompletedRequest  )

static

Update an existing leaderboard with the provided details.

Parameters

LeaderboardKey	The key of the leaderboard to update
NewLeaderboardKey	The unique key to set for the leaderboard, if you do not want to change it then set it to the same as LeaderboardKey
Name	Name of the leaderboard
DirectionMethod	Sort order (Ascending or Descending), based on whether highest rank is lowest or highest number
EnableGameApiWrites	Whether the Game API is permitted to write to this leaderboard
OverwriteScoreOnSubmit	Submitting a new score for member will always overwrite their existing score on leaderboard
OnCompletedRequest	Delegate for handling the response

Returns

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

Functions
static FString	ULootLockerServerForCpp::ListLeaderboards (const FLootLockerServerListLeaderboardsResponseDelegate &OnCompletedRequest)
	List information about all leaderboards in the game.
static FString	ULootLockerServerForCpp::ListLeaderboards (int32 Count, int32 After, const FLootLockerServerListLeaderboardsResponseDelegate &OnCompletedRequest)
	List information about all leaderboards in the game.
static FString	ULootLockerServerForCpp::GetLeaderboard (const FString &LeaderboardKey, const FLootLockerServerGetLeaderboardResponseDelegate &OnCompletedRequest)
	Get information about a given leaderboard.
static FString	ULootLockerServerForCpp::CreateLeaderboard (FString LeaderboardKey, FString Name, ELootLockerServerLeaderboardType Type, bool HasMetadata, ELootLockerServerLeaderboardDirection DirectionMethod, bool EnableGameApiWrites, bool OverwriteScoreOnSubmit, const FLootLockerServerCreateLeaderboardResponseDelegate &OnCompletedRequest)
	Create a new leaderboard with the provided details.
static FString	ULootLockerServerForCpp::ListAssets (const FLootLockerServerListAssetsRequest &Request, int PerPage, int Page, const FLootLockerServerListAssetsResponseDelegate &OnCompletedRequest)
	List assets with configurable response data.
static FString	ULootLockerServerForCpp::ListAssetsWithDefaultParameters (const FLootLockerServerListAssetsResponseDelegate &OnCompletedRequest)
	List assets with default parameters (no filters, first page, default page size) Lightweight alternative for retrieving assets where only selected data is needed.
static FString	ULootLockerServerForCpp::ListContexts (int PerPage, int Page, const FLootLockerServerListContextsResponseDelegate &OnCompletedRequest)
	List contexts with pagination support.
static FString	ULootLockerServerForCpp::UpdateLeaderboard (FString LeaderboardKey, FString NewLeaderboardKey, FString Name, ELootLockerServerLeaderboardDirection DirectionMethod, bool EnableGameApiWrites, bool OverwriteScoreOnSubmit, const FLootLockerServerUpdateLeaderboardResponseDelegate &OnCompletedRequest)
	Update an existing leaderboard with the provided details.
static FString	ULootLockerServerForCpp::DeleteLeaderboard (FString LeaderboardKey, const FLootLockerServerDeleteLeaderboardResponseDelegate &OnCompletedRequest)
	Delete an existing leaderboard.
static FString	ULootLockerServerForCpp::SubmitScore (FString LeaderboardKey, FString MemberID, int Score, FString Metadata, const FLootLockerServerLeaderboardSubmitScoreResponseDelegate &OnCompletedRequest)
	Submit a score to the given leaderboard.
static FString	ULootLockerServerForCpp::IncrementScore (FString LeaderboardKey, FString MemberID, int Amount, const FLootLockerServerLeaderboardIncrementScoreResponseDelegate &OnCompletedRequest)
	Increment a member's score on the given leaderboard by the specified amount.
static FString	ULootLockerServerForCpp::GetAllMemberRanks (FString MemberID, const FLootLockerServerGetAllMemberRanksResponseDelegate &OnCompletedRequest)
	For all leaderboards that this member has scores on, get the score, member information, rank, score, and metadata (if metadata is enabled on that leaderboard), as well as player information if the leaderboard is of type player.
static FString	ULootLockerServerForCpp::GetPaginatedAllMemberRanks (FString MemberID, const int Count, const int After, const FLootLockerServerGetAllMemberRanksResponseDelegate &OnCompletedRequest)
	For all leaderboards that this member has scores on, get the score, member information, rank, score, and metadata (if metadata is enabled on that leaderboard), as well as player information if the leaderboard is of type player, using pagination settings.
static FString	ULootLockerServerForCpp::GetScoresFromLeaderboard (FString LeaderboardKey, const FLootLockerServerGetScoresFromLeaderboardResponseDelegate &OnCompletedRequest)
	From the requested leaderboard get <count> number of scores.
static FString	ULootLockerServerForCpp::GetPaginatedScoresFromLeaderboard (FString LeaderboardKey, int Count, int After, const FLootLockerServerGetScoresFromLeaderboardResponseDelegate &OnCompletedRequest)
	From the requested leaderboard get <count> number of scores.
static FString	ULootLockerServerForCpp::GetLeaderboardSchedule (const FString &LeaderboardKey, const FLootLockerServerGetLeaderboardScheduleResponseDelegate &OnCompletedRequest)
	Get the schedule for the specified leaderboard.
static FString	ULootLockerServerForCpp::CreateLeaderboardSchedule (const FString &LeaderboardKey, const FString &CronExpression, const FLootLockerServerGetLeaderboardScheduleResponseDelegate &OnCompletedRequest)
	Set the provided schedule for the specified leaderboard NOTE: Cron expressions are used for setting up the schedule.
static FString	ULootLockerServerForCpp::DeleteLeaderboardSchedule (const FString &LeaderboardKey, const FLootLockerServerDeleteLeaderboardScheduleResponseDelegate &OnCompletedRequest)
	Remove the schedule (if any) from the specified leadeboard.
static FString	ULootLockerServerForCpp::ListLeaderboardArchive (const FString &LeaderboardKey, const FLootLockerServerLeaderboardArchiveResponseDelegate &OnCompletedRequest)
	List the archive of a specific Leaderboard,.
static FString	ULootLockerServerForCpp::GetLeaderboardArchive (const FString &Key, int Count, const FString &After, const FLootLockerServerLeaderboardArchiveDetailResponseDelegate &OnCompletedRequest)
	Get the specified Archive which includes details such as ranks, scores and rewards.