![]() |
LootLocker Unity SDK 8.0.0
Game backend SDK for Unity
|
Retrieve and manage the current player's profile, name, and identifiers.
Covers public profile data, display-name assignment, and account info lookups. For inventory see Asset Instances; for XP/levels see Player Progressions; for currency balances see Balances; for cloud file storage see Player Files.
See the LootLocker documentation.
|
inlinestatic |
Mark the logged in player for deletion.
After 30 days the player will be deleted from the system.
| onComplete | onComplete Action for handling the response of type LootLockerResponse> |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get assets that have been given to the currently logged in player since the last time this endpoint was called.
| onComplete | onComplete Action for handling the response of type LootLockerPlayerAssetNotificationsResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get the amount of credits/currency that the player has.
| onComplete | onComplete Action for handling the response of type LootLockerBalanceResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get information about the currently logged in player such as name and different ids to use for subsequent calls to LootLocker methods.
| onComplete | Action for handling the response |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get asset deactivations for the currently logged in player since the last time this endpoint was called.
| onComplete | onComplete Action for handling the response of type LootLockerDeactivatedAssetsResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get a list of DLC's migrated for the player.
This response will only list the asset-ID's of the migrated DLC, if you want more information about the assets, use GetAssetNotification(Action<LootLockerPlayerAssetNotificationsResponse> onComplete) instead.
| onComplete | onComplete Action for handling the response of type LootLockerDlcResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get the players inventory.
| 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. |
|
inlinestatic |
Get the players inventory.
| count | Amount of assets to retrieve |
| 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. |
|
inlinestatic |
Get the players inventory.
| count | Amount of assets to retrieve |
| after | The instance ID the list should start from |
| 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. |
|
inlinestatic |
Get the logged in players name.
| onComplete | onComplete Action for handling the response of type PlayerNameResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Initiate DLC Migration for the player: https://docs.lootlocker.com/background/live-ops-tools#dlc-migration 5 minutes after calling this endpoint you should issue a call to the Player Asset Notifications call to get the results of the migrated DLC, if any.
If you only want the ID's of the assets you can also use GetDLCMigrated(Action<LootLockerDlcResponse> onComplete).
| onComplete | onComplete Action for handling the response of type LootLockerDlcResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
List character inventory with minimal response data.
Due to looking up less data, this endpoint is significantly faster than GetInventory.
| request | Request object containing filters and optional metadata includes. To include metadata in the response, assign request.includes.metadata to a LootLockerListSimplifiedInventoryMetadataIncludes instance:
|
| characterId | Optional : Filter inventory by character ID. |
| perPage | Optional : Number of items per page. |
| page | Optional : Page number to retrieve. |
| onComplete | onComplete Action for handling the response |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
List character inventory with default parameters (no filters, first page, default page size).
| onComplete | onComplete Action for handling the response |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
List information for one or more other players.
| playerIdsToLookUp | A list of ULID ids of players to look up. These ids are in the form of ULIDs and are sometimes called player_ulid or similar |
| playerLegacyIdsToLookUp | A list of legacy ids of players to look up. These ids are in the form of integers and are sometimes called simply player_id or id |
| playerPublicUidsToLookUp | A list of public uids to look up. These ids are in the form of UIDs. |
| onComplete | Action for handling the response |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
List player inventory with minimal response data.
Due to looking up less data, this endpoint is significantly faster than GetInventory.
| request | Request object containing filters and optional metadata includes. To include metadata in the response, assign request.includes.metadata to a LootLockerListSimplifiedInventoryMetadataIncludes instance:
|
| perPage | Optional : Number of items per page. |
| page | Optional : Page number to retrieve. |
| onComplete | onComplete Action for handling the response |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
List player inventory with default parameters (no filters, first page, default page size).
| onComplete | onComplete Action for handling the response |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get players 1st party platform ID's from the provided list of playerID's.
| playerPublicUIds | A list of multiple player public UID's |
| onComplete | onComplete Action for handling the response of type Player1stPartyPlatformIDsLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get players 1st party platform ID's from the provided list of playerID's.
| playerIds | A list of multiple player ID's |
| onComplete | onComplete Action for handling the response of type Player1stPartyPlatformIDsLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by Epic Games ID's.
| epicGamesIds | A list of multiple player Epic Games ID's |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by Google Play Games ID's.
| googlePlayGamesIds | A list of multiple player Google Play Games ID's |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by public playerID's.
| guestLoginIds | A list of guest login ids |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by playerID's.
| playerIds | A list of multiple player ID's< |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by public playerID's.
| playerNames | A list of player names |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by public playerID's.
| playerPublicUIds | A list of multiple player public UID's |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by public playerID's.
| playerUlids | A list of player ulids |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by PSN ID's.
| psnIds | A list of multiple player PSN ID's |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by PSN ID's.
| psnIds | A list of multiple player PSN ID's |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by Steam ID's.
| steamIds | A list of multiple player Steam ID's |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by steam ID's.
| steamIds | A list of multiple player Steam ID's |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Get player names and important ids of a set of players from their last active platform by Xbox ID's.
| xboxIds | A list of multiple player XBOX ID's |
| onComplete | onComplete Action for handling the response of type PlayerNameLookupResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Set the logged in players name.
Max length of a name is 255 characters.
| name | The name to set to the currently logged in player |
| onComplete | onComplete Action for handling the response of type PlayerNameResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Set the players profile to be private.
This means that their inventory will not be displayed publicly on Steam and other places.
| onComplete | onComplete Action for handling the response of type LootLockerStandardResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
|
inlinestatic |
Set the players profile to public.
This means that their inventory will be displayed publicly on Steam and other places.
| onComplete | onComplete Action for handling the response of type LootLockerStandardResponse |
| forPlayerWithUlid | Optional : Execute the request for the specified player. If not supplied, the default player will be used. |
Functions | |
| static void | LootLocker.Requests.LootLockerSDKManager.GetCurrentPlayerInfo (Action< LootLockerGetCurrentPlayerInfoResponse > onComplete, string forPlayerWithUlid=null) |
| Get information about the currently logged in player such as name and different ids to use for subsequent calls to LootLocker methods. | |
| static void | LootLocker.Requests.LootLockerSDKManager.ListPlayerInfo (string[] playerIdsToLookUp, int[] playerLegacyIdsToLookUp, string[] playerPublicUidsToLookUp, Action< LootLockerListPlayerInfoResponse > onComplete, string forPlayerWithUlid=null) |
| List information for one or more other players. | |
| static void | LootLocker.Requests.LootLockerSDKManager.GetInventory (int count, int after, Action< LootLockerInventoryResponse > onComplete, string forPlayerWithUlid=null) |
| Get the players inventory. | |
| static void | LootLocker.Requests.LootLockerSDKManager.GetInventory (Action< LootLockerInventoryResponse > onComplete, string forPlayerWithUlid=null) |
| Get the players inventory. | |
| static void | LootLocker.Requests.LootLockerSDKManager.GetInventory (int count, Action< LootLockerInventoryResponse > onComplete, string forPlayerWithUlid=null) |
| Get the players inventory. | |
| static void | LootLocker.Requests.LootLockerSDKManager.ListPlayerInventoryWithDefaultParameters (Action< LootLockerSimpleInventoryResponse > onComplete, string forPlayerWithUlid=null) |
| List player inventory with default parameters (no filters, first page, default page size). | |
| static void | LootLocker.Requests.LootLockerSDKManager.ListPlayerInventory (LootLockerListSimplifiedInventoryRequest request, int perPage, int page, Action< LootLockerSimpleInventoryResponse > onComplete, string forPlayerWithUlid=null) |
| List player inventory with minimal response data. | |
| static void | LootLocker.Requests.LootLockerSDKManager.ListCharacterInventoryWithDefaultParameters (Action< LootLockerSimpleInventoryResponse > onComplete, string forPlayerWithUlid=null) |
| List character inventory with default parameters (no filters, first page, default page size). | |
| static void | LootLocker.Requests.LootLockerSDKManager.ListCharacterInventory (LootLockerListSimplifiedInventoryRequest request, int characterId, int perPage, int page, Action< LootLockerSimpleInventoryResponse > onComplete, string forPlayerWithUlid=null) |
| List character inventory with minimal response data. | |
| static void | LootLocker.Requests.LootLockerSDKManager.GetBalance (Action< LootLockerBalanceResponse > onComplete, string forPlayerWithUlid=null) |
| Get the amount of credits/currency that the player has. | |
| static void | LootLocker.Requests.LootLockerSDKManager.GetAssetNotification (Action< LootLockerPlayerAssetNotificationsResponse > onComplete, string forPlayerWithUlid=null) |
| Get assets that have been given to the currently logged in player since the last time this endpoint was called. | |
| static void | LootLocker.Requests.LootLockerSDKManager.GetDeactivatedAssetNotification (Action< LootLockerDeactivatedAssetsResponse > onComplete, string forPlayerWithUlid=null) |
| Get asset deactivations for the currently logged in player since the last time this endpoint was called. | |
| static void | LootLocker.Requests.LootLockerSDKManager.InitiateDLCMigration (Action< LootLockerDlcResponse > onComplete, string forPlayerWithUlid=null) |
| Initiate DLC Migration for the player: https://docs.lootlocker.com/background/live-ops-tools#dlc-migration 5 minutes after calling this endpoint you should issue a call to the Player Asset Notifications call to get the results of the migrated DLC, if any. | |
| static void | LootLocker.Requests.LootLockerSDKManager.GetDLCMigrated (Action< LootLockerDlcResponse > onComplete, string forPlayerWithUlid=null) |
| Get a list of DLC's migrated for the player. | |
| static void | LootLocker.Requests.LootLockerSDKManager.SetProfilePrivate (Action< LootLockerStandardResponse > onComplete, string forPlayerWithUlid=null) |
| Set the players profile to be private. | |
| static void | LootLocker.Requests.LootLockerSDKManager.SetProfilePublic (Action< LootLockerStandardResponse > onComplete, string forPlayerWithUlid=null) |
| Set the players profile to public. | |
| static void | LootLocker.Requests.LootLockerSDKManager.GetPlayerName (Action< PlayerNameResponse > onComplete, string forPlayerWithUlid=null) |
| Get the logged in players name. | |
| static void | LootLocker.Requests.LootLockerSDKManager.SetPlayerName (string name, Action< PlayerNameResponse > onComplete, string forPlayerWithUlid=null) |
| Set the logged in players name. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayer1stPartyPlatformIds (ulong[] playerIds, Action< Player1stPartyPlatformIDsLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get players 1st party platform ID's from the provided list of playerID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayer1stPartyPlatformIds (string[] playerPublicUIds, Action< Player1stPartyPlatformIDsLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get players 1st party platform ID's from the provided list of playerID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByPlayerIds (ulong[] playerIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by playerID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByPlayerPublicUIds (string[] playerPublicUIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by public playerID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByPlayerUlids (string[] playerUlids, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by public playerID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByGuestLoginIds (string[] guestLoginIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by public playerID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByPlayerNames (string[] playerNames, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by public playerID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesBySteamIds (ulong[] steamIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by steam ID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesBySteamIds (string[] steamIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by Steam ID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByPSNIds (ulong[] psnIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by PSN ID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByPSNIds (string[] psnIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by PSN ID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByXboxIds (string[] xboxIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by Xbox ID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByEpicGamesIds (string[] epicGamesIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by Epic Games ID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.LookupPlayerNamesByGooglePlayGamesIds (string[] googlePlayGamesIds, Action< PlayerNameLookupResponse > onComplete, string forPlayerWithUlid=null) |
| Get player names and important ids of a set of players from their last active platform by Google Play Games ID's. | |
| static void | LootLocker.Requests.LootLockerSDKManager.DeletePlayer (Action< LootLockerResponse > onComplete, string forPlayerWithUlid=null) |
| Mark the logged in player for deletion. | |