Balances

Detailed Description

Read and adjust a player's wallet balances for each currency.

Each player (and optionally each character or hero) holds a Wallet with a unique ID. Balances update automatically when currency is granted via rewards or spent via Catalog purchases, and can also be credited or debited directly through the API or Web Console. See Currency for currency type definitions.

See the LootLocker documentation.

Typedef Documentation

FLootLockerCreateWalletResponseDelegate

typedef void(* FLootLockerCreateWalletResponseDelegate) (FLootLockerCreateWalletResponse)

C++ response delegate for creating a wallet.

FLootLockerCreditWalletResponseDelegate

typedef void(* FLootLockerCreditWalletResponseDelegate) (FLootLockerCreditWalletResponse)

C++ response delegate for crediting currency to a wallet.

FLootLockerDebitWalletResponseDelegate

typedef void(* FLootLockerDebitWalletResponseDelegate) (FLootLockerDebitWalletResponse)

C++ response delegate for debiting currency from a wallet.

FLootLockerGetWalletResponseDelegate

typedef void(* FLootLockerGetWalletResponseDelegate) (FLootLockerGetWalletResponse)

C++ response delegate for getting a wallet.

FLootLockerListBalancesForWalletResponseDelegate

typedef void(* FLootLockerListBalancesForWalletResponseDelegate) (FLootLockerListBalancesForWalletResponse)

C++ response delegate for listing balances in a wallet.

Enumeration Type Documentation

ELootLockerWalletHolderTypes

enum class ELootLockerWalletHolderTypes : uint8

strong

Possible wallet holder types.

Enumerator
character
player

Function Documentation

CreditBalanceToWallet()

static FString ULootLockerSDKManager::CreditBalanceToWallet ( const FString &  WalletID, const FString &  CurrencyID, const FString &  Amount, const FLootLockerCreditWalletResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

Credit (increase) a wallet balance.

Parameters

WalletID	Wallet id
CurrencyID	Currency id
Amount	Amount to credit
OnComplete	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

DebitBalanceToWallet()

static FString ULootLockerSDKManager::DebitBalanceToWallet ( const FString &  WalletID, const FString &  CurrencyID, const FString &  Amount, const FLootLockerDebitWalletResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

Debit (decrease) a wallet balance.

Parameters

WalletID	Wallet id
CurrencyID	Currency id
Amount	Amount to debit
OnComplete	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

GetWalletByHolderID()

static FString ULootLockerSDKManager::GetWalletByHolderID ( const FString &  HolderULID, const ELootLockerWalletHolderTypes &  HolderType, const FLootLockerGetWalletResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

Get wallet information by holder ULID and type.

Parameters

HolderULID	Holder ULID
HolderType	Holder type
OnComplete	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

GetWalletByWalletID()

static FString ULootLockerSDKManager::GetWalletByWalletID ( const FString &  WalletID, const FLootLockerGetWalletResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

Get wallet information by wallet id.

Parameters

WalletID	Wallet id
OnComplete	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

ListBalancesInWallet()

static FString ULootLockerSDKManager::ListBalancesInWallet ( const FString &  WalletID, const FLootLockerListBalancesForWalletResponseDelegate &  OnComplete, const FString &  ForPlayerWithUlid = ""  )

static

List balances in a wallet.

Parameters

WalletID	Wallet id
OnComplete	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(*	FLootLockerListBalancesForWalletResponseDelegate) (FLootLockerListBalancesForWalletResponse)
	C++ response delegate for listing balances in a wallet.
typedef void(*	FLootLockerGetWalletResponseDelegate) (FLootLockerGetWalletResponse)
	C++ response delegate for getting a wallet.
typedef void(*	FLootLockerCreditWalletResponseDelegate) (FLootLockerCreditWalletResponse)
	C++ response delegate for crediting currency to a wallet.
typedef void(*	FLootLockerDebitWalletResponseDelegate) (FLootLockerDebitWalletResponse)
	C++ response delegate for debiting currency from a wallet.
typedef void(*	FLootLockerCreateWalletResponseDelegate) (FLootLockerCreateWalletResponse)
	C++ response delegate for creating a wallet.

Enumerations
enum class	ELootLockerWalletHolderTypes : uint8 { ELootLockerWalletHolderTypes::character = 0 , ELootLockerWalletHolderTypes::player = 1 }
	Possible wallet holder types. More...

Functions
static FString	ULootLockerSDKManager::ListBalancesInWallet (const FString &WalletID, const FLootLockerListBalancesForWalletResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	List balances in a wallet.
static FString	ULootLockerSDKManager::GetWalletByWalletID (const FString &WalletID, const FLootLockerGetWalletResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	Get wallet information by wallet id.
static FString	ULootLockerSDKManager::GetWalletByHolderID (const FString &HolderULID, const ELootLockerWalletHolderTypes &HolderType, const FLootLockerGetWalletResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	Get wallet information by holder ULID and type.
static FString	ULootLockerSDKManager::CreditBalanceToWallet (const FString &WalletID, const FString &CurrencyID, const FString &Amount, const FLootLockerCreditWalletResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	Credit (increase) a wallet balance.
static FString	ULootLockerSDKManager::DebitBalanceToWallet (const FString &WalletID, const FString &CurrencyID, const FString &Amount, const FLootLockerDebitWalletResponseDelegate &OnComplete, const FString &ForPlayerWithUlid="")
	Debit (decrease) a wallet balance.