LootLockerPlayerRequestHandler.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once
 
 
#include "CoreMinimal.h"
#include "LootLockerResponse.h"
#include "LootLockerPlayerData.h"
#include "GameAPI/LootLockerAssetsRequestHandler.h"
#include "LootLockerPlayerRequestHandler.generated.h"
 
USTRUCT(BlueprintType)
struct FLootLockerPlayerInfo 
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    FString Created_at = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    FString Last_seen = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    FString Name = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    FString Public_uid = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    int Legacy_id = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    FString Id = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerListPlayerInfoRequest
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    TArray<FString> Player_id;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    TArray<int> Player_legacy_id;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    TArray<FString> Player_public_uid;
};
 
USTRUCT(BlueprintType)
struct FLootLockerGetCurrentPlayerInfoResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    FLootLockerPlayerInfo Info;
};
 
USTRUCT(BlueprintType)
struct FLootLockerListPlayerInfoResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="LootLocker")
    TArray<FLootLockerPlayerInfo> Info;
};
 
USTRUCT(BlueprintType)
struct FLootLockerBalanceResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    float balance = 0.0f;
};
 
USTRUCT(BlueprintType)
struct FLootLockerDlcResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FString> dlcs;
};
 
USTRUCT(BlueprintType)
struct FLootLockerRental {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool is_rental = false;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString time_left = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString duration = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString is_active = "";
};
USTRUCT(BlueprintType)
struct FLootLockerInventory {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 instance_id = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 variation_id = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString rental_option_id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString acquisition_source = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerAsset asset;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerRental rental;
};
USTRUCT(BlueprintType)
struct FLootLockerInventoryResponse : public FLootLockerResponse {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerInventory> inventory;
};
 
USTRUCT(BlueprintType)
struct FLootLockerPlayerLevel {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 level = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 xp_threshold = 0;
};
USTRUCT(BlueprintType)
struct FLootLockerXp {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 previous = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 current = 0;
};
 
USTRUCT(BlueprintType)
struct FLootLockerObjects
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 instance_id = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 variation_id = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerAsset asset;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString acquisition_source = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString reason = "";
};
USTRUCT(BlueprintType)
struct FLootLockerPlayerAssetNotificationResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerObjects> objects;
};
 
USTRUCT(BlueprintType)
struct FLootLockerNameResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString name = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerPlayerNameRequest
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString name = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerPlayerXpInfo
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 xp = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 level = 0;
};
 
 
USTRUCT(BlueprintType)
struct FLootLockerMultiplePlayersNames
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString player_id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString player_public_uid = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString ulid = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString name = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString last_active_platform = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString platform_player_id = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerPlatformIds
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 steam_id = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString xbox_id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 psn_id = 0;
};
 
USTRUCT(BlueprintType)
struct FLootLockerMultiplePlayersPlatformIds
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString player_id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString player_public_uid = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString name = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString last_active_platform = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerPlatformIds platform_ids;
};
 
USTRUCT(BlueprintType)
struct FLootLockerMultiplePlayersPlatformIdsResponse : public FLootLockerResponse {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerMultiplePlayersPlatformIds> players;
};
 
USTRUCT(BlueprintType)
struct FLootLockerMultiplePlayersNamesResponse : public FLootLockerResponse {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerMultiplePlayersNames> players;
};
 
UENUM(BlueprintType)
enum class ELootLockerPlayerDataLookupIdType : uint8
{
    Player_id = 0,
    Player_public_uid = 1,
    Player_guest_login_id = 2,
    Steam_id = 3,
    Psn_id = 4,
    Xbox_id = 5,
    Player_ulid = 6,
    Player_name = 7,
    Epic_games_id = 8,
    Google_play_games_id = 9
};
 
USTRUCT(BlueprintType)
struct FLootLockerPlayerDataLookupPair
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerPlayerDataLookupIdType IdType = ELootLockerPlayerDataLookupIdType::Player_id;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Id = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerMultiplePlayerNameRequest {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString platform = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString player_id = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerMultiplePlayerNamesRequest {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerMultiplePlayerNameRequest> player_ids;
};
 
USTRUCT(BlueprintType)
struct FLootLockerLookupMultiplePlayersDataRequest {
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerPlayerDataLookupPair> player_ids;
};
 
USTRUCT(BlueprintType)
struct FLootLockerMultiplePlayerNamesAndPlatformsRequest {
    GENERATED_BODY()
        UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
        TArray<FString> player_ids;
        UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
        TArray<FString> player_public_uids;
};
 
USTRUCT(BlueprintType)
struct FLootLockerInventoryItemPurchaseData
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString store = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString entitlement_id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString purchase_group_id = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerSimpleInventoryItem
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Asset_id = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Asset_ulid = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Asset_name = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Instance_id = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Ulid = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Acquisition_source = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Acquisition_date = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerMetadataEntry> Metadata;
 
    LOOTLOCKERSDK_API bool TryGetPurchaseData(FLootLockerInventoryItemPurchaseData& Output) const;
};
 
USTRUCT(BlueprintType)
struct FLootLockerListSimplifiedInventoryFilter
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<int32> Asset_ids;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<int32> Context_ids;
};
 
USTRUCT(BlueprintType)
struct FLootLockerListSimplifiedInventoryMetadataIncludes
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool All = false;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FString> Keys;
};
 
USTRUCT(BlueprintType)
struct FLootLockerListSimplifiedInventoryIncludes
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerListSimplifiedInventoryMetadataIncludes Metadata;
};
 
USTRUCT(BlueprintType)
struct FLootLockerListSimplifiedInventoryRequest
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerListSimplifiedInventoryIncludes Includes;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerListSimplifiedInventoryFilter Filters;
};
 
USTRUCT(BlueprintType)
struct FLootLockerSimpleInventoryResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerSimpleInventoryItem> Items;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerExtendedIndexBasedPagination Pagination;
};
 
 
DECLARE_DELEGATE_OneParam(FLootLockerGetCurrentPlayerInfoResponseDelegate, FLootLockerGetCurrentPlayerInfoResponse);
 
DECLARE_DELEGATE_OneParam(FLootLockerListPlayerInfoResponseDelegate, FLootLockerListPlayerInfoResponse);
 
DECLARE_DELEGATE_OneParam(FInventoryResponse, FLootLockerInventoryResponse);
 
DECLARE_DELEGATE_OneParam(FLootLockerAssetNotificationResponse, FLootLockerPlayerAssetNotificationResponse);
 
DECLARE_DELEGATE_OneParam(FPBalanceResponse, FLootLockerBalanceResponse);
 
DECLARE_DELEGATE_OneParam(FPDlcResponse, FLootLockerDlcResponse);
 
DECLARE_DELEGATE_OneParam(FPNameResponse, FLootLockerNameResponse);
 
DECLARE_DELEGATE_OneParam(FPMultiplePlayerNames, FLootLockerMultiplePlayersNamesResponse);
 
DECLARE_DELEGATE_OneParam(FPMultiplePlayersPlatformIdsNames, FLootLockerMultiplePlayersPlatformIdsResponse);
 
DECLARE_DELEGATE_OneParam(FLootLockerSimpleInventoryResponseDelegate, FLootLockerSimpleInventoryResponse);
 
UCLASS()
class LOOTLOCKERSDK_API ULootLockerPlayerRequestHandler : public UObject
{
    GENERATED_BODY()
public:
    ULootLockerPlayerRequestHandler() {};
 
    static FString GetCurrentPlayerInfo(const FLootLockerPlayerData& PlayerData, const FLootLockerGetCurrentPlayerInfoResponseDelegate& OnCompletedRequest);
    static FString ListPlayerInfo(const FLootLockerPlayerData& PlayerData, TArray<FString> PlayerIdsToLookUp, TArray<int> PlayerLegacyIdsToLookUp, TArray<FString> PlayerPublicUidsToLookUp, const FLootLockerListPlayerInfoResponseDelegate& OnCompletedRequest);
    static FString GetInventory(const FLootLockerPlayerData& PlayerData, const FInventoryResponse& OnCompletedRequest);
    static FString GetFullInventory(const FLootLockerPlayerData& PlayerData, const FInventoryResponse& OnCompletedRequest, int32 StartIndex = 0);
    static FString CheckPlayerAssetNotification(const FLootLockerPlayerData& PlayerData, const FLootLockerAssetNotificationResponse& OnCompletedRequest);
    static FString GetCurrencyBalance(const FLootLockerPlayerData& PlayerData, const FPBalanceResponse& OnCompletedRequest);
    static FString InitiateDLCMigration(const FLootLockerPlayerData& PlayerData, const FResponseCallback& OnCompletedRequest);
    static FString GetDLCsMigration(const FLootLockerPlayerData& PlayerData, const FPDlcResponse& OnCompletedRequest);
    static FString SetProfilePrivate(const FLootLockerPlayerData& PlayerData, const FResponseCallback& OnCompletedRequest);
    static FString SetProfilePublic(const FLootLockerPlayerData& PlayerData, const FResponseCallback& OnCompletedRequest);
    static FString SetPlayerName(const FLootLockerPlayerData& PlayerData, FString Name, const FPNameResponse& OnCompletedRequest);
    static FString GetPlayerName(const FLootLockerPlayerData& PlayerData, const FPNameResponse& OnCompletedRequest);
    // Deprecated date 20250304
    static FString LookupMultiplePlayerNamesUsingIDs(const FLootLockerPlayerData& PlayerData, FLootLockerMultiplePlayerNamesRequest Request, const FPMultiplePlayerNames& OnCompletedRequest);
    static FString LookupMultiplePlayersDataUsingIDs(const FLootLockerPlayerData& PlayerData, FLootLockerLookupMultiplePlayersDataRequest Request, const FPMultiplePlayerNames& OnCompletedRequest);
    static FString LookupMultiplePlayerNames1stPlatformIDs(const FLootLockerPlayerData& PlayerData, const FLootLockerMultiplePlayerNamesAndPlatformsRequest& Request, const FPMultiplePlayersPlatformIdsNames& OnCompletedRequest);
    static FString DeletePlayer(const FLootLockerPlayerData& PlayerData, const FLootLockerDefaultDelegate OnCompletedRequest);
    
    // Simple inventory listing methods
    static FString ListPlayerInventory(const FLootLockerPlayerData& PlayerData, const FLootLockerListSimplifiedInventoryRequest& Request, int32 PerPage, int32 Page, const FLootLockerSimpleInventoryResponseDelegate& OnCompletedRequest);
    static FString ListCharacterInventory(const FLootLockerPlayerData& PlayerData, const FLootLockerListSimplifiedInventoryRequest& Request, int32 CharacterId, int32 PerPage, int32 Page, const FLootLockerSimpleInventoryResponseDelegate& OnCompletedRequest);
};