Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Projects > FModuleDescriptor

Light Theme

Dark Theme

FModuleDescriptor

Description of a loadable module.

Choose your operating system:

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
	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::...	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< EBuildT...	TargetAllowList	List of allowed targets
	TArray< EBuildC...	TargetConfigurationAllowList	List of allowed target configurations
	TArray< EBuildC...	TargetConfigurationDenyList	List of disallowed target configurations
	TArray< EBuildT...	TargetDenyList	List of disallowed targets
	EHostType::Type	Type	Usage type of module

Constructors

	Name	Description
	FModuleDescriptor ( const FName InName, EHostType::Type InType, ELoadingPhase::Type InLoadingPhase )	Normal constructor

Functions

		Name	Description
	bool	CheckModuleCompatibility ( const TArray< FModuleDescriptor >&..., TArray< FString >& OutIncompatible... )	Checks that all modules are compatible with the current engine version.
	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
	bool	IsCompiledInCurrentConfiguration()	Tests whether the module should be built for the current engine configuration
	bool	IsLoadedInCurrentConfiguration()	Tests whether the module should be loaded for the current engine configuration
	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
	bool	Read ( const FJsonObject& Object, FText* OutFailReason )	Reads a descriptor from the given JSON object
	bool	Read ( const FJsonObject& Object, FText& OutFailReason )	Reads a descriptor from the given JSON object
	bool	ReadArray ( const FJsonObject& Object, const TCHAR* Name, TArray< FModuleDescriptor >& OutMo..., FText* OutFailReason )	Reads an array of modules from the given JSON object
	bool	ReadArray ( const FJsonObject& Object, const TCHAR* Name, TArray< FModuleDescriptor >& OutMo..., FText& OutFailReason )	Reads an array of modules from the given JSON object
	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)
	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, const TCHAR* ArrayName, const TArray< FModuleDescriptor >&... )	Writes an array of modules to JSON