IProjectManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
 
#include "CoreMinimal.h"
#include "ModuleDescriptor.h"
 
struct FProjectDescriptor;
 
class FProjectStatus
{
public:
 
    FString Name;
 
    FString Description;
 
    FString Category;
 
    bool bSignedSampleProject;
 
    bool bCodeBasedProject;
 
    bool bRequiresUpdate;
 
    TArray<FName> TargetPlatforms;
 
    FProjectStatus()
        : bSignedSampleProject(false)
        , bCodeBasedProject(false)
        , bRequiresUpdate(false)
    {}
 
    bool IsTargetPlatformSupported(const FName& InPlatformName, const bool bAllowSupportedIfEmptyList = true) const
    {
        // An empty list is considered the same as supporting all platforms
        return (bAllowSupportedIfEmptyList && TargetPlatforms.Num() == 0) || TargetPlatforms.Contains(InPlatformName);
    }
 
    bool SupportsAllPlatforms() const
    {
        return TargetPlatforms.Num() == 0;
    }
};
 
class IProjectManager
{
 
public:
    virtual ~IProjectManager() { }
 
    static PROJECTS_API IProjectManager& Get();
 
    virtual const FProjectDescriptor* GetCurrentProject() const = 0;
 
    virtual bool LoadProjectFile( const FString& ProjectFile ) = 0;
 
    virtual bool LoadModulesForProject( const ELoadingPhase::Type LoadingPhase ) = 0;
 
    virtual bool SubstituteModule(const FString& OriginalModuleName, const FString& NewModuleName) = 0;
 
    DECLARE_EVENT_TwoParams(IProjectManager, FLoadingModulesForPhaseEvent, ELoadingPhase::Type /*LoadingPhase*/, bool /*bSuccess*/);
    virtual FLoadingModulesForPhaseEvent& OnLoadingPhaseComplete() = 0;
 
#if !IS_MONOLITHIC
    virtual bool CheckModuleCompatibility(TArray<FString>& OutIncompatibleModules) = 0;
#endif
 
    virtual const FString& GetAutoLoadProjectFileName() = 0;
 
    virtual bool SignSampleProject(const FString& FilePath, const FString& Category, FText& OutFailReason) = 0;
 
    virtual bool QueryStatusForProject(const FString& FilePath, FProjectStatus& OutProjectStatus) const = 0;
 
    virtual bool QueryStatusForCurrentProject(FProjectStatus& OutProjectStatus) const = 0;
 
    virtual void UpdateSupportedTargetPlatformsForProject(const FString& FilePath, const FName& InPlatformName, const bool bIsSupported) = 0;
 
    virtual void UpdateSupportedTargetPlatformsForCurrentProject(const FName& InPlatformName, const bool bIsSupported) = 0;
 
    virtual void ClearSupportedTargetPlatformsForProject(const FString& FilePath) = 0;
 
    virtual void ClearSupportedTargetPlatformsForCurrentProject() = 0;
 
    DECLARE_MULTICAST_DELEGATE(FOnTargetPlatformsForCurrentProjectChangedEvent);
    virtual FOnTargetPlatformsForCurrentProjectChangedEvent& OnTargetPlatformsForCurrentProjectChanged() = 0;
 
    virtual bool HasDefaultPluginSettings() const = 0;
 
    virtual bool SetPluginEnabled(const FString& PluginName, bool bEnabled, FText& OutFailReason) = 0;
 
    virtual bool RemovePluginReference(const FString& PluginName, FText& OutFailReason) = 0;
 
    virtual bool UpdateAdditionalPluginDirectory(const FString& Dir, const bool bAddOrRemove) = 0;
 
    virtual const TArray<FString>& GetAdditionalPluginDirectories() const = 0;
 
    virtual bool IsCurrentProjectDirty() const = 0;
 
    virtual bool SaveCurrentProjectToDisk(FText& OutFailReason) = 0;
 
    virtual bool IsEnterpriseProject() = 0;
 
    virtual void SetIsEnterpriseProject(bool bValue) = 0;
    
    virtual TArray<FModuleContextInfo>& GetCurrentProjectModuleContextInfos() = 0;
 
    virtual bool IsSuppressingProjectFileWrite() const = 0;
 
    virtual void AddSuppressProjectFileWrite(const FName InName) = 0;
 
    virtual void RemoveSuppressProjectFileWrite(const FName InName) = 0;
};