Game Progressions

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.

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.

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.

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).

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.