Managing Event Configurations
The Configurator Events page lists Events and allows you to create new Events and edit or delete existing ones.
You can use the following options (highlighted above):
- Add - Add a new Event.
- - Edit Event.
- - Delete Event.
Events with Cloud Code! You cannot delete an Event that has Cloud Code script attached to it. To fully delete an Event's Cloud Code, you must open the Cloud Editor for the Event and click Delete.
Creating a New Event Configuration
The Create/Edit screen contains the following fields:
- Short Code - Short Code of the Event, which is used by the API to allow you to identify which Event you want to call. Short Codes are always unique.
- Name - Name of the Event, which you can use to identify the Event in the portal, if you have a number of Events.
- Description - Description for the Event.
Creating Event Attributes
Each Event can have a number of Attributes associated with it.
Add an Attribute by clicking Add. Each Attribute has a number of different configuration options:
- Short Code - Short Code of the Attribute, which is used by the API to allow you to identify which Attribute you are trying to set.
- Name - Name of the Attribute, which you can use to identify the Attribute if there are several associated with an Event.
- Data Type - Each Attribute needs to be defined as either String, Number, or JSON.
- Default Value - Allows a specific value to be used if the user request does not contain this attribute.
- Default Aggregation Type - Select the default calculation you want to use for when the Event/Attribute is used as a Running Total for a Leaderboard. (Select Used In Script if you do not want to make the Event/Attribute available for a Leaderboard Running Total):
- Maximum - A Running Total will be created to track the maximum value posted.
- Minimum - A Running Total will be created to track the minimum value posted.
- Sum - A Running Total will be created to add all the values posted together.
- Count - A Running Total will be created to count the number of times the player has called the Event.
- Last - A Running Total will be created using the last value posted.
- Used In Script - The Event will not be used in a Running Total.
- Grouped - The Running Total will use this Attribute to group the other Attributes. This will lead to a Running Total with an entry per Attribute/user combination. A typical use case would be where you want to track each player's highest score relative to each level of your game, not simply each player's highest score across all game levels.
- Supplemental - A Running Total will be created with no value calculated. You can use this when you want to store some extra information within the game context but do not want this to affect the Leaderboard ranking. (For example, in a racing game you can keep note of weather conditions on the track as well as player lap times but changing weather conditions do not affect the player's Leaderboard ranking.)
Understanding Event Attributes as Leaderboard Running Totals
How do Event Attributes become Available as Running Totals?
If you want an Event/Attribute to be available for selection as a Running Total when you create and configure Leaderboards for your game, two conditions must be met:
- First, you must add at least one Attribute to the Event.
- Second, you cannot select Used in Script as the Default Aggregation Type for the Attribute.
Events with Attributes that meet these two conditions become System Generated Running Totals. Running Totals are more fully explained here.
What is the Significance of the Event Attribute's Default Aggregation Type Setting?
When you create an Event/Attribute that qualifies as a Running Total, you'll be able to use that directly as a System Generated Running Total to configure a Leaderboard for your game. If you do this, the Running Total will aggregate the Leaderboard data according to the Default Aggregation Type setting you've selected for the Event/Attribute.
However, on the Configurator>Leaderboards page on the Running Totals tab, you can also create your own customized User Configured Running Totals, which are based on the Event/Attributes that qualify as Running Totals. When you create a User Configured Running Total, you can select a Calculation Type for how the Running Total will aggregate data for your Leaderboards and this aggregation method will override the Default Aggregation Type you originally selected for the Event/Attribute on which the User Configured Running Total is based.