Player Storage

Detailed Description

Server-side read and write of a player's persistent key-value store.

Read, write, and delete named string values persisted server-side on behalf of a player. Useful for carrying server-only state or updating player data derived from gameplay events.

See the LootLocker documentation.

Function Documentation

DeletePersistentStorageForPlayersAndKeys()

static FString ULootLockerServerForCpp::DeletePersistentStorageForPlayersAndKeys ( TArray< int >  PlayerIDs, TArray< FString >  Keys, const FLootLockerServerDeletePersistentStorageForPlayersAndKeysResponseDelegate &  OnCompletedRequest  )

static

Delete the persistent storage for the provided keys on the provided players If the request fails you will be given an error message.

We recommend you make a get request on the players and keys to see what keys failed to delete.

Parameters

PlayerIDs	The IDs of the players for whom to apply the delete
Keys	The keys to delete for the provided players
OnCompletedRequest	Delegate 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

GetEntirePublicPersistentStorageForPlayers()

static FString ULootLockerServerForCpp::GetEntirePublicPersistentStorageForPlayers ( TArray< int >  PlayerIDs, const FLootLockerServerGetPublicPersistentStorageForPlayersAndKeysResponseDelegate &  OnCompletedRequest  )

static

Get all the public (if any) persistent storage for the provided players.

Parameters

PlayerIDs	The IDs of the players to fetch the persistent storage for
OnCompletedRequest	Delegate 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

GetPersistentStorageForPlayer()

static FString ULootLockerServerForCpp::GetPersistentStorageForPlayer ( int  PlayerID, const FLootLockerServerGetPersistentStorageForPlayersResponseDelegate &  OnCompletedRequest  )

static

Get the persistent storage for the provided player.

Parameters

PlayerID	The ID of the player to fetch the persistent storage for
OnCompletedRequest	Delegate 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

GetPersistentStorageForPlayers()

static FString ULootLockerServerForCpp::GetPersistentStorageForPlayers ( TArray< int >  PlayerIDs, const FLootLockerServerGetPersistentStorageForPlayersResponseDelegate &  OnCompletedRequest  )

static

Get the persistent storage for all the player ids provided.

Parameters

PlayerIDs	The IDs of the players to fetch the persistent storage for
OnCompletedRequest	Delegate 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

GetPublicPersistentStorageForPlayersAndKeys()

static FString ULootLockerServerForCpp::GetPublicPersistentStorageForPlayersAndKeys ( TArray< int >  PlayerIDs, TArray< FString >  Keys, const FLootLockerServerGetPublicPersistentStorageForPlayersAndKeysResponseDelegate &  OnCompletedRequest  )

static

Get all the public (if any) persistent storage for the provided players, but filter the list by the provided keys.

Parameters

PlayerIDs	The IDs of the players to fetch the persistent storage for
Keys	The keys to filter the persistent storage by, if empty all keys will be returned.
OnCompletedRequest	Delegate 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

UpdatePersistentStorageForPlayersAndKeys()

static FString ULootLockerServerForCpp::UpdatePersistentStorageForPlayersAndKeys ( TArray< FLootLockerServerPlayerPersistentStorageEntry_NamedSets >  StorageEntriesToUpdate, const FLootLockerServerUpdatePersistentStorageForPlayersAndKeysResponseDelegate &  OnCompletedRequest  )

static

Update the persistent storage for the provided player according to the objects provided.

Parameters

StorageEntriesToUpdate	The data to update the persistent storage with
OnCompletedRequest	Delegate 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::GetPersistentStorageForPlayer (int PlayerID, const FLootLockerServerGetPersistentStorageForPlayersResponseDelegate &OnCompletedRequest)
	Get the persistent storage for the provided player.
static FString	ULootLockerServerForCpp::GetPersistentStorageForPlayers (TArray< int > PlayerIDs, const FLootLockerServerGetPersistentStorageForPlayersResponseDelegate &OnCompletedRequest)
	Get the persistent storage for all the player ids provided.
static FString	ULootLockerServerForCpp::GetEntirePublicPersistentStorageForPlayers (TArray< int > PlayerIDs, const FLootLockerServerGetPublicPersistentStorageForPlayersAndKeysResponseDelegate &OnCompletedRequest)
	Get all the public (if any) persistent storage for the provided players.
static FString	ULootLockerServerForCpp::GetPublicPersistentStorageForPlayersAndKeys (TArray< int > PlayerIDs, TArray< FString > Keys, const FLootLockerServerGetPublicPersistentStorageForPlayersAndKeysResponseDelegate &OnCompletedRequest)
	Get all the public (if any) persistent storage for the provided players, but filter the list by the provided keys.
static FString	ULootLockerServerForCpp::UpdatePersistentStorageForPlayersAndKeys (TArray< FLootLockerServerPlayerPersistentStorageEntry_NamedSets > StorageEntriesToUpdate, const FLootLockerServerUpdatePersistentStorageForPlayersAndKeysResponseDelegate &OnCompletedRequest)
	Update the persistent storage for the provided player according to the objects provided.
static FString	ULootLockerServerForCpp::DeletePersistentStorageForPlayersAndKeys (TArray< int > PlayerIDs, TArray< FString > Keys, const FLootLockerServerDeletePersistentStorageForPlayersAndKeysResponseDelegate &OnCompletedRequest)
	Delete the persistent storage for the provided keys on the provided players If the request fails you will be given an error message.