Content
Introduction
What are Parameters?
Types of Parameters
Where are Parameters Defined?
Event Type Parameters
Client Leaderboard Parameters
Activity Template Parameters
Activity Templates
What are Parameters?
Parameters can help you configure, how the event should behave on the client side. They serve as input variables that influence event and/or activity behaviour in the game/on the client side.
In the Parameters section, each parameter is predefined with essential attributes like Name, Key, Value, Type, and Default Value during event or activity configuration.
Types of Parameters
Boolean : A true/false or on/off value. Useful for enabling or disabling features.
Integer : A whole number (e.g., 1, 10, -5). Used for numerical values without decimals.
String : A text-based parameter, storing alphanumeric data (e.g., "Event Name").
Float : A number with decimals (e.g., 1.5, 3.14). Ideal for precise calculations.
Asset Bundle : Refers to game-related assets (e.g., images, textures) packaged together. You can change the value to select the appropriate one from the available options. Asset bundles are fetched from Game Server and are interpreted by type.
Localisation Key : Used for multilingual support by referencing text from a localisation file. Localisations are fetched from Harmony.
Formula: A calculated parameter based on players' attributes of type integer or float. The result can be rounded to the nearest integer or to a float when not rounded, and a fallback value is mandatory for cases where the formula cannot be computed. If rounding is enabled, the fallback value will also be rounded.
List : The list parameter allows multiple predefined options. For example, in the configuration, two options: Left and Right can be configured, with Left set as the default. Additional options can be added to expand the selection. One parameter can only have a single value selected. List is similar to String as the server returns values as a string, but it simplifies and makes safer configuration of the values, because user can select only pre-defined values (using String can be risky if the client relies on the exact match).
Multiple-selection list : A Multiple-selection list parameter allows to define a list of options where multiple selections can be made. Unlike a standard list, this type enables users to choose more than one value at a time. For example, multiple options can be configured as shown in the image below. and multiple options can also be selected as default values. In case of Multiple-selection list, the Live Ops server returns an array, even if only one option is selected.
Where are Parameters Defined?
Drop Rate for Special Tiles
To illustrate how formulas can be used in Rewarded Video placements, here’s an example where the drop rate of special tiles is determined based on the player’s session length:
Drop Rate for Special Tiles
To illustrate how formulas can be used in Rewarded Video placements, here’s an example where the drop rate of special tiles is determined based on the player’s session length:
Parameters are defined at two levels: Event Level and Activity Level (specific to individual activity types). Event parameters are configured within event types, while activity parameters are set up in activity templates. Additionally, for the Client Leaderboards activity type, there is a separate provision for configuring parameters. There are three types of activity templates where these parameters are configured. Refer to the Activity Templates section for more details.
| Category | Event Parameters | Activity Parameters | Parameters in Activity Templates | Parameters in Event Types |
| --- | --- | --- | --- | --- |
| Definition | Parameters applied at the event level | Parameters applied at the activity level | Predefined templates for different activity types where activity parameters are configured. | Types of Events where event parameters are configured. |
| Where is it configured? | In Event configuration, you can configure the event. The parameters are configured in Event Types. You need to submit a request to the Hawk team for the Event Type configuration. | In Activity configuration, you can configure the activity. The parameters are configured in an Activity Template. | You cannot configure the activity template but need to submit a request to the Hawk team for the configuration. | You cannot configure the event types but need to submit a request to the Hawk team for the configuration. |
| Scope | Affects the entire event. | Affects only the specific activity type within the event. | Used to define parameters for activities. | Used to define parameters for events. |
| Modifications | Only values for the parameters can be modified at the time of event configuration. | Only values for the parameters can be modified at the time of activity configuration. | You cannot configure the activity templates, nor can you modify the parameter values. Request the Hawk team to carry out the modifications if required. | You cannot configure the event types, but you can modify the parameter values. |
| Usage and Display | One-time Event Configuration: Parameters are displayed after the Event Type is selected. Recurring Events: Parameters are displayed only when Event Type is selected and the option of same across all occurrences is selected in the Parameters section. If the Parameter set option is selected, then the parameters are not displayed. Refer to the Event Type Parameters section below for more details. | Objectives: Parameters are used and displayed while configuring the “Objective” activity. There are two types of parameters for the “Objective” activity type: parameters for Objective templates and parameters for Goal templates. Both of these templates can be requested to be configured but you cannot configure these templates yourself. Races: Parameters are used and displayed while configuring the “Race” activity. These parameters are configured when configuring Race templates. You cannot configure Race templates yourself. Request the configuration to the Hawk team. Client Leaderboards: Parameters are used and displayed while configuring the Client Leaderboard activity. The client leaderboards comprise two types of parameters: Leaderboard Configuration Parameters and Bot Configuration Parameters. You can modify the values of both of these parameters at the time of configuring the client leaderboard activity. Refer to the Client Leaderboard Parameters section below for more details. | Activity Configuration: Activity templates are used for Objectives and Races activity types. The Activity templates comprise a set of parameters defined at the time of the template configuration. You cannot modify the values of the parameters in the activity templates nor are the parameters displayed when you select an activity template while configuring Races or Objective type activities. Refer to the Activity Template Parameters section below for more details. | Event Configuration: Events types are selected when configuring events both One-time and recurring events. |
Event Type Parameters
The parameters associated at an event level are configured while configuring the Event Types. You can request the configuration of an Event Type and consequently the parameters to the Hawk team.
Event Types are used while:
Configuring One-time Events. Refer to the One Time Events user guide for more details.
Configuring Recurring Events. Refer to the Recurring Events user guide for more details.
Configuring Parameter Sets and Activity Sets for Recurring Events. Refer to the Parameters Sets and Activity Sets user guides for more details.
You cannot configure the event types, nor can you modify the parameters included in an Event type. You can only change the parameter values while configuring the events.
Modifying Parameter Values Directly in the Event
You can modify the parameter values directly in the event itself. The rest of the fields cannot be changed.
- One-Time Event:
The parameters section includes:
Name, Key, Value, Type, and Default Value fields , defined during event type configuration.
Value fields can be updated during event configuration, while other fields remain locked for editing.
- Recurring Event:
The parameters section includes:
Name, Key, Value, Type, and Default Value fields , defined during event type configuration.
Value fields can be updated during event configuration, while other fields remain locked for editing.
If you have a new parameter in your event type, and you already have events for that event type, the Sever will apply the new parameters to the old events immediately. The server will serve the default value from the event type, unless changed manually.
Client Leaderboard Parameters
Client Leaderboard Parameters are specifically linked to the Client Leaderboard activity type. Unlike other activity types that use the Activity Templates parameters (see the Activity Templates Parameters section below), these parameters can be defined independently and are consistent across all client leaderboards. They are therefore exclusively used for Client Leaderboards.
Client Leaderboard Parameters are used while:
- Configuring Client Leaderboards. Refer to the Client Leaderboards user guide for more details.
Remember! You cannot configure the client Leaderboard parameters. Request the Hawk Team to configure them for you.
Accessing Client Leaderboard Parameters
Admin users can access a new button labeled "Client Leaderboard Parameters" at the top of the Client Leaderboards page. Clicking this button opens the Client Leaderboards Parameters Configuration page.
Permissions
The "Client Leaderboard Parameters" is covered with permissions and it is disabled until permissions are granted.
If the admin does not have the required permission, the button will be hidden.
The configuration page consists of two sections:
Leaderboard Configuration Parameters
Bots Configuration Parameters
Each section contains a table with the following fields:
Name
Key
Type (Boolean, Integer, Float, String, List, Multi-selection list, Asset bundle, Localisation key, and Formula.)
Config (Used for Multi-selection list to provide options)
Default Value
Actions
Refer this section to configure the Formula parameter type.
Activity Templates
Activity Templates define the parameters to Objectives and Races activity types within the system.
There are three types of activity templates:
Objective Templates
When configuring objectives in Hawk Live Ops, each objective includes an "Objective Template" selection.
This allows users to associate an objective with a predefined activity template of type "Objective".
Example: The associated Asset Bundle for a particular objective in a game.
Here’s how it works:
Behaviour of the Objective Template Selection
- The dropdown lists only the activity templates that have been created with the type "Objective".
Goal Templates
When configuring objectives in Hawk Live Ops, each goal within an objective includes a "Goal Template" dropdown.
This dropdown enables users to associate a goal with an existing Goal template.
Here’s how it works:
Behaviour of the Goal Template Selection
The dropdown lists only the activity templates that have been created with the type "Goal".
Once selected, the chosen template applies predefined configurations to the goal.
Race Templates
When configuring races in Hawk Live Ops, each race includes a "Race Template" selection.
This allows users to associate a race with a predefined activity template of type "Race".
Here’s how it works:
Behaviour of the Race Template Selection
The dropdown lists only the activity templates that have been created with the type "Race".
The selected race template may include pre-defined parameters.
Users can modify parameter values directly to customise the race as needed.
Chunks 4
## Introduction
- What are Parameters?
- Types of Parameters
- Where are Parameters Defined?
- Event Type Parameters
- Client Leaderboard Parameters
- Activity Template Parameters
- Activity Templates
* * *
## What are Parameters?
Parameters can help you configure, how the event should behave on the client side. They serve as input variables that influence event and/or activity behaviour in the game/on the client side.
In the Parameters section, each parameter is predefined with essential attributes like Name, Key, Value, Type, and Default Value during event or activity configuration.
Types of Parameters
- **Boolean** : A true/false or on/off value. Useful for enabling or disabling features.
- **Integer** : A whole number (e.g., 1, 10, -5). Used for numerical values without decimals.
- **String** : A text-based parameter, storing alphanumeric data (e.g., "Event Name").
- **Float** : A number with decimals (e.g., 1.5, 3.14). Ideal for precise calculations.
- **Asset Bundle** : Refers to game-related assets (e.g., images, textures) packaged together. You can change the value to select the appropriate one from the available options. Asset bundles are fetched from Game Server and are interpreted by type.
- **Localisation Key** : Used for multilingual support by referencing text from a localisation file. Localisations are fetched from Harmony.
- **Formula:** A calculated parameter based on players' attributes of type integer or float. The result can be rounded to the nearest integer or to a float when not rounded, and a fallback value is mandatory for cases where the formula cannot be computed. If rounding is enabled, the fallback value will also be rounded.
- **List** : The list parameter allows multiple predefined options. For example, in the configuration, two options: Left and Right can be configured, with Left set as the default. Additional options can be added to expand the selection. One parameter can only have a single value selected. List is similar to String as the server returns values as a string, but it simplifies and makes safer configuration of the values, because user can select only pre-defined values (using String can be risky if the client relies on the exact match).
- **Multiple-selection list** : A Multiple-selection list parameter allows to define a list of options where multiple selections can be made. Unlike a standard list, this type enables users to choose more than one value at a time. For example, multiple options can be configured as shown in the image below. and multiple options can also be selected as default values. In case of Multiple-selection list, the Live Ops server returns an array, even if only one option is selected.
- **Where are Parameters Defined?**
### Drop Rate for Special Tiles
To illustrate how formulas can be used in Rewarded Video placements, here’s an example where the **drop rate of special tiles** is determined based on the player’s session length:
### Drop Rate for Special Tiles
To illustrate how formulas can be used in Rewarded Video placements, here’s an example where the **drop rate of special tiles** is determined based on the player’s session length:
Parameters are defined at two levels: Event Level and Activity Level (specific to individual activity types). Event parameters are configured within event types, while activity parameters are set up in activity templates. Additionally, for the Client Leaderboards activity type, there is a separate provision for configuring parameters. There are three types of activity templates where these parameters are configured. Refer to the Activity Templates section for more details.
| **Category** | **Event Parameters** | **Activity Parameters** | **Parameters in Activity Templates** | **Parameters in Event Types** |
| --- | --- | --- | --- | --- |
| **Definition** | Parameters applied at the event level | Parameters applied at the activity level | Predefined templates for different activity types where activity parameters are configured. | Types of Events where event parameters are configured. |
| **Where is it configured?** | In Event configuration, you can configure the event. The parameters are configured in Event Types. You need to submit a request to the Hawk team for the Event Type configuration. | In Activity configuration, you can configure the activity. The parameters are configured in an Activity Template. | You cannot configure the activity template but need to submit a request to the Hawk team for the configuration. | You cannot configure the event types but need to submit a request to the Hawk team for the configuration. |
| **Scope** | Affects the entire event. | Affects only the specific activity type within the event. | Used to define parameters for activities. | Used to define parameters for events. |
| **Modifications** | Only values for the parameters can be modified at the time of event configuration. | Only values for the parameters can be modified at the time of activity configuration. | You cannot configure the activity templates, nor can you modify the parameter values. Request the Hawk team to carry out the modifications if required. | You cannot configure the event types, but you can modify the parameter values. |
| **Usage and Display** | **One-time Event Configuration:** Parameters are displayed after the Event Type is selected. **Recurring Events:** Parameters are displayed **only** when Event Type is selected and the option of same across all occurrences is selected in the Parameters section. If the Parameter set option is selected, then the parameters are not displayed. Refer to the [Event Type Parameters](https://tripledotstudios.atlassian.net/wiki/spaces/KB/pages/4124409886/Parameters+and+Activity+Templates#Event-Type-Parameters) section below for more details. | **Objectives:** Parameters are used and displayed while configuring the “Objective” activity. There are two types of parameters for the “Objective” activity type: parameters for Objective templates and parameters for Goal templates. Both of these templates can be requested to be configured but you cannot configure these templates yourself. **Races:** Parameters are used and displayed while configuring the “Race” activity. These parameters are configured when configuring Race templates. You cannot configure Race templates yourself. Request the configuration to the Hawk team. **Client Leaderboards:** Parameters are used and displayed while configuring the Client Leaderboard activity. The client leaderboards comprise two types of parameters: Leaderboard Configuration Parameters and Bot Configuration Parameters. You can modify the values of both of these parameters at the time of configuring the client leaderboard activity. Refer to the [Client Leaderboard Parameters](https://tripledotstudios.atlassian.net/wiki/spaces/KB/pages/4124409886/Parameters+and+Activity+Templates#Client-Leaderboard-Parameters) section below for more details. | **Activity Configuration:** Activity templates are used for Objectives and Races activity types. The Activity templates comprise a set of parameters defined at the time of the template configuration. You cannot modify the values of the parameters in the activity templates nor are the parameters displayed when you select an activity template while configuring Races or Objective type activities. Refer to the [Activity Template Parameters](https://tripledotstudios.atlassian.net/wiki/spaces/KB/pages/4124409886/Parameters+and+Activity+Templates#Activity-Templates-Parameters) section below for more details. | **Event Configuration:** Events types are selected when configuring events both One-time and recurring events. |
Event Type Parameters
The parameters associated at an event level are configured while configuring the Event Types. You can request the configuration of an Event Type and consequently the parameters to the Hawk team.
Event Types are used while:
- Configuring One-time Events. Refer to the [One Time Events](https://tripledotstudios.atlassian.net/wiki/x/XoCU1Q?atlOrigin=eyJpIjoiZmVhZWVkMjljZGQyNDcwMmE5MDQ0ZWIxM2YwZDdiYzEiLCJwIjoiYyJ9) user guide for more details.
- Configuring Recurring Events. Refer to the [Recurring Events](https://tripledotstudios.atlassian.net/wiki/x/FgDU9Q?atlOrigin=eyJpIjoiZjgxYTg4OGQzYjJmNGNkMmJkNWIxNzg0M2U1ZjVlZTkiLCJwIjoiYyJ9) user guide for more details.
- Configuring Parameter Sets and Activity Sets for Recurring Events. Refer to the [Parameters Sets](https://tripledotstudios.atlassian.net/wiki/x/agDR9Q?atlOrigin=eyJpIjoiMTVjMTNhYjEyNzM0NDBhNjk0YzAxZjBlOGJhYWI0OTUiLCJwIjoiYyJ9) and [Activity Sets](https://tripledotstudios.atlassian.net/wiki/x/DQDS9Q) user guides for more details.
You cannot configure the event types, nor can you modify the parameters included in an Event type. You can only change the parameter values while configuring the events.
#### **Modifying Parameter Values Directly in the Event**
You can modify the parameter values directly in the event itself. The rest of the fields cannot be changed.
- **One-Time Event:**
The parameters section includes:
- **Name, Key, Value, Type, and Default Value fields** , defined during event type configuration.
- **Value fields** can be updated during event configuration, while other fields remain locked for editing.
- **Recurring Event:**
The parameters section includes:
- **Name, Key, Value, Type, and Default Value fields** , defined during event type configuration.
- **Value fields** can be updated during event configuration, while other fields remain locked for editing.
If you have a new parameter in your event type, and you already have events for that event type, the Sever will apply the new parameters to the old events immediately. The server will serve the default value from the event type, unless changed manually.
### Client Leaderboard Parameters
Client Leaderboard Parameters are specifically linked to the Client Leaderboard activity type. Unlike other activity types that use the Activity Templates parameters (see the [Activity Templates Parameters](https://tripledotstudios.atlassian.net/wiki/spaces/KB/pages/4124409886/Parameters+and+Activity+Templates#Activity-Templates-Parameters) section below), these parameters can be defined independently and are consistent across all client leaderboards. They are therefore exclusively used for Client Leaderboards.
Client Leaderboard Parameters are used while:
- Configuring Client Leaderboards. Refer to the [Client Leaderboards](https://tripledotstudios.atlassian.net/wiki/pages/resumedraft.action?draftId=4123721814&atlOrigin=eyJpIjoiY2Q2Y2JhYjk1NWY3NDBjOGE2OGU2NzBmNjJiM2I3MzIiLCJwIjoiYyJ9) user guide for more details.
Remember! You cannot configure the client Leaderboard parameters. Request the Hawk Team to configure them for you.
#### **Accessing Client Leaderboard Parameters**
Admin users can access a new button labeled "Client Leaderboard Parameters" at the top of the Client Leaderboards page. Clicking this button opens the Client Leaderboards Parameters Configuration page.
##### **Permissions**
- The "Client Leaderboard Parameters" is covered with permissions and it is disabled until permissions are granted.
- If the admin does not have the required permission, the button will be hidden.
The configuration page consists of two sections:
1. Leaderboard Configuration Parameters
2. Bots Configuration Parameters
Each section contains a table with the following fields:
- Name
- Key
- Type (Boolean, Integer, Float, String, List, Multi-selection list, Asset bundle, Localisation key, and Formula.)
- Config (Used for Multi-selection list to provide options)
- Default Value
- Actions
Refer [this section](https://tripledotstudios.atlassian.net/wiki/spaces/KB/pages/4124409886#Configuring-Formula) to configure the Formula parameter type.
**Activity Templates**
Activity Templates define the parameters to Objectives and Races activity types within the system.
There are three types of activity templates:
### Objective Templates
When configuring objectives in Hawk Live Ops, each objective includes an "Objective Template" selection.
This allows users to associate an objective with a predefined activity template of type "Objective".
**Example:** The associated Asset Bundle for a particular objective in a game.
Here’s how it works:
#### **Behaviour of the Objective Template Selection**
- The dropdown lists **only** the activity templates that have been created with the type "Objective".
### Goal Templates
When configuring objectives in Hawk Live Ops, each goal within an objective includes a "Goal Template" dropdown.
This dropdown enables users to associate a goal with an existing Goal template.
Here’s how it works:
**Behaviour of the Goal Template Selection**
- The dropdown lists **only** the activity templates that have been created with the type "Goal".
- Once selected, the chosen template applies predefined configurations to the goal.
#### Race Templates
When configuring races in Hawk Live Ops, each race includes a "Race Template" selection.
This allows users to associate a race with a predefined activity template of type "Race".
Here’s how it works:
**Behaviour of the Race Template Selection**
- The dropdown lists **only** the activity templates that have been created with the type **"Race"**.
- The selected race template may include pre-defined parameters.
- Users can modify parameter values directly to customise the race as needed.