Navigation
Unreal Engine C++ API Reference > Runtime > Projects
References
Module | Projects |
Header | /Engine/Source/Runtime/Projects/Public/ModuleDescriptor.h |
Include | #include "ModuleDescriptor.h" |
Syntax
struct FModuleDescriptor
Remarks
Description of a loadable module.
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
TArray< FString > | AdditionalDependencies | List of additional dependencies for building this module. |
![]() |
bool | bHasExplicitPlatforms | When true, an empty PlatformAllowList is interpeted as 'no platforms' with the expectation that explict platforms will be added in plugin extensions |
![]() |
ELoadingPhase::Type | LoadingPhase | When should the module be loaded during the startup sequence? This is sort of an advanced setting. |
![]() |
FName | Name | Name of this module |
![]() |
TArray< FString > | PlatformAllowList | List of allowed platforms |
![]() |
TArray< FString > | PlatformDenyList | List of disallowed platforms |
![]() |
TArray< FString > | ProgramAllowList | List of allowed programs |
![]() |
TArray< FString > | ProgramDenyList | List of disallowed programs |
![]() |
TArray< EBuildTargetType > | TargetAllowList | List of allowed targets |
![]() |
TArray< EBuildConfiguration > | TargetConfigurationAllowList | List of allowed target configurations |
![]() |
TArray< EBuildConfiguration > | TargetConfigurationDenyList | List of disallowed target configurations |
![]() |
TArray< EBuildTargetType > | TargetDenyList | List of disallowed targets |
![]() |
EHostType::Type | Type | Usage type of module |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
FModuleDescriptor
(
const FName InName, |
Normal constructor |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
bool | CheckModuleCompatibility
(
const TArray< FModuleDescriptor >& Modules, |
Checks that all modules are compatible with the current engine version. |
![]() ![]() |
bool | IsCompiledInConfiguration
(
const FString& Platform, |
Tests whether the module should be built for the given target |
![]() ![]() |
bool | Tests whether the module should be built for the current engine configuration | |
![]() ![]() |
bool | Tests whether the module should be loaded for the current engine configuration | |
![]() ![]() |
void | LoadModulesForPhase
(
ELoadingPhase::Type LoadingPhase, |
Loads all the modules for a given loading phase. Returns a map of module names to load errors |
![]() |
bool | Read
(
const FJsonObject& Object, |
Reads a descriptor from the given JSON object |
![]() |
bool | Read
(
const FJsonObject& Object, |
Reads a descriptor from the given JSON object |
![]() ![]() |
bool | ReadArray
(
const FJsonObject& Object, |
Reads an array of modules from the given JSON object |
![]() ![]() |
bool | ReadArray
(
const FJsonObject& Object, |
Reads an array of modules from the given JSON object |
![]() ![]() |
void | UpdateArray
(
FJsonObject& JsonObject, |
Updates an array of module descriptors in the specified JSON field (indexed by module name) |
![]() ![]() |
void | UpdateJson
(
FJsonObject& JsonObject |
Updates the given json object with values in this descriptor |
![]() ![]() |
void | Write
(
TJsonWriter<>& Writer |
Writes a descriptor to JSON |
![]() ![]() |
void | WriteArray
(
TJsonWriter<>& Writer, |
Writes an array of modules to JSON |