1. Epic GamesDeveloper
  3. IModuleInterface

IModuleInterface

Interface class that all module implementations should derive from.

API > API/Runtime > API/Runtime/Core

Interface class that all module implementations should derive from. This is used to initialize a module after it's been loaded, and also to clean it up before the module is unloaded.

   
Name IModuleInterface
Type class
Header File /Engine/Source/Runtime/Core/Public/Modules/ModuleInterface.h
Include Path #include "Modules/ModuleInterface.h"

Syntax

class IModuleInterface

Derived Classes

IModuleInterface derived class hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IModuleInterface()

 Note: Even though this is an interface class we need a virtual destructor here because modules are deleted via a pointer to this interface Modules/ModuleInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool IsGameModule()

 Returns true if this module hosts gameplay code Modules/ModuleInterface.h  

virtual void PostLoadCallback()

 Called after the module has been reloaded Modules/ModuleInterface.h  

virtual void PreUnloadCallback()

 Called before the module has been unloaded Modules/ModuleInterface.h  

virtual void ShutdownModule ()

 Called before the module is unloaded, right before the module object is destroyed. Modules/ModuleInterface.h  

virtual void StartupModule ()

 Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. Modules/ModuleInterface.h  

virtual bool SupportsAutomaticShutdown()

 Override this to set whether your module would like cleanup on application shutdown Modules/ModuleInterface.h  

virtual bool SupportsDynamicReloading()

 Override this to set whether your module is allowed to be unloaded on the fly Modules/ModuleInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page