LootLocker Unity SDK 8.0.0
Game backend SDK for Unity
Loading...
Searching...
No Matches
Assets

Detailed Description

Browse and filter the asset catalogue defined in the LootLocker console.

Assets are anything a player can earn, purchase, possess, or equip — cosmetics, weapons, game configs, loot boxes, drop tables, or rental items. Each asset is assigned a Context (category) and a Complexity (Generic, Loot Box, Rental, or Drop Table) that adds behaviour. This group covers listing reference assets and their metadata; for player-owned instances see Asset Instances.

See the LootLocker documentation.

Function Documentation

◆ AddFavouriteAsset()

static void LootLocker.Requests.LootLockerSDKManager.AddFavouriteAsset ( string  assetId,
Action< LootLockerAssetResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

Add an asset to the current players favorite assets.

Parameters
assetIdThe ID of the asset to add to favourites
onCompleteonComplete Action for handling the response of type LootLockerAssetResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

◆ GetAssetById()

static void LootLocker.Requests.LootLockerSDKManager.GetAssetById ( int  assetId,
Action< LootLockerSingleAssetResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

Get information about a specific asset.

Parameters
assetIdThe ID of the asset that you want information about
onCompleteonComplete Action for handling the response of type LootLockerSingleAssetResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

◆ GetAssetInformation()

static void LootLocker.Requests.LootLockerSDKManager.GetAssetInformation ( int  assetId,
Action< LootLockerSingleAssetResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

Get information about a specific asset.

Parameters
assetIdThe ID of the asset that you want information about
onCompleteonComplete Action for handling the response of type LootLockerSingleAssetResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

◆ GetAssetListWithCount()

static void LootLocker.Requests.LootLockerSDKManager.GetAssetListWithCount ( int  assetCount,
Action< LootLockerAssetResponse onComplete,
List< LootLocker::LootLockerEnums::AssetFilter filter = null,
bool  includeUGC = false,
Dictionary< string, string >  assetFilters = null,
int  UGCCreatorPlayerID = 0,
string  forPlayerWithUlid = null,
int  contextID = 0 
)
inlinestatic

Get the available assets for the game.

Up to 200 at a time. Includes amount of assets in the response.

Parameters
assetCountAmount of assets to get
onCompleteonComplete Action for handling the response of type LootLockerAssetResponse
filterA list of LootLocker.LootLockerEnums.AssetFilter to get just specific assets.
includeUGCShould User Generated Content be included in this response?
assetFiltersA Dictionary<string, string> of custom filters to use when retrieving assets
UGCCreatorPlayerIDOnly get assets created by a specific player
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.
contextIDOnly get assets for a specific context

◆ GetAssetNextList()

static void LootLocker.Requests.LootLockerSDKManager.GetAssetNextList ( int  assetCount,
Action< LootLockerAssetResponse onComplete,
List< LootLocker::LootLockerEnums::AssetFilter filter = null,
bool  includeUGC = false,
Dictionary< string, string >  assetFilters = null,
int  UGCCreatorPlayerID = 0,
string  forPlayerWithUlid = null,
int  contextID = 0 
)
inlinestatic

Get the next set of assets after a previous call to GetAssetsOriginal or GetAssetListWithCount.

Parameters
assetCountAmount of assets to get
onCompleteonComplete Action for handling the response of type LootLockerAssetResponse
filterA list of LootLocker.LootLockerEnums.AssetFilter to get just specific assets.
includeUGCShould User Generated Content be included in this response?
assetFiltersA Dictionary<string, string> of custom filters to use when retrieving assets
UGCCreatorPlayerIDOnly get assets created by a specific player
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.
contextIDOnly get assets for a specific context

◆ GetAssetsById()

static void LootLocker.Requests.LootLockerSDKManager.GetAssetsById ( string[]  assetIdsToRetrieve,
Action< LootLockerAssetResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

Get multiple assets by their IDs.

Parameters
assetIdsToRetrieveA list of multiple assets to retrieve
onCompleteonComplete Action for handling the response of type LootLockerAssetResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

◆ GetAssetsOriginal()

static void LootLocker.Requests.LootLockerSDKManager.GetAssetsOriginal ( int  assetCount,
Action< LootLockerAssetResponse onComplete,
int?  idOfLastAsset = null,
List< LootLocker::LootLockerEnums::AssetFilter filter = null,
bool  includeUGC = false,
Dictionary< string, string >  assetFilters = null,
int  UGCCreatorPlayerID = 0,
string  forPlayerWithUlid = null,
int  contextID = 0 
)
inlinestatic

Get the available assets for the game.

Up to 200 at a time.

Parameters
assetCountAmount of assets to get
onCompleteonComplete Action for handling the response of type LootLockerAssetResponse
idOfLastAssetSet this to stop getting assets after a certain asset
filterA list of LootLocker.LootLockerEnums.AssetFilter to get just specific assets.
includeUGCShould User Generated Content be included in this response?
assetFiltersA Dictionary<string, string> of custom filters to use when retrieving assets
UGCCreatorPlayerIDOnly get assets created by a specific player
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.
contextIDOnly get assets for a specific context

◆ GetContext()

static void LootLocker.Requests.LootLockerSDKManager.GetContext ( Action< LootLockerContextResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

Get the available contexts for the game.

Parameters
onCompleteonComplete Action for handling the response of type LootLockerContextResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

◆ GrantAssetToPlayerInventory() [1/2]

static void LootLocker.Requests.LootLockerSDKManager.GrantAssetToPlayerInventory ( int  assetID,
Action< LootLockerGrantAssetResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

Grant an Asset to the Player's Inventory.

Parameters
assetIDThe Asset you want to create an Instance of and give to the current player
onCompleteonComplete Action for handling the response of type LootLockerGrantAssetResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

◆ GrantAssetToPlayerInventory() [2/2]

static void LootLocker.Requests.LootLockerSDKManager.GrantAssetToPlayerInventory ( int  assetID,
int?  assetVariationID,
int?  assetRentalOptionID,
Action< LootLockerGrantAssetResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

Grant an Asset Instance to the Player's Inventory.

Parameters
assetIDThe Asset you want to create an Instance of and give to the current player
assetVariationIDThe id of the Asset Variation you want to grant
assetRentalOptionIDThe rental option id you want to give the Asset Instance
onCompleteonComplete Action for handling the response of type LootLockerGrantAssetResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

◆ ListAssets()

static void LootLocker.Requests.LootLockerSDKManager.ListAssets ( LootLockerListAssetsRequest  Request,
Action< LootLockerListAssetsResponse onComplete,
int  PerPage = 0,
int  Page = 0,
OrderAssetListBy  orderBy = OrderAssetListBy::none,
OrderAssetListDirection  orderDirection = OrderAssetListDirection::none,
string  forPlayerWithUlid = null 
)
inlinestatic

List assets with configurable response data.

Use this to limit the fields returned in the response and improve performance.

Parameters
RequestRequest object with settings on what fields to include, exclude, and what assets to filter
onCompleteDelegate for handling the server response
PerPage(Optional) Used together with Page to apply pagination to this Request. PerPage designates how many notifications are considered a "page". Set to 0 to not use this filter.
Page(Optional) Used together with PerPage to apply pagination to this Request. Page designates which "page" of items to fetch. Set to 0 to not use this filter.
orderBy(Optional) Order the list by a specific field. Default is unordered.
orderDirection(Optional) Order the list in ascending or descending order. Default is unordered.
forPlayerWithUlidOptional: Execute the Request for the specified player. If not supplied, the default player will be used.

◆ ListAssetsWithDefaultParameters()

static void LootLocker.Requests.LootLockerSDKManager.ListAssetsWithDefaultParameters ( Action< LootLockerListAssetsResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

List assets with default parameters (no filters, first page, default page size).

Parameters
onCompleteDelegate for handling the server response
forPlayerWithUlidOptional: Execute the request for the specified player. If not supplied, the default player will be used.

◆ ListFavouriteAssets()

static void LootLocker.Requests.LootLockerSDKManager.ListFavouriteAssets ( Action< LootLockerFavouritesListResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

List the current players favorite assets.

Parameters
onCompleteonComplete Action for handling the response of type LootLockerFavouritesListResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

◆ RemoveFavouriteAsset()

static void LootLocker.Requests.LootLockerSDKManager.RemoveFavouriteAsset ( string  assetId,
Action< LootLockerAssetResponse onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

Remove an asset from the current players favorite assets.

Parameters
assetIdThe ID of the asset to remove from favourites
onCompleteonComplete Action for handling the response of type LootLockerAssetResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

Functions

static void LootLocker.Requests.LootLockerSDKManager.GetContext (Action< LootLockerContextResponse > onComplete, string forPlayerWithUlid=null)
 Get the available contexts for the game.
 
static void LootLocker.Requests.LootLockerSDKManager.GetAssetsOriginal (int assetCount, Action< LootLockerAssetResponse > onComplete, int? idOfLastAsset=null, List< LootLocker.LootLockerEnums.AssetFilter > filter=null, bool includeUGC=false, Dictionary< string, string > assetFilters=null, int UGCCreatorPlayerID=0, string forPlayerWithUlid=null, int contextID=0)
 Get the available assets for the game.
 
static void LootLocker.Requests.LootLockerSDKManager.GetAssetListWithCount (int assetCount, Action< LootLockerAssetResponse > onComplete, List< LootLocker.LootLockerEnums.AssetFilter > filter=null, bool includeUGC=false, Dictionary< string, string > assetFilters=null, int UGCCreatorPlayerID=0, string forPlayerWithUlid=null, int contextID=0)
 Get the available assets for the game.
 
static void LootLocker.Requests.LootLockerSDKManager.GetAssetNextList (int assetCount, Action< LootLockerAssetResponse > onComplete, List< LootLocker.LootLockerEnums.AssetFilter > filter=null, bool includeUGC=false, Dictionary< string, string > assetFilters=null, int UGCCreatorPlayerID=0, string forPlayerWithUlid=null, int contextID=0)
 Get the next set of assets after a previous call to GetAssetsOriginal or GetAssetListWithCount.
 
static void LootLocker.Requests.LootLockerSDKManager.ResetAssetCalls ()
 Reset the last id used in GetAssetNextList().
 
static void LootLocker.Requests.LootLockerSDKManager.GetAssetInformation (int assetId, Action< LootLockerSingleAssetResponse > onComplete, string forPlayerWithUlid=null)
 Get information about a specific asset.
 
static void LootLocker.Requests.LootLockerSDKManager.GetAssetById (int assetId, Action< LootLockerSingleAssetResponse > onComplete, string forPlayerWithUlid=null)
 Get information about a specific asset.
 
static void LootLocker.Requests.LootLockerSDKManager.ListFavouriteAssets (Action< LootLockerFavouritesListResponse > onComplete, string forPlayerWithUlid=null)
 List the current players favorite assets.
 
static void LootLocker.Requests.LootLockerSDKManager.AddFavouriteAsset (string assetId, Action< LootLockerAssetResponse > onComplete, string forPlayerWithUlid=null)
 Add an asset to the current players favorite assets.
 
static void LootLocker.Requests.LootLockerSDKManager.RemoveFavouriteAsset (string assetId, Action< LootLockerAssetResponse > onComplete, string forPlayerWithUlid=null)
 Remove an asset from the current players favorite assets.
 
static void LootLocker.Requests.LootLockerSDKManager.GetAssetsById (string[] assetIdsToRetrieve, Action< LootLockerAssetResponse > onComplete, string forPlayerWithUlid=null)
 Get multiple assets by their IDs.
 
static void LootLocker.Requests.LootLockerSDKManager.GrantAssetToPlayerInventory (int assetID, Action< LootLockerGrantAssetResponse > onComplete, string forPlayerWithUlid=null)
 Grant an Asset to the Player's Inventory.
 
static void LootLocker.Requests.LootLockerSDKManager.GrantAssetToPlayerInventory (int assetID, int? assetVariationID, int? assetRentalOptionID, Action< LootLockerGrantAssetResponse > onComplete, string forPlayerWithUlid=null)
 Grant an Asset Instance to the Player's Inventory.
 
static void LootLocker.Requests.LootLockerSDKManager.ListAssetsWithDefaultParameters (Action< LootLockerListAssetsResponse > onComplete, string forPlayerWithUlid=null)
 List assets with default parameters (no filters, first page, default page size).
 
static void LootLocker.Requests.LootLockerSDKManager.ListAssets (LootLockerListAssetsRequest Request, Action< LootLockerListAssetsResponse > onComplete, int PerPage=0, int Page=0, OrderAssetListBy orderBy=OrderAssetListBy.none, OrderAssetListDirection orderDirection=OrderAssetListDirection.none, string forPlayerWithUlid=null)
 List assets with configurable response data.