GetStoredStats.h

Go to the documentation of this file.

// Copyright 2021 Artur 'NijoMeisteR' Dworaczek. All Rights Reserved.
 
#pragma once
#pragma warning(disable:4996)
#pragma warning(disable:4265)
#pragma warning(disable:4701)
 
#include "CoreMinimal.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "SteamRequests.h"
#pragma push_macro("ARRAY_COUNT")
#undef ARRAY_COUNT
 
#if USING_CODE_ANALYSIS
MSVC_PRAGMA(warning(push))
MSVC_PRAGMA(warning(disable : ALL_CODE_ANALYSIS_WARNINGS))
#endif
 
#include "OnlineSubsystemSteam.h"
#include <steam/steam_api.h>
 
#if USING_CODE_ANALYSIS
MSVC_PRAGMA(warning(pop))
#endif
 
#pragma pop_macro("ARRAY_COUNT")
#include "GetStoredStats.generated.h"
 
UCLASS()
class STATSINTEGRATION_API UGetStoredStats : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
    
public:
    /* 
        Gets the current value of the a stat for the specified user. 
 
        You must have called RequestUserStats and it needs to return successfully via its callback prior to calling this. 
    */
    UFUNCTION(BlueprintCallable, Category = "Simple Steam Stats & Achievements")
        static void GetUserStoredStats(TArray<FSteamStat> StatsToGet, TArray<FSteamStat>& StatsOut);
 
    /* 
        Gets the current value of the a stat for the specified user. 
    
        You must have called RequestUserStats and it needs to return successfully via its callback prior to calling this. 
    */
    UFUNCTION(BlueprintCallable, Category = "Simple Steam Stats & Achievements")
        static void GetUserStoredStat(FString APIStatName, ESteamStatType StatType, int32& IntegerValue, float& FloatValue);
 
    /* 
        Gets the current value of the global stat. 
        
        You must have called RequestGlobalStats and it needs to return successfully via its callback prior to calling this. 
 
        Returns: Boolean 
            This function returns true upon success if all of the following conditions are met; otherwise, false.
                The specified stat exists in App Admin on the Steamworks website, and the changes are published.
                RequestGlobalStats has completed and successfully returned its callback.
                The type matches the type listed in the App Admin panel of the Steamworks website.
    */
    UFUNCTION(BlueprintCallable, Category = "Simple Steam Stats & Achievements")
        static bool GetGlobalStat(FString APIStatName, ESteamGlobalStatType StatType, FString& Value);
    
    /* 
        Gets the current value of the global stat. 
        
        You must have called RequestGlobalStats and it needs to return successfully via its callback prior to calling this. 
    
        Data will be filled with daily values, starting with today.
        So when called, Array[0] will be today, Array[1] will be yesterday, and Array[2] will be two days ago, etc.
 
        Returns: Int32 Number of entries inside the Array.
    */
    UFUNCTION(BlueprintCallable, Category = "Simple Steam Stats & Achievements")
        static int32 GetGlobalStatHistory(FString APIStatName, ESteamGlobalStatType StatType, TArray<FString>& ValuesArray);
};