Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Projects > Interfaces > IPluginManager

Light Theme

Dark Theme

IPluginManager

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

Windows

MacOS

Linux

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

	Name	Description
	~IPluginManager()

Functions

	Name	Description
bool	AddPluginSearchPath ( const FString& ExtraDiscoveryPath, bool bRefresh )	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	AreRequiredPluginsAvailable()	Checks if all the required plug-ins are available.
bool	CheckModuleCompatibility ( TArray< FString >& OutIncompatible..., TArray< FString >& OutIncompatible... )	Checks whether modules for the enabled plug-ins are up to date.
TSharedPtr< ...	FindPlugin ( const FString& Name )	Finds information for an enabled plugin.
IPluginManag...	Get()	Static: Access singleton instance.
const TSet< ...	GetAdditionalPluginSearchPaths()	Returns the list of extra directories that are recursively searched for plugins (aside from the engine and project plugin directories).
TArray< TSha...	GetDiscoveredPlugins()	Gets an array of all the discovered plugins.
TArray< TSha...	GetEnabledPlugins()	Gets an array of all the enabled plugins.
TArray< TSha...	GetEnabledPluginsWithContent()	Gets an array of all enabled plugins that can have content.
ELoadingPhas...	GetLastCompletedLoadingPhase()	Returns the highest loading phase that has so far completed
void	GetLocalizationPathsForEnabledPlugins ( TArray< FString >& OutLocResPaths )	Get the localization paths for all enabled plugins.
TArray< TSha...	GetPluginsWithPakFile()	Gets an array of plugins that loaded their own content pak file
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
bool	LoadModulesForEnabledPlugins ( const ELoadingPhase::Type LoadingPh... )	Loads all plug-ins
void	MountExplicitlyLoadedPlugin ( const FString& PluginName )	Marks an explicitly loaded plugin as enabled, mounts its content and tries to load its modules.
void	MountNewlyCreatedPlugin ( const FString& PluginName )	Marks a newly created plugin as enabled, mounts its content and tries to load its modules
FLoadingModu...	OnLoadingPhaseComplete()
FNewPluginMo...	OnNewPluginCreated()
FNewPluginMo...	OnNewPluginMounted()	Gets an array of plugins that loaded their own content pak file
FName	PackageNameFromModuleName ( FName ModuleName )	Does a reverse lookup to try to figure out what the UObject package name is for a plugin
void	RefreshPluginsList()	Updates the list of plugins.
bool	RequiresTempTargetForCodePlugin ( const FProjectDescriptor* Proj..., 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
void	SetRegisterMountPointDelegate ( const FRegisterMountPointDelegate&... )	Sets the delegate to call to register a new content mount point.
void	SetUnRegisterMountPointDelegate ( const FRegisterMountPointDelegate&... )	Sets the delegate to call to unregister a new content mount point.
void	SetUpdatePackageLocalizationCacheDelegate ( const FUpdatePackageLocalizationCac... )	Sets the delegate to call to update the package localization cache.
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

	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.

Deprecated Functions

		Name	Description
	TArray< FPlu...	QueryStatusForAllPlugins()	QueryStatusForAllPlugins() has been deprecated. Please use GetDiscoveredPlugins() instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss