Class Progressions

Class progressions are progressions that the Class is currently on, your game may have many progressions but the Class doesn't necessarily progress through all of them at a given time, some may need to be unlocked or may be mutually exclusive.

Starting a Class on a progression is as easy as just starting to add points to it. That progression will then be listed when retrieving progressions for that Class.

Retrieving Class Progressions

Retrieving a single Class Progression using the progression key

int characterId = 1;
string progressionKey = "mage";

LootLockerSDKManager.GetCharacterProgression(characterId, progressionKey, response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }
    
    // Output the character level and show how much points are needed to progress to the next tier
    Debug.Log($"The character is currently level {response.step}");
    if (response.next_threshold != null)
    {
        Debug.Log($"Points needed to reach next level: {response.next_threshold - response.points}");
    }
});

Retrieving all Class Progressions

int characterId = 1;

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

    // Output the character level and show how much points are needed to progress to the next tier for all character progressions
    foreach (var characterProgression in response.items)
    {
        Debug.Log($"Current level in {characterProgression.progression_name} is {characterProgression.step}");
        if (characterProgression.next_threshold != null)
        {
            Debug.Log($"Points needed to reach next level in {characterProgression.progression_name}: {characterProgression.next_threshold - characterProgression.points}");
        }
    }
});

Retrieving Class Progressions using count

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

int characterId = 1;
int count = 20;

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

    // Output the character level and show how much points are needed to progress to the next tier for all character progressions
    foreach (var characterProgression in response.items)
    {
        Debug.Log($"Current level in {characterProgression.progression_name} is {characterProgression.step}");
        if (characterProgression.next_threshold != null)
        {
            Debug.Log($"Points needed to reach next level in {characterProgression.progression_name}: {characterProgression.next_threshold - characterProgression.points}");
        }
    }
});

Paginating through Class Progressions

You can use "after" parameter to paginate if the Class is on many progressions.

int characterId = 1;
int numberOfItemsPerPage = 10;
LootLockerPaginatedCharacterProgressionsResponse characterProgressions;

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

            if (response.pagination.total == 0)
            {
                Debug.Log("You character does not have any progressions, start them by giving some exp to the character");
            }

            characterProgressions = response;
        });
    });
}

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

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

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

Above is an example of how to implement retrieval of multiple character 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, look here.

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.

You also need to supply the id of the character for which you want to retrieve the progression.

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:

Trigger the GetCharacterProgressions 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 GetCharacterProgressions calls to "offset" the call to start at the next progression item after the ones you've already received.
Trigger the GetCharacterProgressions 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.
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.

Interacting with Class Progressions

Adding points to a Class Progression

int characterId = 1;
string progressionKey = "mage";
ulong amountOfPoints = 100;

LootLockerSDKManager.AddPointsToCharacterProgression(characterId, progressionKey, amountOfPoints, response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }

    // If the awarded_tiers array contains any items that means the character leveled up
    // There can also be multiple level-ups at once
    if (response.awarded_tiers.Any())
    {
        foreach (var awardedTier in response.awarded_tiers)
        {
            Debug.Log($"Reached level {awardedTier.step}!");

            foreach (var assetReward in awardedTier.rewards.asset_rewards)
            {
                Debug.Log($"Rewarded with an asset, id: {assetReward.asset_id}!");
            }
            
            foreach (var progressionPointsReward in awardedTier.rewards.progression_points_rewards)
            {
                Debug.Log($"Rewarded with {progressionPointsReward.amount} bonus points in {progressionPointsReward.progression_name} progression!");
            }
            
            foreach (var progressionResetReward in awardedTier.rewards.progression_reset_rewards)
            {
                Debug.Log($"Progression {progressionResetReward.progression_name} has been reset as a reward!");
            }
        }
    }
});

Subtracting points from a Class Progression

int characterId = 1;
string progressionKey = "mage";
ulong amountOfPoints = 10;

LootLockerSDKManager.SubtractPointsFromCharacterProgression(characterId, progressionKey, amountOfPoints, response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }
    
    // Output the amount of points the character has after subtracting points
    Debug.Log($"Character now has {response.points} points in {response.progression_name} progression");
});

Resetting a Class Progression

Resets the Class Progression points to 0, effectively returning the Class to level 1, if you want to remove the progression from a Class see below.

int characterId = 1;
string progressionKey = "mage";

LootLockerSDKManager.ResetCharacterProgression(characterId, progressionKey, response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }
    
    // Character level is now 1 
    Debug.Log($"Character is level {response.step} since the {response.progression_name} was reset");
});

Deleting a Class Progression

Completely removes a Class Progression, it will no longer be listed when retrieving Class Progressions.

int characterId = 1;
string progressionKey = "mage";

LootLockerSDKManager.DeleteCharacterProgression(characterId, progressionKey, response =>
{
    if (!response.success) {
        Debug.Log("Failed: " + response.Error);
    }
    
    // Trying to fetch the deleted character progression will result in a "Not Found" error
    LootLockerSDKManager.GetCharacterProgression(progressionKey, response =>
    {
        if (!response.success) {
            Debug.Log("Failed: " + response.Error);
        }
    }
});

PreviousPlayer Progressions NextAsset Instance Progressions

Last updated 1 year ago