LootLocker Unreal SDK 10.4.0
Game backend SDK for Unreal Engine
Loading...
Searching...
No Matches
LootLocker Unreal SDK — API Reference

LootLocker is a game backend-as-a-service that ships fully-managed, cross-platform systems so your team can focus on making the game instead of maintaining infrastructure. This reference covers every public method and type in the C++ SDK.


Quick Start

1. Install

Add the plugin to your project's Plugins/ folder or install from the Unreal Marketplace. Enable the LootLockerSDK plugin in Edit → Plugins.

2. Configure

Open Edit → Project Settings → LootLocker SDK and paste your Game API Key from the LootLocker console.

3. Start a session

ULootLockerSDKManager::StartGuestSession(
FLootLockerSessionResponse::CreateLambda([](FLootLockerGuestSessionResponse Response)
{
if (!Response.success)
{
UE_LOG(LogTemp, Warning, TEXT("Session failed: %s"), *Response.ErrorData.Message);
return;
}
UE_LOG(LogTemp, Log, TEXT("Session started for player: %s"), *Response.player_ulid);
})
);

All SDK calls are static methods on ULootLockerSDKManager and return results asynchronously via a delegate callback whose first argument derives from FLootLockerResponse. Check Response.success before accessing the payload fields.


Navigating This Reference

The Topics tab (left sidebar or top nav) is the recommended entry point. Methods are grouped by feature — start there to find everything related to a particular system without needing to know which class or file it lives in.

Topic What it covers
Initialization Set up and configure the SDK before starting a session.
Multi-User Management Manage multiple simultaneous player sessions on a single device.
Authentication Start and end player sessions via Guest, Platform, or White Label login.
White Label Login Custom email/password account system built into your game.
Remote Sessions Log in to a different platform than the one you are currently playing on.
Connected Accounts Link multiple platform accounts together under a single LootLocker player identity.
Presence Track when and how players are active across all platforms in real time.
Friends Cross-platform friend list — send, accept, and manage friend requests.
Followers One-way player subscriptions — follow without requiring approval.
Player Retrieve and manage the current player's profile, name, and identifiers.
Player Files CDN-backed file storage scoped to a player's profile.
Player Progressions Award points and read tier state for a player's progressions.
Player Storage Simple key-value store scoped to the player.
Hero Create and manage hero instances for the current player.
Character Progressions Award points and read tier state for a character's progressions.
Currency Define and query the virtual currency types in your game's economy.
Balances Read and adjust a player's wallet balances for each currency.
Catalog Browse item listings and prices in the LootLocker storefront catalog.
Purchasing Initiate and validate purchases — both real-money (IAP) and virtual-currency.
Entitlements Inspect a player's purchase history and individual transaction statuses.
Drop Tables Evaluate weighted loot rolls from a Drop Table asset and claim the results.
Assets Browse and filter the asset catalogue defined in the LootLocker console.
Asset Instances Access and manage asset instances in the current player's inventory.
Asset Instance Progressions Progression tracking scoped to a specific asset instance.
User-Generated Content (UGC) Create, edit, and publish player-authored assets.
Collectables Collectable items — groups, items, and player collection state.
Progressions Configure and query the shared progression infrastructure.
Leaderboards Rank players or any custom key by score, with optional resets and rewards.
Missions Time-limited challenges with completion tracking.
Maps Retrieve map configurations and node data.
Triggers Invoke named trigger events that grant server-configured rewards.
Metadata Attach and retrieve typed key-value metadata on any LootLocker entity.
Messages Read player inbox messages from the LootLocker console.
Notifications Poll and acknowledge queued event notifications generated by other SDK systems.
Broadcasts Fetch scheduled, localizable messages published from the LootLocker console.
Reports Submit player-generated moderation reports to LootLocker.
Feedback Submit player, UGC, or game-level reports to LootLocker's moderation system.
Miscellaneous Utilities Helpers that don't fit neatly into a feature group.

Response Conventions

Every callback receives a response struct deriving from FLootLockerResponse :

Field Type Meaning
success bool true if the call succeeded
StatusCode int32 HTTP status (200, 401, 422, …)
ErrorData FLootLockerErrorData Populated on failure
Context FLootLockerRequestContext Contains contextual information about the request such as who it was made for and the ID of the request
FullTextFromServer FString Raw JSON body (useful for debugging)

Always check Response.success first. Never access payload fields if success is false.


Multi-Player Device Support

The SDK can maintain independent sessions for multiple players on the same device (local co-op or couch multiplayer). Each call accepts an optional PlayerUlid parameter. Use Multi-User Management to enumerate cached players and switch the default player.


Useful Links