PluginReferenceDescriptor.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "CustomBuildSteps.h"
#include "HAL/PlatformCrt.h"
#include "HAL/PlatformMisc.h"
#include "LocalizationDescriptor.h"
#include "Misc/Optional.h"
#include "ModuleDescriptor.h"
#include "Serialization/JsonWriter.h"
#include "Templates/SharedPointer.h"
 
class FJsonObject;
class FJsonValue;
class FText;
 
struct FPluginReferenceDescriptor
{
    FString Name;
 
    bool bEnabled;
 
    bool bOptional;
 
    bool bActivate;
    
    FString Description;
 
    FString MarketplaceURL;
 
    TArray<FString> PlatformAllowList;
 
    TArray<FString> PlatformDenyList;
 
    TArray<EBuildConfiguration> TargetConfigurationAllowList;
 
    TArray<EBuildConfiguration> TargetConfigurationDenyList;
 
    TArray<EBuildTargetType> TargetAllowList;
 
    TArray<EBuildTargetType> TargetDenyList;
 
    TArray<FString> SupportedTargetPlatforms;
 
    bool bHasExplicitPlatforms;
 
    TOptional<int32> RequestedVersion;
 
#if WITH_EDITOR
    mutable TSharedPtr<FJsonObject> CachedJson;
 
    TMap<FString, TSharedPtr<FJsonValue>> AdditionalFieldsToWrite;
#endif //if WITH_EDITOR
 
    PROJECTS_API FPluginReferenceDescriptor(FString InName = TEXT(""), bool bInEnabled = false);
 
    PROJECTS_API bool IsEnabledForPlatform(const FString& Platform) const;
 
    PROJECTS_API bool IsEnabledForTargetConfiguration(EBuildConfiguration Configuration) const;
 
    PROJECTS_API bool IsEnabledForTarget(EBuildTargetType TargetType) const;
 
    PROJECTS_API bool IsSupportedTargetPlatform(const FString& Platform) const;
 
    PROJECTS_API bool Read(const TSharedRef<FJsonObject>& Object, FText* OutFailReason = nullptr);
 
    UE_DEPRECATED(5.1, "Use Read(const TSharedRef<FJsonObject>&) instead.")
    PROJECTS_API bool Read(const FJsonObject& Object, FText* OutFailReason = nullptr, TSharedPtr<FJsonObject> ObjectPtr = nullptr);
 
    UE_DEPRECATED(5.1, "Use Read(const TSharedRef<FJsonObject>&) instead.")
    PROJECTS_API bool Read(const FJsonObject& Object, FText& OutFailReason, TSharedPtr<FJsonObject> ObjectPtr = nullptr);
 
    static PROJECTS_API bool ReadArray(const FJsonObject& Object, const TCHAR* Name, TArray<FPluginReferenceDescriptor>& OutModules, FText* OutFailReason = nullptr);
 
    static PROJECTS_API bool ReadArray(const FJsonObject& Object, const TCHAR* Name, TArray<FPluginReferenceDescriptor>& OutModules, FText& OutFailReason);
 
    PROJECTS_API void Write(TJsonWriter<>& Writer) const;
    
    PROJECTS_API void UpdateJson(FJsonObject& JsonObject) const;
 
    static PROJECTS_API void WriteArray(TJsonWriter<>& Writer, const TCHAR* ArrayName, const TArray<FPluginReferenceDescriptor>& Plugins);
 
    static PROJECTS_API void UpdateArray(FJsonObject& JsonObject, const TCHAR* ArrayName, const TArray<FPluginReferenceDescriptor>& Plugins);
 
#if WITH_EDITOR
    PROJECTS_API bool GetAdditionalStringField(const FString& Key, FString& OutValue) const;
#endif //if WITH_EDITOR
};