Hero

Detailed Description

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. This group covers listing available heroes, creating player hero instances, and managing equipped item loadouts.

See the LootLocker documentation.

Function Documentation

AddAssetToHeroLoadout()

static void LootLocker.Requests.LootLockerSDKManager.AddAssetToHeroLoadout ( int  heroID, int  assetInstanceID, Action< LootLockerHeroLoadoutResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Equip the specified Asset Instance to the specified Hero that the current player owns.

Parameters

heroID	Id of the hero
assetInstanceID	Id of the asset instance to give
onComplete	onComplete Action for handling the response of type LootLockerHeroLoadoutResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

AddAssetVariationToHeroLoadout()

static void LootLocker.Requests.LootLockerSDKManager.AddAssetVariationToHeroLoadout ( int  heroID, int  assetID, int  assetInstanceID, Action< LootLockerHeroLoadoutResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Equip the specified Asset Variation to the specified Hero that the current player owns.

Parameters

heroID	Id of the hero
assetID	Id of the asset
assetInstanceID	Id of the asset instance to give
onComplete	onComplete Action for handling the response of type LootLockerHeroLoadoutResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

CreateHero()

static void LootLocker.Requests.LootLockerSDKManager.CreateHero ( int  heroId, string  name, bool  isDefault, Action< LootLockerHeroLoadoutResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Create a hero with the provided type and name.

The hero will be owned by the currently active player.

Parameters

heroId	The id of the hero
name	The new name for the hero
isDefault	Should this hero be the default hero?
onComplete	onComplete Action for handling the response of type LootLockerHeroLoadoutResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

CreateHeroWithVariation()

static void LootLocker.Requests.LootLockerSDKManager.CreateHeroWithVariation ( string  name, int  heroId, int  assetVariationId, bool  isDefault, Action< LootLockerHeroLoadoutResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Create a hero for the current player with the supplied name from the game hero specified with the supplied hero id, asset variation id, and whether to set as default.

Parameters

name	The new name for the hero
heroId	The id of the hero
assetVariationId	ID of the asset variation to use
isDefault	Should this hero be the default hero?
onComplete	onComplete Action for handling the response of type LootLockerHeroLoadoutResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

DeleteHero()

static void LootLocker.Requests.LootLockerSDKManager.DeleteHero ( int  heroID, Action< LootLockerPlayerHeroResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Remove the hero with the specified id from the current players list of heroes.

Parameters

heroID	HeroID Id of the hero
onComplete	onComplete Action for handling the response of type LootLockerPlayerHeroResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetGameHeroes()

static void LootLocker.Requests.LootLockerSDKManager.GetGameHeroes ( Action< LootLockerGameHeroResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List the heroes with names and character information.

Parameters

onComplete	onComplete Action for handling the response of type LootLockerGameHeroResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetHero()

static void LootLocker.Requests.LootLockerSDKManager.GetHero ( int  heroId, Action< LootLockerPlayerHeroResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Return information about the requested hero on the current player.

Parameters

heroId	The id of the hero to get
onComplete	onComplete Action for handling the response of type LootLockerPlayerHeroResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetHeroInventory()

static void LootLocker.Requests.LootLockerSDKManager.GetHeroInventory ( int  heroID, Action< LootLockerInventoryResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List Asset Instances owned by the specified hero.

Parameters

heroID	HeroID Id of the hero
onComplete	onComplete Action for handling the response of type LootLockerInventoryResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetHeroLoadout()

static void LootLocker.Requests.LootLockerSDKManager.GetHeroLoadout ( int  HeroID, Action< LootLockerHeroLoadoutResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List the loadout of the specified hero that the current player owns.

Parameters

HeroID	Id of the hero
onComplete	onComplete Action for handling the response of type LootLockerHeroLoadoutResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetOtherPlayersDefaultHeroBySteamID64()

static void LootLocker.Requests.LootLockerSDKManager.GetOtherPlayersDefaultHeroBySteamID64 ( int  steamId, Action< LootLockerPlayerHeroResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Get the default hero for the player with the specified SteamID64.

Parameters

steamId	Steam Id of the requested player
onComplete	onComplete Action for handling the response of type LootLockerPlayerHeroResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

GetOtherPlayersHeroLoadout()

static void LootLocker.Requests.LootLockerSDKManager.GetOtherPlayersHeroLoadout ( int  heroID, Action< LootLockerHeroLoadoutResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List the loadout of the specified hero that the another player owns.

Parameters

heroID	HeroID Id of the hero
onComplete	onComplete Action for handling the response of type LootLockerHeroLoadoutResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

ListOtherPlayersHeroesBySteamID64()

static void LootLocker.Requests.LootLockerSDKManager.ListOtherPlayersHeroesBySteamID64 ( int  steamID64, Action< LootLockerPlayerHeroResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List player that the player with the specified SteamID64 owns.

Parameters

steamID64	Steam id of the requested player
onComplete	onComplete Action for handling the response of type LootLockerPlayerHeroResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

ListPlayerHeroes()

static void LootLocker.Requests.LootLockerSDKManager.ListPlayerHeroes ( Action< LootLockerListHeroResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

List the heroes that the current player owns.

Parameters

onComplete	onComplete Action for handling the response of type LootLockerPlayerHeroResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

RemoveAssetFromHeroLoadout()

static void LootLocker.Requests.LootLockerSDKManager.RemoveAssetFromHeroLoadout ( int  assetID, int  heroID, Action< LootLockerHeroLoadoutResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Unequip the specified Asset Instance to the specified Hero that the current player owns.

Parameters

assetID	Id of the asset
heroID	Id of the hero
onComplete	onComplete Action for handling the response of type LootLockerHeroLoadoutResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

UpdateHero()

static void LootLocker.Requests.LootLockerSDKManager.UpdateHero ( string  heroId, string  name, bool  isDefault, Action< LootLockerPlayerHeroResponse >  onComplete, string  forPlayerWithUlid = null  )

inlinestatic

Update the name of the hero with the specified id and/or set it as default for the current player.

Parameters

heroId	Id of the hero
name	The new name for the hero
isDefault	Should this hero be the default hero?
onComplete	onComplete Action for handling the response of type LootLockerPlayerHeroResponse
forPlayerWithUlid	Optional : Execute the request for the specified player. If not supplied, the default player will be used.

Functions
static void	LootLocker.Requests.LootLockerSDKManager.CreateHero (int heroId, string name, bool isDefault, Action< LootLockerHeroLoadoutResponse > onComplete, string forPlayerWithUlid=null)
	Create a hero with the provided type and name.
static void	LootLocker.Requests.LootLockerSDKManager.GetGameHeroes (Action< LootLockerGameHeroResponse > onComplete, string forPlayerWithUlid=null)
	List the heroes with names and character information.
static void	LootLocker.Requests.LootLockerSDKManager.ListPlayerHeroes (Action< LootLockerListHeroResponse > onComplete, string forPlayerWithUlid=null)
	List the heroes that the current player owns.
static void	LootLocker.Requests.LootLockerSDKManager.ListOtherPlayersHeroesBySteamID64 (int steamID64, Action< LootLockerPlayerHeroResponse > onComplete, string forPlayerWithUlid=null)
	List player that the player with the specified SteamID64 owns.
static void	LootLocker.Requests.LootLockerSDKManager.CreateHeroWithVariation (string name, int heroId, int assetVariationId, bool isDefault, Action< LootLockerHeroLoadoutResponse > onComplete, string forPlayerWithUlid=null)
	Create a hero for the current player with the supplied name from the game hero specified with the supplied hero id, asset variation id, and whether to set as default.
static void	LootLocker.Requests.LootLockerSDKManager.GetHero (int heroId, Action< LootLockerPlayerHeroResponse > onComplete, string forPlayerWithUlid=null)
	Return information about the requested hero on the current player.
static void	LootLocker.Requests.LootLockerSDKManager.GetOtherPlayersDefaultHeroBySteamID64 (int steamId, Action< LootLockerPlayerHeroResponse > onComplete, string forPlayerWithUlid=null)
	Get the default hero for the player with the specified SteamID64.
static void	LootLocker.Requests.LootLockerSDKManager.UpdateHero (string heroId, string name, bool isDefault, Action< LootLockerPlayerHeroResponse > onComplete, string forPlayerWithUlid=null)
	Update the name of the hero with the specified id and/or set it as default for the current player.
static void	LootLocker.Requests.LootLockerSDKManager.DeleteHero (int heroID, Action< LootLockerPlayerHeroResponse > onComplete, string forPlayerWithUlid=null)
	Remove the hero with the specified id from the current players list of heroes.
static void	LootLocker.Requests.LootLockerSDKManager.GetHeroInventory (int heroID, Action< LootLockerInventoryResponse > onComplete, string forPlayerWithUlid=null)
	List Asset Instances owned by the specified hero.
static void	LootLocker.Requests.LootLockerSDKManager.GetHeroLoadout (int HeroID, Action< LootLockerHeroLoadoutResponse > onComplete, string forPlayerWithUlid=null)
	List the loadout of the specified hero that the current player owns.
static void	LootLocker.Requests.LootLockerSDKManager.GetOtherPlayersHeroLoadout (int heroID, Action< LootLockerHeroLoadoutResponse > onComplete, string forPlayerWithUlid=null)
	List the loadout of the specified hero that the another player owns.
static void	LootLocker.Requests.LootLockerSDKManager.AddAssetToHeroLoadout (int heroID, int assetInstanceID, Action< LootLockerHeroLoadoutResponse > onComplete, string forPlayerWithUlid=null)
	Equip the specified Asset Instance to the specified Hero that the current player owns.
static void	LootLocker.Requests.LootLockerSDKManager.AddAssetVariationToHeroLoadout (int heroID, int assetID, int assetInstanceID, Action< LootLockerHeroLoadoutResponse > onComplete, string forPlayerWithUlid=null)
	Equip the specified Asset Variation to the specified Hero that the current player owns.
static void	LootLocker.Requests.LootLockerSDKManager.RemoveAssetFromHeroLoadout (int assetID, int heroID, Action< LootLockerHeroLoadoutResponse > onComplete, string forPlayerWithUlid=null)
	Unequip the specified Asset Instance to the specified Hero that the current player owns.