LeaderboardData.h

Go to the documentation of this file.

// Fill out your copyright notice in the Description page of Project Settings.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Friends/SteamFriendsData.h"
#include "LeaderboardData.generated.h"
 
USTRUCT(BlueprintType)
struct FSteamLeaderboardEntry
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "Steam Leaderboards")
    int32 Rank = 0;
    UPROPERTY(BlueprintReadOnly, Category = "Steam Leaderboards")
    FString UserID = "UserID";
    UPROPERTY(BlueprintReadOnly, Category = "Steam Leaderboards")
    FString User = "User";
    UPROPERTY(BlueprintReadOnly, Category = "Steam Leaderboards")
    int32 Score = 0;
};
 
 
// the sort order of a leaderboard
UENUM(BlueprintType, Category = "Simple Steam Stats & Achievements")
enum ESteamLeaderboardSortMethod : uint8
{
    LeaderboardSortMethodNone = 0,
    LeaderboardSortMethodAscending = 1, // top-score is lowest number
    LeaderboardSortMethodDescending = 2,    // top-score is highest number
};
 
// type of data request, when downloading leaderboard entries
UENUM(BlueprintType, Category = "Simple Steam Stats & Achievements")
enum ESteamLeaderboardDataRequest : uint8
{
    LeaderboardDataRequestGlobal = 0,
    LeaderboardDataRequestGlobalAroundUser = 1,
    LeaderboardDataRequestFriends = 2,
    LeaderboardDataRequestUsers = 3
};
 
// the display type (used by the Steam Community web site) for a leaderboard
UENUM(BlueprintType, Category = "Simple Steam Stats & Achievements")
enum ESteamLeaderboardDisplayType : uint8
{
    LeaderboardDisplayTypeNone = 0, 
    LeaderboardDisplayTypeNumeric = 1,          // simple numerical score
    LeaderboardDisplayTypeTimeSeconds = 2,      // the score represents a time, in seconds
    LeaderboardDisplayTypeTimeMilliSeconds = 3, // the score represents a time, in milliseconds
};
 
UENUM(BlueprintType, Category = "Simple Steam Stats & Achievements")
enum ESteamLeaderboardUploadScoreMethod : uint8
{
    LeaderboardUploadScoreMethodNone = 0,
    LeaderboardUploadScoreMethodKeepBest = 1,   // Leaderboard will keep user's best score
    LeaderboardUploadScoreMethodForceUpdate = 2,    // Leaderboard will always replace score with specified
};
 
 
// Define FSteamLeaderboard as a uint64 type
typedef uint64 FSteamLeaderboard;
 
USTRUCT(BlueprintType)
struct FSteamLeaderboardHandle
{
    GENERATED_BODY()
    
    FSteamLeaderboard Handle;
    
    FSteamLeaderboardHandle()
        : Handle(0)
    {
    }
 
    FSteamLeaderboardHandle(FSteamLeaderboard InHandle)
        : Handle(InHandle)
    {
    }
 
    bool IsValid() const
    {
        return Handle != 0;
    }
};
 
USTRUCT(BlueprintType)
struct FLeaderboardData
{
    GENERATED_BODY()
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    FString LeaderboardName = "Default";
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    bool bCreateIfNotFound = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    int32 StartNumber = 0;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    int32 EndNumber = 5;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    TEnumAsByte<ESteamLeaderboardDisplayType> DisplayType = LeaderboardDisplayTypeNumeric;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    TEnumAsByte<ESteamLeaderboardSortMethod> SortMethod = LeaderboardSortMethodAscending;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Leaderboard|General")
    TEnumAsByte<ESteamLeaderboardDataRequest> DataRequest = LeaderboardDataRequestGlobal;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Leaderboard|General")
    TEnumAsByte<ESteamAvatarSize> AvatarSize = SteamAvatar_Medium; 
 
};
 
 
class STATSINTEGRATION_API LeaderboardData
{
public:
};