1. Epic GamesDeveloper
  3. FModuleDescriptor

FModuleDescriptor

Description of a loadable module.

API > API/Runtime > API/Runtime/Projects

Description of a loadable module.

   
Name FModuleDescriptor
Type struct
Header File /Engine/Source/Runtime/Projects/Public/ModuleDescriptor.h
Include Path #include "ModuleDescriptor.h"

Syntax

struct FModuleDescriptor

Constructors

Name Remarks Include Path Unreal Specifiers

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

 Normal constructor ModuleDescriptor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AdditionalDependencies TArray< FString > List of additional dependencies for building this module. ModuleDescriptor.h  
bHasExplicitPlatforms bool When true, an empty PlatformAllowList is interpeted as 'no platforms' with the expectation that explict platforms will be added in plugin extensions ModuleDescriptor.h  
GameTargetAllowList TArray< FString > List of allowed game targets ModuleDescriptor.h  
GameTargetDenyList TArray< FString > List of disallowed game targets ModuleDescriptor.h  
LoadingPhase ELoadingPhase::Type When should the module be loaded during the startup sequence? This is sort of an advanced setting. ModuleDescriptor.h  
Name FName Name of this module ModuleDescriptor.h  
PlatformAllowList TArray< FString > List of allowed platforms ModuleDescriptor.h  
PlatformArchitectureAllowList TMap< FString, TArray< FString > > List of allowed platform architectures ModuleDescriptor.h  
PlatformArchitectureDenyList TMap< FString, TArray< FString > > List of disallowed platform architectures ModuleDescriptor.h  
PlatformDenyList TArray< FString > List of disallowed platforms ModuleDescriptor.h  
ProgramAllowList TArray< FString > List of allowed programs ModuleDescriptor.h  
ProgramDenyList TArray< FString > List of disallowed programs ModuleDescriptor.h  
TargetAllowList TArray< EBuildTargetType > List of allowed targets ModuleDescriptor.h  
TargetConfigurationAllowList TArray< EBuildConfiguration > List of allowed target configurations ModuleDescriptor.h  
TargetConfigurationDenyList TArray< EBuildConfiguration > List of disallowed target configurations ModuleDescriptor.h  
TargetDenyList TArray< EBuildTargetType > List of disallowed targets ModuleDescriptor.h  
Type EHostType::Type Usage type of module ModuleDescriptor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Tests whether the module should be built for the given target ModuleDescriptor.h  

bool IsCompiledInCurrentConfiguration()

 Tests whether the module should be built for the current engine configuration ModuleDescriptor.h  

bool IsLoadedInCurrentConfiguration()

 Tests whether the module should be loaded for the current engine configuration ModuleDescriptor.h  

bool Read ( const FJsonObject& Object,
FText* OutFailReason
)

 Reads a descriptor from the given JSON object ModuleDescriptor.h  

bool Read ( const FJsonObject& Object,
FText& OutFailReason
)

 Reads a descriptor from the given JSON object ModuleDescriptor.h  

void UpdateJson ( FJsonObject& JsonObject
) const

 Updates the given json object with values in this descriptor ModuleDescriptor.h  

void Write ( TJsonWriter<>& Writer
) const

 Writes a descriptor to JSON ModuleDescriptor.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CheckModuleCompatibility ( const TArray< FModuleDescriptor >& Modules,
TArray< FString >& OutIncompatibleFiles
)

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

static void LoadModulesForPhase ( ELoadingPhase::Type LoadingPhase,
const TArray< FModuleDescriptor >& Modules,
TMap< FName, EModuleLoadResult >& ModuleLoadErrors
)

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

static bool ReadArray ( const FJsonObject& Object,
const TCHAR* Name,
TArray< FModuleDescriptor >& OutModules,
FText* OutFailReason
)

 Reads an array of modules from the given JSON object ModuleDescriptor.h  

static bool ReadArray ( const FJsonObject& Object,
const TCHAR* Name,
TArray< FModuleDescriptor >& OutModules,
FText& OutFailReason
)

 Reads an array of modules from the given JSON object ModuleDescriptor.h  

static void UnloadModulesForPhase ( ELoadingPhase::Type LoadingPhase,
const TArray< FModuleDescriptor >& Modules,
TMap< FName, EModuleUnloadResult >& OutErrors,
bool bSkipUnload,
bool bAllowUnloadCode
)

 Unloads all the modules for a given loading phase. ModuleDescriptor.h  

static void UpdateArray ( FJsonObject& JsonObject,
const TCHAR* ArrayName,
const TArray< FModuleDescriptor >& Modules
)

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

static void WriteArray ( TJsonWriter<>& Writer,
const TCHAR* ArrayName,
const TArray< FModuleDescriptor >& Modules
)

 Writes an array of modules to JSON ModuleDescriptor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page