Modules

Choose your operating system:

Windows

macOS

Linux

Filters

Classes

Name

Description

Public class

FBuildVersion

Stores the version information associated with a build

Public class

FDefaultGameModuleImpl

Default minimal module class for gameplay modules. Does nothing at startup and shutdown.

Public class

FDefaultModuleImpl

A default minimal implementation of a module that does nothing at startup and shutdown

Public class

FModuleManager

Implements the module manager.

Public class

FModuleManifest

Stores a record of a built target, with all metadata that other tools may need to know about the build.

Public class

FModuleObserver

A simple class that observes the currently active module list for a specific module to be (un)loaded

Public struct

FModuleStatus

Structure for reporting module statuses.

Public class

FStaticallyLinkedModuleRegistrant

Utility class for registering modules that are statically linked.

Public class

IModuleInterface

Interface class that all module implementations should derive from.

Typedefs

Name

Description

FInitializeModuleFunctionPtr

Function pointer type for InitializeModule().

Enums

Name

Description

Public enum

EActiveReloadType

Enumerates the type of reload in progress

Public enum

ECheckModuleCompatibilityFlags

Public enum

ELoadModuleFlags

Public enum

EModuleChangeReason

Enumerates reasons for modules to change.

Public enum

EModuleLoadResult

Enumerates reasons for failed module loads.

Functions

Name Description

Public function

void

 

BeginReload

(
    EActiveReloadType ActiveReloadType,
    IReload& Interface
)

Begins the reload process.

Public function

void

 

EndReload()

Ends the reload process

Public function

IReload *...

 

GetActiveReloadInterface()

Get the currently active reload interface.

Public function

EActiveReloa...

 

GetActiveReloadType()

Return the currently active reload.

Public function

bool

 

IsReloadActive()

Helper method to check to see if reloading is active.

Public function

constexpr bo...

 

operator!

(
    ECheckModuleCompatibilityFlags E
)

Public function

constexpr bo...

 

operator!

(
    ELoadModuleFlags E
)

Public function

constexpr EC...

 

operator&

(
    ECheckModuleCompatibilityFlags Lhs,
    ECheckModuleCompatibilityFlags Rhs
)

Public function

constexpr EL...

 

operator&

(
    ELoadModuleFlags Lhs,
    ELoadModuleFlags Rhs
)

Public function

ELoadModuleF...

 

operator&=

(
    ELoadModuleFlags& Lhs,
    ELoadModuleFlags Rhs
)

Public function

ECheckModule...

 

operator&=

(
    ECheckModuleCompatibilityFlags& Lh...,
    ECheckModuleCompatibilityFlags Rhs
)

Public function

constexpr EC...

 

operator^

(
    ECheckModuleCompatibilityFlags Lhs,
    ECheckModuleCompatibilityFlags Rhs
)

Public function

constexpr EL...

 

operator^

(
    ELoadModuleFlags Lhs,
    ELoadModuleFlags Rhs
)

Public function

ECheckModule...

 

operator^=

(
    ECheckModuleCompatibilityFlags& Lh...,
    ECheckModuleCompatibilityFlags Rhs
)

Public function

ELoadModuleF...

 

operator^=

(
    ELoadModuleFlags& Lhs,
    ELoadModuleFlags Rhs
)

Public function

constexpr EC...

 

operator|

(
    ECheckModuleCompatibilityFlags Lhs,
    ECheckModuleCompatibilityFlags Rhs
)

Public function

constexpr EL...

 

operator|

(
    ELoadModuleFlags Lhs,
    ELoadModuleFlags Rhs
)

Public function

ECheckModule...

 

operator|=

(
    ECheckModuleCompatibilityFlags& Lh...,
    ECheckModuleCompatibilityFlags Rhs
)

Public function

ELoadModuleF...

 

operator|=

(
    ELoadModuleFlags& Lhs,
    ELoadModuleFlags Rhs
)

Public function

constexpr EC...

 

operator~

(
    ECheckModuleCompatibilityFlags E
)

Public function

constexpr EL...

 

operator~

(
    ELoadModuleFlags E
)

Variables

Name Description

Public variable

bool

 

GIsHotReload

GIsHotReload has been deprecated, use IsReloadActive to test to see if a reload is in progress.