Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Projects > Interfaces > IProjectManager

Light Theme

Dark Theme

IProjectManager

ProjectAndPluginManager manages available code and content extensions (both loaded and not loaded.)

Windows

MacOS

Linux

References

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

Syntax

class IProjectManager

Remarks

ProjectAndPluginManager manages available code and content extensions (both loaded and not loaded.)

Destructors

	Name	Description
	~IProjectManager()

Functions

	Name	Description
void	AddSuppressProjectFileWrite ( const FName InName )	Suppress project file writes.
bool	CheckModuleCompatibility ( TArray< FString >& OutIncompatible... )	Checks if the modules for a project are up to date
void	ClearSupportedTargetPlatformsForCurrentProject()	Clear the list of supported target platforms for the current project
void	ClearSupportedTargetPlatformsForProject ( const FString& FilePath )	Clear the list of supported target platforms for the target project
IProjectMana...	Get()	Static: Access singleton instance
const TArray...	GetAdditionalPluginDirectories()	Returns the list of additional directories to be scanned for plugins (aside from the engine and project plugin directories).
const FStrin...	GetAutoLoadProjectFileName()	Gets the name of the text file that contains the most recently loaded filename.
const FProje...	GetCurrentProject()	Gets the current project descriptor.
TArray< FMod...	GetCurrentProjectModuleContextInfos()	Access array used to cache current project's list of module context infos
bool	HasDefaultPluginSettings()	Checks whether the current project has default settings for plugins (ie. does not enable any new plugins, or disable any default plugins)
bool	IsCurrentProjectDirty()	Checks whether the current loaded project has been modified but not saved to disk
bool	IsEnterpriseProject()	Gets the enterprise flag value on the current project
bool	IsSuppressingProjectFileWrite()	Returns true if project file write should be suppressed.
bool	LoadModulesForProject ( const ELoadingPhase::Type LoadingPh... )	Loads all modules for the currently loaded project in the specified loading phase
bool	LoadProjectFile ( const FString& ProjectFile )	Loads the specified project file.
FLoadingModu...	OnLoadingPhaseComplete()
FOnTargetPla...	OnTargetPlatformsForCurrentProjectChanged()
bool	QueryStatusForCurrentProject ( FProjectStatus& OutProjectStatus )	Gets status about the current project
bool	QueryStatusForProject ( const FString& FilePath, FProjectStatus& OutProjectStatus )	Gets status about the specified project
bool	RemovePluginReference ( const FString& PluginName, FText& OutFailReason )
void	RemoveSuppressProjectFileWrite ( const FName InName )	Removes suppression of project file writes.
bool	SaveCurrentProjectToDisk ( FText& OutFailReason )	Saves the current project to the project path
void	SetIsEnterpriseProject ( bool bValue )	Sets the enterprise flag value on the current project
bool	SetPluginEnabled ( const FString& PluginName, bool bEnabled, FText& OutFailReason )	Sets whether a plugin is enabled for the current project configuration.
bool	SignSampleProject ( const FString& FilePath, const FString& Category, FText& OutFailReason )	Sets the project's EpicSampleNameHash (based on its filename) and category, then saves the file to disk.
bool	UpdateAdditionalPluginDirectory ( const FString& Dir, const bool bAddOrRemove )	Updates a directory to be scanned for plugins (added or removed)
void	UpdateSupportedTargetPlatformsForCurrentProject ( const FName& InPlatformName, const bool bIsSupported )	Update the list of supported target platforms for the current project based upon the parameters provided
void	UpdateSupportedTargetPlatformsForProject ( const FString& FilePath, const FName& InPlatformName, const bool bIsSupported )	Update the list of supported target platforms for the target project based upon the parameters provided

Classes

	Name	Description
	FLoadingModulesForPhaseEvent	Callback for when modules for when LoadModulesForProject() completes loading for a specific phase.

Typedefs

Name	Description
FOnTargetPlatformsForCurrentProjectChangedEvent	Called when the target platforms for the current project are changed

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss