Put it all together - Stat tracking and display - (Unity module)

Last updated on March 12, 2025

What's in the Starter Pack

In this tutorial, you will update statistic (stat) values with gameplay data and display them in the Stats Profile Menu.

The StatsHelper_Starter class has been prepared for you as starter that subscribes to events related to changes in Options Menu. It is available in the Resources section and consists of the following file:

StatsHelper_Starter.cs: /Assets/Resources/Modules/StatsEssentials/Scripts/StatsHelper_Starter.cs

The helper class has some functionalities provided for you:

The AccelByte Gaming Services (AGS) Game SDK library declarations to allow the use of the Statistic and ServerStatistic classes.
```
using AccelByte.Core;
using AccelByte.Models;
```

Update stats with gameplay data when the game ended

In this section, you will learn how to update player statistics values based on the gameplay data, such as the score when the game ended.

Open the /Assets/Resources/Modules/StatsEssentials/Scripts/StatsHelper_Starter.cs.

Add a local variable to hold the reference of StatsEssentialsWrapper_Starter and initialize it by using the utility class called TutorialModuleManager to get the module class.

private StatsEssentialsWrapper_Starter statsWrapper;

private void Start()
{
    statsWrapper = TutorialModuleManager.Instance.GetModuleClass<StatsEssentialsWrapper_Starter>();
    ...
}

Next, create these constant variables to hold the hold statistic codes you've configured in the Admin Portal. You need these codes to get and update statisic values.

private const string SinglePlayerStatCode = "unity-highestscore-singleplayer";
private const string EliminationStatCode = "unity-highestscore-elimination";
private const string TeamDeathmatchStatCode = "unity-highestscore-teamdeathmatch";

Create a new function below to update player statistic values when the game ended. This function select the statistic code based on the game mode. Then, it collect the player score and update the statistic values with MAX update strategy to record the highest score. If the game mode is single-player, the game client will update their own score. If the game mode is online mode, the server will update all connected players statistic values.

private void UpdateConnectedPlayersStatsOnGameEnds(GameManager.GameOverReason reason) 
{
    if (reason != GameManager.GameOverReason.MatchEnded) 
    {
        return;
    }

    GameModeEnum gameMode = GameManager.Instance.GameMode;
    InGameMode inGameMode = GameManager.Instance.InGameMode;
    List<PlayerState> playerStates = GameManager.Instance.ConnectedPlayerStates.Values.ToList();

    // Set the correct statistic code based on game mode.
    string targetStatCode = string.Empty;
    if (gameMode is GameModeEnum.SinglePlayer or GameModeEnum.LocalMultiplayer) 
    {
        targetStatCode = SinglePlayerStatCode;
    }
    else if (gameMode is GameModeEnum.OnlineMultiplayer) 
    {
        switch (inGameMode)
        {
            case InGameMode.MatchmakingElimination:
            case InGameMode.CreateMatchElimination:
                targetStatCode = EliminationStatCode;
                break;
            case InGameMode.MatchmakingTeamDeathmatch:
            case InGameMode.CreateMatchTeamDeathmatch:
                targetStatCode = TeamDeathmatchStatCode;
                break;
        }
    }

    if (string.IsNullOrEmpty(targetStatCode)) 
    {
        BytewarsLogger.LogWarning($"Failed to update the stats of connected players when the game ended. Target stat code to update is empty.");
        return;
    }

#if UNITY_SERVER
    BytewarsLogger.Log($"[Server] Update the stats of connected players when the game ended. Game mode: {gameMode}. In game mode: {inGameMode}");

    Dictionary<string, float> userStats = playerStates.ToDictionary(state => state.PlayerId, state => state.Score);
    List<UserStatItemUpdate> statItems = new List<UserStatItemUpdate>();
    foreach (KeyValuePair<string, float> userStat in userStats)
    {
        UserStatItemUpdate statItem = new UserStatItemUpdate()
        {
            updateStrategy = StatisticUpdateStrategy.MAX,
            statCode = targetStatCode,
            userId = userStat.Key,
            value = userStat.Value
        };
        statItems.Add(statItem);
    }

    statsWrapper.UpdateManyUserStatsFromServer(targetStatCode, statItems, (Result<StatItemOperationResult[]> result) =>
    {
        if (!result.IsError)
        {
            BytewarsLogger.Log("[Server] Successfully updated the stats of connected players when the game ended.");
        }
        else
        {
            BytewarsLogger.LogWarning($"[Server] Failed to update the stats of connected players when the game ended. Error: {result.Error.Message}");
        }
    });
#else
    BytewarsLogger.Log($"[Client] Update the stats of local connected players when the game ended. Game mode: {gameMode}. In game mode: {inGameMode}");

    /* Local gameplay only has one valid account, which is the player who logged in to the game.
     * Thus, we can only update the stats based on that player's user ID. */
    string targetUserID = AccelByteSDK.GetClientRegistry().GetApi().session.UserId;
    if (string.IsNullOrEmpty(targetUserID))
    {
        BytewarsLogger.LogWarning($"[Client] Failed to update the stats of connected players when the game ended. Current logged-in player user ID is not found.");
        return;
    }

    /* Local gameplay only has one valid account, which is the player who logged in to the game.
     * Thus, set the stats based on the highest data. */
    float highestLocalScore = playerStates.Count > 0 ? playerStates.OrderByDescending(p => p.Score).ToArray()[0].Score : 0.0f;
    PublicUpdateUserStatItem statItem = new PublicUpdateUserStatItem
    {
        updateStrategy = StatisticUpdateStrategy.MAX,
        value = highestLocalScore
    };
    statsWrapper.UpdateUserStatsFromClient(targetStatCode, statItem, string.Empty, (Result<UpdateUserStatItemValueResponse> result) =>
    {
        if (!result.IsError)
        {
            BytewarsLogger.Log("[Client] Successfully updated the stats of connected players when the game ended.");
        }
        else
        {
            BytewarsLogger.LogWarning($"[Client] Failed to update the stats of connected players when the game ended. Error: {result.Error.Message}");
        }
    });
#endif
}

Finally, modify the Start() function to bind the UpdateConnectedPlayersStatsOnGameEnds() function to subscribe to the OnGameEnded event of GameManager, which will be triggered when the game ended.
```
void Start()
{
    ...
    GameManager.OnGameEnded += UpdateConnectedPlayersStatsOnGameEnds;
}
```

Connect the UI to display the user's stats

In this section, you will learn how to connect the Stats Profile Menu user interface (UI) with the implemented functions from the previous section.

Open /Assets/Resources/Modules/StatsEssentials/Scripts/UI/StatsHandler_Starter.cs.

Add a local variable to hold the reference of StatsEssentialsWrapper_Starter and initialize it in the Start() function by using the utility class called TutorialModuleManager to get the module class.

private StatsEssentialsWrapper_Starter statsWrapper;

private void Start()
{
    statsWrapper = TutorialModuleManager.Instance.GetModuleClass<StatsEssentialsWrapper_Starter>();
    ...
}

Next, create these constant variables to hold the hold statistic codes you've configured in the Admin Portal. You need these codes to get the statisic values.

private const string SinglePlayerStatCode = "unity-highestscore-singleplayer";
private const string EliminationStatCode = "unity-highestscore-elimination";
private const string TeamDeathmatchStatCode = "unity-highestscore-teamdeathmatch";

Create a new callback function called OnGetUserStatsCompleted. Display the query stat values result on the Text UI you prepared previously.

private void OnGetUserStatsCompleted(Result<PagedStatItems> result)
{
    if (!result.IsError){
        foreach (StatItem statItem in result.Value.data)
        {
            BytewarsLogger.Log("[STATS]" + statItem.statCode + " - " + statItem.value);
            switch (statItem.statCode)
            {
                case SinglePlayerStatCode:
                    singlePlayerStatValueText.text = statItem.value.ToString();
                    break;
                case EliminationStatCode:
                    eliminationStatValueText.text = statItem.value.ToString();
                    break;
                case TeamDeathmatchStatCode:
                    teamDeathmatchStatValueText.text = statItem.value.ToString();
                    break;
            }
        }
    }
}

Create a new function called DisplayStats() and define a string array statCodes that holds the stat values you want to display. Since the Stats Profile Menu UI is part of the game client, call the GetUserStatsFromClient() function in StatsEssentialsWrapper_Starter to get the stat values with the AGS Game SDK as game client.
```
private void DisplayStats()
{
    string[] statCodes =
    {
        SinglePlayerStatCode,
        EliminationStatCode,
        TeamDeathmatchStatCode
    };
    statsWrapper.GetUserStatsFromClient(statCodes, null, OnGetUserStatsCompleted);
}
```
Now modify the Start() function to call the DisplayStats() function on initializing the Stats Profile Menu.
```
void Start()
{
    ...
    DisplayStats();
}
```
Add the OnEnable() function and call the DisplayStats() function on the Stats Profile Menu UI active status so it can keep the value up to date.
```
void OnEnable()
{
    if (gameObject.activeSelf && statsWrapper != null)
    {
        DisplayStats();
    }
}
```

Resources

GitHub link to the file in the Unity Byte Wars repository:
- Assets/Resources/Modules/StatsEssentials/Scripts/StatsHelper_Starter.cs

What's in the Starter Pack​

Update stats with gameplay data when the game ended​

Connect the UI to display the user's stats​

Resources​

On this page

What's in the Starter Pack

Update stats with gameplay data when the game ended

Connect the UI to display the user's stats

Resources