FModuleDescriptor

Description of a loadable module.

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

Name Description

Public variable

TArray< FString...

 

AdditionalDependencies

List of additional dependencies for building this module.

Public variable

bool

 

bHasExplicitPlatforms

When true, an empty PlatformAllowList is interpeted as 'no platforms' with the expectation that explict platforms will be added in plugin extensions

Public variable

ELoadingPhase::...

 

LoadingPhase

When should the module be loaded during the startup sequence? This is sort of an advanced setting.

Public variable

FName

 

Name

Name of this module

Public variable

TArray< FString...

 

PlatformAllowList

List of allowed platforms

Public variable

TArray< FString...

 

PlatformDenyList

List of disallowed platforms

Public variable

TArray< FString...

 

ProgramAllowList

List of allowed programs

Public variable

TArray< FString...

 

ProgramDenyList

List of disallowed programs

Public variable

TArray< EBuildT...

 

TargetAllowList

List of allowed targets

Public variable

TArray< EBuildC...

 

TargetConfigurationAllowList

List of allowed target configurations

Public variable

TArray< EBuildC...

 

TargetConfigurationDenyList

List of disallowed target configurations

Public variable

TArray< EBuildT...

 

TargetDenyList

List of disallowed targets

Public variable

EHostType::Type

 

Type

Usage type of module

Constructors

Name Description

Public function

FModuleDescriptor

(
    const FName InName,
    EHostType::Type InType,
    ELoadingPhase::Type InLoadingPhase
)

Normal constructor

Functions

Name Description

Public function Static

bool

 

CheckModuleCompatibility

(
    const TArray< FModuleDescriptor >&...,
    TArray< FString >& OutIncompatible...
)

Checks that all modules are compatible with the current engine version.

Public function Const

bool

 

IsCompiledInConfiguration

(
    const FString& Platform,
    EBuildConfiguration Configuration,
    const FString& TargetName,
    EBuildTargetType TargetType,
    bool bBuildDeveloperTools,
    bool bBuildRequiresCookedData
)

Tests whether the module should be built for the given target

Public function Const

bool

 

IsCompiledInCurrentConfiguration()

Tests whether the module should be built for the current engine configuration

Public function Const

bool

 

IsLoadedInCurrentConfiguration()

Tests whether the module should be loaded for the current engine configuration

Public function Static

void

 

LoadModulesForPhase

(
    ELoadingPhase::Type LoadingPhase,
    const TArray< FModuleDescriptor >&...,
    TMap< FName, EModuleLoadResult >& ...
)

Loads all the modules for a given loading phase. Returns a map of module names to load errors

Public function

bool

 

Read

(
    const FJsonObject& Object,
    FText* OutFailReason
)

Reads a descriptor from the given JSON object

Public function

bool

 

Read

(
    const FJsonObject& Object,
    FText& OutFailReason
)

Reads a descriptor from the given JSON object

Public function Static

bool

 

ReadArray

(
    const FJsonObject& Object,
    const TCHAR* Name,
    TArray< FModuleDescriptor >& OutMo...,
    FText* OutFailReason
)

Reads an array of modules from the given JSON object

Public function Static

bool

 

ReadArray

(
    const FJsonObject& Object,
    const TCHAR* Name,
    TArray< FModuleDescriptor >& OutMo...,
    FText& OutFailReason
)

Reads an array of modules from the given JSON object

Public function Static

void

 

UpdateArray

(
    FJsonObject& JsonObject,
    const TCHAR* ArrayName,
    const TArray< FModuleDescriptor >&...
)

Updates an array of module descriptors in the specified JSON field (indexed by module name)

Public function Const

void

 

UpdateJson

(
    FJsonObject& JsonObject
)

Updates the given json object with values in this descriptor

Public function Const

void

 

Write

(
    TJsonWriter<>& Writer
)

Writes a descriptor to JSON

Public function Static

void

 

WriteArray

(
    TJsonWriter<>& Writer,
    const TCHAR* ArrayName,
    const TArray< FModuleDescriptor >&...
)

Writes an array of modules to JSON

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel