LootLocker Unreal Server SDK 6.5.0
Server-side backend SDK for Unreal Engine
Loading...
Searching...
No Matches
Balances

Detailed Description

Read and adjust player currency balances from the server.

Each player holds a Wallet with a balance per currency. From the server you can credit or debit balances directly — for example, awarding a kill bonus, deducting a crafting cost, or granting a battle-pass reward. See Currency for currency type definitions.

See the LootLocker documentation.

Function Documentation

◆ CreditBalanceToWallet()

static FString ULootLockerServerForCpp::CreditBalanceToWallet ( const FString &  WalletID,
const FString &  CurrencyID,
const FString &  Amount,
const FLootLockerServerCreditWalletResponseDelegate OnComplete 
)
static

Credit (increase) the specified amount of the provided currency to the provided wallet.

Parameters
WalletIDUnique ID of the wallet to credit the given amount of the given currency to
CurrencyIDUnique ID of the currency to credit
AmountThe amount of the given currency to credit to the given wallet
OnCompleteDelegate 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

◆ DebitBalanceToWallet()

static FString ULootLockerServerForCpp::DebitBalanceToWallet ( const FString &  WalletID,
const FString &  CurrencyID,
const FString &  Amount,
const FLootLockerServerDebitWalletResponseDelegate OnComplete 
)
static

Debit (decrease) the specified amount of the provided currency to the provided wallet.

Parameters
WalletIDUnique ID of the wallet to debit the given amount of the given currency from
CurrencyIDUnique ID of the currency to debit
AmountThe amount of the given currency to debit from the given wallet
OnCompleteDelegate 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

◆ GetWalletByHolderID()

static FString ULootLockerServerForCpp::GetWalletByHolderID ( const FString &  HolderULID,
const ELootLockerServerWalletHolderTypes HolderType,
const FLootLockerServerGetWalletResponseDelegate OnComplete 
)
static

Get information about a wallet for a specified holder.

Parameters
HolderULIDULID of the holder of the wallet you want to get information for
HolderTypeThe type of the holder to get the wallet for
OnCompleteDelegate 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

◆ GetWalletByWalletID()

static FString ULootLockerServerForCpp::GetWalletByWalletID ( const FString &  WalletID,
const FLootLockerServerGetWalletResponseDelegate OnComplete 
)
static

Get information about a specified wallet.

Parameters
WalletIDUnique ID of the wallet to get information for
OnCompleteDelegate 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

◆ ListBalancesInWallet()

static FString ULootLockerServerForCpp::ListBalancesInWallet ( const FString &  WalletID,
const FLootLockerServerListBalancesForWalletResponseDelegate OnComplete 
)
static

Get a list of balances in a specified wallet.

Parameters
WalletIDUnique ID of the wallet to get balances for
OnCompleteDelegate 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

Functions

static FString ULootLockerServerForCpp::ListBalancesInWallet (const FString &WalletID, const FLootLockerServerListBalancesForWalletResponseDelegate &OnComplete)
 Get a list of balances in a specified wallet.
 
static FString ULootLockerServerForCpp::GetWalletByWalletID (const FString &WalletID, const FLootLockerServerGetWalletResponseDelegate &OnComplete)
 Get information about a specified wallet.
 
static FString ULootLockerServerForCpp::GetWalletByHolderID (const FString &HolderULID, const ELootLockerServerWalletHolderTypes &HolderType, const FLootLockerServerGetWalletResponseDelegate &OnComplete)
 Get information about a wallet for a specified holder.
 
static FString ULootLockerServerForCpp::CreditBalanceToWallet (const FString &WalletID, const FString &CurrencyID, const FString &Amount, const FLootLockerServerCreditWalletResponseDelegate &OnComplete)
 Credit (increase) the specified amount of the provided currency to the provided wallet.
 
static FString ULootLockerServerForCpp::DebitBalanceToWallet (const FString &WalletID, const FString &CurrencyID, const FString &Amount, const FLootLockerServerDebitWalletResponseDelegate &OnComplete)
 Debit (decrease) the specified amount of the provided currency to the provided wallet.