The battle pass lets you increase player engagement by issuing rewards for completing quests or playing actively during the period of the battle pass.

A free battle pass with limited rewards is available to all players. The final reward is also not included in the free pass.

Additionally, the player can purchase a premium pass with all the rewards, including the final one.

Battle pass progress is divided into levels. To unlock new levels and have time to open the final reward before the battle pass expires, the player needs to gain the necessary experience or purchase the level.

The demo project provides an example of implementing a battle pass using Xsolla products. To try battle pass:

1. Start the Xsollus demo map.
2. Log in as a demo user or create a new user.
3. Click Battle pass in the side menu.

To adapt the battle pass for your project:

1. Add battle pass logic to your project.
2. Create a set of reward coupons.
3. Create a battle pass configuration.
4. Create a battle pass item.
5. Create a level-up item.

Ajouter la logique de passe de combat au projet

To add battle pass logic:

1. Copy the BP_BattlepassPanel and BP_StoreDemo blueprints with all dependencies into your project.
2. Change the interface (optional).
3. Modify the storing information logic.

Créer un ensemble de coupons de récompense

Rewards can be virtual items and virtual currency packages.

In the current solution, rewards are granted to a player via the coupon redemption. To create a coupon set:

1. Go to your project in Publisher Account.
2. Create virtual items and virtual currency packs for rewarding players.
3. For each reward set up a campaign with coupons using the following recommendations:

1. • Specify the number of redemptions per user as the planned amount of coupon redemption in the battle pass. One coupon can be redeemed multiple times as a part of the battle pass (e.g., at different battle pass levels, at premium and free versions).
   • The campaign must be valid for the same period as the battle pass.

To build the battle pass configuration, it is recommended that you create a list of rewards in advance and for each of them indicate:

• coupon code
• virtual item or virtual currency package SKU
• if the reward belongs to a specific level of the battle pass
• If the reward belongs to the free or premium version

Créer une configuration de passe de combat

The battle pass configuration is a JSON file containing:

• the name of the battle pass
• the expiry date of the battle pass
• the structure of the levels, indicating the rewards for the free and premium versions

JSON file structure:

Battle pass configuration example:

{
  "Name": "BP2021JAN",
  "ExpiryDate": "29-03-2021",
  "Levels": [
    {
      "Tier": 1,
      "Experience": 1000,
      "FreeItem": {
        "Sku": "Sku",
        "Quantity": 10,
        "Promocode": "HELLO_WORLD"
      },
      "PremiumItem": {
        "Sku": "Sku2",
        "Promocode": "HELLO_WORLD2"
      }
    },
    {
      "Tier": 2,
      "Experience": 1000
    },
    {
      "Tier": 3,
      "Experience": 1000
    }
  ]
}

Créer un passe de combat

The battle pass item is a container for the battle pass configuration and is used to determine the player’s premium status (whether the player has purchased a premium version).

To create a battle pass item:

1. Go to your project in Publisher Account.
2. Create a virtual item group named #BATTLEPASS#.

3. Create a virtual item with the following parameters:
   • Item name — the name of the battle pass specified in the configuration.
   • SKU — the battle pass ID. It is recommended to use the name of the battle pass specified in the configuration.
   • Item property — consumable or nonconsumable item.

1. • Price — the price of the premium version of the battle pass. It is set in virtual or real currency.

1. • Group — #BATTLEPASS#.

4. Add the battle pass configuration to the created virtual item:
   1. Get the current description of the item in a JSON format using the Get virtual item API call.
   2. Convert the battle pass configuration to a string using an online service or the JSON.stringify() method in JavaScript.
   3. In the item description, specify the resulting string in the en object of the long_description parameter.
   4. Modify the item using the Update virtual item API call, specifying the updated item description in the request body.

Example of the battle pass item description:

{
  "sku": "BP2021JAN",
  "name":{
    "en": "BP2021JAN"
  },
  "type": "virtual_good",
  "description":{
    "en": "BP2021JAN"
  },
  "image_url": "https://cdn3.xsolla.com/img/misc/images/7cb1c2b719af329a9bc1df994d58b749.png",
  "long_description": {
    "en": "{
                \"Name\":\"BP2021JAN\",
                \"ExpiryDate\":\"01-07-2021\",
                \"Levels\":
                    [
                        {
                            \"Tier\":1,
                            \"Experience\":100,
                            \"FreeItem\":
                                {
                                    \"Sku\":\"Bullets\",
                                    \"Promocode\":\"B2021S1FL1E100\",
                                    \"Quantity\":50
                                }
                        }
                    ]
            }"
  },
  "attributes":[
  ],
  "is_free": false,
  "order": 1,
  "groups":[
    "Battlepass"
  ],
  "regional_prices":[
  ],
  "prices":[
    {
      "amount": 1,
      "currency": "USD",
      "is_default": true,
      "is_enabled": true
    }
  ],
  "media_list":[
  ],
  "vc_prices":[
  ],
  "is_enabled": true,
  "is_show_in_store": true,
  "regions":[
  ],
  "inventory_options":{
    "consumable": false,
    "expiration_period": null
  }
}

Créer un objet de mise à niveau

The current battle pass solution lets players purchase levels for real or virtual currency. The price of a level is always the same. The experience the player gains within the current level is transferred to the next level.

To create a level-up item:

1. Go to your project in Publisher Account.
2. Create a virtual item with the following parameters:
   • Item name — the name of the level-up item in the format <battlepassname>_levelup_util, where <battlepassname> is the name of the battle pass specified in the configuration.
   • SKU — it is recommended to use the name of the battle pass specified in the configuration.
   • Item property — consumable or nonconsumable item.
   • Price — the price of a level. It is set in virtual or real currency.

1. • Group — #BATTLEPASS#.

Spécificités de la solution actuelle pour le passe de combat

Logique d'affichage du passe de combat

The application displays only one battle pass according to the logic:

• If one or more unexpired battle passes exist, the application displays the battle pass with the closest expiration date.
• If all battle passes are expired, the application displays the last expired battle pass.

EXAMPLE 1

Current date: 03/04/2021.

The expiration dates of the battle passes: 03/01/2021, 04/01/2021, 05/01/2021.

The application displays a battle pass with an expiration date of 04/01/2021.

EXAMPLE 2

Current date: 03/04/2021.

Expiration dates for battle passes: 02/01/2021, 03/01/2021.

The application displays a battle pass with an expiration date of 03/01/2021.

Logique de stockage des informations

In the current solution, all information about a player’s progress on a battle pass (level, experience, received rewards, etc.) is stored in the user-editable attributes. As part of the demo, reading and editing these attributes is available on the Character page.

If the system doesn’t find the required attribute, a new one is automatically created. If the system finds attributes for the not current battle pass, those attributes are automatically deleted.

To determine the premium status of a player, the presence of the battle pass item in the player’s inventory is checked.

The SDK includes a UI builder. The UI builder lets you configure the visuals of the application UI.

You can change the UI by editing global settings that affect UI elements’ visuals — color, texture, and font. These properties group into a theme.

To swap the UI elements of the same type, you can use the widget wrappers — containers for created UI elements.

The UI builder contains 2 independent parts:

• Themes are responsible for working with visuals.
• Widget manager is responsible for working with widgets and lets you replace whole parts of the UI.

Travailler avec les thèmes

Theme is a XsollaUtilsTheme type asset. It contains the list of colors, fonts, and textures that are used by the UI elements. Every list is a set of key-value pairs where the key is a unique name of a theme parameter, and the value is a corresponding color, font, or texture.

You can work with themes in Settings > Project Settings > Plugins > Xsolla Utils:

• To set the theme of the UI, select it in the Interface Theme field.
• To edit the selected theme, click the 🔎 icon near the Interface Theme field.

• To create a new theme, click the + icon near the Interface Theme field.
• To delete a selected theme, click the × icon near the Interface Theme field.

Connecter un élément de l'interface au thème

To connect the UI element to the theme:

1. In the UI element widget blueprint, get access to the theme by the following methods:
   • GetCurrentTheme — returns the current theme specified in the plug-in settings.
   • GetTheme — returns a theme by the name specified in the ThemeClass parameter.
2. Use the following methods to get the values of definite parameters from the theme by passing the theme parameter name to them:
   • GetColor — gets color value.
   • GetFont — gets font.
   • GetBrush — gets texture.

In the demo project, every widget that supports themes has a set of String type parameters with theme parameter names. These parameters are used for setting up a visual for the UI element.

To find examples of widgets that support themes, go to Content Browser > Xsolla Content > Common > Components > Primitives.

Travailler avec le gestionnaire de widgets

The widget manager is a mechanism that lets you automatically replace the UI elements with the UI elements of the same type by changing their visuals and behavior.

To create the UI that supports the widget manager, the following conditions should be met:

• Create a widget with the specified unified interface for the UI element.
• Define the type name for the UI element widget in the widget library.
• Pass the widget type for the UI element to the wrapper. The wrapper is a container for creating the UI elements. The name of the widget type should be identical to the name in the library.
• When creating a UI, use the wrapper instead of the widget.

Wrappers de widgets

A wrapper is a container that creates a required widget in the area of the page that is occupied by the wrapper.

Using the widget wrappers when creating the UI lets you automatically change the UI elements within the whole UI. To do this, change the widget in the wrapper. The standard flow, that uses UI primitives, suggests replacing all widgets manually in this scenario.

Here are the following wrappers for different widget types:

• W_ButtonWrapper — for a button
• W_InputWrapper — for an input field
• W_TextWrapper — for text
• W_RichTextWrapper — for rich text
• W_ImageWrapper — for an image
• W_CheckBoxWrapper — for a box

In the Details panel, you can configure the display parameters of the widgets created by a wrapper. In the Widget Library Name field, you should specify the name of the widget type from the current widget library.

You can find the widget wrappers blueprints in Content Browser > Xsolla Content > Common > Components > Wrappers.

The wrappers use the widget manager methods to interact with the widgets.

Interfaces de widgets

To make the UI primitives interact with the widget wrapper as they would with the usual widget, the wrappers use unified interfaces.

There are the following wrappers for different widget types:

• BPI_PrimitivesButton — for a button
• BPI_PrimitivesInput — for an input field
• BPI_PrimitivesText — for text
• BPI_PrimitivesRichText — for rich text
• BPI_PrimitivesImage — for an image
• BPI_PrimitivesCheckbox — for a box

You can configure interfaces for the UI elements widgets in the Implemented Interfaces section of the Details panel.

You can find the widget interfaces in Content Browser > Xsolla Content > Common > Components > Interface.

Bibliothèque de widgets

The widget library is an asset of the XsollaUtilsWidgetsLibrary type that contains the list of widget classes in a form of key-value pairs. The key contains the name of the widget type and the value contains the widget class that will be created by a corresponding wrapper with this key.

The widget library works as a connector between the wrappers and widget classes.

The BP_DefaultWidgetLibrary default widget library is included in the SDK. This library contains the list of UI elements from the demo project.

You can work with the widget library in Settings > Project Settings > Plugins > Xsolla Utils:

• To install the current widget library, select it in the Widgets Library field.
• To edit the selected widget library, click the 🔎 icon near the Widgets Library field.

• To create a new widget library, click the + icon near the Widgets Library field.
• To delete the selected widget library, click the × icon near the Widgets Library field.

Use the following methods in the wrapper blueprints to get access to the widget library:

• GetCurrentWidgetsLibrary — returns the current widget library specified in the plug-in settings.
• GetWidgetsLibrary — returns the specified widget library by the name specified in the WidgetLibraryClass parameter.

Use the GetWidget method in the wrapper blueprints, to get the widget type from the library.

Méthodes du gestionnaire de widgets

The following methods are used by the wrappers to interact with the widgets. Use them when creating your own wrappers and widgets that support themes.

Méthodes pour utiliser les boutons

Méthodes pour utiliser les cases à cocher

Méthodes pour utiliser du texte ou du texte enrichi

Méthodes pour utiliser les images

Méthodes pour utiliser les champs de saisie