Detailed Description

Access and manage asset instances in the current player's inventory.

When an asset is granted, a unique Asset Instance is created that extends the reference asset with a player-specific Instance ID and mutable state. Instances enter inventory via leaderboard/progression/trigger rewards, Catalog purchases, or default class loadouts. This group covers listing, updating key-value storage per instance, and managing rental states. For the reference catalogue see Assets.

See the LootLocker documentation.

Typedef Documentation

◆ FAssetInstanceStorageItemResponseDelegate

typedef void(* FAssetInstanceStorageItemResponseDelegate) (FLootLockerAssetInstanceStorageItemResponse)

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

◆ FAssetInstanceStorageItemsResponseDelegate

typedef void(* FAssetInstanceStorageItemsResponseDelegate) (FLootLockerAssetInstanceStorageItemsResponse)

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

◆ FDeleteAssetInstanceResponseDelegate

typedef void(* FDeleteAssetInstanceResponseDelegate) (FLootLockerDeleteAssetInstanceResponse)

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

◆ FLootBoxContentResponseDelegate

typedef void(* FLootBoxContentResponseDelegate) (FLootLockerLootBoxContentResponse)

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

◆ FOpenLootBoxResponseDelegate

typedef void(* FOpenLootBoxResponseDelegate) (FLootLockerOpenLootBoxResponse)

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

Function Documentation

◆ CreateAKeyValuePairForAssetInstance()

static FString ULootLockerSDKManager::CreateAKeyValuePairForAssetInstance	(	int	AssetInstanceId,
		const FLootLockerAssetInstanceStorageItem &	Item,
		const FAssetInstanceStorageItemsResponseDelegate &	OnCompletedRequest,
		const FString &	ForPlayerWithUlid = `""`
	)

static

Create a key/value pair for an asset instance.

Parameters

AssetInstanceId	Asset instance id
Item	Key/value pair to create
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

◆ DeleteAKeyValuePairByIdForAssetInstance()

static FString ULootLockerSDKManager::DeleteAKeyValuePairByIdForAssetInstance	(	int	AssetInstanceId,
		int	StorageItemId,
		const FAssetInstanceStorageItemsResponseDelegate &	OnCompletedRequest,
		const FString &	ForPlayerWithUlid = `""`
	)

static

Delete a key/value pair for an asset instance by storage item id.

Parameters

AssetInstanceId	Asset instance id
StorageItemId	Storage item id
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

◆ DeleteAssetInstanceFromPlayerInventory()

static FString ULootLockerSDKManager::DeleteAssetInstanceFromPlayerInventory	(	int	AssetInstanceID,
		const FDeleteAssetInstanceResponseDelegate &	OnCompletedRequest,
		const FString &	ForPlayerWithUlid = `""`
	)

static

Delete an asset instance permanently from the player's inventory (irreversible).

Parameters

AssetInstanceID	Asset instance id
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

◆ GetAKeyValuePairByIdForAssetInstance()

static FString ULootLockerSDKManager::GetAKeyValuePairByIdForAssetInstance	(	int	AssetInstanceId,
		int	StorageItemId,
		const FAssetInstanceStorageItemResponseDelegate &	OnCompletedRequest,
		const FString &	ForPlayerWithUlid = `""`
	)

static

Get a single key/value pair for an asset instance.

Parameters

AssetInstanceId	Asset instance id
StorageItemId	Storage item id
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

◆ GetAllKeyValuePairsForAssetInstance()

static FString ULootLockerSDKManager::GetAllKeyValuePairsForAssetInstance	(	int	AssetInstanceId,
		const FAssetInstanceStorageItemsResponseDelegate &	OnCompletedRequest,
		const FString &	ForPlayerWithUlid = `""`
	)

static

List all key/value pairs for an asset instance.

Parameters

AssetInstanceId	Asset instance id
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

◆ InspectLootBox()

static FString ULootLockerSDKManager::InspectLootBox	(	int	AssetInstanceId,
		const FLootBoxContentResponseDelegate &	OnCompletedRequest,
		const FString &	ForPlayerWithUlid = `""`
	)

static

Inspect a loot box asset instance for drop rates and potential contents.

Parameters

AssetInstanceId	Asset instance id
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

◆ OpenLootBox()

static FString ULootLockerSDKManager::OpenLootBox	(	int	AssetInstanceId,
		const FOpenLootBoxResponseDelegate &	OnCompletedRequest,
		const FString &	ForPlayerWithUlid = `""`
	)

static

Open a loot box asset instance (consumes the instance and grants contents).

Parameters

AssetInstanceId	Asset instance id
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

◆ UpdateAKeyValuePairByIdForAssetInstance()

static FString ULootLockerSDKManager::UpdateAKeyValuePairByIdForAssetInstance	(	int	AssetInstanceId,
		int	StorageItemId,
		const FLootLockerAssetInstanceStorageItem	Item,
		const FAssetInstanceStorageItemResponseDelegate &	OnCompletedRequest,
		const FString &	ForPlayerWithUlid = `""`
	)

static

Update a single key/value pair for an asset instance by storage item id.

Parameters

AssetInstanceId	Asset instance id
StorageItemId	Storage item id
Item	Storage item data
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

◆ UpdateOneOrMoreKeyValuePairForAssetInstance()

static FString ULootLockerSDKManager::UpdateOneOrMoreKeyValuePairForAssetInstance	(	int	AssetInstanceId,
		FLootLockerAssetInstanceStorageItems	Items,
		const FAssetInstanceStorageItemsResponseDelegate &	OnCompletedRequest,
		const FString &	ForPlayerWithUlid = `""`
	)

static

Update one or more key/value pairs for an asset instance.

Parameters

AssetInstanceId	Asset instance id
Items	Key/value pairs to update
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(*	FAssetInstanceStorageItemsResponseDelegate) (FLootLockerAssetInstanceStorageItemsResponse)
	C++ response callback delegate; receives an FLootLockerAssetInstanceStorageItemsResponse result.

typedef void(*	FAssetInstanceStorageItemResponseDelegate) (FLootLockerAssetInstanceStorageItemResponse)
	C++ response callback delegate; receives an FLootLockerAssetInstanceStorageItemResponse result.

typedef void(*	FLootBoxContentResponseDelegate) (FLootLockerLootBoxContentResponse)
	C++ response callback delegate; receives an FLootLockerLootBoxContentResponse result.

typedef void(*	FOpenLootBoxResponseDelegate) (FLootLockerOpenLootBoxResponse)
	C++ response callback delegate; receives an FLootLockerOpenLootBoxResponse result.

typedef void(*	FDeleteAssetInstanceResponseDelegate) (FLootLockerDeleteAssetInstanceResponse)
	C++ response callback delegate; receives an FLootLockerDeleteAssetInstanceResponse result.

Functions
static FString	ULootLockerSDKManager::GetAllKeyValuePairsForAssetInstance (int AssetInstanceId, const FAssetInstanceStorageItemsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List all key/value pairs for an asset instance.

static FString	ULootLockerSDKManager::GetAKeyValuePairByIdForAssetInstance (int AssetInstanceId, int StorageItemId, const FAssetInstanceStorageItemResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get a single key/value pair for an asset instance.

static FString	ULootLockerSDKManager::CreateAKeyValuePairForAssetInstance (int AssetInstanceId, const FLootLockerAssetInstanceStorageItem &Item, const FAssetInstanceStorageItemsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Create a key/value pair for an asset instance.

static FString	ULootLockerSDKManager::UpdateOneOrMoreKeyValuePairForAssetInstance (int AssetInstanceId, FLootLockerAssetInstanceStorageItems Items, const FAssetInstanceStorageItemsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Update one or more key/value pairs for an asset instance.

static FString	ULootLockerSDKManager::UpdateAKeyValuePairByIdForAssetInstance (int AssetInstanceId, int StorageItemId, const FLootLockerAssetInstanceStorageItem Item, const FAssetInstanceStorageItemResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Update a single key/value pair for an asset instance by storage item id.

static FString	ULootLockerSDKManager::DeleteAKeyValuePairByIdForAssetInstance (int AssetInstanceId, int StorageItemId, const FAssetInstanceStorageItemsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Delete a key/value pair for an asset instance by storage item id.

static FString	ULootLockerSDKManager::InspectLootBox (int AssetInstanceId, const FLootBoxContentResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Inspect a loot box asset instance for drop rates and potential contents.

static FString	ULootLockerSDKManager::OpenLootBox (int AssetInstanceId, const FOpenLootBoxResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Open a loot box asset instance (consumes the instance and grants contents).

static FString	ULootLockerSDKManager::DeleteAssetInstanceFromPlayerInventory (int AssetInstanceID, const FDeleteAssetInstanceResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Delete an asset instance permanently from the player's inventory (irreversible).

Detailed Description

Typedef Documentation

◆ FAssetInstanceStorageItemResponseDelegate

◆ FAssetInstanceStorageItemsResponseDelegate

◆ FDeleteAssetInstanceResponseDelegate

◆ FLootBoxContentResponseDelegate

◆ FOpenLootBoxResponseDelegate

Function Documentation

◆ CreateAKeyValuePairForAssetInstance()

◆ DeleteAKeyValuePairByIdForAssetInstance()

◆ DeleteAssetInstanceFromPlayerInventory()

◆ GetAKeyValuePairByIdForAssetInstance()

◆ GetAllKeyValuePairsForAssetInstance()

◆ InspectLootBox()

◆ OpenLootBox()

◆ UpdateAKeyValuePairByIdForAssetInstance()

◆ UpdateOneOrMoreKeyValuePairForAssetInstance()

Typedefs

Functions