Player

Detailed Description

Retrieve and manage the current player's profile, name, and identifiers.

Covers public profile data, display-name assignment, and account info lookups. For inventory see Asset Instances; for XP/levels see Player Progressions; for currency balances see Balances; for cloud file storage see Player Files.

See the LootLocker documentation.

Typedef Documentation

FInventoryResponse

typedef void(* FInventoryResponse) (FLootLockerInventoryResponse)

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

FLootLockerAssetNotificationResponse

typedef void(* FLootLockerAssetNotificationResponse) (FLootLockerPlayerAssetNotificationResponse)

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

FLootLockerGetCurrentPlayerInfoResponseDelegate

typedef void(* FLootLockerGetCurrentPlayerInfoResponseDelegate) (FLootLockerGetCurrentPlayerInfoResponse)

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

FLootLockerListPlayerInfoResponseDelegate

typedef void(* FLootLockerListPlayerInfoResponseDelegate) (FLootLockerListPlayerInfoResponse)

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

FLootLockerSimpleInventoryResponseDelegate

typedef void(* FLootLockerSimpleInventoryResponseDelegate) (FLootLockerSimpleInventoryResponse)

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

FPBalanceResponse

typedef void(* FPBalanceResponse) (FLootLockerBalanceResponse)

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

FPDlcResponse

typedef void(* FPDlcResponse) (FLootLockerDlcResponse)

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

FPMultiplePlayerNames

typedef void(* FPMultiplePlayerNames) (FLootLockerMultiplePlayersNamesResponse)

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

FPMultiplePlayersPlatformIdsNames

typedef void(* FPMultiplePlayersPlatformIdsNames) (FLootLockerMultiplePlayersPlatformIdsResponse)

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

FPNameResponse

typedef void(* FPNameResponse) (FLootLockerNameResponse)

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

Enumeration Type Documentation

ELootLockerPlayerDataLookupIdType

enum class ELootLockerPlayerDataLookupIdType : uint8

strong

Enumerator
Player_id
Player_public_uid
Player_guest_login_id
Steam_id
Psn_id
Xbox_id
Player_ulid
Player_name
Epic_games_id
Google_play_games_id

Function Documentation

CheckPlayerAssetActivationNotification()

static FString ULootLockerSDKManager::CheckPlayerAssetActivationNotification ( const FLootLockerAssetNotificationResponse &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get assets granted to the player since the last activation notification check.

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

DeletePlayer()

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

static

Mark the player for deletion (permanently removed after a 30 day grace period).

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

GetCurrencyBalance()

static FString ULootLockerSDKManager::GetCurrencyBalance ( const FPBalanceResponse &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get the player's current credit / currency balance.

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

GetCurrentPlayerInfo()

static FString ULootLockerSDKManager::GetCurrentPlayerInfo ( const FLootLockerGetCurrentPlayerInfoResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get current player profile information (ids, name and identifiers) for subsequent requests.

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

GetDLCsMigration()

static FString ULootLockerSDKManager::GetDLCsMigration ( const FPDlcResponse &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List DLC identifiers migrated for the player (always returned as strings regardless of numeric value).

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

GetFullInventory()

static FString ULootLockerSDKManager::GetFullInventory ( const FInventoryResponse &  OnCompletedRequest, int32  StartIndex, const FString &  ForPlayerWithUlid = ""  )

static

Get a paginated segment of the player's inventory starting after a given asset instance id.

Parameters

OnCompletedRequest	Delegate for handling the server response
StartIndex	Pagination pointer; returns items after this asset instance id
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

GetInventory()

static FString ULootLockerSDKManager::GetInventory ( const FInventoryResponse &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get all inventory asset instances owned by the player.

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

GetPlayerName()

static FString ULootLockerSDKManager::GetPlayerName ( const FPNameResponse &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get the player's current display name.

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

InitiateDLCMigration()

static FString ULootLockerSDKManager::InitiateDLCMigration ( const FResponseCallback &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Initiate a DLC migration for the current player.

Poll asset notifications after ~5 minutes for results.

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

ListCharacterInventory()

static FString ULootLockerSDKManager::ListCharacterInventory ( int  CharacterId, const FLootLockerListSimplifiedInventoryRequest &  Request, int  PerPage, int  Page, const FLootLockerSimpleInventoryResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get a simplified list of a character's inventory.

Parameters

CharacterId	ID of the character to retrieve inventory for
Request	Request object containing filters and optional includes.
PerPage	Number of items 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

ListCharacterInventoryWithDefaultParameters()

static FString ULootLockerSDKManager::ListCharacterInventoryWithDefaultParameters ( int  CharacterId, const FLootLockerSimpleInventoryResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get a simplified list of the character's inventory with default parameters.

Parameters

CharacterId	ID of the character to retrieve inventory for
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

ListPlayerInfo()

static FString ULootLockerSDKManager::ListPlayerInfo ( TArray< FString >  PlayerIdsToLookUp, TArray< int >  PlayerLegacyIdsToLookUp, TArray< FString >  PlayerPublicUidsToLookUp, const FLootLockerListPlayerInfoResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

List profile information for multiple players.

Parameters

PlayerIdsToLookUp	Array of player ULIDs to look up
PlayerLegacyIdsToLookUp	Array of legacy integer player ids to look up
PlayerPublicUidsToLookUp	Array of public player UIDs to look up
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

ListPlayerInventory()

static FString ULootLockerSDKManager::ListPlayerInventory ( const FLootLockerListSimplifiedInventoryRequest &  Request, int  PerPage, int  Page, const FLootLockerSimpleInventoryResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get a simplified list of the player's inventory.

Parameters

Request	Request object containing filters and optional includes.
PerPage	Number of items 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

ListPlayerInventoryWithDefaultParameters()

static FString ULootLockerSDKManager::ListPlayerInventoryWithDefaultParameters ( const FLootLockerSimpleInventoryResponseDelegate &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Get a simplified list of the player's inventory with default parameters.

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

LookupMultiplePlayerNames1stPlatformIDs()

static FString ULootLockerSDKManager::LookupMultiplePlayerNames1stPlatformIDs ( const FLootLockerMultiplePlayerNamesAndPlatformsRequest &  Request, const FPMultiplePlayersPlatformIdsNames &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Look up player names using first-platform player ids and/or public UIDs.

Parameters

Request	Payload containing player ids and/or public UIDs
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

LookupMultiplePlayerNamesUsingIDs()

static FString ULootLockerSDKManager::LookupMultiplePlayerNamesUsingIDs ( const FLootLockerMultiplePlayerNamesRequest &  Request, const FPMultiplePlayerNames &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Look up multiple player names on their last active platform (Deprecated – use LookupMultiplePlayersDataUsingIDs).

Parameters

Request	Payload containing platform and id combinations to search
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

LookupMultiplePlayersDataUsingIDs()

static FString ULootLockerSDKManager::LookupMultiplePlayersDataUsingIDs ( const FLootLockerLookupMultiplePlayersDataRequest &  Request, const FPMultiplePlayerNames &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Look up multiple players' data using various identifier types.

Parameters

Request	Payload containing platforms and ids for player data lookup
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

SetPlayerName()

static FString ULootLockerSDKManager::SetPlayerName ( FString  Name, const FPNameResponse &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Set (or change) the player's display name.

Parameters

Name	New player display name
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

SetProfilePrivate()

static FString ULootLockerSDKManager::SetProfilePrivate ( const FResponseCallback &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Set the player's profile visibility to private (inventory not publicly visible on external platforms).

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

SetProfilePublic()

static FString ULootLockerSDKManager::SetProfilePublic ( const FResponseCallback &  OnCompletedRequest, const FString &  ForPlayerWithUlid = ""  )

static

Set the player's profile visibility to public (inventory may be displayed on external platforms).

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

Typedefs
typedef void(*	FLootLockerGetCurrentPlayerInfoResponseDelegate) (FLootLockerGetCurrentPlayerInfoResponse)
	C++ response callback delegate; receives an FLootLockerGetCurrentPlayerInfoResponse result.
typedef void(*	FLootLockerListPlayerInfoResponseDelegate) (FLootLockerListPlayerInfoResponse)
	C++ response callback delegate; receives an FLootLockerListPlayerInfoResponse result.
typedef void(*	FInventoryResponse) (FLootLockerInventoryResponse)
	C++ response callback delegate; receives an FLootLockerInventoryResponse result.
typedef void(*	FLootLockerAssetNotificationResponse) (FLootLockerPlayerAssetNotificationResponse)
	C++ response callback delegate; receives an FLootLockerPlayerAssetNotificationResponse result.
typedef void(*	FPBalanceResponse) (FLootLockerBalanceResponse)
	C++ response callback delegate; receives an FLootLockerBalanceResponse result.
typedef void(*	FPDlcResponse) (FLootLockerDlcResponse)
	C++ response callback delegate; receives an FLootLockerDlcResponse result.
typedef void(*	FPNameResponse) (FLootLockerNameResponse)
	C++ response callback delegate; receives an FLootLockerNameResponse result.
typedef void(*	FPMultiplePlayerNames) (FLootLockerMultiplePlayersNamesResponse)
	C++ response callback delegate; receives an FLootLockerMultiplePlayersNamesResponse result.
typedef void(*	FPMultiplePlayersPlatformIdsNames) (FLootLockerMultiplePlayersPlatformIdsResponse)
	C++ response callback delegate; receives an FLootLockerMultiplePlayersPlatformIdsResponse result.
typedef void(*	FLootLockerSimpleInventoryResponseDelegate) (FLootLockerSimpleInventoryResponse)
	C++ response callback delegate; receives an FLootLockerSimpleInventoryResponse result.

Enumerations
enum class	ELootLockerPlayerDataLookupIdType : uint8 {   ELootLockerPlayerDataLookupIdType::Player_id = 0 , ELootLockerPlayerDataLookupIdType::Player_public_uid = 1 , ELootLockerPlayerDataLookupIdType::Player_guest_login_id = 2 , ELootLockerPlayerDataLookupIdType::Steam_id = 3 ,   ELootLockerPlayerDataLookupIdType::Psn_id = 4 , ELootLockerPlayerDataLookupIdType::Xbox_id = 5 , ELootLockerPlayerDataLookupIdType::Player_ulid = 6 , ELootLockerPlayerDataLookupIdType::Player_name = 7 ,   ELootLockerPlayerDataLookupIdType::Epic_games_id = 8 , ELootLockerPlayerDataLookupIdType::Google_play_games_id = 9 }

Functions
static FString	ULootLockerSDKManager::GetCurrentPlayerInfo (const FLootLockerGetCurrentPlayerInfoResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get current player profile information (ids, name and identifiers) for subsequent requests.
static FString	ULootLockerSDKManager::ListPlayerInfo (TArray< FString > PlayerIdsToLookUp, TArray< int > PlayerLegacyIdsToLookUp, TArray< FString > PlayerPublicUidsToLookUp, const FLootLockerListPlayerInfoResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List profile information for multiple players.
static FString	ULootLockerSDKManager::GetInventory (const FInventoryResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get all inventory asset instances owned by the player.
static FString	ULootLockerSDKManager::GetFullInventory (const FInventoryResponse &OnCompletedRequest, int32 StartIndex, const FString &ForPlayerWithUlid="")
	Get a paginated segment of the player's inventory starting after a given asset instance id.
static FString	ULootLockerSDKManager::CheckPlayerAssetActivationNotification (const FLootLockerAssetNotificationResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get assets granted to the player since the last activation notification check.
static FString	ULootLockerSDKManager::ListPlayerInventoryWithDefaultParameters (const FLootLockerSimpleInventoryResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get a simplified list of the player's inventory with default parameters.
static FString	ULootLockerSDKManager::ListPlayerInventory (const FLootLockerListSimplifiedInventoryRequest &Request, int PerPage, int Page, const FLootLockerSimpleInventoryResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get a simplified list of the player's inventory.
static FString	ULootLockerSDKManager::ListCharacterInventoryWithDefaultParameters (int CharacterId, const FLootLockerSimpleInventoryResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get a simplified list of the character's inventory with default parameters.
static FString	ULootLockerSDKManager::ListCharacterInventory (int CharacterId, const FLootLockerListSimplifiedInventoryRequest &Request, int PerPage, int Page, const FLootLockerSimpleInventoryResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get a simplified list of a character's inventory.
static FString	ULootLockerSDKManager::GetCurrencyBalance (const FPBalanceResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get the player's current credit / currency balance.
static FString	ULootLockerSDKManager::InitiateDLCMigration (const FResponseCallback &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Initiate a DLC migration for the current player.
static FString	ULootLockerSDKManager::GetDLCsMigration (const FPDlcResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	List DLC identifiers migrated for the player (always returned as strings regardless of numeric value).
static FString	ULootLockerSDKManager::SetProfilePrivate (const FResponseCallback &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Set the player's profile visibility to private (inventory not publicly visible on external platforms).
static FString	ULootLockerSDKManager::SetProfilePublic (const FResponseCallback &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Set the player's profile visibility to public (inventory may be displayed on external platforms).
static FString	ULootLockerSDKManager::SetPlayerName (FString Name, const FPNameResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Set (or change) the player's display name.
static FString	ULootLockerSDKManager::GetPlayerName (const FPNameResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Get the player's current display name.
static FString	ULootLockerSDKManager::LookupMultiplePlayerNamesUsingIDs (const FLootLockerMultiplePlayerNamesRequest &Request, const FPMultiplePlayerNames &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Look up multiple player names on their last active platform (Deprecated – use LookupMultiplePlayersDataUsingIDs).
static FString	ULootLockerSDKManager::LookupMultiplePlayersDataUsingIDs (const FLootLockerLookupMultiplePlayersDataRequest &Request, const FPMultiplePlayerNames &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Look up multiple players' data using various identifier types.
static FString	ULootLockerSDKManager::LookupMultiplePlayerNames1stPlatformIDs (const FLootLockerMultiplePlayerNamesAndPlatformsRequest &Request, const FPMultiplePlayersPlatformIdsNames &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Look up player names using first-platform player ids and/or public UIDs.
static FString	ULootLockerSDKManager::DeletePlayer (const FLootLockerDefaultDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
	Mark the player for deletion (permanently removed after a 30 day grace period).