Asset Instance Progressions
Asset instance progressions are progressions that track the progressions of Assets.
Starting an Asset instance 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 Asset.
Retrieving Asset instance progressions
Retrieving a single Asset instance progression using the progression key
int assetInstanceId = 1;
string progressionKey = "mage";
LootLockerSDKManager.GetAssetInstanceProgression(assetInstanceId, progressionKey, response =>
{
if (!response.success) {
Debug.Log("Failed: " + response.Error);
}
// Output the asset instance level and show how much points are needed to progress to the next tier
Debug.Log($"The asset instance is currently level {response.step}");
if (response.next_threshold != null)
{
Debug.Log($"Points needed to reach next level: {response.next_threshold - response.points}");
}
});
Above is an example of how to implement retrieval of a single asset instance progression using blueprints in Unreal Engine.
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.
You also need to supply the id of the asset instance for which you want to retrieve the progression.
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. It also provides properties that tell you the place in the progression ladder, among that current amount of points, the previous threshold (points needed to achieve this level), next threshold (points needed to achieve next level), step (number of points between levels), as well as the date of the last level up.
Retrieving all Asset instance progressions
Above is an example of how to implement retrieval of multiple asset instance progressions using blueprints in Unreal Engine.
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 asset instance for which you want to retrieve the progressions from.
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 progressions as well as pagination data (for information on how to use that see the section on it). The returned progressions contain the needed information on each progression that you may want to use for display or flow control.
Retrieving Asset instance progressions using count
Count can be used to limit the number of entries returned.
Above is an example of how to implement retrieval of multiple asset instance progressions supplying a count to limit the number of progressions to receive using blueprints in Unreal Engine.
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 asset instance for which you want to retrieve the progression from.
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.
Paginating through Asset instance progressions
You can use "after" parameter to paginate if the Asset instance is on many progressions.
Above is an example of how to implement retrieval of multiple asset instance 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.
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 asset instance for which you want to retrieve the progression from.
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 GetInstanceProgressions node with a count parameter of 10.
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.
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 GetInstanceProgressions calls to "offset" the call to start at the next progression item after the ones you've already received.
Trigger the GetInstanceProgressions 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.
Use the 10 new progression items returned as you want. Note that this time it is progressions 11-20 of your 50 progressions.
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 Asset instance progressions
Adding points to an Asset instance progression
Above is an example of how to add points to an asset instance progression using blueprints in Unreal Engine.
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 asset instance for which you want to retrieve the progression from.
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.
The node also requires you to supply an amount of points to add to the progression.
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 the current state of the progression, like when getting a single progression. It also contains a list of all the awards received after the points were added.
Subtracting points from an asset instance progression
Above is an example of how to subtract points from an asset instance progression using blueprints in Unreal Engine.
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 asset instance for which you want to retrieve the progression.
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.
The node also requires you to supply points to subtract from the progression.
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 the current state of the progression, like when getting a single progression. It also contains a list of all the awards received after the points were subtracted.
Resetting an asset instance progression
Resets the asset instance progression points to 0, effectively returning the asset instance to level 1, if you want to remove the progression from a asset instance see below.
Above is an example of how to reset an instance progression progression using blueprints in Unreal Engine.
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 asset instance for which you want to retrieve the progression.
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 contains the current state of the progression, like when getting a single progression. It also contains a list of all the awards received after the points were subtracted.
Deleting an asset instance progression
Completely removes an asset instance progression, it will no longer be listed when retrieving asset instance progressions.
Above is an example of how to delete an asset instance progression using blueprints in Unreal Engine.
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 asset instance for which you want to retrieve the progression.
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.
Last updated