Pico_Leaderboards.h

// Copyright 2022 Pico Technology Co., Ltd.All rights reserved.
// This plugin incorporates portions of the Unreal® Engine. Unreal® is a trademark or registered trademark of Epic Games, Inc.In the United States of America and elsewhere.
// Unreal® Engine, Copyright 1998 – 2022, Epic Games, Inc.All rights reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/NoExportTypes.h"
#include "PPF_Platform.h"
#include "OnlineSubsystemPicoNames.h"
#include "OnlineSubsystemPico.h"
#include "Pico_User.h"
#include "Pico_Leaderboards.generated.h"
 
 
DECLARE_LOG_CATEGORY_EXTERN(PicoLeaderboards, Log, All);
 
class UPico_Leaderboard;
class UPico_LeaderboardEntry;
class UPico_LeaderboardEntryArray;
class UPico_LeaderboardArray;
class UPico_User;
 
 
DECLARE_DYNAMIC_DELEGATE_ThreeParams(FGet, bool, bIsError, const FString&, ErrorMessage, UPico_LeaderboardArray*, LeaderboardList);
DECLARE_DYNAMIC_DELEGATE_ThreeParams(FGetEntries, bool, bIsError, const FString&, ErrorMessage, UPico_LeaderboardEntryArray*, LeaderboardEntryList);
DECLARE_DYNAMIC_DELEGATE_ThreeParams(FGetEntriesAfterRank, bool, bIsError, const FString&, ErrorMessage, UPico_LeaderboardEntryArray*, LeaderboardEntryList);
DECLARE_DYNAMIC_DELEGATE_ThreeParams(FGetEntriesByIds, bool, bIsError, const FString&, ErrorMessage, UPico_LeaderboardEntryArray*, LeaderboardEntryList);
DECLARE_DYNAMIC_DELEGATE_ThreeParams(FWriteEntry, bool, bIsError, const FString&, ErrorMessage, bool, WriteResult);
DECLARE_DYNAMIC_DELEGATE_ThreeParams(FWriteEntryWithSupplementaryMetric, bool, bIsError, const FString&, ErrorMessage, bool, WriteResult); // todo WriteResult
 
class ONLINESUBSYSTEMPICO_API FPicoLeaderboardsInterface
{
private:
 
    FOnlineSubsystemPico& PicoSubsystem;
 
public:
    FPicoLeaderboardsInterface(FOnlineSubsystemPico& InSubsystem);
    ~FPicoLeaderboardsInterface();
 
    FGet GetDelegate;
    FGetEntries GetEntriesDelegate;
    FGetEntriesAfterRank GetEntriesAfterRankDelegate;
    FGetEntriesByIds GetEntriesByIdsDelegate;
    FWriteEntry WriteEntryDelegate;
    FWriteEntryWithSupplementaryMetric WriteEntryWithSupplementaryMetricDelegate;
 
    bool Get(const FString& LeaderboardName, FGet InGetDelegate);
 
    bool GetEntries(const FString& LeaderboardName, int PageIdx, int PageSize, ppfLeaderboardFilterType Filter, ppfLeaderboardStartAt StartAt, FGetEntries InGetEntriesDelegate);
    
    bool GetEntriesAfterRank(const FString& LeaderboardName, int PageIdx, int PageSize, unsigned long long AfterRank, FGetEntriesAfterRank InGetEntriesAfterRankDelegate);
 
    bool GetEntriesByIds(const FString& LeaderboardName, int PageIdx, int PageSize, ppfLeaderboardStartAt StartAt, const TArray<FString>& UserIDs, FGetEntriesByIds InGetEntriesByIdsDelegate);
 
    bool WriteEntry(const FString& LeaderboardName, const int64& Score, const FString& ExtraData, bool ForceUpdate, FWriteEntry InWriteEntryDelegate);
 
    bool WriteEntryWithSupplementaryMetric(const FString& LeaderboardName, const int64& Score, const int64& SupplementaryMetric, const FString& ExtraData, bool ForceUpdate, FWriteEntryWithSupplementaryMetric InWriteEntryWithSupplementaryMetricDelegate);
 
};
UCLASS()
class ONLINESUBSYSTEMPICO_API UOnlinePicoLeaderboardsFunction : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
 
public:
 
    UFUNCTION(BlueprintCallable, meta = (WorldContext = "WorldContextObject"), Category = "OnlinePico|Leaderboards")
    static void Get(UObject* WorldContextObject, const FString& LeaderboardName, FGet InGetDelegate);
 
    UFUNCTION(BlueprintCallable, meta = (WorldContext = "WorldContextObject"), Category = "OnlinePico|Leaderboards")
    static void GetEntries(UObject* WorldContextObject, const FString& LeaderboardName, int PageIdx, int PageSize, ELeaderboardFilterType Filter, ELeaderboardStartAt StartAt, FGetEntries InGetEntriesDelegate);
    
    UFUNCTION(BlueprintCallable, meta = (WorldContext = "WorldContextObject"), Category = "OnlinePico|Leaderboards")
    static void GetEntriesAfterRank(UObject* WorldContextObject, const FString& LeaderboardName, int PageIdx, int PageSize, const FString& AfterRank, FGetEntriesAfterRank InGetEntriesAfterRankDelegate);
 
    UFUNCTION(BlueprintCallable, meta = (WorldContext = "WorldContextObject"), Category = "OnlinePico|Leaderboards")
    static void GetEntriesByIds(UObject* WorldContextObject, const FString& LeaderboardName, int PageIdx, int PageSize, ELeaderboardStartAt StartAt, const TArray<FString>& UserIDs, FGetEntriesByIds InGetEntriesByIdsDelegate);
 
    UFUNCTION(BlueprintCallable, meta = (WorldContext = "WorldContextObject"), Category = "OnlinePico|Leaderboards")
    static void WriteEntry(UObject* WorldContextObject, const FString& LeaderboardName, const FString& Score, const FString& ExtraData, bool ForceUpdate, FWriteEntry InWriteEntryDelegate);
 
    UFUNCTION(BlueprintCallable, meta = (WorldContext = "WorldContextObject"), Category = "OnlinePico|Leaderboards")
    static void WriteEntryWithSupplementaryMetric(UObject* WorldContextObject, const FString& LeaderboardName, const FString& Score, const FString& SupplementaryMetric, const FString& ExtraData, bool ForceUpdate, FWriteEntryWithSupplementaryMetric InWriteEntryWithSupplementaryMetricDelegate);
    
};
 // end of BP_Leaderboards // end of BlueprintFunction
 
 
//
UCLASS(BlueprintType)
class ONLINESUBSYSTEMPICO_API UPico_LeaderboardEntry : public UObject
{
 
    GENERATED_BODY()
    
public:
    void InitParams(ppfLeaderboardEntryHandle ppfLeaderboardEntryHandle);
 
private:
    uint64_t ID = 0;
    FString DisplayScore = FString();
    int Rank = 0;
    long Score = 0;
    FPicoSupplementaryMetric SupplementaryMetricOptional;
    unsigned long long Timestamp = 0;
    UPROPERTY()
    UPico_User* User = nullptr;
    TArray<uint8> ExtraData;
public:
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry")
    FString GetID();
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry")
    FString GetDisplayScore();
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry")
    int32 GetRank();
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry")
    int64 GetScore();
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry")
    FPicoSupplementaryMetric GetSupplementaryMetricOptional();
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry")
    FString GetTimestamp();
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry")
    FDateTime GetTimestampDateTime();
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry")
    UPico_User* GetUser();
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry")
    FString GetExtraDataString();
 
};
UCLASS(BlueprintType)
class ONLINESUBSYSTEMPICO_API UPico_Leaderboard : public UObject
{
 
    GENERATED_BODY()
 
public:
    void InitParams(ppfLeaderboard* ppfLeaderboardHandle);
 
private:
    FString ApiName = FString();
    uint64_t ID = 0;
    FPicoDestination DestinationOptional;
public:
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard")
    FString GetApiName();
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard")
    FString GetID();
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard")
    FPicoDestination GetDestinationOptional();
};
 
UCLASS(BlueprintType)
class ONLINESUBSYSTEMPICO_API UPico_LeaderboardEntryArray : public UObject
{
    GENERATED_BODY()
private:
    UPROPERTY()
    TArray<UPico_LeaderboardEntry*> LeaderboardEntryArray;
    FString NextPageParam = FString();
    int32 Size = 0;
    bool bHasNextPage;
    int32 TotalSize = 0;
public:
    void InitParams(ppfLeaderboardEntryArrayHandle InppfLeaderboardEntryArrayHandle);
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry Array")
    UPico_LeaderboardEntry* GetElement(int32 Index);
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry Array")
    FString GetNextPageParam();
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry Array")
    int32 GetSize();
    
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry Array")
    int32 GetTotalSize();
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Entry Array")
    bool HasNextPage();
};
 
UCLASS(BlueprintType)
class ONLINESUBSYSTEMPICO_API UPico_LeaderboardArray : public UObject
{
 
    GENERATED_BODY()
private:
    UPROPERTY()
    TArray<UPico_Leaderboard*> LeaderboardArray;
    FString NextPageParam = FString();
    int32 Size = 0;
    bool bHasNextPage;
 
public:
    void InitParams(ppfLeaderboardArrayHandle InppfLeaderboardArrayHandle);
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Definition Array")
        UPico_Leaderboard* GetElement(int32 Index);
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Definition Array")
        FString GetNextPageParam();
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Definition Array")
        int32 GetSize();
 
    UFUNCTION(BlueprintPure, Category = "Pico Platform|Leaderboards|Leaderboard Definition Array")
        bool HasNextPage();
};