Player Storage

Detailed Description

Simple key-value store scoped to the player.

Read, write, and delete named string values persisted server-side.

Typedef Documentation

FPersistentStorageItemResponseDelegate

typedef void(* FPersistentStorageItemResponseDelegate) (FLootLockerPersistentStorageItemResponse)

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

FPersistentStorageItemsResponseDelegate

typedef void(* FPersistentStorageItemsResponseDelegate) (FLootLockerPersistentStorageItemsResponse)

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

Function Documentation

AddItemsToPersistentStorage() [1/2]

static FString ULootLockerSDKManager::AddItemsToPersistentStorage ( const FLootLockerPersistentStorageItem  Item, const FPersistentStorageItemResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Create or update a single key/value pair in persistent storage.

Player Metadata will eventually replace Persistent Storage; prefer Metadata for new integrations.

Parameters

Item	Item to create or 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

AddItemsToPersistentStorage() [2/2]

static FString ULootLockerSDKManager::AddItemsToPersistentStorage ( const FLootLockerPersistentStorageItems  Items, const FPersistentStorageItemsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Create or update multiple key/value pairs in persistent storage.

Player Metadata will eventually replace Persistent Storage; prefer Metadata for new integrations.

Parameters

Items	Items to create or 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

DeleteItemFromPersistentStorage()

static FString ULootLockerSDKManager::DeleteItemFromPersistentStorage ( const FString &  Key, const FPersistentStorageItemsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Delete a key/value pair from persistent storage.

Player Metadata will eventually replace Persistent Storage; prefer Metadata for new integrations.

Parameters

Key	Key of the key/value pair
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

GetEntirePersistentStorage()

static FString ULootLockerSDKManager::GetEntirePersistentStorage ( const FPersistentStorageItemsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List all key/value pairs in the player's persistent storage (may return a large payload).

Player Metadata will eventually replace Persistent Storage; prefer Metadata for new integrations.

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

GetItemFromPersistentStorage()

static FString ULootLockerSDKManager::GetItemFromPersistentStorage ( const FString &  Key, const FPersistentStorageItemResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get a single key/value pair from the player's persistent storage.

Player Metadata will eventually replace Persistent Storage; prefer Metadata for new integrations.

Parameters

Key	Key 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

GetPlayerPersistentStorage()

static FString ULootLockerSDKManager::GetPlayerPersistentStorage ( const FString &  PlayerId, const FPersistentStorageItemsResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Read another player's public persistent storage key/value pairs.

Player Metadata will eventually replace Persistent Storage; prefer Metadata for new integrations.

Parameters

PlayerId	Player id or public UID
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(*	FPersistentStorageItemsResponseDelegate) (FLootLockerPersistentStorageItemsResponse)
	C++ response callback delegate; receives an FLootLockerPersistentStorageItemsResponse result.
typedef void(*	FPersistentStorageItemResponseDelegate) (FLootLockerPersistentStorageItemResponse)
	C++ response callback delegate; receives an FLootLockerPersistentStorageItemResponse result.

Functions
static FString	ULootLockerSDKManager::GetEntirePersistentStorage (const FPersistentStorageItemsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List all key/value pairs in the player's persistent storage (may return a large payload).
static FString	ULootLockerSDKManager::GetItemFromPersistentStorage (const FString &Key, const FPersistentStorageItemResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get a single key/value pair from the player's persistent storage.
static FString	ULootLockerSDKManager::AddItemsToPersistentStorage (const FLootLockerPersistentStorageItems Items, const FPersistentStorageItemsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Create or update multiple key/value pairs in persistent storage.
static FString	ULootLockerSDKManager::AddItemsToPersistentStorage (const FLootLockerPersistentStorageItem Item, const FPersistentStorageItemResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Create or update a single key/value pair in persistent storage.
static FString	ULootLockerSDKManager::DeleteItemFromPersistentStorage (const FString &Key, const FPersistentStorageItemsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Delete a key/value pair from persistent storage.
static FString	ULootLockerSDKManager::GetPlayerPersistentStorage (const FString &PlayerId, const FPersistentStorageItemsResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Read another player's public persistent storage key/value pairs.