Stat Data

Like what your seeing?

Support us as a GitHub Sponsor and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude. These articles are made possible by our GitHub Sponsors ... become a sponsor today!

Introduction

using HeathenEngineering.SteamworksIntegration;

public struct StatData : IEquatable<StatData>, 
                         IEquatable<string>, 
                         IComparable<StatData>, 
                         IComparable<string>

A data wrapper around Steam's concept of a stat. This is implicitly convertible from string expecting that string to be the "API Name" of the stat.

StatData myStat = "NumGames";
myStat.Set(42);
myStat.Store();

Debug.Log($"NumGames = {myStat.IntValue()}");

Fields and Attributes

Id

public string id;

The API name of the achievement.

Methods

FloatValue

public float FloatValue()

Returns the float value of the stat.

IntValue

public int IntValue()

Returns the int value of the stat.

RequestUserStats

public void RequestUserStats(UserData user, 
                             Action<UserStatsReceived_t, bool> callback)

Requests the stats of a specific user be downloaded from Valve's servers. The callback on this inidicates when the request is completed along with its status ... the handler would look similar to the following

void HandleCallback(UserStatsRecieved_t results, bool IOError)
{
    if(!IOError 
        && results.m_eResult == EResult.k_EResultOK)
    {
        //We now have the stats for this user
    }
}

GetValue

For use after you have called RequestUserStats, this gets the value for a specific user and has two overloads one for int values and one for float values.

public bool GetValue(UserData user, out int value)

or

public bool GetValue(UserData user, out float value)

If the method returns false the stat was not found, if it returns true then the value will be populated with the result.

Set

public void Set(float value)

Sets the float value of the stat.

public void Set(int value)

Sets the int value of the stat.

public void Set(float value, double length)

Updates the average rate state value of the stat.

Store

public void Store()

A simple short cut to the Stats and Achievements Store Stats and achievements. You can call this on any achievement or stat and it will commit all changes to the backend for all stats and achievements.