![]() |
LootLocker Unreal SDK 10.4.0
Game backend SDK for Unreal Engine
|
Create and manage hero instances for the current player.
Heroes are player-owned instances of a Hero Class, which in turn extends a Base Class. Hero Classes inherit the default loadout and equippable asset rules of their Base Class but may override them with exceptions (e.g., a Healer Hero that can also wield two-handed weapons). This group covers listing available heroes, creating player hero instances, and managing equipped item loadouts.
See the LootLocker documentation.
| typedef void(* FCharacterLoadoutResponse) (FLootLockerCharacterLoadoutResponse) |
C++ response callback delegate; receives an FLootLockerCharacterLoadoutResponse result.
| typedef void(* FHeroLoadoutReseponseDelegate) (FLootLockerHeroLoadoutResponse) |
C++ response callback delegate; receives an FLootLockerHeroLoadoutResponse result.
| typedef void(* FLLHeroDefaultResponseDelegate) (FLootLockerResponse) |
C++ response callback delegate; receives an FLootLockerResponse result.
| typedef void(* FLootLockerCharacterDefaultResponse) (FLootLockerResponse) |
C++ response callback delegate; receives an FLootLockerResponse result.
| typedef void(* FLootLockerGameHeroListDelegate) (FLootLockerGameHeroListResponse) |
C++ response callback delegate; receives an FLootLockerGameHeroListResponse result.
| typedef void(* FLootLockerHeroDelegate) (FLootLockerHeroResponse) |
C++ response callback delegate; receives an FLootLockerHeroResponse result.
| typedef void(* FLootLockerHeroListDelegate) (FLootLockerHeroListResponse) |
C++ response callback delegate; receives an FLootLockerHeroListResponse result.
| typedef void(* FLootLockerPlayerHeroDelegate) (FLootLockerPlayerHeroResponse) |
C++ response callback delegate; receives an FLootLockerPlayerHeroResponse result.
| typedef void(* FPLootLockerListCharacterTypesResponse) (FLootLockerListCharacterTypesResponse) |
C++ response callback delegate; receives an FLootLockerListCharacterTypesResponse result.
| typedef void(* FPLootLockerListPlayerCharactersResponse) (FLootLockerListPlayerCharactersResponse) |
C++ response callback delegate; receives an FLootLockerListPlayerCharactersResponse result.
|
static |
Equip an existing asset instance to a hero.
| HeroID | Id of the hero |
| AssetInstanceID | Id of the asset instance to equip |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Equip a global asset (default variation) to a hero.
| HeroID | Id of the hero |
| AssetID | Id of the global asset |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Equip a specific global asset variation to a hero.
| HeroID | Id of the hero |
| AssetID | Id of the global asset |
| AssetVariationID | Variation id of the global asset |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Create a character of a specified type and name (optionally set as default).
Use ListCharacterTypes to enumerate available character types.
| IsDefault | Whether the new character should be default |
| CharacterName | Character name |
| CharacterTypeId | Character type id |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Create a character of a specified type and name (optionally set as default).
Use ListCharacterTypes to enumerate available character types.
| IsDefault | Whether the new character should be default |
| CharacterName | Character name |
| CharacterTypeId | Character type id |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Create a hero from a game hero template.
| Request | Request containing template hero id and desired hero name |
| OnCompleteRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Create a hero with a specific variation and optional default flag.
| Request | Request including template hero id, hero name, variation id and default flag |
| OnCompleteRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Delete a character by id (irreversible) and return its equipped items to inventory.
| CharacterId | Id of the character to delete |
| OnCompletedRequestBP | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Delete a hero (irreversible; hero inventory is returned to player inventory and loadout reset).
| HeroID | Id of the hero to delete |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Equip an asset (by asset id and variation) to a specific character.
| CharacterId | Id of the character |
| AssetId | Asset id |
| AssetVariationId | Asset variation id |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Equip an asset instance to a specific character.
| CharacterId | Id of the character |
| InstanceId | Asset instance id |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Equip an asset instance to the player's default character.
| InstanceId | Asset instance id (from inventory or loadout) |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
List loadouts for all characters owned by the player including basic character info.
Succeeds even if there are no characters (response may be empty).
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Get the asset instances currently equipped on the player's default character.
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
List equipable contexts for another player's character by character id.
| OtherCharacterId | Target character id |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
List equipable contexts (slots/categories) for the player's default character.
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
List game hero templates (names and character info).
| OnCompleteRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Get information about a specific hero owned by the player.
| HeroID | Id of the hero to fetch |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
List asset instances owned by the specified hero (first page only; endpoint is paginated).
| HeroID | Id of the hero |
| OnCompleteRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Get the loadout (equipped items) for a hero owned by the player.
| HeroID | Id of the hero |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Get character loadouts for another player by platform-specific id.
| OtherPlayerId | Platform-specific id of the target player |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
| OtherPlayerPlatform | Optional: Platform the id refers to (if differing) |
| OnCompletedRequest | Delegate for handling the server response |
|
static |
Get character loadouts for another player by public UID.
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
| OtherPlayerUid | Public UID of the target player |
| OnCompletedRequest | Delegate for handling the server response |
|
static |
Get the default character loadout for another player identified by a platform-specific id.
| OtherPlayerId | Platform-specific id of the target player |
| OnCompletedRequest | Delegate for handling the server response |
| OtherPlayerPlatform | Optional: Platform the id refers to (if different than current) |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Get the default hero for another player by SteamID64.
| SteamID64 | SteamID64 of the target player |
| OnCompleteRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Get the loadout for another player's hero.
| HeroID | Id of the hero |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
List character types configured for the game.
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
List heroes owned by another player identified by SteamID64.
| SteamID64 | SteamID64 of the target player |
| OnCompleteRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
List characters owned by the player.
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
List heroes owned by the player.
| OnCompleteRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Unequip an asset instance from a hero.
| HeroID | Id of the hero |
| AssetInstanceID | Id of the asset instance to unequip |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Unequip an asset instance from a specific character.
| CharacterId | Id of the character |
| InstanceId | Asset instance id |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Unequip an asset instance from the player's default character.
| InstanceId | Asset instance id |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Update a character's name and/or mark it as the default character.
| CharacterId | Id of the character to update |
| IsDefault | Whether the character should become default |
| Name | New character name |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
|
static |
Update a hero's name and/or mark it as the default hero.
| HeroID | Id of the hero to update |
| Request | Request specifying new name and default flag |
| OnCompletedRequest | Delegate for handling the server response |
| ForPlayerWithUlid | Optional: Execute for the specified player ULID (default player if empty) |
Functions | |
| static FString | ULootLockerSDKManager::GetGameHeroes (const FLootLockerGameHeroListDelegate &OnCompleteRequest, const FString &ForPlayerWithUlid="") |
| List game hero templates (names and character info). | |
| static FString | ULootLockerSDKManager::ListPlayerHeroes (const FLootLockerHeroListDelegate &OnCompleteRequest, const FString &ForPlayerWithUlid="") |
| List heroes owned by the player. | |
| static FString | ULootLockerSDKManager::ListOtherPlayersHeroesBySteamID64 (const int64 SteamID64, const FLootLockerHeroListDelegate &OnCompleteRequest, const FString &ForPlayerWithUlid="") |
| List heroes owned by another player identified by SteamID64. | |
| static FString | ULootLockerSDKManager::CreateHero (const FLootLockerCreateHeroRequest &Request, const FLootLockerPlayerHeroDelegate &OnCompleteRequest, const FString &ForPlayerWithUlid="") |
| Create a hero from a game hero template. | |
| static FString | ULootLockerSDKManager::CreateHeroWithVariation (const FLootLockerCreateHeroWithVariationRequest &Request, const FLootLockerPlayerHeroDelegate &OnCompleteRequest, const FString &ForPlayerWithUlid="") |
| Create a hero with a specific variation and optional default flag. | |
| static FString | ULootLockerSDKManager::GetHero (const int32 HeroID, const FLootLockerPlayerHeroDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Get information about a specific hero owned by the player. | |
| static FString | ULootLockerSDKManager::GetOtherPlayersDefaultHeroBySteamID64 (const int64 SteamID64, const FLootLockerPlayerHeroDelegate &OnCompleteRequest, const FString &ForPlayerWithUlid="") |
| Get the default hero for another player by SteamID64. | |
| static FString | ULootLockerSDKManager::UpdateHero (const int32 HeroID, const FLootLockerUpdateHeroRequest &Request, const FLootLockerPlayerHeroDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Update a hero's name and/or mark it as the default hero. | |
| static FString | ULootLockerSDKManager::DeleteHero (const int32 HeroID, const FLLHeroDefaultResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Delete a hero (irreversible; hero inventory is returned to player inventory and loadout reset). | |
| static FString | ULootLockerSDKManager::GetHeroInventory (const int32 HeroID, const FInventoryResponse &OnCompleteRequest, const FString &ForPlayerWithUlid="") |
| List asset instances owned by the specified hero (first page only; endpoint is paginated). | |
| static FString | ULootLockerSDKManager::GetHeroLoadout (const int32 HeroID, const FHeroLoadoutReseponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Get the loadout (equipped items) for a hero owned by the player. | |
| static FString | ULootLockerSDKManager::GetOtherPlayersHeroLoadout (const int32 HeroID, const FHeroLoadoutReseponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Get the loadout for another player's hero. | |
| static FString | ULootLockerSDKManager::AddAssetToHeroLoadout (const int32 HeroID, const int32 AssetInstanceID, const FHeroLoadoutReseponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Equip an existing asset instance to a hero. | |
| static FString | ULootLockerSDKManager::AddGlobalAssetToHeroLoadout (const int32 HeroID, const int32 AssetID, const FHeroLoadoutReseponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Equip a global asset (default variation) to a hero. | |
| static FString | ULootLockerSDKManager::AddGlobalAssetVariationToHeroLoadout (const int32 HeroID, const int32 AssetID, const int32 AssetVariationID, const FHeroLoadoutReseponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Equip a specific global asset variation to a hero. | |
| static FString | ULootLockerSDKManager::RemoveAssetToHeroLoadout (const int32 HeroID, const int32 AssetInstanceID, const FHeroLoadoutReseponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Unequip an asset instance from a hero. | |
| static FString | ULootLockerSDKManager::GetCharacterLoadout (const FCharacterLoadoutResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| List loadouts for all characters owned by the player including basic character info. | |
| static FString | ULootLockerSDKManager::UpdateCharacter (int CharacterId, bool IsDefault, FString &Name, const FCharacterLoadoutResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Update a character's name and/or mark it as the default character. | |
| static FString | ULootLockerSDKManager::CreateCharacter (bool IsDefault, const FString &CharacterName, const FString &CharacterTypeId, const FCharacterLoadoutResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Create a character of a specified type and name (optionally set as default). | |
| static FString | ULootLockerSDKManager::CreateCharacter (bool IsDefault, const FString &CharacterName, const int &CharacterTypeId, const FCharacterLoadoutResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Create a character of a specified type and name (optionally set as default). | |
| static FString | ULootLockerSDKManager::DeleteCharacter (int CharacterId, const FLootLockerCharacterDefaultResponse &OnCompletedRequestBP, const FString &ForPlayerWithUlid="") |
| Delete a character by id (irreversible) and return its equipped items to inventory. | |
| static FString | ULootLockerSDKManager::ListCharacterTypes (const FPLootLockerListCharacterTypesResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| List character types configured for the game. | |
| static FString | ULootLockerSDKManager::EquipAssetToDefaultCharacter (int InstanceId, const FLootLockerCharacterDefaultResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Equip an asset instance to the player's default character. | |
| static FString | ULootLockerSDKManager::EquipAssetToCharacterById (int CharacterId, int AssetId, int AssetVariationId, const FLootLockerCharacterDefaultResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Equip an asset (by asset id and variation) to a specific character. | |
| static FString | ULootLockerSDKManager::EquipAssetToCharacterById (int CharacterId, int InstanceId, const FLootLockerCharacterDefaultResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Equip an asset instance to a specific character. | |
| static FString | ULootLockerSDKManager::UnEquipAssetToDefaultCharacter (int InstanceId, const FLootLockerCharacterDefaultResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Unequip an asset instance from the player's default character. | |
| static FString | ULootLockerSDKManager::UnEquipAssetToCharacterById (int CharacterId, int InstanceId, const FLootLockerCharacterDefaultResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Unequip an asset instance from a specific character. | |
| static FString | ULootLockerSDKManager::GetCurrentLoadoutToDefaultCharacter (const FCharacterLoadoutResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Get the asset instances currently equipped on the player's default character. | |
| static FString | ULootLockerSDKManager::GetOtherPlayersCurrentLoadoutToDefaultCharacter (FString OtherPlayerId, const FCharacterLoadoutResponse &OnCompletedRequest, const FString &OtherPlayerPlatform=FString(TEXT("")), const FString &ForPlayerWithUlid="") |
| Get the default character loadout for another player identified by a platform-specific id. | |
| static FString | ULootLockerSDKManager::GetEquipableContextsToDefaultCharacter (const FContextDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| List equipable contexts (slots/categories) for the player's default character. | |
| static FString | ULootLockerSDKManager::GetEquipableContextsByCharacterId (int OtherCharacterId, const FContextDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| List equipable contexts for another player's character by character id. | |
| static FString | ULootLockerSDKManager::ListPlayerCharacters (const FPLootLockerListPlayerCharactersResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| List characters owned by the player. | |
| static FString | ULootLockerSDKManager::GetOtherPlayersCharacterLoadouts (const FString &OtherPlayerId, const FCharacterLoadoutResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="", const FString &OtherPlayerPlatform="") |
| Get character loadouts for another player by platform-specific id. | |
| static FString | ULootLockerSDKManager::GetOtherPlayersCharacterLoadoutsByUid (const FString &OtherPlayerUid, const FCharacterLoadoutResponse &OnCompletedRequest, const FString &ForPlayerWithUlid="") |
| Get character loadouts for another player by public UID. | |