1. Epic GamesDeveloper
  3. IPluginManager

IPluginManager

PluginManager manages available code and content extensions (both loaded and not loaded).

API > API/Runtime > API/Runtime/Projects > API/Runtime/Projects/Interfaces

References

   
Module Projects
Header /Engine/Source/Runtime/Projects/Public/Interfaces/IPluginManager.h
Include #include "Interfaces/IPluginManager.h"

Syntax

class IPluginManager

Remarks

PluginManager manages available code and content extensions (both loaded and not loaded).

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool

AddPluginSearchPath ( const FString& ExtraDiscoveryPath,
bool bRefresh
)

 Stores the specified path, utilizing it in future search passes when searching for available plugins.
Public function bool

AddToPluginsList ( const FString& PluginFilename,
FText* OutFailReason
)

 Adds a single plugin to the list of plugins.
Public function bool Checks if all the required plug-ins are available.
Public function bool

CheckModuleCompatibility ( TArray< FString >& OutIncompatibleModules,
TArray< FString >& OutIncompatibleEngineModules
)

 Checks whether modules for the enabled plug-ins are up to date.
Public function TSharedPtr< IPlugin >

FindPlugin ( const FStringView Name
)

 Finds information for a plugin.
Public function TSharedPtr< IPlugin >

FindPlugin ( const ANSICHAR* Name
)

  
Public function TSharedPtr< IPlugin >  
Public function TSharedPtr< IPlugin >

FindPluginFromPath ( const FString& PluginPath
)

  
Public function void

FindPluginsUnderDirectory ( const FString& Directory,
TArray< FString >& OutPluginFilePaths
)

 Finds all plugin descriptors underneath a given directory (recursively)
Public function Static IPluginManager &

Get ()

 Static: Access singleton instance.
Public function Const const TSet< FString > & Returns the list of extra directories that are recursively searched for plugins (aside from the engine and project plugin directories).
Public function Const const TSet< FString > & Returns the set of built-in plugin names
Public function TArray< TSharedRef< IPlugin > > Gets an array of all the discovered plugins.
Public function TArray< TSharedRef< IPlugin > > Gets an array of all the enabled plugins.
Public function Const TArray< TSharedRef< IPlugin > > Gets an array of all enabled plugins that can have content.
Public function Const TArray< TSharedRef< IPlugin > > Gets an array of all enabled plugins that can have content or Verse code.
Public function Const TArray< TSharedRef< IPlugin > > Gets an array of all enabled plugins that can have Verse code.
Public function Const ELoadingPhase::Type Returns the highest loading phase that has so far completed
Public function void Get the localization paths for all enabled plugins.
Public function Const TSharedPtr< IPlugin >

GetModuleOwnerPlugin ( FName ModuleName
)

 Returns the plugin that owns the specified module, if any
Public function bool

GetPluginDependencies ( const FString& PluginName,
TArray< FPluginReferenceDescriptor >& PluginDependencies
)

 Tries to get a list of plugin dependencies for a given plugin.
Public function bool  
Public function bool

GetPluginDependencies_FromFileName ( const FString& PluginFileName,
TArray< FPluginReferenceDescriptor >& PluginDependencies
)

  
Public function Const TArray< TSharedRef< IPlugin > > Gets an array of plugins that loaded their own content pak file
Public function bool  
Public function bool

IntegratePluginsIntoConfig ( FConfigCacheIni& ConfigSystem,
const TCHAR* EngineIniName,
const TCHAR* PlatformName,
const TCHAR* StagedPluginsFile
)

 Scans a set of given plugins and adds them to the passed in ConfigSystem so that the runtime can load faster without needing to scan all plugins looking for config/paks
Public function bool Loads all plug-ins
Public function bool

MountExplicitlyLoadedPlugin ( const FString& PluginName
)

 Marks an explicitly loaded plugin as enabled, mounts its content and tries to load its modules.
Public function bool  
Public function bool  
Public function void

MountNewlyCreatedPlugin ( const FString& PluginName
)

 Marks a newly created plugin as enabled, mounts its content and tries to load its modules
Public function FLoadingModulesForPhaseEvent &  
Public function FNewPluginMountedEvent & Event signature for being notified that a new plugin has been created
Public function FNewPluginMountedEvent & Event for being notified that a new plugin has been mounted
Public function FNewPluginMountedEvent & Event for being notified that a plugin has been edited
Public function FNewPluginMountedEvent & Event for being notified that a plugin has been unmounted
Public function FName Does a reverse lookup to try to figure out what the UObject package name is for a plugin
Public function void Updates the list of plugins.
Public function bool

RemoveFromPluginsList ( const FString& PluginFilename,
FText* OutFailReason
)

 Remove a single plugin from the list of plugins.
Public function bool

RequiresTempTargetForCodePlugin ( const FProjectDescriptor* ProjectDescriptor,
const FString& Platform,
EBuildConfiguration Configuration,
EBuildTargetType TargetType,
FText& OutReason
)

 Determines if a content-only project requires a temporary target due to having a plugin enabled
Public function void

SetBinariesRootDirectories ( const FString& EngineBinariesRootDir,
const FString& ProjectBinariesRootDir
)

 Set root directories for where to find binaries for plugins.
Public function void If preload binaries is set all plugin binaries will be loaded in an early Loading phase.
Public function void Sets the delegate to call to register a new content mount point.
Public function void Sets the delegate to call to unregister a new content mount point.
Public function void Sets the delegate to call to update the package localization cache.
Public function bool

UnmountExplicitlyLoadedPlugin ( const FString& PluginName,
FText* OutReason
)

 Marks an explicitly loaded plugin as disabled, unmounts its content (does not work on plugins with compiled modules).

Classes

  Type Name Description
Public class FLoadingModulesForPhaseEvent Callback for when modules for when LoadModulesForEnabledPlugins() completes loading for a specific phase.  
Public class FNewPluginMountedEvent Event signature for being notified that a new plugin has been mounted  

Typedefs

Name Description
FRegisterMountPointDelegate Delegate type for mounting content paths.
FUpdatePackageLocalizationCacheDelegate Delegate type for updating the package localization cache.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page