FModuleDescriptor

Description of a loadable module.

Windows
MacOS
Linux

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

TArray< FString...

 

BlacklistPlatforms

List of disallowed platforms

Public variable

TArray< FString...

 

BlacklistPrograms

List of disallowed programs

Public variable

TArray< FString...

 

BlacklistTargetConfigurations

List of disallowed target configurations

Public variable

TArray< FString...

 

BlacklistTargets

List of disallowed targets

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

EHostType::Type

 

Type

Usage type of module

Public variable

TArray< FString...

 

WhitelistPlatforms

List of allowed platforms

Public variable

TArray< FString...

 

WhitelistPrograms

List of allowed programs

Public variable

TArray< FString...

 

WhitelistTargetConfigurations

List of allowed target configurations

Public variable

TArray< FString...

 

WhitelistTargets

List of allowed targets

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

 

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 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 Const

void

 

Write

(
    TJsonWriter<>& Writer
)

Writes a descriptor to JSON

Public function Static

void

 

WriteArray

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

Writes an array of modules to JSON

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback