LootLocker
The BasicsGame SystemsContent ManagementPlayer Management
LootLocker
  • 📌The Basics
    • Getting Started
    • What is LootLocker?
    • Core Concepts
      • Players
      • Assets
      • Character Classes
      • API Types
      • Web Console
      • Stage & Live Environments
      • Glossary
    • Unity Quick Start
      • Install the SDK
      • Configure the SDK
      • Authenticate Your First Player
      • Update the SDK
    • Unreal Quick Start
      • Install & Configure the SDK
        • Older versions
      • Authenticate Your First Player
    • Godot Quick Start
      • Install the SDK
      • Configure the SDK
      • Authenticate Your First Player
      • Update the SDK
    • SDKs
    • Samples
      • Authentication Samples
      • Leaderboard Samples
      • Progression Samples
      • Player Samples
    • Launching Your Game
    • Support
      • Error Codes
      • Unreal Marketplace Plugin Support
  • 🎭Players
    • Overview
    • Authentication
      • How To
        • Guest Login
        • Steam
        • Apple
        • Apple Game Center
        • Google
        • Epic Games
        • PlayStation
        • Meta / Oculus
        • Xbox
        • Nintendo Switch
    • Files
      • How To
        • Manage Files in Web Console
        • Work with Files In-Game
    • Inventory
      • How To
        • Work with Player Inventory
    • Messages
      • How To
        • Configure Messages in Web Console
    • Names
      • How To
        • Work with Player Names
    • Player Manager
      • How To
        • Manage Players through Web Console
        • Manage Players In-Game
        • Use Player Operations
    • Unified Player Accounts
      • How To
        • Configure UPA in Web Console
        • Use Remote Login In-Game
        • Connect Identiy Provider to Player
        • External Provider Linking
        • Transition from Guest Login to Other Provider
        • Disconnect Identity Provider from Player
    • White Label Login
      • How To
        • Configure White Label Login
        • Create a New White Label User
        • Request User Verification
        • Handle Returning Users
        • Start a White Label Session
  • 🪙Commerce
    • Overview
    • Catalogs
      • How To
        • Configure Catalogs in LootLocker Console
        • List all Catalogs
        • Use Catalogs In-Game
        • Setup In-Game Store
    • Currencies
      • How To
        • Configure a Currency in Web Console
        • Use Currencies In-Game
    • DLC Management
      • How To
        • Configure DLC in Web Console
        • Use DLC In-Game
    • Entitlements
      • How To
        • Work with Entitlements In-Game
    • Real Money Purchases
      • How To
        • Configure In-App Purchase in Web Console
        • Make Purchases through Google Play Store
        • Make Purchases through Apple Store
        • Make Purchases through Steam Store
    • Virtual Purchases
    • Wallets
      • How To
        • Manage a Wallet in Web Console
        • Use Wallets In-Game
  • ⚔️Content
    • Overview
    • Assets
      • How To
        • Create & Configure an Asset
        • Organize & Search for Assets
        • Retrieve Assets In-Game
        • Set up Asset Storage Template
        • Check Grant Notifications
        • Set up a Game Config Asset
        • Create a Loot Box
        • Work with Loot Boxes In-Game
        • Create a Drop Table
        • Work with Drop Tables In-Game
        • Create a Rental Asset
        • Work with Rental Assets In-Game
    • User Generated Content (UGC)
      • How To
        • Create UGC In-Game
    • Twitch Drops
  • 🕹️Game Systems
    • Overview
    • Classes & Heroes
      • How To
        • Base Classes
        • Hero Classes
        • Implement Classes In-Game
        • Implement Heroes In-Game
    • Leaderboards
      • How To
        • Configure Leaderboard in Web Console
        • Use Player Leaderboards
        • Use Generic Leaderboards
        • Use Metadata to Store Additional Information
        • Use Scheduled Reset with Rewards
        • Use Leaderboards for Time Based Rankings
      • Leaderboard FAQ
      • GameMaker References
    • Feedback
      • How To
        • Manage Feedback Categories
        • Create Player Feedback
        • Create UGC Feedback
        • Create Game Feedback
        • View and Manage Feedback
    • Progressions
      • How To
        • Create a Progression
        • Game Progressions
        • Player Progressions
        • Class Progressions
        • Asset Instance Progressions
    • Triggers
      • How To
        • Setup a trigger in the Web Console
        • Invoke trigger from game
  • ⛓️Shared Systems
    • Overview
    • Metadata
      • How To
        • Add Metadata in Console
        • Fetch a Single Metadata In-Game
        • Fetch Metadata In-Game by Tags
        • Fetch Metadata In-Game from Multiple Sources
    • Notifications
      • How To
        • List Notifications and Mark as Read In-Game
  • 🗝️Admin
    • Settings
    • User Settings
    • Organization Settings
    • CORS Allowlist
  • ⭕️ Legacy
    • Deprecations
      • Unity SDK Deprecation Log
        • Version 2.1.5 - Migration to Open UPM
        • Version 2.0.0
      • Unreal SDK Deprecation Log
        • Version 4.0.0
        • Version 3.0.0
    • Legacy Storage
    • Legacy Triggers
      • Activate a trigger
      • Create a trigger
    • Legacy Progressions
      • Create a Progression System
      • Use a Progression System In-Game
Powered by GitBook
On this page
  • Retrieving progressions
  • Retrieving progression tiers
  1. Game Systems
  2. Progressions
  3. How To

Game Progressions

PreviousCreate a ProgressionNextPlayer Progressions

Last updated 1 year ago

Game progressions are all of the progressions defined for your game in the Web Console.

You can create as many progressions with as many tiers and rewards as your game needs, go wild!

This section shows you how to fetch progressions, tiers and rewards in your game.

Retrieving progressions

Retrieving a single progression using the progression key

string progressionKey = "mage";

LootLockerSDKManager.GetProgression(progressionKey, response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }
    
    // Output the name of the fetched progression
    Debug.Log(response.name);
});

Above is an example of how to implement retrieval of a single progression using blueprints in Unreal Engine. For an example you can copy and paste into your editor, .

Input

You need to exchange the trigger with an event that you want to trigger the flow. For example a button click or xp gain.

Progression Key is required for this node so connect it from a variable or remove the reroute node and hard code a value in the node.

Output

We recommend branching the completed event on the success flag, and if you do this you will probably want to add error handling in case the request fails.

The retrieved progression provides the id, key, and name of the progression as well as a boolean telling you if the progression is active or not.

Retrieving all progressions

LootLockerSDKManager.GetProgressions(response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }

    if (!response.items.Any())
    {
        Debug.Log("Your game does not have any progressions, login to your LootLocker web console and create some");
    }
    
    // Output the name for all progressions
    foreach (var progression in response.items)
    {
        Debug.Log(progression.name);
    }
});

Input

You need to exchange the trigger with an event that you want to trigger the flow. For example a button click or level start.

Output

We recommend branching the completed event on the success flag, and if you do this you will probably want to add error handling in case the request fails.

Retrieving all progressions using count

Count can be used to limit the number of entries returned.

int count = 20;

LootLockerSDKManager.GetProgressions(count, response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }

    if (!response.items.Any())
    {
        Debug.Log("Your game does not have any progressions, login to your LootLocker web console and create some");
    }
    
    // Output the name for all progressions
    foreach (var progression in response.items)
    {
        Debug.Log(progression.name);
    }
});

Paginating through progressions

You can use "after" parameter to paginate if your game has many progressions.

int numberOfItemsPerPage = 10;
LootLockerPaginatedProgressionsResponse progressions;

void Start()
{
    LootLockerSDKManager.StartGuestSession(_ =>
    {
        // Fetch the initial progressions list
        LootLockerSDKManager.GetProgressions(numberOfItemsPerPage, response =>
        {
            if (!response.success)
            {
                Debug.Log("Failed: " + response.Error);
            }

            if (response.pagination.total == 0)
            {
                Debug.Log("You game does not have any progressions, login to your LootLocker web console and create some");
            }

            progressions = response;
        });
    });
}

void Update()
{
    if (progressions == null) return;

    // Fetch the next page if more progressions exist
    if (Input.GetKeyDown(KeyCode.RightArrow) && progressions.pagination.next_cursor != null)
    {
        LootLockerSDKManager.GetProgressions(numberOfItemsPerPage, progressions.pagination.next_cursor, response =>
        {
            if (!response.success)
            {
                Debug.Log("Failed: " + response.Error);
            }
            
            progressions = response;
            Debug.Log($"Paginating right, got {progressions.items.Count} progressions");
        });
    }

    // Fetch the previous page if we are not on the first page
    if (Input.GetKeyDown(KeyCode.LeftArrow) && progressions.pagination.previous_cursor != null)
    {
        LootLockerSDKManager.GetProgressions(numberOfItemsPerPage, progressions.pagination.previous_cursor, response =>
        {
            if (!response.success)
            {
                Debug.Log("Failed: " + response.Error);
            }

            progressions = response;
            Debug.Log($"Paginating left, got {progressions.items.Count} progressions");
        });
    }
}

Input

You need to exchange the trigger with an event that you want to trigger the flow. For example a button click or level start.

To use pagination you should supply a value to the after parameter and optionally a value to the count parameter. For an explanation, see below.

Output

We recommend branching the completed event on the success flag, and if you do this you will probably want to add error handling in case the request fails.

The response contains a list of progressions. The returned progressions contain the needed information on each progression that you may want to use for display or flow control.

The response also contains pagination data which you use as follows.

Usage example

Understanding pagination for the first time can be a challenge. So an example can help.

Say you have 50 progressions to receive. You can do this with pagination like this:

  1. Trigger the GetProgressions node with a count parameter of 10.

    1. Use the 10 progression items returned as you want (for example display in the UI). Note that out of your 50 progressions, these are progressions 1-10.

    2. Save the returned pagination data to make the next request. The most important here is the "Next Cursor" property. This is the value that you need to submit to subsequent GetProgressions calls to "offset" the call to start at the next progression item after the ones you've already received.

  2. Trigger the GetProgressions node again with a count of 10 but now also input the value "Next Cursor" into the after parameter. This tells the node to start off where it finished last time.

    1. Use the 10 new progression items returned as you want. Note that this time it is progressions 11-20 of your 50 progressions.

    2. Again, save the returned pagination data so that you can make subsequent requests.

  3. Repeat step 2 with new values for "Next Cursor" until you have received all the progressions.

This is how you paginate. It may seem redundant in this example because you could just set Count to 50 and get everything at once. But imagine you have thousands of progressions with rewards of all kinds. Then this system is very valuable.

Retrieving progression tiers

Retrieving all progression tiers

string progressionKey = "mage";

LootLockerSDKManager.GetProgressionTiers(progressionKey, response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }
    
    // Output the progression tiers with levels, required points and rewards
    foreach (var progressionTier in response.items)
    {
        Debug.Log($"Level {progressionTier.step} requires {progressionTier.points_threshold} experience points");

        foreach (var assetReward in progressionTier.rewards.asset_rewards)
        {
            Debug.Log($"Reaching level {progressionTier.step} awards asset with id: {assetReward.asset_id}");
        }
        
        foreach (var progressionPointsReward in progressionTier.rewards.progression_points_rewards)
        {
            Debug.Log($"Reaching level {progressionTier.step} awards {progressionPointsReward.amount} points in {progressionPointsReward.progression_name} progression");
        }
        
        foreach (var progressionResetReward in progressionTier.rewards.progression_reset_rewards)
        {
            Debug.Log($"Reaching level {progressionTier.step} resets the {progressionResetReward.progression_name} progression");
        }
    }
});

Input

You need to exchange the trigger with an event that you want to trigger the flow. For example a button click or level start.

Progression Key is required for this node so connect it from a variable or remove the reroute node and hard code a value in the node.

Output

We recommend branching the completed event on the success flag, and if you do this you will probably want to add error handling in case the request fails.

The response is a list of progression tiers (what points they are awarded at and some data on the tier) as well as lists of all the rewards (point rewards, asset rewards, and reset rewards).

Retrieving all progression tiers using count

Count can be used to limit the number of entries returned.

string progressionKey = "mage";
int count = 20;

LootLockerSDKManager.GetProgressionTiers(progressionKey, count, response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }
    
    // Output the progression tiers with levels, required points and rewards
    foreach (var progressionTier in response.items)
    {
        Debug.Log($"Level {progressionTier.step} requires {progressionTier.points_threshold} experience points");

        foreach (var assetReward in progressionTier.rewards.asset_rewards)
        {
            Debug.Log($"Reaching level {progressionTier.step} awards asset with id: {assetReward.asset_id}");
        }
        
        foreach (var progressionPointsReward in progressionTier.rewards.progression_points_rewards)
        {
            Debug.Log($"Reaching level {progressionTier.step} awards {progressionPointsReward.amount} points in {progressionPointsReward.progression_name} progression");
        }
        
        foreach (var progressionResetReward in progressionTier.rewards.progression_reset_rewards)
        {
            Debug.Log($"Reaching level {progressionTier.step} resets the {progressionResetReward.progression_name} progression");
        }
    }
});

Paginating through progression tiers

You can use "after" parameter to paginate if your progression has many tiers.

string progressionKey = "mage";
int numberOfItemsPerPage = 10;
LootLockerPaginatedProgressionTiersResponse progressionTiers;

void Start()
{
    LootLockerSDKManager.StartGuestSession(_ =>
    {
        // Fetch the initial list of character progressions
        LootLockerSDKManager.GetProgressionTiers(progressionKey, numberOfItemsPerPage, response =>
        {
            if (!response.success)
            {
                Debug.Log("Failed: " + response.Error);
            }

            progressionTiers = response;
        });
    });
}

void Update()
{
    if (progressionTiers == null) return;

    // Fetch the next page if more tiers exist
    if (Input.GetKeyDown(KeyCode.RightArrow) && progressionTiers.pagination.next_cursor != null)
    {
        LootLockerSDKManager.GetProgressionTiers(progressionKey, numberOfItemsPerPage, progressionTiers.pagination.next_cursor, response =>
        {
            if (!response.success)
            {
                Debug.Log("Failed: " + response.Error);
            }
            
            progressionTiers = response;
            Debug.Log($"Paginating right, got {progressionTiers.items.Count} progression tiers");
        });
    }
    
    // Fetch the previous page if we are not on the first page
    if (Input.GetKeyDown(KeyCode.LeftArrow) && progressionTiers.pagination.previous_cursor != null)
    {
        LootLockerSDKManager.GetProgressionTiers(progressionKey, numberOfItemsPerPage, progressionTiers.pagination.previous_cursor, response =>
        {
            if (!response.success)
            {
                Debug.Log("Failed: " + response.Error);
            }

            progressionTiers = response;
            Debug.Log($"Paginating left, got {progressionTiers.items.Count} progression tiers");
        });
    }
}

Input

You need to exchange the trigger with an event that you want to trigger the flow. For example a button click or level start.

To use pagination you should supply a value to the after parameter and optionally a value to the count parameter. For an explanation, see below.

Output

We recommend branching the completed event on the success flag, and if you do this you will probably want to add error handling in case the request fails.

The response is a list of progression tiers (what points they are awarded at and some data on the tier) as well as lists of all the rewards (point rewards, asset rewards, and reset rewards).

The response also contains pagination data which you use as follows.

Usage example

Understanding pagination for the first time can be a challenge. So an example can help.

Say you have 50 progression tiers to receive. You can do this with pagination like this:

  1. Trigger the GetProgressionTiers node with a count parameter of 10.

    1. Use the 10 progression tier items returned as you want (for example display in the UI). Note that out of your 50 progressions tiers, these are progression tiers 1-10.

    2. Save the returned pagination data to make the next request. The most important here is the "Next Cursor" property. This is the value that you need to submit to subsequent GetProgressions calls to "offset" the call to start at the next progression tier item after the ones you've already received.

  2. Trigger the GetProgressionTiers node again with a count of 10 but now also input the value "Next Cursor" into the after parameter. This tells the node to start off where it finished last time.

    1. Use the 10 new progression tier items returned as you want. Note that this time it is progression tiers 11-20 of your 50 progression tiers.

    2. Again, save the returned pagination data so that you can make subsequent requests.

  3. Repeat step 2 with new values for "Next Cursor" until you have received all the progression tiers.

This is how you paginate. It may seem redundant in this example because you could just set Count to 50 and get everything at once. But imagine you have thousands of progression tiers with rewards of all kinds. Then this system is very valuable.

Above is an example of how to implement retrieval of multiple progressions using blueprints in Unreal Engine. For an example you can copy and paste into your editor, .

The response is a list of progressions as well as pagination data (for information on how to use that see ). The returned progressions contain the needed information on each progression that you may want to use for display or flow control.

Above is an example of how to implement retrieval of multiple progressions supplying a count to limit the number of progressions to receive and supplying a cursor into the after parameter to paginate using blueprints in Unreal Engine. For an example you can copy and paste into your editor, .

Above is an example of how to implement retrieval of progression tiers using blueprints in Unreal Engine. For an example you can copy and paste into your editor, .

The response also contains pagination data (for information on how to use that see ).

Above is an example of how to implement retrieval of progression tiers supplying a count to limit the number of progressioniers to receive and supplying a cursor into the after parameter to paginate using blueprints in Unreal Engine. For an example you can copy and paste into your editor, .

🕹️
look here
look here
look here
look here
the section on it
the section on it
look here
Blueprint example of how to retrieve a single progression using a progression key. To copy the example, see .
Blueprint example of how to retrieve multiple progressions. To copy the example, see .
Blueprint example of how to retrieve multiple progressions. To copy the example, see .
Blueprint example of how to retrieve progression tiers. To copy the example, see .
Blueprint example of how to retrieve multiple progressions. To copy the example, see
https://blueprintue.com/blueprint/vtb5usd-/
https://blueprintue.com/blueprint/vtb5usd-/
https://blueprintue.com/blueprint/ejcvqllv/
https://blueprintue.com/blueprint/_74ujs10/
https://blueprintue.com/blueprint/b29_k0yn/