UFindLeaderboard Class Reference

#include <FindLeaderboard.h>

Inheritance diagram for UFindLeaderboard:

Static Public Member Functions
static UFindLeaderboard *	FindOrCreateLeaderboard (FString Name, ESteamLeaderboardSortMethod SortMethod, ESteamLeaderboardDisplayType DisplayType)
static UFindLeaderboard *	FindLeaderboard (FString Name)

Public Attributes
FResponseFindLeaderboardDelegate	OnSuccess
FResponseFindLeaderboardDelegate	OnFailure

Private Member Functions
virtual void	Activate () override
void	FindLeaderboardByName ()
void	FindOrCreateLeaderboardByName ()
void	OnLeaderboardFound (LeaderboardFindResult_t *pCallback, bool bIOFailure)

Private Attributes
FOnlineSubsystemSteam *	SteamSubsystem
FSteamLeaderboardHandle	Handle
FString	LeaderboardName
bool	bCreateLeaderboard
ESteamLeaderboardSortMethod	LeaderboardSortMethod
ESteamLeaderboardDisplayType	LeaderboardDisplayType
CCallResult< UFindLeaderboard, LeaderboardFindResult_t >	m_callFindResult

Member Function Documentation

Activate()

void UFindLeaderboard::Activate ( )

overrideprivatevirtual

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

FindLeaderboard()

UFindLeaderboard * UFindLeaderboard::FindLeaderboard ( FString Name )

static

{
    UFindLeaderboard* SelfRef = NewObject<UFindLeaderboard>();
    SelfRef->SteamSubsystem = static_cast<FOnlineSubsystemSteam*>(IOnlineSubsystem::Get());
    SelfRef->bCreateLeaderboard = false;
    SelfRef->LeaderboardName = Name;
    return SelfRef;
}

FindLeaderboardByName()

void UFindLeaderboard::FindLeaderboardByName ( )

private

{
    //- Call Find Function  //
    SteamAPICall_t hSteamAPICall = SteamUserStats()->FindLeaderboard(TCHAR_TO_ANSI(*LeaderboardName));
    //- Attach Callback function    //
    m_callFindResult.Set(hSteamAPICall, this, &UFindLeaderboard::OnLeaderboardFound);
}

FindOrCreateLeaderboard()

UFindLeaderboard * UFindLeaderboard::FindOrCreateLeaderboard ( FString Name, ESteamLeaderboardSortMethod SortMethod, ESteamLeaderboardDisplayType DisplayType )

static

{
    UFindLeaderboard* SelfRef = NewObject<UFindLeaderboard>();
    SelfRef->SteamSubsystem = static_cast<FOnlineSubsystemSteam*>(IOnlineSubsystem::Get());
    SelfRef->LeaderboardName = Name;
    SelfRef->bCreateLeaderboard = true;
    SelfRef->LeaderboardSortMethod = SortMethod;
    SelfRef->LeaderboardDisplayType = DisplayType;
    return SelfRef;
}

FindOrCreateLeaderboardByName()

void UFindLeaderboard::FindOrCreateLeaderboardByName ( )

private

{
    uint8 SortMethodIndex = static_cast<uint8>(LeaderboardSortMethod);
    uint8 DisplayTypeIndex = static_cast<uint8>(LeaderboardDisplayType);
    const ELeaderboardSortMethod SortMethod = static_cast<ELeaderboardSortMethod>(SortMethodIndex);
    const ELeaderboardDisplayType DisplayType = static_cast<ELeaderboardDisplayType>(DisplayTypeIndex);
    //- Call Find Function  //
    SteamAPICall_t hSteamAPICall = SteamUserStats()->FindOrCreateLeaderboard(TCHAR_TO_ANSI(*LeaderboardName), SortMethod, DisplayType);
    //- Attach Callback function    //
    m_callFindResult.Set(hSteamAPICall, this, &UFindLeaderboard::OnLeaderboardFound);
}

OnLeaderboardFound()

void UFindLeaderboard::OnLeaderboardFound ( LeaderboardFindResult_t * pCallback, bool bIOFailure )

private

{
    Handle = FSteamLeaderboardHandle(pCallback->m_hSteamLeaderboard);
    if(!bIOFailure && pCallback->m_bLeaderboardFound != 0)
    {
        AsyncTask(ENamedThreads::GameThread, [this]()
            {   OnSuccess.Broadcast(Handle, EResult::k_EResultOK);}
        );
        GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Green, TEXT("Leaderboard Found!"));
    }
    else
    {
        GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, TEXT("Failed to find Leaderboard!"));
        OnFailure.Broadcast(Handle, 99);
    }
    RemoveFromRoot();
}

Member Data Documentation

bCreateLeaderboard

bool UFindLeaderboard::bCreateLeaderboard

private

Handle

FSteamLeaderboardHandle UFindLeaderboard::Handle

private

LeaderboardDisplayType

ESteamLeaderboardDisplayType UFindLeaderboard::LeaderboardDisplayType

private

LeaderboardName

FString UFindLeaderboard::LeaderboardName

private

LeaderboardSortMethod

ESteamLeaderboardSortMethod UFindLeaderboard::LeaderboardSortMethod

private

m_callFindResult

CCallResult<UFindLeaderboard, LeaderboardFindResult_t> UFindLeaderboard::m_callFindResult

private

OnFailure

FResponseFindLeaderboardDelegate UFindLeaderboard::OnFailure

OnSuccess

FResponseFindLeaderboardDelegate UFindLeaderboard::OnSuccess

SteamSubsystem

FOnlineSubsystemSteam* UFindLeaderboard::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/FindLeaderboard.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/SteamStats/Source/StatsIntegration/Private/Leaderboards/FindLeaderboard.cpp