1. Epic GamesDeveloper
  3. FModuleDescriptor

FModuleDescriptor

Description of a loadable module.

API > API/Runtime > API/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
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::Type 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< EBuildTargetType > TargetAllowList List of allowed targets
Public variable TArray< EBuildConfiguration > TargetConfigurationAllowList List of allowed target configurations
Public variable TArray< EBuildConfiguration > TargetConfigurationDenyList List of disallowed target configurations
Public variable TArray< EBuildTargetType > TargetDenyList List of disallowed targets
Public variable EHostType::Type Type Usage type of module

Constructors

  Type Name Description
Public function  

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

 Normal constructor

Functions

  Type Name Description
Public function Static bool

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

 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 Tests whether the module should be built for the current engine configuration
Public function Const bool Tests whether the module should be loaded for the current engine configuration
Public function 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
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 >& OutModules,
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 >& OutModules,
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 >& Modules
)

 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 >& Modules
)

 Writes an array of modules to JSON

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page