Characters

Detailed Description

Server-side management of player characters.

Query and manage characters owned by players. Characters define a player's chosen loadout type and equipped items. Use the server API to inspect or update a player's character state as part of gameplay logic running on the server.

See the LootLocker documentation.

Function Documentation

EquipAssetToPlayerCharacterLoadoutByAssetIdAndAssetVariationId()

static FString ULootLockerServerForCpp::EquipAssetToPlayerCharacterLoadoutByAssetIdAndAssetVariationId ( int  PlayerID, int  CharacterID, int  AssetID, int  AssetVariationID, const FLootLockerServerEquipAssetToCharacterLoadoutResponseDelegate &  OnCompletedRequest  )

static

Equip an asset instance to the loadout of specified player and character using an asset id and an asset variation id.

Parameters

PlayerID	The ID of the player for whom to equip the asset instance
CharacterID	The ID of the character on the specified player for whose loadout to equip the asset instance
AssetID	The ID of the asset to equip to the specified player character's loadout
AssetVariationID	The ID of the variation of the specified asset to equip to the specified player character's loadout
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

EquipAssetToPlayerCharacterLoadoutByAssetIdAndRentalOptionId()

static FString ULootLockerServerForCpp::EquipAssetToPlayerCharacterLoadoutByAssetIdAndRentalOptionId ( int  PlayerID, int  CharacterID, int  AssetID, int  RentalOptionID, const FLootLockerServerEquipAssetToCharacterLoadoutResponseDelegate &  OnCompletedRequest  )

static

Equip an asset instance to the loadout of specified player and character using an asset id and a rental option id.

Parameters

PlayerID	The ID of the player for whom to equip the asset instance
CharacterID	The ID of the character on the specified player for whose loadout to equip the asset instance
AssetID	The ID of the asset to equip to the specified player character's loadout
RentalOptionID	The ID of the rental option of the specified asset to equip to the specified player character's loadout
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

EquipAssetToPlayerCharacterLoadoutByAssetInstanceId()

static FString ULootLockerServerForCpp::EquipAssetToPlayerCharacterLoadoutByAssetInstanceId ( int  PlayerID, int  CharacterID, int  AssetInstanceID, const FLootLockerServerEquipAssetToCharacterLoadoutResponseDelegate &  OnCompletedRequest  )

static

Equip an asset instance to the loadout of specified player and character using an asset instance id.

Parameters

PlayerID	The ID of the player for whom to equip the asset instance
CharacterID	The ID of the character on the specified player for whose loadout to equip the asset instance
AssetInstanceID	The ID of the asset instance to equip to the specified player character's loadout
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

GetPaginatedPlayerCharacterInventory()

static FString ULootLockerServerForCpp::GetPaginatedPlayerCharacterInventory ( int  PlayerID, int  CharacterID, int  Count, int  After, const FLootLockerServerGetCharacterInventoryResponseDelegate &  OnCompletedRequest  )

static

Get a subset of the inventory for the specified player and character using pagination settings.

Parameters

PlayerID	The ID of the player for whom to get the character inventory
CharacterID	The ID of the character on the specified player for which to get the inventory
Count	The number of inventory items to get. Must be a value between 1 and 200
After	The id of the inventory item from where to start getting inventory items (non inclusive). Set to 0 to start from the first item
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

GetPlayerCharacterInventory()

static FString ULootLockerServerForCpp::GetPlayerCharacterInventory ( int  PlayerID, int  CharacterID, const FLootLockerServerGetCharacterInventoryResponseDelegate &  OnCompletedRequest  )

static

Get the inventory for the specified player and character.

Parameters

PlayerID	The ID of the player for whom to get the character inventory
CharacterID	The ID of the character on the specified player for which to get the inventory
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

GetPlayerCharacterLoadout()

static FString ULootLockerServerForCpp::GetPlayerCharacterLoadout ( int  PlayerID, int  CharacterID, const FLootLockerServerGetCharacterLoadoutResponseDelegate &  OnCompletedRequest  )

static

Get the full loadout for the specified player and character.

Parameters

PlayerID	The ID of the player for whom to get the character loadout
CharacterID	The ID of the character on the specified player for which to get the loadout
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

GetPlayerCharacters()

static FString ULootLockerServerForCpp::GetPlayerCharacters ( int  PlayerID, const FLootLockerServerGetPlayerCharacterResponseDelegate &  OnCompletedRequest  )

static

List all characters for this player.

If your game uses heroes the characters underlaying the heroes will be listed too.

Parameters

PlayerID	The ID of the player for whom to get the characters
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

UnequipAssetFromPlayerCharacterLoadout()

static FString ULootLockerServerForCpp::UnequipAssetFromPlayerCharacterLoadout ( int  PlayerID, int  CharacterID, int  InstanceID, const FLootLockerServerUnequipAssetFromCharacterLoadoutResponseDelegate &  OnCompletedRequest  )

static

Unequip an asset instance from the loadout of specified player and character using the instance id.

Parameters

PlayerID	The ID of the player for whom to unequip the asset instance
CharacterID	The ID of the character on the specified player for whose loadout to unequip the asset instance
InstanceID	The ID of the asset instance to unequip from the specified player character's loadout
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::GetPlayerCharacters (int PlayerID, const FLootLockerServerGetPlayerCharacterResponseDelegate &OnCompletedRequest)
	List all characters for this player.
static FString	ULootLockerServerForCpp::GetPlayerCharacterInventory (int PlayerID, int CharacterID, const FLootLockerServerGetCharacterInventoryResponseDelegate &OnCompletedRequest)
	Get the inventory for the specified player and character.
static FString	ULootLockerServerForCpp::GetPaginatedPlayerCharacterInventory (int PlayerID, int CharacterID, int Count, int After, const FLootLockerServerGetCharacterInventoryResponseDelegate &OnCompletedRequest)
	Get a subset of the inventory for the specified player and character using pagination settings.
static FString	ULootLockerServerForCpp::GetPlayerCharacterLoadout (int PlayerID, int CharacterID, const FLootLockerServerGetCharacterLoadoutResponseDelegate &OnCompletedRequest)
	Get the full loadout for the specified player and character.
static FString	ULootLockerServerForCpp::EquipAssetToPlayerCharacterLoadoutByAssetInstanceId (int PlayerID, int CharacterID, int AssetInstanceID, const FLootLockerServerEquipAssetToCharacterLoadoutResponseDelegate &OnCompletedRequest)
	Equip an asset instance to the loadout of specified player and character using an asset instance id.
static FString	ULootLockerServerForCpp::EquipAssetToPlayerCharacterLoadoutByAssetIdAndAssetVariationId (int PlayerID, int CharacterID, int AssetID, int AssetVariationID, const FLootLockerServerEquipAssetToCharacterLoadoutResponseDelegate &OnCompletedRequest)
	Equip an asset instance to the loadout of specified player and character using an asset id and an asset variation id.
static FString	ULootLockerServerForCpp::EquipAssetToPlayerCharacterLoadoutByAssetIdAndRentalOptionId (int PlayerID, int CharacterID, int AssetID, int RentalOptionID, const FLootLockerServerEquipAssetToCharacterLoadoutResponseDelegate &OnCompletedRequest)
	Equip an asset instance to the loadout of specified player and character using an asset id and a rental option id.
static FString	ULootLockerServerForCpp::UnequipAssetFromPlayerCharacterLoadout (int PlayerID, int CharacterID, int InstanceID, const FLootLockerServerUnequipAssetFromCharacterLoadoutResponseDelegate &OnCompletedRequest)
	Unequip an asset instance from the loadout of specified player and character using the instance id.