1. Epic GamesDeveloper
  3. IProjectManager

IProjectManager

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

API > API/Runtime > API/Runtime/Projects

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

   
Name IProjectManager
Type class
Header File /Engine/Source/Runtime/Projects/Public/Interfaces/IProjectManager.h
Include Path #include "Interfaces/IProjectManager.h"

Syntax

class IProjectManager

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IProjectManager()

   Interfaces/IProjectManager.h  

Classes

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

Typedefs

Name Type Remarks Include Path
FOnTargetPlatformsForCurrentProjectChangedEvent TMulticastDelegate_NoParams< void > Called when the target platforms for the current project are changed Interfaces/IProjectManager.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddSuppressProjectFileWrite ( const FName InName
)

 Suppress project file writes. Interfaces/IProjectManager.h  

bool CheckModuleCompatibility ( TArray< FString >& OutIncompatibleModules
)

 Checks if the modules for a project are up to date Interfaces/IProjectManager.h  

void ClearSupportedTargetPlatformsForCurrentProject()

 Clear the list of supported target platforms for the current project Interfaces/IProjectManager.h  

void ClearSupportedTargetPlatformsForProject ( const FString& FilePath
)

 Clear the list of supported target platforms for the target project Interfaces/IProjectManager.h  

const TArray< FString > & GetAdditionalPluginDirectories()

 Returns the list of additional directories to be scanned for plugins (aside from the engine and project plugin directories). Interfaces/IProjectManager.h  

const FString & GetAutoLoadProjectFileName ()

 Gets the name of the text file that contains the most recently loaded filename. Interfaces/IProjectManager.h  

const FProjectDescriptor * GetCurrentProject()

 Gets the current project descriptor. Interfaces/IProjectManager.h  

TArray< FModuleContextInfo > & GetCurrentProjectModuleContextInfos()

 Access array used to cache current project's list of module context infos Interfaces/IProjectManager.h  

bool HasDefaultPluginSettings()

 Checks whether the current project has default settings for plugins (ie. does not enable any new plugins, or disable any default plugins) Interfaces/IProjectManager.h  

bool IsCurrentProjectDirty()

 Checks whether the current loaded project has been modified but not saved to disk Interfaces/IProjectManager.h  

bool IsEnterpriseProject()

 Gets the enterprise flag value on the current project Interfaces/IProjectManager.h  

bool IsSuppressingProjectFileWrite()

 Returns true if project file write should be suppressed. Interfaces/IProjectManager.h  

bool LoadModulesForProject ( const ELoadingPhase::Type LoadingPhase
)

 Loads all modules for the currently loaded project in the specified loading phase Interfaces/IProjectManager.h  

bool LoadProjectFile ( const FString& ProjectFile
)

 Loads the specified project file. Interfaces/IProjectManager.h  

FLoadingModulesForPhaseEvent & OnLoadingPhaseComplete()

   Interfaces/IProjectManager.h  

FOnTargetPlatformsForCurrentProjectChangedEvent & OnTargetPlatformsForCurrentProjectChanged()

   Interfaces/IProjectManager.h  

bool QueryStatusForCurrentProject ( FProjectStatus& OutProjectStatus
) const

 Gets status about the current project Interfaces/IProjectManager.h  

bool QueryStatusForProject ( const FString& FilePath,
FProjectStatus& OutProjectStatus
) const

 Gets status about the specified project Interfaces/IProjectManager.h  

bool RemovePluginReference ( const FString& PluginName,
FText& OutFailReason
)

   Interfaces/IProjectManager.h  

void RemoveSuppressProjectFileWrite ( const FName InName
)

 Removes suppression of project file writes. Interfaces/IProjectManager.h  

bool SaveCurrentProjectToDisk ( FText& OutFailReason
)

 Saves the current project to the project path Interfaces/IProjectManager.h  

void SetIsEnterpriseProject ( bool bValue
)

 Sets the enterprise flag value on the current project Interfaces/IProjectManager.h  

bool SetPluginEnabled ( const FString& PluginName,
bool bEnabled,
FText& OutFailReason
)

 Sets whether a plugin is enabled for the current project configuration. Interfaces/IProjectManager.h  

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. Interfaces/IProjectManager.h  

bool SubstituteModule ( const FString& OriginalModuleName,
const FString& NewModuleName
)

 Replaces a referenced module with a new name Interfaces/IProjectManager.h  

bool UpdateAdditionalPluginDirectory ( const FString& Dir,
const bool bAddOrRemove
)

 Updates a directory to be scanned for plugins (added or removed) Interfaces/IProjectManager.h  

void UpdateSupportedTargetPlatformsForCurrentProject ( const FName& InPlatformName,
const bool bIsSupported
)

 Update the list of supported target platforms for the current project based upon the parameters provided Interfaces/IProjectManager.h  

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 Interfaces/IProjectManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static IProjectManager & Get()

 Static: Access singleton instance Interfaces/IProjectManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page