USetLeaderboard Class Reference

#include <SetLeaderboard.h>

Inheritance diagram for USetLeaderboard:

Static Public Member Functions
static USetLeaderboard *	SetLeaderboard (const FSteamLeaderboardHandle Handle, const ESteamLeaderboardUploadScoreMethod UploadMethod, const int32 NewScore, const TArray< int32 > NewScoreDetails)

Public Attributes
FResponseUploadLeaderboardDelegate	OnSuccess
FResponseUploadLeaderboardDelegate	OnFailure

Private Member Functions
virtual void	Activate () override
void	UploadLeaderboard ()
void	OnUploadLeaderboard (LeaderboardScoreUploaded_t *pLeaderboardScoresUploaded, bool bIOFailure)

Private Attributes
FOnlineSubsystemSteam *	SteamSubsystem
FSteamLeaderboardHandle	LeaderboardHandle
ESteamLeaderboardUploadScoreMethod	Method
int32	Score
TArray< int32 >	ScoreDetails
CCallResult< USetLeaderboard, LeaderboardScoreUploaded_t >	m_callUploadResult

Member Function Documentation

Activate()

void USetLeaderboard::Activate ( )

overrideprivatevirtual

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

OnUploadLeaderboard()

void USetLeaderboard::OnUploadLeaderboard ( LeaderboardScoreUploaded_t * pLeaderboardScoresUploaded, bool bIOFailure )

private

{
    if(!bIOFailure)
    {
        AsyncTask(ENamedThreads::GameThread, [this]()
        {
            OnSuccess.Broadcast(EResult::k_EResultOK);
        });
        GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Green, TEXT("Leaderboards Uploaded!"));
        if(pLeaderboardScoresUploaded->m_bSuccess)
        {
            UE_LOG(LogTemp,Warning,TEXT("Success Leaderboard Upload in Callback"));
        }
    }
    else
    {
        GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, TEXT("Failed to Upload Leaderboard!"));
        OnFailure.Broadcast(99);
    }
    RemoveFromRoot();
}

SetLeaderboard()

USetLeaderboard * USetLeaderboard::SetLeaderboard ( const FSteamLeaderboardHandle Handle, const ESteamLeaderboardUploadScoreMethod UploadMethod, const int32 NewScore, const TArray< int32 > NewScoreDetails )

static

{
    USetLeaderboard* SelfRef = NewObject<USetLeaderboard>();
    SelfRef->SteamSubsystem = static_cast<FOnlineSubsystemSteam*>(IOnlineSubsystem::Get());
    SelfRef->LeaderboardHandle = Handle;
    SelfRef->Score = NewScore;
    SelfRef->ScoreDetails = NewScoreDetails;
    return SelfRef;
}

UploadLeaderboard()

void USetLeaderboard::UploadLeaderboard ( )

private

{
    if(LeaderboardHandle.Handle == 0)
    {
        GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, TEXT("Invalid leaderboard handle!"));
        OnFailure.Broadcast(EResult::k_EResultFail);
        RemoveFromRoot();
        return;
    }
    uint8 MethodIndex = static_cast<uint8>(Method);
    const ELeaderboardUploadScoreMethod UploadMethod = static_cast<ELeaderboardUploadScoreMethod>(MethodIndex);
    const int32* ScoreDetailsPtr = ScoreDetails.Num() > 0 ? ScoreDetails.GetData() : nullptr;
    SteamAPICall_t hSteamAPICall = SteamUserStats()->UploadLeaderboardScore(LeaderboardHandle.Handle, k_ELeaderboardUploadScoreMethodForceUpdate, Score, ScoreDetailsPtr, ScoreDetails.Num());
    m_callUploadResult.Set(hSteamAPICall, this, &USetLeaderboard::OnUploadLeaderboard);
}

Member Data Documentation

LeaderboardHandle

FSteamLeaderboardHandle USetLeaderboard::LeaderboardHandle

private

m_callUploadResult

CCallResult<USetLeaderboard, LeaderboardScoreUploaded_t> USetLeaderboard::m_callUploadResult

private

Method

ESteamLeaderboardUploadScoreMethod USetLeaderboard::Method

private

OnFailure

FResponseUploadLeaderboardDelegate USetLeaderboard::OnFailure

OnSuccess

FResponseUploadLeaderboardDelegate USetLeaderboard::OnSuccess

Score

int32 USetLeaderboard::Score

private

ScoreDetails

TArray<int32> USetLeaderboard::ScoreDetails

private

SteamSubsystem

FOnlineSubsystemSteam* USetLeaderboard::SteamSubsystem

private

---

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

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