IProjectManager

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

Choose your operating system:

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

Public function Virtual

~IProjectManager()

Functions

Name Description

Public function

void

 

AddSuppressProjectFileWrite

(
    const FName InName
)

Suppress project file writes.

Public function

bool

 

CheckModuleCompatibility

(
    TArray< FString >& OutIncompatible...
)

Checks if the modules for a project are up to date

Public function

void

 

ClearSupportedTargetPlatformsForCurrentProject()

Clear the list of supported target platforms for the current project

Public function

void

 

ClearSupportedTargetPlatformsForProject

(
    const FString& FilePath
)

Clear the list of supported target platforms for the target project

Public function Static

IProjectMana...

 

Get()

Static: Access singleton instance

Public function Const

const TArray...

 

GetAdditionalPluginDirectories()

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

Public function

const FStrin...

 

GetAutoLoadProjectFileName()

Gets the name of the text file that contains the most recently loaded filename.

Public function Const

const FProje...

 

GetCurrentProject()

Gets the current project descriptor.

Public function

TArray< FMod...

 

GetCurrentProjectModuleContextInfos()

Access array used to cache current project's list of module context infos

Public function Const

bool

 

HasDefaultPluginSettings()

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

Public function Const

bool

 

IsCurrentProjectDirty()

Checks whether the current loaded project has been modified but not saved to disk

Public function

bool

 

IsEnterpriseProject()

Gets the enterprise flag value on the current project

Public function Const

bool

 

IsSuppressingProjectFileWrite()

Returns true if project file write should be suppressed.

Public function

bool

 

LoadModulesForProject

(
    const ELoadingPhase::Type LoadingPh...
)

Loads all modules for the currently loaded project in the specified loading phase

Public function

bool

 

LoadProjectFile

(
    const FString& ProjectFile
)

Loads the specified project file.

Public function

FLoadingModu...

 

OnLoadingPhaseComplete()

Public function

FOnTargetPla...

 

OnTargetPlatformsForCurrentProjectChanged()

Public function Const

bool

 

QueryStatusForCurrentProject

(
    FProjectStatus& OutProjectStatus
)

Gets status about the current project

Public function Const

bool

 

QueryStatusForProject

(
    const FString& FilePath,
    FProjectStatus& OutProjectStatus
)

Gets status about the specified project

Public function

bool

 

RemovePluginReference

(
    const FString& PluginName,
    FText& OutFailReason
)

Public function

void

 

RemoveSuppressProjectFileWrite

(
    const FName InName
)

Removes suppression of project file writes.

Public function

bool

 

SaveCurrentProjectToDisk

(
    FText& OutFailReason
)

Saves the current project to the project path

Public function

void

 

SetIsEnterpriseProject

(
    bool bValue
)

Sets the enterprise flag value on the current project

Public function

bool

 

SetPluginEnabled

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

Sets whether a plugin is enabled for the current project configuration.

Public function

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.

Public function

bool

 

UpdateAdditionalPluginDirectory

(
    const FString& Dir,
    const bool bAddOrRemove
)

Updates a directory to be scanned for plugins (added or removed)

Public function

void

 

UpdateSupportedTargetPlatformsForCurrentProject

(
    const FName& InPlatformName,
    const bool bIsSupported
)

Update the list of supported target platforms for the current project based upon the parameters provided

Public function

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

Public class

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