DownloadLeaderboard.h

Go to the documentation of this file.

// Fill out your copyright notice in the Description page of Project Settings.
 
#pragma once
#pragma warning(disable:4996)
#pragma warning(disable:4265)
#pragma warning(disable:4701)
 
#include "CoreMinimal.h"
#include "SteamRequests.h"
#include "Kismet/BlueprintAsyncActionBase.h"
#pragma push_macro("ARRAY_COUNT")
#undef ARRAY_COUNT
 
#if USING_CODE_ANALYSIS
MSVC_PRAGMA(warning(push))
MSVC_PRAGMA(warning(disable : ALL_CODE_ANALYSIS_WARNINGS))
#endif
 
#include "OnlineSubsystem.h"
#include "OnlineSubsystemSteam.h"
#include <steam/steam_api.h>
 
#include "LeaderboardData.h"
 
#if USING_CODE_ANALYSIS
MSVC_PRAGMA(warning(pop))
#endif
 
#pragma pop_macro("ARRAY_COUNT")
#include "DownloadLeaderboard.generated.h"
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FResponseDownloadLeaderboardDelegate, const TArray<FSteamLeaderboardEntry>&, LeaderboardResults, int32, SteamErrorOutput);
 
UCLASS()
class STATSINTEGRATION_API UDownloadLeaderboard : public UBlueprintAsyncActionBase
{
    GENERATED_BODY()
    
public:
    UPROPERTY(BlueprintAssignable)
    FResponseDownloadLeaderboardDelegate OnSuccess;
 
    UPROPERTY(BlueprintAssignable)
    FResponseDownloadLeaderboardDelegate OnFailure;
 
    // Asks the Steam back-end for a set of rows in the leaderboard.
    // This call is asynchronous, with the result returned in LeaderboardScoresDownloaded_t
    // LeaderboardScoresDownloaded_t will contain a handle to pull the results from GetDownloadedLeaderboardEntries() (below)
    // You can ask for more entries than exist, and it will return as many as do exist.
    // k_ELeaderboardDataRequestGlobal requests rows in the leaderboard from the full table, with nRangeStart & nRangeEnd in the range [1, TotalEntries]
    // k_ELeaderboardDataRequestGlobalAroundUser requests rows around the current user, nRangeStart being negate
    //   e.g. DownloadLeaderboardEntries( hLeaderboard, k_ELeaderboardDataRequestGlobalAroundUser, -3, 3 ) will return 7 rows, 3 before the user, 3 after
    // k_ELeaderboardDataRequestFriends requests all the rows for friends of the current user 
    UFUNCTION(BlueprintCallable, meta = (BlueprintInternalUseOnly = "true"), Category = "Simple Steam Stats & Achievements")
    static UDownloadLeaderboard* DownloadLeaderboard(const FSteamLeaderboardHandle Handle, const ESteamLeaderboardDataRequest RequestType, const int32 Start, const int32 End);
 
    // as above, but downloads leaderboard entries for an arbitrary set of users - ELeaderboardDataRequest is k_ELeaderboardDataRequestUsers
    // if a user doesn't have a leaderboard entry, they won't be included in the result
    // a max of 100 users can be downloaded at a time, with only one outstanding call at a time
    // UFUNCTION(BlueprintCallable, meta = (BlueprintInternalUseOnly = "true"), Category = "Simple Steam Stats & Achievements")
    // virtual UDownloadLeaderboard* DownloadLeaderboardEntriesForUsers(const FSteamLeaderboardHandle Handle, CSteamID *prgUsers, const int32 Users);
    
private:
    FOnlineSubsystemSteam* SteamSubsystem;
    virtual void Activate() override;
 
    void DownloadLeaderboardEntries();
 
    FSteamLeaderboardHandle LeaderboardHandle;
    FString LeaderboardName;
    ESteamLeaderboardDataRequest Type;
    int32 RangeStart;
    int32 RangeEnd;
    
    TArray<FSteamLeaderboardEntry> SteamLeaderboardResults;
 
    void OnLeaderboardDownloaded(LeaderboardScoresDownloaded_t* pLeaderboardScoresDownloaded, bool bIOFailure);
    CCallResult<UDownloadLeaderboard, LeaderboardScoresDownloaded_t> m_callDownloadResult;  
};