Server-side management of player hero instances.
Query and manage hero instances for players. Heroes are player-owned instances of a Hero Class, which extends a Base Class with optional overrides. This group covers listing available heroes and managing equipped item loadouts for players from the server.
See the LootLocker documentation.
◆ EquipAssetToPlayerHeroLoadoutByAssetIdAndAssetVariationId()
Equip an asset instance to the loadout of specified player and hero using an asset id and an asset variation id.
- Parameters
-
| PlayerID | The ID of the player for whom to equip the asset instance |
| HeroID | The ID of the hero on the specified player for whose loadout to equip the asset instance |
| AssetID | The ID of the asset to equip to the specified player hero's loadout |
| AssetVariationID | The ID of the variation of the specified asset to equip to the specified player hero'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
◆ EquipAssetToPlayerHeroLoadoutByAssetIdAndRentalOptionId()
Equip an asset instance to the loadout of specified player and hero using an asset id and a rental option id.
- Parameters
-
| PlayerID | The ID of the player for whom to equip the asset instance |
| HeroID | The ID of the hero on the specified player for whose loadout to equip the asset instance |
| AssetID | The ID of the asset to equip to the specified player hero's loadout |
| RentalOptionID | The ID of the rental option of the specified asset to equip to the specified player hero'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
◆ EquipAssetToPlayerHeroLoadoutByAssetInstanceId()
Equip an asset instance to the loadout of specified player and hero using an asset instance id.
- Parameters
-
| PlayerID | The ID of the player for whom to equip the asset instance |
| HeroID | The ID of the hero 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 hero'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
◆ GetPaginatedPlayerHeroInventory()
Get a subset of the inventory for the specified player and hero using pagination settings.
- Parameters
-
| PlayerID | The ID of the player for whom to get the hero inventory |
| HeroID | The ID of the hero 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
◆ GetPlayerHeroes()
List all heroes for this player.
- Parameters
-
| PlayerID | The ID of the player for whom to get the heroes |
| 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
◆ GetPlayerHeroInventory()
Get the inventory for the specified player and hero.
- Parameters
-
| PlayerID | The ID of the player for whom to get the hero inventory |
| HeroID | The ID of the hero 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
◆ GetPlayerHeroLoadout()
Get the full loadout for the specified player and hero.
- Parameters
-
| PlayerID | The ID of the player for whom to get the hero loadout |
| HeroID | The ID of the hero 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
◆ UnequipAssetFromPlayerHeroLoadout()
Unequip an asset instance from the loadout of specified player and hero using the instance id.
- Parameters
-
| PlayerID | The ID of the player for whom to unequip the asset instance |
| HeroID | The ID of the hero 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 hero'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
|
| static FString | ULootLockerServerForCpp::GetPlayerHeroes (int PlayerID, const FLootLockerServerGetPlayerHeroResponseDelegate &OnCompletedRequest) |
| | List all heroes for this player.
|
| |
| static FString | ULootLockerServerForCpp::GetPlayerHeroInventory (int PlayerID, int HeroID, const FLootLockerServerGetHeroInventoryResponseDelegate &OnCompletedRequest) |
| | Get the inventory for the specified player and hero.
|
| |
| static FString | ULootLockerServerForCpp::GetPaginatedPlayerHeroInventory (int PlayerID, int HeroID, int Count, int After, const FLootLockerServerGetHeroInventoryResponseDelegate &OnCompletedRequest) |
| | Get a subset of the inventory for the specified player and hero using pagination settings.
|
| |
| static FString | ULootLockerServerForCpp::GetPlayerHeroLoadout (int PlayerID, int HeroID, const FLootLockerServerGetHeroLoadoutResponseDelegate &OnCompletedRequest) |
| | Get the full loadout for the specified player and hero.
|
| |
| static FString | ULootLockerServerForCpp::EquipAssetToPlayerHeroLoadoutByAssetInstanceId (int PlayerID, int HeroID, int AssetInstanceID, const FLootLockerServerEquipAssetToHeroLoadoutResponseDelegate &OnCompletedRequest) |
| | Equip an asset instance to the loadout of specified player and hero using an asset instance id.
|
| |
| static FString | ULootLockerServerForCpp::EquipAssetToPlayerHeroLoadoutByAssetIdAndAssetVariationId (int PlayerID, int HeroID, int AssetID, int AssetVariationID, const FLootLockerServerEquipAssetToHeroLoadoutResponseDelegate &OnCompletedRequest) |
| | Equip an asset instance to the loadout of specified player and hero using an asset id and an asset variation id.
|
| |
| static FString | ULootLockerServerForCpp::EquipAssetToPlayerHeroLoadoutByAssetIdAndRentalOptionId (int PlayerID, int HeroID, int AssetID, int RentalOptionID, const FLootLockerServerEquipAssetToHeroLoadoutResponseDelegate &OnCompletedRequest) |
| | Equip an asset instance to the loadout of specified player and hero using an asset id and a rental option id.
|
| |
| static FString | ULootLockerServerForCpp::UnequipAssetFromPlayerHeroLoadout (int PlayerID, int HeroID, int InstanceID, const FLootLockerServerUnequipAssetFromHeroLoadoutResponseDelegate &OnCompletedRequest) |
| | Unequip an asset instance from the loadout of specified player and hero using the instance id.
|
| |