PluginDescriptor.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 "CustomBuildSteps.h"
#include "HAL/Platform.h"
#include "LocalizationDescriptor.h"
#include "Misc/CoreDelegates.h"
#include "Misc/Optional.h"
#include "ModuleDescriptor.h"
#include "PluginDisallowedDescriptor.h"
#include "PluginReferenceDescriptor.h"
#include "Serialization/JsonWriter.h"
#include "Templates/SharedPointer.h"
#include "VerseScope.h"
 
class FJsonObject;
class FJsonValue;
class FText;
 
enum class EPluginEnabledByDefault : uint8
{
    Unspecified,
    Enabled,
    Disabled,
};
 
struct FPluginDescriptor
{
    int32 Version;
 
    FString VersionName;
 
    FString FriendlyName;
 
    FString Description;
 
    FString Category;
 
    FString CreatedBy;
 
    FString CreatedByURL;
 
    FString DocsURL;
 
    FString MarketplaceURL;
 
    FString SupportURL;
 
    FString EngineVersion;
 
    FString EditorCustomVirtualPath;
 
    TArray<FString> SupportedTargetPlatforms;
 
    TArray<FString> SupportedPrograms;
 
    FString ParentPluginName;
 
    TArray<FModuleDescriptor> Modules;
 
    TArray<FLocalizationTargetDescriptor> LocalizationTargets;
 
    FString VersePath;
 
    FString DeprecatedEngineVersion; 
 
    EVerseScope::Type VerseScope = EVerseScope::PublicUser;
 
    TOptional<uint32> VerseVersion;
 
    bool bEnableSceneGraph = false;
 
    bool bEnableVerseAssetReflection = false;
 
    bool bEnableIAD = false;
 
    EPluginEnabledByDefault EnabledByDefault;
 
    bool bCanContainContent;
 
    bool bCanContainVerse;
 
    bool bIsBetaVersion;
 
    bool bIsExperimentalVersion;
 
    bool bInstalled;
 
    bool bRequiresBuildPlatform;
 
    bool bIsHidden;
 
    bool bIsSealed;
 
    bool bNoCode;
 
    bool bExplicitlyLoaded;
 
    bool bHasExplicitPlatforms;
 
    bool bIsPluginExtension;
 
    FCustomBuildSteps PreBuildSteps;
 
    FCustomBuildSteps PostBuildSteps;
 
    TArray<FPluginReferenceDescriptor> Plugins;
 
    TArray<FPluginDisallowedDescriptor> DisallowedPlugins;
 
 
#if WITH_EDITOR
    mutable TSharedPtr<FJsonObject> CachedJson;
 
    TMap<FString, TSharedPtr<FJsonValue>> AdditionalFieldsToWrite;
 
    TSet<FString> AdditionalFieldsToRemove;
#endif
 
    static PROJECTS_API const FString& GetFileExtension();
 
    PROJECTS_API FPluginDescriptor();
 
    PROJECTS_API bool Load(const TCHAR* FileName, FText* OutFailReason = nullptr);
 
    PROJECTS_API bool Load(const FString& FileName, FText* OutFailReason = nullptr);
 
    PROJECTS_API bool Load(const FString& FileName, FText& OutFailReason);
 
    /* Reads the descriptor using the global CustomPluginDescriptorReaderDelegate */
    PROJECTS_API bool ReadWithCustomPluginDescriptorReader(const TCHAR* FileName, FText* OutFailReason = nullptr);
 
    PROJECTS_API bool Read(const FString& Text, FText* OutFailReason = nullptr);
 
    PROJECTS_API bool Read(const FString& Text, FText& OutFailReason);
 
    PROJECTS_API bool Read(const FJsonObject& Object, FText* OutFailReason = nullptr);
 
    PROJECTS_API bool Read(const FJsonObject& Object, FText& OutFailReason);
 
    PROJECTS_API bool Save(const TCHAR* FileName, FText* OutFailReason = nullptr) const;
 
    PROJECTS_API bool Save(const FString& FileName, FText* OutFailReason = nullptr) const;
 
    PROJECTS_API bool Save(const FString& FileName, FText& OutFailReason) const;
 
    PROJECTS_API void Write(FString& Text) const;
 
    PROJECTS_API void Write(TJsonWriter<>& Writer) const;
 
    PROJECTS_API void UpdateJson(FJsonObject& JsonObject) const;
 
    PROJECTS_API bool UpdatePluginFile(const FString& FileName, FText* OutFailReason = nullptr) const;
 
    PROJECTS_API bool UpdatePluginFile(const FString& FileName, FText& OutFailReason) const;
 
    PROJECTS_API bool SupportsTargetPlatform(const FString& Platform) const;
 
    // Custom hook for providing a plugin descriptor (as an FJsonObject) based on a filename
    DECLARE_DELEGATE_RetVal_FourParams(bool, FPluginDescriptorReaderDelegate, const TCHAR*/*Filename*/, FText*/*OutFailReason*/,  TSharedPtr<FJsonObject>&/*OutJson*/, bool&/*OutRetryWithNative*/);
    PROJECTS_API static FPluginDescriptorReaderDelegate CustomPluginDescriptorReaderDelegate;
};
 
namespace UE::PluginDescriptor::Internal
{
    PROJECTS_API bool ReadFile(const TCHAR* FileName, FString& Text, FText* OutFailReason = nullptr);
    PROJECTS_API TSharedPtr<FJsonObject> DeserializeJson(const FString& Text, FText* OutFailReason = nullptr);
}