Module |
|
Header |
/Engine/Source/Runtime/Projects/Public/ModuleDescriptor.h |
Include |
#include "ModuleDescriptor.h" |
struct FModuleDescriptor
Description of a loadable module.
Name | Description | ||
---|---|---|---|
|
AdditionalDependencies |
List of additional dependencies for building this module. |
|
|
BlacklistPlatforms |
List of disallowed platforms |
|
|
BlacklistPrograms |
List of disallowed programs |
|
|
BlacklistTargetConfigurations |
List of disallowed target configurations |
|
|
BlacklistTargets |
List of disallowed targets |
|
|
LoadingPhase |
When should the module be loaded during the startup sequence? This is sort of an advanced setting. |
|
|
Name |
Name of this module |
|
|
Type |
Usage type of module |
|
|
WhitelistPlatforms |
List of allowed platforms |
|
|
WhitelistPrograms |
List of allowed programs |
|
|
WhitelistTargetConfigurations |
List of allowed target configurations |
|
|
WhitelistTargets |
List of allowed targets |
Name | Description | |
---|---|---|
|
FModuleDescriptor ( |
Normal constructor |
Name | Description | ||
---|---|---|---|
|
CheckModuleCompatibility ( |
Checks that all modules are compatible with the current engine version. |
|
|
IsCompiledInConfiguration ( |
Tests whether the module should be built for the given target |
|
|
IsCompiledInCurrentConfiguration() |
Tests whether the module should be built for the current engine configuration |
|
|
IsLoadedInCurrentConfiguration() |
Tests whether the module should be loaded for the current engine configuration |
|
|
LoadModulesForPhase ( |
Loads all the modules for a given loading phase. Returns a map of module names to load errors |
|
|
Read ( |
Reads a descriptor from the given JSON object |
|
|
ReadArray ( |
Reads an array of modules from the given JSON object |
|
|
Write ( |
Writes a descriptor to JSON |
|
|
WriteArray ( |
Writes an array of modules to JSON |