Use Player Progressions

This how-to retrieves a Player's Progressions in your game, and adds, subtracts, resets, or deletes their points on a Progression.

Prerequisites

Unity, Unreal, or Godot SDK installed and configured in your project (not required for REST).
An active Player session (see Authentication).
At least one Progression created in the Web Console.

Start a Player Progression

A Player is started on a Progression the moment you add points to it — you don't need to create the association separately. Your game may define many Progressions, and a Player only progresses through the ones they've started.

The Unity SDK also provides a RegisterPlayerProgression method to explicitly start a Player on a Progression without adding points yet.

string progressionKey = "global_exp";

LootLockerSDKManager.RegisterPlayerProgression(progressionKey, (response) =>
{
    if(!response.success)
    {
        Debug.Log("Error registering progression!");
        Debug.Log(response.errorData.ToString());
        return;
    }

    Debug.Log("Progression registered successfully!");
});

Retrieve Player Progressions

Get a Single Player Progression

string progressionKey = "mage";

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

    // Output the player level and show how much points are needed to progress to the next tier
    Debug.Log($"The player is currently level {response.step}");
    if (response.next_threshold != null)
    {
        Debug.Log($"Points needed to reach next level: {response.next_threshold - response.points}");
    }
});

See the Reference Documentation for the full response.

Get All Player Progressions

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

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

See the Reference Documentation for the full response.

Get All Player Progressions Using Count

Count limits the number of entries returned.

int count = 20;

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

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

See the Reference Documentation for the full response.

Paginate Player Progressions

Use the After parameter to paginate if the Player is on many Progressions.

int numberOfItemsPerPage = 10;
LootLockerPaginatedPlayerProgressionsResponse playerProgressions;

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

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

            playerProgressions = response;
        });
    });
}

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

    // Fetch the next page if more player progressions exist
    if (Input.GetKeyDown(KeyCode.RightArrow) && playerProgressions.pagination.next_cursor != null)
    {
        LootLockerSDKManager.GetPlayerProgressions(numberOfItemsPerPage, playerProgressions.pagination.next_cursor, response =>
        {
            if (!response.success)
            {
                Debug.Log("Failed: " + response.Error);
            }

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

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

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

See the Reference Documentation for the full response.

Update Player Progressions

Add Points to a Player Progression

If the Player levels up, the awarded_tiers field contains the Rewards acquired.

string progressionKey = "mage";
ulong amountOfPoints = 100;

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

    // If the awarded_tiers array contains any items that means the player 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!");
            }
        }
    }
});

See the Reference Documentation for the full response.

Subtract Points from a Player Progression

string progressionKey = "mage";
ulong amountOfPoints = 10;

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

    // Output the amount of points the player has after subtracting points
    Debug.Log($"Player now has {response.points} points in {response.progression_name} progression");
});

See the Reference Documentation for the full response.

Reset a Player Progression

Resets the Player's points on the Progression to 0, returning them to level 1. To remove the Progression from the Player entirely, see Delete a Player Progression below.

string progressionKey = "mage";

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

    // Player level is now 1
    Debug.Log($"Player is level {response.step} since the {response.progression_name} was reset");
});

See the Reference Documentation for the full response.

Delete a Player Progression

Completely removes a Player Progression — it's no longer listed when retrieving the Player's Progressions.

string progressionKey = "mage";

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

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

See the Reference Documentation for the full response.

Conclusion

You've retrieved a Player's Progressions and updated their points from your game. Next, explore Character Class Progressions or Asset Instance Progressions if your game also tracks progress on those holders.