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 > Core > Modules > FModuleManager

Light Theme

Dark Theme

FModuleManager

Implements the module manager.

Windows

MacOS

Linux

Inheritance Hierarchy

FExec

FSelfRegisteringExec

FModuleManager

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Modules/ModuleManager.h
Include	#include "Modules/ModuleManager.h"

Syntax

class FModuleManager : private FSelfRegisteringExec

Remarks

Implements the module manager.

The module manager is used to load and unload modules, as well as to keep track of all of the modules that are currently loaded. You can access this singleton using FModuleManager::Get().

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

	Name	Description
void	AbandonModule ( const FName InModuleName )	Abandons a loaded module, leaving it loaded in memory but no longer tracking it in the module manager.
void	AbandonModuleWithCallback ( const FName InModuleName )	Calls PreUnload then abandons a module in memory.
void	AddBinariesDirectory ( const TCHAR* InDirectory, bool bIsGameDirectory )	Adds an engine binaries directory.
void	AddExtraBinarySearchPaths()	Add any extra search paths that may be required
void	AddModule ( const FName InModuleName )	Adds a module to our list of modules, unless it's already known.
void	AddModuleToModulesList ( const FName InModuleName, FModuleManager::ModuleInfoRef& Mod... )
bool	DoesLoadedModuleHaveUObjects ( const FName ModuleName )	Determines whether the specified module contains UObjects.
void	FindModules ( const TCHAR* WildcardWithoutEx..., TArray< FName >& OutModules )	Finds module files on the disk for loadable modules matching the specified wildcard.
FModuleManag...	Get()	Gets the singleton instance of the module manager.
FString	GetGameBinariesDirectory()	Gets the game binaries directory
IModuleInter...	GetModule ( const FName InModuleName )	Gets the specified module.
TModuleInter...	GetModuleChecked ( const FName ModuleName )	Gets a module by name, checking to ensure it exists.
int32	GetModuleCount()	Gets the number of loaded modules.
FString	GetModuleFilename ( FName ModuleName )	Gets the filename for a module.
TModuleInter...	GetModulePtr ( const FName ModuleName )	Gets a module by name.
const TCHAR ...	GetUBTConfiguration()	Gets the build configuration for compiling modules, as required by UBT.
bool	HasAnyOverridenModuleFilename()	Determines if any non-default module instances are loaded (eg. hot reloaded modules)
bool	IsModuleLoaded ( const FName InModuleName )	Checks whether the specified module is currently loaded. This is an O(1) operation.
bool	IsModuleUpToDate ( const FName InModuleName )	Checks to see if the specified module exists and is compatible with the current engine version.
FIsPackageLo...	IsPackageLoadedCallback()
IModuleInter...	LoadModule ( const FName InModuleName )	Loads the specified module.
IModuleInter...	LoadModuleChecked ( const FName InModuleName )	Loads the specified module, checking to ensure it exists.
TModuleInter...	LoadModuleChecked ( const FName InModuleName )	Loads a module by name, checking to ensure it exists.
TModuleInter...	LoadModulePtr ( const FName InModuleName )	Loads a module by name.
bool	LoadModuleWithCallback ( const FName InModuleName, FOutputDevice& Ar )	Loads a module in memory then calls PostLoad.
IModuleInter...	LoadModuleWithFailureReason ( const FName InModuleName, EModuleLoadResult& OutFailureReaso... )	Loads the specified module and returns a result.
void	MakeUniqueModuleFilename ( const FName InModuleName, FString& UniqueSuffix, FString& UniqueModuleFileName )	Generates a unique file name for the specified module name by adding a random suffix and checking for file collisions.
bool	ModuleExists ( const TCHAR* ModuleName )	Determines if a module with the given name exists, regardless of whether it is currently loaded.
FModulesChan...	OnModulesChanged()
ProcessLoade...	OnProcessLoadedObjectsCallback()
bool	QueryModule ( const FName InModuleName, FModuleStatus& OutModuleStatus )	Queries information about a specific module name.
void	QueryModules ( TArray< FModuleStatus >& OutModule... )	Queries information about all of the currently known modules.
void	RefreshModuleFilenameFromManifest ( const FName InModuleName )
void	RegisterStaticallyLinkedModule ( const FLazyName InModuleName, const FInitializeStaticallyLinkedMo... )	Registers an initializer for a module that is statically linked.
void	ResetModulePathsCache()	Clears module path cache
void	SaveCurrentStateForBootstrap ( const TCHAR* Filename )	Save the current module manager's state into a file for bootstrapping other processes.
void	SetGameBinariesDirectory ( const TCHAR* InDirectory )	Set the game binaries directory
void	SetModuleFilename ( FName ModuleName, const FString& Filename )	Sets the filename for a module.
void	StartProcessingNewlyLoadedObjects()	Called by the engine at startup to let the Module Manager know that it's now safe to process new UObjects discovered by loading C++ modules.
void	TearDown()	Destroys singleton if it exists.
bool	UnloadModule ( const FName InModuleName, bool bIsShutdown )	Unloads a specific module
void	UnloadModulesAtShutdown()	Unloads modules during the shutdown process.
void	UnloadOrAbandonModuleWithCallback ( const FName InModuleName, FOutputDevice& Ar )	Calls PreUnload then either unloads or abandons a module in memory, depending on whether the module supports unloading.

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler

Classes

	Name	Description
	FModulesChangedEvent	Gets an event delegate that is executed when the set of known modules changed, i.e. upon module load or unload.
	ProcessLoadedObjectsEvent	Gets a multicast delegate that is executed when any UObjects need processing after a module was loaded.

Typedefs

Name	Description
FInitializeStaticallyLinkedModule	Delegate that's used by the module manager to initialize a registered module that we statically linked with (monolithic only)
FIsPackageLoadedCallback	Gets a delegate that is executed when a module containing UObjects has been loaded.
FModuleMap	Type definition for maps of module names to module infos.
ModuleInfoPtr
ModuleInfoRef

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

Take our survey

Dismiss