Navigation
Unreal Engine C++ API Reference > 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 | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
bool | AddPluginSearchPath
(
const FString& ExtraDiscoveryPath, |
Stores the specified path, utilizing it in future search passes when searching for available plugins. |
![]() |
bool | AddToPluginsList
(
const FString& PluginFilename, |
Adds a single plugin to the list of plugins. |
![]() |
bool | Checks if all the required plug-ins are available. | |
![]() |
bool | CheckModuleCompatibility
(
TArray< FString >& OutIncompatibleModules, |
Checks whether modules for the enabled plug-ins are up to date. |
![]() |
TSharedPtr< IPlugin > | FindPlugin
(
const FStringView Name |
Finds information for a plugin. |
![]() |
TSharedPtr< IPlugin > | FindPlugin
(
const ANSICHAR* Name |
|
![]() |
TSharedPtr< IPlugin > | FindPluginFromDescriptor
(
const FPluginReferenceDescriptor& PluginDesc |
|
![]() |
TSharedPtr< IPlugin > | FindPluginFromPath
(
const FString& PluginPath |
|
![]() |
void | FindPluginsUnderDirectory
(
const FString& Directory, |
Finds all plugin descriptors underneath a given directory (recursively) |
![]() ![]() |
IPluginManager & | Get () |
Static: Access singleton instance. |
![]() ![]() |
const TSet< FString > & | Returns the list of extra directories that are recursively searched for plugins (aside from the engine and project plugin directories). | |
![]() ![]() |
const TSet< FString > & | Returns the set of built-in plugin names | |
![]() |
TArray< TSharedRef< IPlugin > > | Gets an array of all the discovered plugins. | |
![]() |
TArray< TSharedRef< IPlugin > > | Gets an array of all the enabled plugins. | |
![]() ![]() |
TArray< TSharedRef< IPlugin > > | Gets an array of all enabled plugins that can have content. | |
![]() ![]() |
TArray< TSharedRef< IPlugin > > | Gets an array of all enabled plugins that can have content or Verse code. | |
![]() ![]() |
TArray< TSharedRef< IPlugin > > | Gets an array of all enabled plugins that can have Verse code. | |
![]() ![]() |
ELoadingPhase::Type | Returns the highest loading phase that has so far completed | |
![]() |
void | GetLocalizationPathsForEnabledPlugins
(
TArray< FString >& OutLocResPaths |
Get the localization paths for all enabled plugins. |
![]() ![]() |
TSharedPtr< IPlugin > | GetModuleOwnerPlugin
(
FName ModuleName |
Returns the plugin that owns the specified module, if any |
![]() |
bool | GetPluginDependencies
(
const FString& PluginName, |
Tries to get a list of plugin dependencies for a given plugin. |
![]() |
bool | GetPluginDependencies_FromDescriptor
(
const FPluginReferenceDescriptor& PluginDescriptor, |
|
![]() |
bool | GetPluginDependencies_FromFileName
(
const FString& PluginFileName, |
|
![]() ![]() |
TArray< TSharedRef< IPlugin > > | Gets an array of plugins that loaded their own content pak file | |
![]() |
bool | ||
![]() |
bool | IntegratePluginsIntoConfig
(
FConfigCacheIni& ConfigSystem, |
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 |
![]() |
bool | LoadModulesForEnabledPlugins
(
const ELoadingPhase::Type LoadingPhase |
Loads all plug-ins |
![]() |
bool | MountExplicitlyLoadedPlugin
(
const FString& PluginName |
Marks an explicitly loaded plugin as enabled, mounts its content and tries to load its modules. |
![]() |
bool | MountExplicitlyLoadedPlugin_FromDescriptor
(
const FPluginReferenceDescriptor& PluginDescriptor |
|
![]() |
bool | MountExplicitlyLoadedPlugin_FromFileName
(
const FString& PluginFileName |
|
![]() |
void | MountNewlyCreatedPlugin
(
const FString& PluginName |
Marks a newly created plugin as enabled, mounts its content and tries to load its modules |
![]() |
FLoadingModulesForPhaseEvent & | ||
![]() |
FNewPluginMountedEvent & | Event signature for being notified that a new plugin has been created | |
![]() |
FNewPluginMountedEvent & | Event for being notified that a new plugin has been mounted | |
![]() |
FNewPluginMountedEvent & | Event for being notified that a plugin has been edited | |
![]() |
FNewPluginMountedEvent & | Event for being notified that a plugin has been unmounted | |
![]() |
FName | PackageNameFromModuleName
(
FName ModuleName |
Does a reverse lookup to try to figure out what the UObject package name is for a plugin |
![]() |
void | Updates the list of plugins. | |
![]() |
bool | RemoveFromPluginsList
(
const FString& PluginFilename, |
Remove a single plugin from the list of plugins. |
![]() |
bool | RequiresTempTargetForCodePlugin
(
const FProjectDescriptor* ProjectDescriptor, |
Determines if a content-only project requires a temporary target due to having a plugin enabled |
![]() |
void | SetBinariesRootDirectories
(
const FString& EngineBinariesRootDir, |
Set root directories for where to find binaries for plugins. |
![]() |
void | If preload binaries is set all plugin binaries will be loaded in an early Loading phase. | |
![]() |
void | SetRegisterMountPointDelegate
(
const FRegisterMountPointDelegate& Delegate |
Sets the delegate to call to register a new content mount point. |
![]() |
void | SetUnRegisterMountPointDelegate
(
const FRegisterMountPointDelegate& Delegate |
Sets the delegate to call to unregister a new content mount point. |
![]() |
void | SetUpdatePackageLocalizationCacheDelegate
(
const FUpdatePackageLocalizationCacheDelegate& Delegate |
Sets the delegate to call to update the package localization cache. |
![]() |
bool | UnmountExplicitlyLoadedPlugin
(
const FString& PluginName, |
Marks an explicitly loaded plugin as disabled, unmounts its content (does not work on plugins with compiled modules). |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
FLoadingModulesForPhaseEvent | Callback for when modules for when LoadModulesForEnabledPlugins() completes loading for a specific phase. | |
![]() |
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. |