Items

Detailed Description

These methods operate on items and item templates.

They are unrelated to the asset-based inventory API above (GetInventory, ListPlayerInventory, ...), which deals with assets and asset instances. The two share a URL prefix but are separate systems.

Typedef Documentation

FLootLockerConsumePlayerInventoryItemResponseDelegate

typedef void(* FLootLockerConsumePlayerInventoryItemResponseDelegate) (FLootLockerConsumePlayerInventoryItemResponse)

C++ response delegate for consuming a player item.

FLootLockerGetPlayerInventoryItemResponseDelegate

typedef void(* FLootLockerGetPlayerInventoryItemResponseDelegate) (FLootLockerGetPlayerInventoryItemResponse)

C++ response delegate for getting a player item.

FLootLockerListItemTemplatesResponseDelegate

typedef void(* FLootLockerListItemTemplatesResponseDelegate) (FLootLockerListItemTemplatesResponse)

C++ response delegate for listing item templates.

FLootLockerListPlayerInventoryItemsResponseDelegate

typedef void(* FLootLockerListPlayerInventoryItemsResponseDelegate) (FLootLockerListPlayerInventoryItemsResponse)

C++ response delegate for listing player items.

FLootLockerMergeInventoryItemStacksResponseDelegate

typedef void(* FLootLockerMergeInventoryItemStacksResponseDelegate) (FLootLockerMergeInventoryItemStacksResponse)

C++ response delegate for merging item stacks.

FLootLockerSplitInventoryItemStackResponseDelegate

typedef void(* FLootLockerSplitInventoryItemStackResponseDelegate) (FLootLockerSplitInventoryItemStackResponse)

C++ response delegate for splitting an item stack.

Enumeration Type Documentation

ELootLockerItemConsumableFilter

enum class ELootLockerItemConsumableFilter : uint8

strong

Enum for filtering player items on whether they are consumable.

Enumerator
All
Consumable
Not_consumable

ELootLockerItemSortField

enum class ELootLockerItemSortField : uint8

strong

The field by which to order a player item list response.

Enumerator
None	No sorting. The backend defaults to created_at.
Created_at	Order by when the item was created.
Updated_at	Order by when the item was last updated.
Source	Order by the source that granted the item.

ELootLockerItemSortOrder

enum class ELootLockerItemSortOrder : uint8

strong

The direction in which to order a player item list response.

Enumerator
None	No explicit order. The backend defaults to descending.
Asc	Order ascending.
Desc	Order descending.

ELootLockerItemType

enum class ELootLockerItemType : uint8

strong

The type of an item, determining whether item instances are stackable or individually tracked.

Enumerator
None	No filter. Only used when passing an item type to a request.
Instanced	Each granted item is a separate, individually tracked instance.
Stackable	The item is stored as a single entry with a count that can be incremented or decremented.

ELootLockerRewardKind

enum class ELootLockerRewardKind : uint8

strong

The kind of reward that was granted as a result of a behaviour.

Enumerator
Unknown	The reward kind could not be determined.
Asset	An asset.
Progression_points	Progression points.
Progression_reset	A progression reset.
Currency	A currency.
Group	A group.
Reward	A reward.
Platform_key	A platform key.
Publisher_currency	A publisher currency.
Publisher_progression_points	Publisher progression points.
Player_metadata	Player metadata.
File	A file.
Discord_role	A Discord role.
Item_template	An item template.

Function Documentation

ConsumePlayerInventoryItem()

static FString ULootLockerSDKManager::ConsumePlayerInventoryItem ( const FString &  InventoryId, const FLootLockerConsumeInventoryItemRequest &  Request, const FLootLockerConsumePlayerInventoryItemResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Consume one or more of an item owned by the player.

Parameters

InventoryId	The ULID of the inventory item to consume
Request	Request object containing the number of items to consume
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

DeletePlayerInventoryItem()

static FString ULootLockerSDKManager::DeletePlayerInventoryItem ( const FString &  InventoryId, const FLootLockerDefaultDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Delete a single item owned by the player.

Parameters

InventoryId	The ULID of the inventory item to delete
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

GetPlayerInventoryItem()

static FString ULootLockerSDKManager::GetPlayerInventoryItem ( const FString &  InventoryId, const FLootLockerGetPlayerInventoryItemResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get a single item owned by the player.

Parameters

InventoryId	The ULID of the inventory item to fetch
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

ListItemTemplates()

static FString ULootLockerSDKManager::ListItemTemplates ( int  PerPage, int  Page, const FLootLockerListItemTemplatesResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List all item templates available in the game.

Parameters

PerPage	Number of item templates to return per page
Page	Page number to retrieve
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

ListPlayerInventoryItems()

static FString ULootLockerSDKManager::ListPlayerInventoryItems ( int  PerPage, int  Page, const FString &  Name, ELootLockerItemType  ItemType, ELootLockerItemConsumableFilter  ConsumableFilter, ELootLockerItemSortField  Sort, ELootLockerItemSortOrder  Order, const FLootLockerListPlayerInventoryItemsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List all items owned by the player, with optional filtering.

Parameters

PerPage	Number of items to return per page
Page	Page number to retrieve
Name	Optional prefix filter on the item template name
ItemType	Optional filter on item type (None to not filter)
ConsumableFilter	Optional filter on whether the item is consumable (All, Consumable, Not_consumable)
Sort	Optional field to sort by (None to not filter)
Order	Optional sort order (None to not filter)
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

MergePlayerInventoryItemStacks()

static FString ULootLockerSDKManager::MergePlayerInventoryItemStacks ( const FLootLockerMergeInventoryItemStacksRequest &  Request, const FLootLockerMergeInventoryItemStacksResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Merge two item stacks into one.

Parameters

Request	Request object containing the source and target inventory ids
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

SplitPlayerInventoryItemStack()

static FString ULootLockerSDKManager::SplitPlayerInventoryItemStack ( const FString &  InventoryId, const FLootLockerSplitInventoryItemStackRequest &  Request, const FLootLockerSplitInventoryItemStackResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Split a stackable item into a separate stack.

Parameters

InventoryId	The ULID of the item stack to split
Request	Request object containing the number of items to move to the new stack
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

Collaboration diagram for Items:

Typedefs
typedef void(*	FLootLockerListItemTemplatesResponseDelegate) (FLootLockerListItemTemplatesResponse)
	C++ response delegate for listing item templates.
typedef void(*	FLootLockerListPlayerInventoryItemsResponseDelegate) (FLootLockerListPlayerInventoryItemsResponse)
	C++ response delegate for listing player items.
typedef void(*	FLootLockerGetPlayerInventoryItemResponseDelegate) (FLootLockerGetPlayerInventoryItemResponse)
	C++ response delegate for getting a player item.
typedef void(*	FLootLockerConsumePlayerInventoryItemResponseDelegate) (FLootLockerConsumePlayerInventoryItemResponse)
	C++ response delegate for consuming a player item.
typedef void(*	FLootLockerSplitInventoryItemStackResponseDelegate) (FLootLockerSplitInventoryItemStackResponse)
	C++ response delegate for splitting an item stack.
typedef void(*	FLootLockerMergeInventoryItemStacksResponseDelegate) (FLootLockerMergeInventoryItemStacksResponse)
	C++ response delegate for merging item stacks.

Enumerations
enum class	ELootLockerItemConsumableFilter : uint8 { ELootLockerItemConsumableFilter::All = 0 , ELootLockerItemConsumableFilter::Consumable = 1 , ELootLockerItemConsumableFilter::Not_consumable = 2 }
	Enum for filtering player items on whether they are consumable. More...
enum class	ELootLockerItemType : uint8 { ELootLockerItemType::None = 0 , ELootLockerItemType::Instanced = 1 , ELootLockerItemType::Stackable = 2 }
	The type of an item, determining whether item instances are stackable or individually tracked. More...
enum class	ELootLockerItemSortField : uint8 { ELootLockerItemSortField::None = 0 , ELootLockerItemSortField::Created_at = 1 , ELootLockerItemSortField::Updated_at = 2 , ELootLockerItemSortField::Source = 3 }
	The field by which to order a player item list response. More...
enum class	ELootLockerItemSortOrder : uint8 { ELootLockerItemSortOrder::None = 0 , ELootLockerItemSortOrder::Asc = 1 , ELootLockerItemSortOrder::Desc = 2 }
	The direction in which to order a player item list response. More...
enum class	ELootLockerRewardKind : uint8 {   ELootLockerRewardKind::Unknown = 0 , ELootLockerRewardKind::Asset = 1 , ELootLockerRewardKind::Progression_points = 2 , ELootLockerRewardKind::Progression_reset = 3 ,   ELootLockerRewardKind::Currency = 4 , ELootLockerRewardKind::Group = 5 , ELootLockerRewardKind::Reward = 6 , ELootLockerRewardKind::Platform_key = 7 ,   ELootLockerRewardKind::Publisher_currency = 8 , ELootLockerRewardKind::Publisher_progression_points = 9 , ELootLockerRewardKind::Player_metadata = 10 , ELootLockerRewardKind::File = 11 ,   ELootLockerRewardKind::Discord_role = 12 , ELootLockerRewardKind::Item_template = 13 }
	The kind of reward that was granted as a result of a behaviour. More...

Functions
static FString	ULootLockerSDKManager::ListItemTemplates (int PerPage, int Page, const FLootLockerListItemTemplatesResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List all item templates available in the game.
static FString	ULootLockerSDKManager::ListPlayerInventoryItems (int PerPage, int Page, const FString &Name, ELootLockerItemType ItemType, ELootLockerItemConsumableFilter ConsumableFilter, ELootLockerItemSortField Sort, ELootLockerItemSortOrder Order, const FLootLockerListPlayerInventoryItemsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List all items owned by the player, with optional filtering.
static FString	ULootLockerSDKManager::GetPlayerInventoryItem (const FString &InventoryId, const FLootLockerGetPlayerInventoryItemResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get a single item owned by the player.
static FString	ULootLockerSDKManager::DeletePlayerInventoryItem (const FString &InventoryId, const FLootLockerDefaultDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Delete a single item owned by the player.
static FString	ULootLockerSDKManager::ConsumePlayerInventoryItem (const FString &InventoryId, const FLootLockerConsumeInventoryItemRequest &Request, const FLootLockerConsumePlayerInventoryItemResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Consume one or more of an item owned by the player.
static FString	ULootLockerSDKManager::SplitPlayerInventoryItemStack (const FString &InventoryId, const FLootLockerSplitInventoryItemStackRequest &Request, const FLootLockerSplitInventoryItemStackResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Split a stackable item into a separate stack.
static FString	ULootLockerSDKManager::MergePlayerInventoryItemStacks (const FLootLockerMergeInventoryItemStacksRequest &Request, const FLootLockerMergeInventoryItemStacksResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Merge two item stacks into one.