UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
FUProjectDictionary Class Reference

#include <UProjectInfo.h>

Public Member Functions

CORE_API FUProjectDictionary (const FString &InRootDir)
 
CORE_API void Refresh ()
 
CORE_API bool IsForeignProject (const FString &ProjectFileName) const
 
CORE_API FString GetRelativeProjectPathForGame (const TCHAR *GameName, const FString &BaseDir) const
 
CORE_API FString GetProjectPathForGame (const TCHAR *GameName) const
 
CORE_API TArray< FString > GetProjectPaths () const
 

Static Public Member Functions

static CORE_API FUProjectDictionary & GetDefault ()
 

Detailed Description

Dictionary of all the non-foreign projects for an engine installation, found by parsing .uprojectdirs files for source directories.

Constructor & Destructor Documentation

◆ FUProjectDictionary()

FUProjectDictionary::FUProjectDictionary ( const FString &  InRootDir)

Scans the engine root directory for all the known projects.

Member Function Documentation

◆ GetDefault()

FUProjectDictionary & FUProjectDictionary::GetDefault ( )
static

Gets the project dictionary for the active engine installation.

◆ GetProjectPathForGame()

FString FUProjectDictionary::GetProjectPathForGame ( const TCHAR *  GameName) const

Gets the project filename for the given game. Empty if not found.

◆ GetProjectPaths()

TArray< FString > FUProjectDictionary::GetProjectPaths ( ) const

Gets a list of all the known projects.

◆ GetRelativeProjectPathForGame()

FString FUProjectDictionary::GetRelativeProjectPathForGame ( const TCHAR *  GameName,
const FString &  BaseDir 
) const

Gets the project filename for the given game. Empty if not found.

◆ IsForeignProject()

bool FUProjectDictionary::IsForeignProject ( const FString &  ProjectFileName) const

Determines whether a project is a foreign project or not.

◆ Refresh()

void FUProjectDictionary::Refresh ( )

Refreshes the list of known projects

The documentation for this class was generated from the following files: