1. Epic GamesDeveloper
  3. FProjectDescriptor

FProjectDescriptor

Descriptor for projects. Contains all the information contained within a .uproject file.

API > API/Runtime > API/Runtime/Projects

Descriptor for projects. Contains all the information contained within a .uproject file.

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

Syntax

struct FProjectDescriptor

Constructors

Name Remarks Include Path Unreal Specifiers

FProjectDescriptor()

 Constructor. ProjectDescriptor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDisableEnginePluginsByDefault bool Indicates that enabled by default engine plugins should not be enabled unless explicitly enabled by the project or target files. ProjectDescriptor.h  
bIsEnterpriseProject bool Indicates if this project is an Enterprise project ProjectDescriptor.h  
Category FString Category to show under the project browser ProjectDescriptor.h  
Description FString Description to show in the project browser ProjectDescriptor.h  
EngineAssociation FString The engine to open this project with. ProjectDescriptor.h  
EpicSampleNameHash uint32 A hash that is used to determine if the project was forked from a sample ProjectDescriptor.h  
FileVersion EProjectDescriptorVersion::Type Descriptor version number. ProjectDescriptor.h  
Modules TArray< FModuleDescriptor > List of all modules associated with this project ProjectDescriptor.h  
Plugins TArray< FPluginReferenceDescriptor > List of plugins for this project (may be enabled/disabled) ProjectDescriptor.h  
PostBuildSteps FCustomBuildSteps Custom steps to execute after building targets in this project ProjectDescriptor.h  
PreBuildSteps FCustomBuildSteps Custom steps to execute before building targets in this project ProjectDescriptor.h  
TargetPlatforms TArray< FName > Array of platforms that this project is targeting ProjectDescriptor.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AdditionalPluginDirectories TArray< FString > List of additional directories to scan for plugins. ProjectDescriptor.h  
AdditionalRootDirectories TArray< FString > List of additional root directories to scan for modules. ProjectDescriptor.h  
ModuleNamesCache TSet< FName > Set of project module names ProjectDescriptor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddPluginDirectory ( const FString& Dir
)

 Adds a directory to the additional plugin directories list. ProjectDescriptor.h  

bool AddRootDirectory ( const FString& Dir
)

 Adds a directory to the additional root directories list. ProjectDescriptor.h  

int32 FindPluginReferenceIndex ( const FString& PluginName
) const

 Finds the index of a plugin in the references array ProjectDescriptor.h  

const TArray< FString > & GetAdditionalPluginDirectories()

   ProjectDescriptor.h  

const TArray< FString > & GetAdditionalRootDirectories()

   ProjectDescriptor.h  

bool HasModule ( FName ModuleName
) const

 Returns whether the project has a module of the given name ProjectDescriptor.h  

bool IsSigned ( const FString& FilePath
) const

 Checks whether the descriptor is signed ProjectDescriptor.h  

bool Load ( const FString& FileName,
FText& OutFailReason
)

 Loads the descriptor from the given file. ProjectDescriptor.h  

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

 Reads the descriptor from the given JSON object ProjectDescriptor.h  

bool RemovePluginDirectory ( const FString& Dir
)

 Removes the directory from the list to scan ProjectDescriptor.h  

bool RemoveRootDirectory ( const FString& Dir
)

 Removes the directory from the list to scan ProjectDescriptor.h  

bool Save ( const FString& FileName,
FText& OutFailReason
)

 Saves the descriptor to the given file. ProjectDescriptor.h  

void Sign ( const FString& FilePath
)

 Signs the project given for the given filename ProjectDescriptor.h  

void UpdateSupportedTargetPlatforms ( const FName& InPlatformName,
bool bIsSupported
)

 Updates the supported target platforms list ProjectDescriptor.h  

void Write ( TJsonWriter<>& Writer,
const FString& PathToProject
) const

 Writes the descriptor to the given JSON object ProjectDescriptor.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString GetExtension()

 Returns the extension used for project descriptors (uproject) ProjectDescriptor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page