UDownloadLeaderboard Class Reference

#include <DownloadLeaderboard.h>

Inheritance diagram for UDownloadLeaderboard:

Static Public Member Functions
static UDownloadLeaderboard *	DownloadLeaderboard (const FSteamLeaderboardHandle Handle, const ESteamLeaderboardDataRequest RequestType, const int32 Start, const int32 End)

Public Attributes
FResponseDownloadLeaderboardDelegate	OnSuccess
FResponseDownloadLeaderboardDelegate	OnFailure

Private Member Functions
virtual void	Activate () override
void	DownloadLeaderboardEntries ()
void	OnLeaderboardDownloaded (LeaderboardScoresDownloaded_t *pLeaderboardScoresDownloaded, bool bIOFailure)

Private Attributes
FOnlineSubsystemSteam *	SteamSubsystem
FSteamLeaderboardHandle	LeaderboardHandle
FString	LeaderboardName
ESteamLeaderboardDataRequest	Type
int32	RangeStart
int32	RangeEnd
TArray< FSteamLeaderboardEntry >	SteamLeaderboardResults
CCallResult< UDownloadLeaderboard, LeaderboardScoresDownloaded_t >	m_callDownloadResult

Member Function Documentation

Activate()

void UDownloadLeaderboard::Activate ( )

overrideprivatevirtual

{
    if(SteamAPI_Init())
    {
        DownloadLeaderboardEntries();
    }
    else 
    {
        GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, TEXT("Failed to initialize the Steam API!"));
        OnFailure.Broadcast(SteamLeaderboardResults, EResult::k_EResultFail);
        RemoveFromRoot();
    }
}

DownloadLeaderboard()

UDownloadLeaderboard * UDownloadLeaderboard::DownloadLeaderboard ( const FSteamLeaderboardHandle Handle, const ESteamLeaderboardDataRequest RequestType, const int32 Start, const int32 End )

static

{
    UDownloadLeaderboard* SelfRef = NewObject<UDownloadLeaderboard>();
    SelfRef->SteamSubsystem = static_cast<FOnlineSubsystemSteam*>(IOnlineSubsystem::Get());
    SelfRef->LeaderboardHandle = Handle;
    SelfRef->RangeStart = Start;
    SelfRef->RangeEnd = End;
    SelfRef->Type = RequestType;
    return SelfRef;
}

DownloadLeaderboardEntries()

void UDownloadLeaderboard::DownloadLeaderboardEntries ( )

private

{
    uint8 RequestTypeIndex = static_cast<uint8>(Type);
    const ELeaderboardDataRequest RequestType = static_cast<ELeaderboardDataRequest>(RequestTypeIndex);
    // if(RequestType == ELeaderboardDataRequest::k_ELeaderboardDataRequestUsers)
    // {
    //  SteamAPICall_t hSteamAPICall = SteamUserStats()->DownloadLeaderboardEntriesForUsers(LeaderboardHandle.Handle, RequestType, RangeStart, RangeEnd);
    // }
    SteamAPICall_t hSteamAPICall = SteamUserStats()->DownloadLeaderboardEntries(LeaderboardHandle.Handle, RequestType, RangeStart, RangeEnd);
    m_callDownloadResult.Set(hSteamAPICall, this, &UDownloadLeaderboard::OnLeaderboardDownloaded);
}

OnLeaderboardDownloaded()

void UDownloadLeaderboard::OnLeaderboardDownloaded ( LeaderboardScoresDownloaded_t * pLeaderboardScoresDownloaded, bool bIOFailure )

private

{
    for(int32 Index = 0; Index < pLeaderboardScoresDownloaded->m_cEntryCount; Index++ )
    {
        FSteamLeaderboardEntry SteamLeaderboardEntry;
        LeaderboardEntry_t LeaderboardEntry;
        int32 Details[3];       // we know this is how many we've stored previously
        if(SteamUserStats()->GetDownloadedLeaderboardEntry( pLeaderboardScoresDownloaded->m_hSteamLeaderboardEntries, Index, &LeaderboardEntry, Details, 3))
        {
            SteamLeaderboardEntry.UserID = FString::Printf(TEXT("%llu"), LeaderboardEntry.m_steamIDUser.ConvertToUint64());
            SteamLeaderboardEntry.User = SteamFriends()->GetFriendPersonaName(LeaderboardEntry.m_steamIDUser);
            SteamLeaderboardEntry.Score = LeaderboardEntry.m_nScore;
            SteamLeaderboardEntry.Rank = LeaderboardEntry.m_nGlobalRank;
            SteamLeaderboardResults.Add(SteamLeaderboardEntry);
        }
    }
 
    if(!bIOFailure)
    {
        AsyncTask(ENamedThreads::GameThread, [this]()
        {
            OnSuccess.Broadcast(SteamLeaderboardResults, EResult::k_EResultOK);
        }
        );
        GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Green, TEXT("Leaderboards Downloaded!"));
        UE_LOG(LogTemp, Warning, TEXT("Leaderboard Entries: %i"), pLeaderboardScoresDownloaded->m_cEntryCount);
        if(SteamLeaderboardResults.IsEmpty())
        {
            GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Green, TEXT("Leaderboard Empty!"));
        }
    }
    else
    {
        GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, TEXT("Failed to find Leaderboard!"));
        OnFailure.Broadcast(SteamLeaderboardResults, 99);
    }
    RemoveFromRoot();
}

Member Data Documentation

LeaderboardHandle

FSteamLeaderboardHandle UDownloadLeaderboard::LeaderboardHandle

private

LeaderboardName

FString UDownloadLeaderboard::LeaderboardName

private

m_callDownloadResult

CCallResult<UDownloadLeaderboard, LeaderboardScoresDownloaded_t> UDownloadLeaderboard::m_callDownloadResult

private

OnFailure

FResponseDownloadLeaderboardDelegate UDownloadLeaderboard::OnFailure

OnSuccess

FResponseDownloadLeaderboardDelegate UDownloadLeaderboard::OnSuccess

RangeEnd

int32 UDownloadLeaderboard::RangeEnd

private

RangeStart

int32 UDownloadLeaderboard::RangeStart

private

SteamLeaderboardResults

TArray<FSteamLeaderboardEntry> UDownloadLeaderboard::SteamLeaderboardResults

private

SteamSubsystem

FOnlineSubsystemSteam* UDownloadLeaderboard::SteamSubsystem

private

Type

ESteamLeaderboardDataRequest UDownloadLeaderboard::Type

private

---

The documentation for this class was generated from the following files:

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/SteamStats/Source/StatsIntegration/Public/Leaderboards/DownloadLeaderboard.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/SteamStats/Source/StatsIntegration/Private/Leaderboards/DownloadLeaderboard.cpp