Navigation
Unreal Engine C++ API Reference > 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 | |
---|---|---|---|
![]() |
bool | bDisableEnginePluginsByDefault | Indicates that enabled by default engine plugins should not be enabled unless explicitly enabled by the project or target files. |
![]() |
bool | bIsEnterpriseProject | Indicates if this project is an Enterprise project |
![]() |
FString | Category | Category to show under the project browser |
![]() |
FString | Description | Description to show in the project browser |
![]() |
FString | EngineAssociation | The engine to open this project with. |
![]() |
uint32 | EpicSampleNameHash | A hash that is used to determine if the project was forked from a sample |
![]() |
EProjectDescriptorVersion::Type | FileVersion | Descriptor version number. |
![]() |
TArray< FModuleDescriptor > | Modules | List of all modules associated with this project |
![]() |
TArray< FPluginReferenceDescriptor > | Plugins | List of plugins for this project (may be enabled/disabled) |
![]() |
FCustomBuildSteps | PostBuildSteps | Custom steps to execute after building targets in this project |
![]() |
FCustomBuildSteps | PreBuildSteps | Custom steps to execute before building targets in this project |
![]() |
TArray< FName > | TargetPlatforms | Array of platforms that this project is targeting |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
Constructor. |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
bool | AddPluginDirectory
(
const FString& Dir |
Adds a directory to the additional plugin directories list. |
![]() |
bool | AddRootDirectory
(
const FString& Dir |
Adds a directory to the additional root directories list. |
![]() ![]() |
int32 | FindPluginReferenceIndex
(
const FString& PluginName |
Finds the index of a plugin in the references array |
![]() ![]() |
const TArray< FString > & | ||
![]() ![]() |
const TArray< FString > & | ||
![]() ![]() |
FString | GetExtension () |
Returns the extension used for project descriptors (uproject) |
![]() ![]() |
bool | Returns whether the project has a module of the given name | |
![]() ![]() |
bool | Checks whether the descriptor is signed | |
![]() |
bool | Loads the descriptor from the given file. | |
![]() |
bool | Read
(
const FJsonObject& Object, |
Reads the descriptor from the given JSON object |
![]() |
bool | RemovePluginDirectory
(
const FString& Dir |
Removes the directory from the list to scan |
![]() |
bool | RemoveRootDirectory
(
const FString& Dir |
Removes the directory from the list to scan |
![]() |
bool | Saves the descriptor to the given file. | |
![]() |
void | Signs the project given for the given filename | |
![]() |
void | UpdateSupportedTargetPlatforms
(
const FName& InPlatformName, |
Updates the supported target platforms list |
![]() ![]() |
void | Write
(
TJsonWriter<>& Writer, |
Writes the descriptor to the given JSON object |