ProjectDescriptor.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Set.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CustomBuildSteps.h"
#include "HAL/Platform.h"
#include "ModuleDescriptor.h"
#include "PluginReferenceDescriptor.h"
#include "Serialization/JsonWriter.h"
#include "UObject/NameTypes.h"
#include "JsonUtils/RapidJsonUtils.h"
 
class FJsonObject;
class FText;
 
namespace EProjectDescriptorVersion
{
    enum Type
    {
        Invalid = 0,
        Initial = 1,
        NameHash = 2,
        ProjectPluginUnification = 3,
        // !!!!!!!!!! IMPORTANT: Remember to also update LatestPluginDescriptorFileVersion in Plugins.cs (and Plugin system documentation) when this changes!!!!!!!!!!!
        // -----<new versions can be added before this line>-------------------------------------------------
        // - this needs to be the last line (see note below)
        LatestPlusOne,
        Latest = LatestPlusOne - 1
    };
}
 
struct FProjectDescriptor
{
    EProjectDescriptorVersion::Type FileVersion;
 
    FString EngineAssociation;
 
    FString Category;
 
    FString Description;
 
    TArray<FModuleDescriptor> Modules;
 
    TArray<FPluginReferenceDescriptor> Plugins;
 
    TArray<FName> TargetPlatforms;
 
    uint32 EpicSampleNameHash;
 
    FCustomBuildSteps PreBuildSteps;
 
    FCustomBuildSteps PostBuildSteps;
 
    bool bIsEnterpriseProject;
 
    bool bDisableEnginePluginsByDefault;
 
    PROJECTS_API FProjectDescriptor();
 
    PROJECTS_API void Sign(const FString& FilePath);
 
    PROJECTS_API bool IsSigned(const FString& FilePath) const;
 
    PROJECTS_API int32 FindPluginReferenceIndex(const FString& PluginName) const;
 
    PROJECTS_API void UpdateSupportedTargetPlatforms(const FName& InPlatformName, bool bIsSupported);
 
    PROJECTS_API bool Load(const FString& FileName, FText& OutFailReason);
 
    PROJECTS_API bool Read(const FJsonObject& Object, const FString& PathToProject, FText& OutFailReason);
 
    PROJECTS_API bool Save(const FString& FileName, FText& OutFailReason);
 
    PROJECTS_API void Write(TJsonWriter<>& Writer, const FString& PathToProject) const;
 
    static PROJECTS_API FString GetExtension();
 
    const TArray<FString>& GetAdditionalPluginDirectories() const
    {
        return AdditionalPluginDirectories;
    }
 
    PROJECTS_API bool AddPluginDirectory(const FString& Dir);
    PROJECTS_API bool RemovePluginDirectory(const FString& Dir);
 
    const TArray<FString>& GetAdditionalRootDirectories() const
    {
        return AdditionalRootDirectories;
    }
 
    PROJECTS_API bool AddRootDirectory(const FString& Dir);
    PROJECTS_API bool RemoveRootDirectory(const FString& Dir);
 
#if WITH_EDITOR
    PROJECTS_API bool HasModule(FName ModuleName) const;
#endif //if WITH_EDITOR
 
private:
    PROJECTS_API const FString MakePathRelativeToProject(const FString& Dir, const FString& PathToProject) const;
 
    TArray<FString> AdditionalPluginDirectories;
 
    TArray<FString> AdditionalRootDirectories;
 
#if WITH_EDITOR
    mutable TSet<FName> ModuleNamesCache;
#endif //if WITH_EDITOR
 
    friend struct FProjectsLoadingPluginDescriptorTestsHelper;
    bool Read(const UE::Json::FConstObject Object, const FString& PathToProject, FText& OutFailReason);
};