Progressions

Detailed Description

Configure and query the shared progression infrastructure.

Progressions are points-based levelling systems with configurable tiers and configurable per-tier rewards (assets, currency, progression points). The same progression can be applied to players (Player Progressions), characters (Character Progressions), or asset instances (Asset Instance Progressions). This group covers cross-cutting endpoints: reading tier and reward definitions, awarding generic points, and resetting a progression. Progressions also support custom Metadata.

See the LootLocker documentation.

Typedef Documentation

FLootLockerCharacterProgressionResponseDelegate

typedef void(* FLootLockerCharacterProgressionResponseDelegate) (FLootLockerCharacterProgressionResponse)

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

FLootLockerCharacterProgressionWithRewardsResponseDelegate

typedef void(* FLootLockerCharacterProgressionWithRewardsResponseDelegate) (FLootLockerCharacterProgressionWithRewardsResponse)

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

FLootLockerDeleteProgressionDelegate

typedef void(* FLootLockerDeleteProgressionDelegate) (FLootLockerResponse)

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

FLootLockerInstanceProgressionResponseDelegate

typedef void(* FLootLockerInstanceProgressionResponseDelegate) (FLootLockerInstanceProgressionResponse)

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

FLootLockerInstanceProgressionWithRewardsResponseDelegate

typedef void(* FLootLockerInstanceProgressionWithRewardsResponseDelegate) (FLootLockerInstanceProgressionWithRewardsResponse)

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

FLootLockerPaginatedCharacterProgressionsResponseDelegate

typedef void(* FLootLockerPaginatedCharacterProgressionsResponseDelegate) (FLootLockerPaginatedCharacterProgressionResponse)

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

FLootLockerPaginatedInstanceProgressionsResponseDelegate

typedef void(* FLootLockerPaginatedInstanceProgressionsResponseDelegate) (FLootLockerPaginatedInstanceProgressionResponse)

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

FLootLockerPaginatedPlayerProgressionsResponseDelegate

typedef void(* FLootLockerPaginatedPlayerProgressionsResponseDelegate) (FLootLockerPaginatedPlayerProgressionResponse)

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

FLootLockerPaginatedProgressionsResponseDelegate

typedef void(* FLootLockerPaginatedProgressionsResponseDelegate) (FLootLockerPaginatedProgressionsResponse)

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

FLootLockerPaginatedProgressionTiersResponseDelegate

typedef void(* FLootLockerPaginatedProgressionTiersResponseDelegate) (FLootLockerPaginatedProgressionTiersResponse)

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

FLootLockerPlayerProgressionResponseDelegate

typedef void(* FLootLockerPlayerProgressionResponseDelegate) (FLootLockerPlayerProgressionResponse)

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

FLootLockerPlayerProgressionWithRewardsResponseDelegate

typedef void(* FLootLockerPlayerProgressionWithRewardsResponseDelegate) (FLootLockerPlayerProgressionWithRewardsResponse)

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

FLootLockerProgressionResponseDelegate

typedef void(* FLootLockerProgressionResponseDelegate) (FLootLockerProgressionResponse)

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

Function Documentation

GetProgression()

static FString ULootLockerSDKManager::GetProgression ( const FString &  ProgressionKey, const FLootLockerProgressionResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

Get a single progression by key.

Parameters

ProgressionKey	Progression key
OnComplete	Delegate for handling the server response (progression)
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

GetProgressions() [1/3]

static FString ULootLockerSDKManager::GetProgressions ( const FLootLockerPaginatedProgressionsResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

List progressions (default page size, first page).

Parameters

OnComplete	Delegate for handling the server response (paginated progressions)
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

GetProgressions() [2/3]

static FString ULootLockerSDKManager::GetProgressions ( const int32 &  Count, const FLootLockerPaginatedProgressionsResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

List progressions (first page only).

Parameters

Count	Number of entries to return
OnComplete	Delegate for handling the server response (paginated progressions)
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

GetProgressions() [3/3]

static FString ULootLockerSDKManager::GetProgressions ( const int32 &  Count, const FString &  After, const FLootLockerPaginatedProgressionsResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

List progressions (paginated).

Parameters

Count	Number of entries to return (page size)
After	Optional: Pagination cursor (progression id to start after)
OnComplete	Delegate for handling the server response (paginated progressions)
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

GetProgressionTiers() [1/3]

static FString ULootLockerSDKManager::GetProgressionTiers ( const FString &  ProgressionKey, const FLootLockerPaginatedProgressionTiersResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

List progression tiers (default page size, first page) for a progression.

Parameters

ProgressionKey	Progression key
OnComplete	Delegate for handling the server response (paginated progression tiers)
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

GetProgressionTiers() [2/3]

static FString ULootLockerSDKManager::GetProgressionTiers ( const FString &  ProgressionKey, const int32 &  Count, const FLootLockerPaginatedProgressionTiersResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

List progression tiers (first page only) for a progression.

Parameters

ProgressionKey	Progression key
Count	Number of tiers to return
OnComplete	Delegate for handling the server response (paginated progression tiers)
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

GetProgressionTiers() [3/3]

static FString ULootLockerSDKManager::GetProgressionTiers ( const FString &  ProgressionKey, const int32 &  Count, const int32 &  After, const FLootLockerPaginatedProgressionTiersResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

List progression tiers (paginated) for a progression.

Parameters

ProgressionKey	Progression key
Count	Number of tiers to return (page size)
After	Optional: Pagination cursor (tier id); use next_cursor / previous_cursor from prior response
OnComplete	Delegate for handling the server response (paginated progression tiers)
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(*	FLootLockerProgressionResponseDelegate) (FLootLockerProgressionResponse)
	C++ response callback delegate; receives an FLootLockerProgressionResponse result.
typedef void(*	FLootLockerPaginatedProgressionsResponseDelegate) (FLootLockerPaginatedProgressionsResponse)
	C++ response callback delegate; receives an FLootLockerPaginatedProgressionsResponse result.
typedef void(*	FLootLockerPlayerProgressionResponseDelegate) (FLootLockerPlayerProgressionResponse)
	C++ response callback delegate; receives an FLootLockerPlayerProgressionResponse result.
typedef void(*	FLootLockerPaginatedPlayerProgressionsResponseDelegate) (FLootLockerPaginatedPlayerProgressionResponse)
	C++ response callback delegate; receives an FLootLockerPaginatedPlayerProgressionResponse result.
typedef void(*	FLootLockerPlayerProgressionWithRewardsResponseDelegate) (FLootLockerPlayerProgressionWithRewardsResponse)
	C++ response callback delegate; receives an FLootLockerPlayerProgressionWithRewardsResponse result.
typedef void(*	FLootLockerCharacterProgressionResponseDelegate) (FLootLockerCharacterProgressionResponse)
	C++ response callback delegate; receives an FLootLockerCharacterProgressionResponse result.
typedef void(*	FLootLockerPaginatedCharacterProgressionsResponseDelegate) (FLootLockerPaginatedCharacterProgressionResponse)
	C++ response callback delegate; receives an FLootLockerPaginatedCharacterProgressionResponse result.
typedef void(*	FLootLockerCharacterProgressionWithRewardsResponseDelegate) (FLootLockerCharacterProgressionWithRewardsResponse)
	C++ response callback delegate; receives an FLootLockerCharacterProgressionWithRewardsResponse result.
typedef void(*	FLootLockerPaginatedProgressionTiersResponseDelegate) (FLootLockerPaginatedProgressionTiersResponse)
	C++ response callback delegate; receives an FLootLockerPaginatedProgressionTiersResponse result.
typedef void(*	FLootLockerDeleteProgressionDelegate) (FLootLockerResponse)
	C++ response callback delegate; receives an FLootLockerResponse result.
typedef void(*	FLootLockerInstanceProgressionResponseDelegate) (FLootLockerInstanceProgressionResponse)
	C++ response callback delegate; receives an FLootLockerInstanceProgressionResponse result.
typedef void(*	FLootLockerPaginatedInstanceProgressionsResponseDelegate) (FLootLockerPaginatedInstanceProgressionResponse)
	C++ response callback delegate; receives an FLootLockerPaginatedInstanceProgressionResponse result.
typedef void(*	FLootLockerInstanceProgressionWithRewardsResponseDelegate) (FLootLockerInstanceProgressionWithRewardsResponse)
	C++ response callback delegate; receives an FLootLockerInstanceProgressionWithRewardsResponse result.

Functions
static FString	ULootLockerSDKManager::GetProgressions (const int32 &Count, const FString &After, const FLootLockerPaginatedProgressionsResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	List progressions (paginated).
static FString	ULootLockerSDKManager::GetProgressions (const int32 &Count, const FLootLockerPaginatedProgressionsResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	List progressions (first page only).
static FString	ULootLockerSDKManager::GetProgressions (const FLootLockerPaginatedProgressionsResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	List progressions (default page size, first page).
static FString	ULootLockerSDKManager::GetProgression (const FString &ProgressionKey, const FLootLockerProgressionResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	Get a single progression by key.
static FString	ULootLockerSDKManager::GetProgressionTiers (const FString &ProgressionKey, const int32 &Count, const int32 &After, const FLootLockerPaginatedProgressionTiersResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	List progression tiers (paginated) for a progression.
static FString	ULootLockerSDKManager::GetProgressionTiers (const FString &ProgressionKey, const int32 &Count, const FLootLockerPaginatedProgressionTiersResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	List progression tiers (first page only) for a progression.
static FString	ULootLockerSDKManager::GetProgressionTiers (const FString &ProgressionKey, const FLootLockerPaginatedProgressionTiersResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	List progression tiers (default page size, first page) for a progression.