1. Epic GamesDeveloper
  3. FModuleManager

FModuleManager

Implements the module manager.

Unreal Engine C++ API Reference > Runtime > Core > Modules

Inheritance Hierarchy

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

  Type Name Description
Public function  

FModuleManager ( FPrivateToken
)

 Hidden constructor.Use the static Get function to return the singleton instance.
Public function    

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Public function void

AbandonModule ( const FName InModuleName
)

 Abandons a loaded module, leaving it loaded in memory but no longer tracking it in the module manager.
Public function void

AbandonModuleWithCallback ( const FName InModuleName
)

 Calls PreUnload then abandons a module in memory.
Public function void

AddBinariesDirectory ( const TCHAR* InDirectory,
bool bIsGameDirectory
)

 Adds an engine binaries directory.
Public function void Add any extra search paths that may be required
Public function void

AddModule ( const FName InModuleName
)

 Adds a module to our list of modules, unless it's already known.
Public function void

AddModuleToModulesList ( const FName InModuleName,
FModuleManager::ModuleInfoRef& ModuleInfo
)

  
Public function Const bool

DoesLoadedModuleHaveUObjects ( const FName ModuleName
)

 Determines whether the specified module contains UObjects.
Public function Const void

FindModules ( const TCHAR* WildcardWithoutExtension,
TArray< FName >& OutModules
)

 Finds module files on the disk for loadable modules matching the specified wildcard.
Public function Static FModuleManager &

Get ()

 Gets the singleton instance of the module manager.
Public function Const FString Gets the game binaries directory
Public function IModuleInterface *

GetModule ( const FName InModuleName
)

 Gets the specified module.
Public function Static TModuleInterface &

GetModuleChecked ( const FName ModuleName
)

 Gets a module by name, checking to ensure it exists.
Public function Const int32 Gets the number of loaded modules.
Public function Const FString

GetModuleFilename ( FName ModuleName
)

 Gets the filename for a module.
Public function Static TModuleInterface *

GetModulePtr ( const FName ModuleName
)

 Gets a module by name.
Public function Static const TCHAR * Gets the build configuration for compiling modules, as required by UBT.
Public function Const bool Determines if any non-default module instances are loaded (eg. hot reloaded modules)
Public function Const bool

IsModuleLoaded ( const FName InModuleName
)

 Checks whether the specified module is currently loaded.This is an O(1) operation.
Public function Const bool

IsModuleUpToDate ( const FName InModuleName
)

 Checks to see if the specified module exists and is compatible with the current engine version.
Public function FIsPackageLoadedCallback &  
Public function IModuleInterface *

LoadModule ( const FName InModuleName,
ELoadModuleFlags InLoadModuleFlags
)

 Loads the specified module.
Public function void

LoadModuleBinaryOnly ( FName ModuleName
)

 Will load the binary without doing initialization.
Public function Static TModuleInterface &

LoadModuleChecked ( const FName InModuleName
)

 Loads a module by name, checking to ensure it exists.
Public function IModuleInterface &

LoadModuleChecked ( const FName InModuleName
)

 Loads the specified module, checking to ensure it exists.
Public function Static TModuleInterface *

LoadModulePtr ( const FName InModuleName
)

 Loads a module by name.
Public function bool

LoadModuleWithCallback ( const FName InModuleName,
FOutputDevice& Ar
)

 Loads a module in memory then calls PostLoad.
Public function IModuleInterface *

LoadModuleWithFailureReason ( const FName InModuleName,
EModuleLoadResult& OutFailureReason,
ELoadModuleFlags InLoadModuleFlags
)

 Loads the specified module and returns a result.
Public function Const 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.
Public function Const bool

ModuleExists ( const TCHAR* ModuleName
)

 Determines if a module with the given name exists, regardless of whether it is currently loaded.
Public function FModulesChangedEvent &  
Public function ProcessLoadedObjectsEvent &  
Public function Const bool

QueryModule ( const FName InModuleName,
FModuleStatus& OutModuleStatus
)

 Queries information about a specific module name.
Public function Const void

QueryModules ( TArray< FModuleStatus >& OutModuleStatuses
)

 Queries information about all of the currently known modules.
Public function void

RefreshModuleFilenameFromManifest ( const FName InModuleName
)

  
Public function void

RegisterStaticallyLinkedModule ( const FLazyName InModuleName,
const FInitializeStaticallyLinkedModule& InInitializerDelegate
)

 Registers an initializer for a module that is statically linked.
Public function void Clears module path cache
Public function void

SaveCurrentStateForBootstrap ( const TCHAR* Filename
)

 Save the current module manager's state into a file for bootstrapping other processes.
Public function void

SetGameBinariesDirectory ( const TCHAR* InDirectory
)

 Set the game binaries directory
Public function void

SetModuleFilename ( FName ModuleName,
const FString& Filename
)

 Sets the filename for a module.
Public function void 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.
Public function Static void Destroys singleton if it exists.
Public function bool

UnloadModule ( const FName InModuleName,
bool bIsShutdown
)

 Unloads a specific module NOTE: You can manually unload a module before the normal shutdown occurs with this, but be careful as you may be unloading another module's dependency too early!
Public function void Unloads modules during the shutdown process.
Public function void Calls PreUnload then either unloads or abandons a module in memory, depending on whether the module supports unloading.

Overridden from FExec

  Type Name Description
Protected function Virtual bool

Exec_Dev ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

 Implementation of Exec that is only called in non-shipping targets

Operators

  Type Name Description
Public function FModuleManager &  

Classes

  Type Name Description
Public class FModulesChangedEvent Gets an event delegate that is executed when the set of known modules changed, i.e. upon module load or unload.  
Public class 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  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page