LeaderboardData.h File Reference

#include "CoreMinimal.h"
#include "Friends/SteamFriendsData.h"
#include "LeaderboardData.generated.h"

Go to the source code of this file.

Classes
struct	FSteamLeaderboardEntry
struct	FSteamLeaderboardHandle
struct	FLeaderboardData
class	LeaderboardData

Typedefs
typedef uint64	FSteamLeaderboard

Enumerations
enum	ESteamLeaderboardSortMethod : uint8 { LeaderboardSortMethodNone = 0 , LeaderboardSortMethodAscending = 1 , LeaderboardSortMethodDescending = 2 }
enum	ESteamLeaderboardDataRequest : uint8 { LeaderboardDataRequestGlobal = 0 , LeaderboardDataRequestGlobalAroundUser = 1 , LeaderboardDataRequestFriends = 2 , LeaderboardDataRequestUsers = 3 }
enum	ESteamLeaderboardDisplayType : uint8 { LeaderboardDisplayTypeNone = 0 , LeaderboardDisplayTypeNumeric = 1 , LeaderboardDisplayTypeTimeSeconds = 2 , LeaderboardDisplayTypeTimeMilliSeconds = 3 }
enum	ESteamLeaderboardUploadScoreMethod : uint8 { LeaderboardUploadScoreMethodNone = 0 , LeaderboardUploadScoreMethodKeepBest = 1 , LeaderboardUploadScoreMethodForceUpdate = 2 }

Typedef Documentation

FSteamLeaderboard

typedef uint64 FSteamLeaderboard

Enumeration Type Documentation

ESteamLeaderboardDataRequest

enum ESteamLeaderboardDataRequest : uint8

Enumerator
LeaderboardDataRequestGlobal
LeaderboardDataRequestGlobalAroundUser
LeaderboardDataRequestFriends
LeaderboardDataRequestUsers

{
    LeaderboardDataRequestGlobal = 0,
    LeaderboardDataRequestGlobalAroundUser = 1,
    LeaderboardDataRequestFriends = 2,
    LeaderboardDataRequestUsers = 3
};

ESteamLeaderboardDisplayType

enum ESteamLeaderboardDisplayType : uint8

Enumerator
LeaderboardDisplayTypeNone
LeaderboardDisplayTypeNumeric
LeaderboardDisplayTypeTimeSeconds
LeaderboardDisplayTypeTimeMilliSeconds

{
    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
};

ESteamLeaderboardSortMethod

enum ESteamLeaderboardSortMethod : uint8

Enumerator
LeaderboardSortMethodNone
LeaderboardSortMethodAscending
LeaderboardSortMethodDescending

{
    LeaderboardSortMethodNone = 0,
    LeaderboardSortMethodAscending = 1, // top-score is lowest number
    LeaderboardSortMethodDescending = 2,    // top-score is highest number
};

ESteamLeaderboardUploadScoreMethod

enum ESteamLeaderboardUploadScoreMethod : uint8

Enumerator
LeaderboardUploadScoreMethodNone
LeaderboardUploadScoreMethodKeepBest
LeaderboardUploadScoreMethodForceUpdate

{
    LeaderboardUploadScoreMethodNone = 0,
    LeaderboardUploadScoreMethodKeepBest = 1,   // Leaderboard will keep user's best score
    LeaderboardUploadScoreMethodForceUpdate = 2,    // Leaderboard will always replace score with specified
};