1. Epic GamesDeveloper
  3. FProjectDescriptor

FProjectDescriptor

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

API > API/Runtime > API/Runtime/Projects

References

   
Module Projects
Header /Engine/Source/Runtime/Projects/Public/ProjectDescriptor.h
Include #include "ProjectDescriptor.h"

Syntax

struct FProjectDescriptor

Remarks

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

Variables

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

Constructors

  Type Name Description
Public function   Constructor.

Functions

  Type Name Description
Public function bool

AddPluginDirectory ( const FString& Dir
)

 Adds a directory to the additional plugin directories list.
Public function bool

AddRootDirectory ( const FString& Dir
)

 Adds a directory to the additional root directories list.
Public function Const int32

FindPluginReferenceIndex ( const FString& PluginName
)

 Finds the index of a plugin in the references array
Public function Const const TArray< FString > &  
Public function Const const TArray< FString > &  
Public function Static FString Returns the extension used for project descriptors (uproject)
Public function Const bool

HasModule ( FName ModuleName
)

 Returns whether the project has a module of the given name
Public function Const bool

IsSigned ( const FString& FilePath
)

 Checks whether the descriptor is signed
Public function bool

Load ( const FString& FileName,
FText& OutFailReason
)

 Loads the descriptor from the given file.
Public function bool

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

 Reads the descriptor from the given JSON object
Public function bool Removes the directory from the list to scan
Public function bool

RemoveRootDirectory ( const FString& Dir
)

 Removes the directory from the list to scan
Public function bool

Save ( const FString& FileName,
FText& OutFailReason
)

 Saves the descriptor to the given file.
Public function void

Sign ( const FString& FilePath
)

 Signs the project given for the given filename
Public function void

UpdateSupportedTargetPlatforms ( const FName& InPlatformName,
bool bIsSupported
)

 Updates the supported target platforms list
Public function Const void

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

 Writes the descriptor to the given JSON object

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page