IPluginManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Delegates/Delegate.h"
#include "PluginDescriptor.h"
#include "Containers/VersePathFwd.h"
#include "Templates/SharedPointer.h"
 
struct FProjectDescriptor;
class FJsonObject;
struct FPluginReferenceDescriptor;
 
enum class EPluginLoadedFrom
{
    Engine,
 
    Project
};
 
enum class EPluginType
{
    Engine,
 
    Enterprise,
 
    Project,
 
    External,
 
    Mod,
};
 
enum class EPluginExternalSource
{
    ProjectDescriptor,
 
    CommandLine,
 
    Environment,
 
    Other,
};
 
struct FExternalPluginPath
{
    FString Path;
    EPluginExternalSource Source;
 
    inline bool operator==(const FExternalPluginPath& Other) const
    {
        return (Other.Path == Path) && (Other.Source == Source);
    }
 
    friend uint32 GetTypeHash(const FExternalPluginPath& ExternalPluginPath)
    {
        return HashCombine(GetTypeHash(ExternalPluginPath.Path), GetTypeHash(ExternalPluginPath.Source));
    }
};
 
struct FPluginStatus
{
    FString Name;
 
    FString PluginDirectory;
 
    bool bIsEnabled;
 
    EPluginLoadedFrom LoadedFrom;
 
    FPluginDescriptor Descriptor;
};
 
 
class IPlugin : public TSharedFromThis<IPlugin>
{
public:
    /* Virtual destructor */
    virtual ~IPlugin(){}
 
    virtual const FString& GetName() const = 0;
 
    virtual const FString& GetFriendlyName() const = 0;
 
    virtual const FString& GetDescriptorFileName() const = 0;
 
    virtual FString GetBaseDir() const = 0;
 
    virtual TArray<FString> GetExtensionBaseDirs() const = 0;
 
    virtual FString GetContentDir() const = 0;
 
    virtual FString GetMountedAssetPath() const = 0;
 
    virtual EPluginType GetType() const = 0;
 
    virtual bool IsEnabled() const = 0;
 
    virtual bool IsEnabledByDefault(bool bAllowEnginePluginsEnabledByDefault) const = 0;
 
    virtual bool IsMounted() const = 0;
 
    virtual bool IsHidden() const = 0;
 
    virtual bool CanContainContent() const = 0;
 
    virtual bool CanContainVerse() const = 0;
 
    virtual const FString& GetVersePath() const = 0;
 
    virtual const FString& GetDeprecatedEngineVersion() const = 0;
 
    virtual TOptional<uint32> GetVerseVersion() const = 0;
 
    virtual bool IsSceneGraphEnabled() const = 0;
 
    virtual EPluginLoadedFrom GetLoadedFrom() const = 0;
 
    virtual const FPluginDescriptor& GetDescriptor() const = 0;
 
    virtual bool UpdateDescriptor(const FPluginDescriptor& NewDescriptor, FText& OutFailReason) = 0;
 
#if WITH_EDITOR
    virtual const TSharedPtr<FJsonObject>& GetDescriptorJson() = 0;
#endif // WITH_EDITOR
};
 
class IPluginManager
{
public:
    virtual ~IPluginManager() { }
 
    virtual void RefreshPluginsList() = 0;
 
    virtual bool AddToPluginsList(const FString& PluginFilename, FText* OutFailReason = nullptr) = 0;
 
    virtual bool RemoveFromPluginsList(const FString& PluginFilename, FText* OutFailReason = nullptr) = 0;
 
    virtual bool LoadModulesForEnabledPlugins( const ELoadingPhase::Type LoadingPhase ) = 0;
 
    virtual ELoadingPhase::Type GetLastCompletedLoadingPhase() const = 0;
 
    DECLARE_EVENT_TwoParams(IPluginManager, FLoadingModulesForPhaseEvent, ELoadingPhase::Type /*LoadingPhase*/, bool /*bSuccess*/);
    virtual FLoadingModulesForPhaseEvent& OnLoadingPhaseComplete() = 0;
 
    virtual void GetLocalizationPathsForEnabledPlugins( TArray<FString>& OutLocResPaths ) = 0;
 
    DECLARE_DELEGATE_TwoParams( FRegisterMountPointDelegate, const FString& /* Root content path */, const FString& /* Directory name */ );
 
    virtual void SetRegisterMountPointDelegate( const FRegisterMountPointDelegate& Delegate ) = 0;
 
    virtual void SetUnRegisterMountPointDelegate( const FRegisterMountPointDelegate& Delegate ) = 0;
 
    virtual bool AreRequiredPluginsAvailable() = 0;
 
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FGetExplanationForUnavailablePackageWithPluginInfoDelegate, const FString& /*Unavailable package*/, class IPlugin* /*Plugin or null if not found*/, FStringBuilderBase& /*InOutStringBuilder*/);
 
    virtual FGetExplanationForUnavailablePackageWithPluginInfoDelegate& GetExplanationForUnavailablePackageWithPluginInfoDelegate() = 0;
 
    virtual void GetExplanationForUnavailablePackage(const FName& UnavailablePackageName, FStringBuilderBase& InOutExplanation) = 0;
 
#if !IS_MONOLITHIC
    virtual bool CheckModuleCompatibility( TArray<FString>& OutIncompatibleModules, TArray<FString>& OutIncompatibleEngineModules ) = 0;
#endif
 
    virtual TSharedPtr<IPlugin> FindPlugin(const FStringView Name) = 0;
    virtual TSharedPtr<IPlugin> FindPlugin(const ANSICHAR* Name) = 0;
 
    virtual TSharedPtr<IPlugin> FindPluginFromPath(const FString& PluginPath) = 0;
    virtual TSharedPtr<IPlugin> FindPluginFromDescriptor(const FPluginReferenceDescriptor& PluginDesc) = 0;
 
    virtual TSharedPtr<IPlugin> FindEnabledPlugin(const FStringView Name) = 0;
    virtual TSharedPtr<IPlugin> FindEnabledPlugin(const ANSICHAR* Name) = 0;
 
    virtual TSharedPtr<IPlugin> FindEnabledPluginFromPath(const FString& PluginPath) = 0;
    virtual TSharedPtr<IPlugin> FindEnabledPluginFromDescriptor(const FPluginReferenceDescriptor& PluginDesc) = 0;
 
    virtual bool CanEnablePluginInCurrentTarget(const FStringView Name) = 0;
    virtual bool CanEnablePluginInCurrentTarget(const ANSICHAR* Name) = 0;
 
    virtual void FindPluginsUnderDirectory(const FString& Directory, TArray<FString>& OutPluginFilePaths) = 0;
 
    virtual TArray<TSharedRef<IPlugin>> GetEnabledPlugins() = 0;
 
    virtual TArray<TSharedRef<IPlugin>> GetEnabledPluginsWithContent() const = 0;
 
    virtual TArray<TSharedRef<IPlugin>> GetEnabledPluginsWithVerse() const = 0;
 
    virtual TArray<TSharedRef<IPlugin>> GetEnabledPluginsWithContentOrVerse() const = 0;
 
    virtual TArray<TSharedRef<IPlugin>> GetDiscoveredPlugins() = 0;
 
    UE_INTERNAL virtual const TSet<FString>& GetPluginsEnabledAtStartup() const = 0;
 
#if WITH_EDITOR
    virtual const TSet<FString>& GetBuiltInPluginNames() const = 0;
 
    virtual TSharedPtr<IPlugin> GetModuleOwnerPlugin(FName ModuleName) const = 0;
#endif //WITH_EDITOR
 
    virtual bool AddPluginSearchPath(const FString& ExtraDiscoveryPath, bool bRefresh = true) = 0;
 
    virtual bool RemovePluginSearchPath(const FString& PathToRemove, bool bRefresh = true) = 0;
 
    virtual const TSet<FString>& GetAdditionalPluginSearchPaths() const = 0;
 
    virtual void GetExternalPluginSources(TSet<FExternalPluginPath>& OutPluginSources) const = 0;
 
    virtual TArray<TSharedRef<IPlugin>> GetPluginsWithPakFile() const = 0;
 
    DECLARE_EVENT_OneParam(IPluginManager, FNewPluginMountedEvent, IPlugin&);
 
    virtual FNewPluginMountedEvent& OnNewPluginCreated() = 0;
 
    virtual FNewPluginMountedEvent& OnNewPluginMounted() = 0;
 
    virtual FNewPluginMountedEvent& OnNewPluginContentMounted() = 0;
 
    virtual FNewPluginMountedEvent& OnPluginEdited() = 0;
 
    virtual FNewPluginMountedEvent& OnPluginUnmounted() = 0;
 
    virtual void MountNewlyCreatedPlugin(const FString& PluginName) = 0;
 
    virtual bool MountExplicitlyLoadedPlugin(const FString& PluginName, ELoadingPhase::Type MaxLoadingPhase = ELoadingPhase::Max) = 0;
    virtual bool MountExplicitlyLoadedPlugin_FromFileName(const FString& PluginFileName) = 0;
    virtual bool MountExplicitlyLoadedPlugin_FromDescriptor(const FPluginReferenceDescriptor& PluginDescriptor) = 0;
 
    virtual bool MountExplicitlyLoadedPluginLocalizationData(const FString& PluginName, TUniqueFunction<void(bool bLoadedLocalization, const FString& PluginName)>&& Notification = nullptr) = 0;
 
    virtual bool UnmountExplicitlyLoadedPluginLocalizationData(const FString& PluginName, TUniqueFunction<void(bool bUnloadedLocalization, const FString& PluginName)>&& Notification = nullptr) = 0;
 
    virtual bool UnmountExplicitlyLoadedPlugin(const FString& PluginName, FText* OutReason) = 0;
    virtual bool UnmountExplicitlyLoadedPlugin(const FString& PluginName, FText* OutReason, bool bAllowUnloadCode) = 0;
 
    virtual bool GetPluginDependencies(const FString& PluginName, TArray<FPluginReferenceDescriptor>& PluginDependencies) = 0;
    virtual bool GetPluginDependencies_FromFileName(const FString& PluginFileName, TArray<FPluginReferenceDescriptor>& PluginDependencies) = 0;
    virtual bool GetPluginDependencies_FromDescriptor(const FPluginReferenceDescriptor& PluginDescriptor, TArray<FPluginReferenceDescriptor>& PluginDependencies) = 0;
 
    virtual FName PackageNameFromModuleName(FName ModuleName) = 0;
 
    UE_INTERNAL virtual void EnumerateVersePathMountPoints(const UE::Core::FVersePath& VersePath, TFunctionRef<bool(FStringView /*MountedAssetPath*/, FStringView /*LeafPath*/)> Callback) = 0;
 
    virtual bool RequiresTempTargetForCodePlugin(const FProjectDescriptor* ProjectDescriptor, const FString& Platform, EBuildConfiguration Configuration, EBuildTargetType TargetType, FText& OutReason) = 0;
 
    UE_DEPRECATED(5.6, "This has never worked and is unsafe. Do not call this function")
    virtual bool IntegratePluginsIntoConfig(FConfigCacheIni& ConfigSystem, const TCHAR* EngineIniName, const TCHAR* PlatformName, const TCHAR* StagedPluginsFile) { return false; }
 
    virtual void SetBinariesRootDirectories(const FString& EngineBinariesRootDir, const FString& ProjectBinariesRootDir) = 0;
 
    virtual void SetPreloadBinaries() = 0;
    virtual bool GetPreloadBinaries() = 0;
 
    UE_INTERNAL virtual void SuppressPluginUnloadGC() = 0;
    UE_INTERNAL virtual void ResumePluginUnloadGC() = 0;
 
public:
 
    static PROJECTS_API IPluginManager& Get();
};