Currency

Detailed Description

Define and query the virtual currency types in your game's economy.

Currencies drive virtual and (indirectly) real-money purchases via the Catalog system. Each currency has a name, shorthand identifier, minor-unit name, and denomination chain (e.g., 1 Gold = 100 Silver = 1,000 Copper). They can be granted by rewards from Progressions, Leaderboards, and Triggers, or exchanged for other currencies. See Balances to read player wallets.

See the LootLocker documentation.

Typedef Documentation

FLootLockerGetCurrencyDetailsResponseDelegate

typedef void(* FLootLockerGetCurrencyDetailsResponseDelegate) (FLootLockerGetCurrencyDetailsResponse)

C++ response delegate for getting details for a single currency.

FLootLockerListCurrenciesResponseDelegate

typedef void(* FLootLockerListCurrenciesResponseDelegate) (FLootLockerListCurrenciesResponse)

C++ response delegate for listing currencies.

FLootLockerListDenominationsResponseDelegate

typedef void(* FLootLockerListDenominationsResponseDelegate) (FLootLockerListDenominationsResponse)

C++ response delegate for listing denominations on a currency.

Function Documentation

GetCurrencyDenominationsByCode()

static FString ULootLockerSDKManager::GetCurrencyDenominationsByCode ( const FString &  CurrencyCode, const FLootLockerListDenominationsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List available denominations for a currency.

Parameters

CurrencyCode	Currency code
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

GetCurrencyDetails()

static FString ULootLockerSDKManager::GetCurrencyDetails ( const FString &  CurrencyCode, const FLootLockerGetCurrencyDetailsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get currency details.

Parameters

CurrencyCode	Currency code
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

ListCurrencies()

static FString ULootLockerSDKManager::ListCurrencies ( const FLootLockerListCurrenciesResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List available game currencies.

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

Typedefs
typedef void(*	FLootLockerListCurrenciesResponseDelegate) (FLootLockerListCurrenciesResponse)
	C++ response delegate for listing currencies.
typedef void(*	FLootLockerGetCurrencyDetailsResponseDelegate) (FLootLockerGetCurrencyDetailsResponse)
	C++ response delegate for getting details for a single currency.
typedef void(*	FLootLockerListDenominationsResponseDelegate) (FLootLockerListDenominationsResponse)
	C++ response delegate for listing denominations on a currency.

Functions
static FString	ULootLockerSDKManager::ListCurrencies (const FLootLockerListCurrenciesResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List available game currencies.
static FString	ULootLockerSDKManager::GetCurrencyDetails (const FString &CurrencyCode, const FLootLockerGetCurrencyDetailsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get currency details.
static FString	ULootLockerSDKManager::GetCurrencyDenominationsByCode (const FString &CurrencyCode, const FLootLockerListDenominationsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List available denominations for a currency.