1. Epic GamesDeveloper
  3. FGameProjectGenerationModule

FGameProjectGenerationModule

Game Project Generation module

API > API/Editor > API/Editor/GameProjectGeneration

Game Project Generation module

   
Name FGameProjectGenerationModule
Type class
Header File /Engine/Source/Editor/GameProjectGeneration/Public/GameProjectGenerationModule.h
Include Path #include "GameProjectGenerationModule.h"

Syntax

class FGameProjectGenerationModule : public IModuleInterface

Implements Interfaces

Classes

Name Remarks
FAddCodeToProjectDialogOpenedEvent Delegate for when the AddCodeToProject dialog is opened

Typedefs

Name Type Remarks Include Path
FTemplateCategoryMap TMap< FName, TSharedPtr< FTemplateCategory > >   GameProjectGenerationModule.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AddCodeToProjectDialogOpenedEvent FAddCodeToProjectDialogOpenedEvent   GameProjectGenerationModule.h  
TemplateCategories FTemplateCategoryMap Map of template categories from type to ptr GameProjectGenerationModule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void CheckAndWarnProjectFilenameValid()

 Warn the user if the project filename is invalid in case they renamed it outside the editor GameProjectGenerationModule.h  

virtual void CheckForOutOfDateGameProjectFile()

 Prompts the user to update their project file, if necessary. GameProjectGenerationModule.h  

virtual void ClearSupportedTargetPlatforms()

 Clear the list of supported target platforms GameProjectGenerationModule.h  

virtual TSharedRef< class SWidget > CreateGameProjectDialog ( bool bAllowProjectOpening,
bool bAllowProjectCreate
)

 Creates the game project dialog GameProjectGenerationModule.h  

virtual TSharedRef< class SWidget > CreateNewClassDialog ( const UClass* InClass
)

 Creates a new class dialog for creating classes based on the passed-in class. GameProjectGenerationModule.h  

virtual bool CreateProject ( const FProjectInformation& InProjectInfo,
FText& OutFailReason,
FText& OutFailLog,
TArray< FString >* OutCreatedFiles
)

 Creates the specified project file and all required folders. GameProjectGenerationModule.h  

virtual TSharedRef< class SWidget > CreateProjectBrowser ( bool bInShowHeaderBar,
bool bInAllowScrolling
)

 Creates the project browser widget GameProjectGenerationModule.h  

virtual FString DetermineModuleIncludePath ( const FModuleContextInfo& ModuleInfo,
const FString& FileRelativeTo
)

 Returns the path to the module's include header GameProjectGenerationModule.h  

virtual bool GenerateBasicSourceCode ( TArray< FString >& OutCreatedFiles,
FText& OutFailReason
)

 Generate basic project source code GameProjectGenerationModule.h  

void GetAllTemplateCategories ( TArray< TSharedPtr< FTemplateCategory > >& OutCategories
) const

   GameProjectGenerationModule.h  

TSharedPtr< const FTemplateCategory > GetCategory ( FName Type
) const

 Non DLL-exposed access to template categories. GameProjectGenerationModule.h  

virtual const TArray< FModuleContextInfo > & GetCurrentProjectModules()

 Get the information about any modules referenced in the .uproject file of the currently loaded project GameProjectGenerationModule.h  

virtual void GetProjectSourceDirectoryInfo ( int32& OutNumFiles,
int64& OutDirectorySize
)

 Gets file and size info about the source directory GameProjectGenerationModule.h  

virtual bool IsValidBaseClassForCreation ( const UClass* InClass,
const FModuleContextInfo& InModuleInfo
)

 Returns true if the specified class is a valid base class for the given module GameProjectGenerationModule.h  

virtual bool IsValidBaseClassForCreation ( const UClass* InClass,
const TArray< FModuleContextInfo >& InModuleInfoArray
)

 Returns true if the specified class is a valid base class for any of the given modules GameProjectGenerationModule.h  

FAddCodeToProjectDialogOpenedEvent & OnAddCodeToProjectDialogOpened()

   GameProjectGenerationModule.h  

virtual void OpenAddBlueprintToProjectDialog ( const FAddToProjectConfig& Config
)

 Opens a dialog to add a new blueprint to the current project. GameProjectGenerationModule.h  

virtual void OpenAddCodeToProjectDialog ( const FAddToProjectConfig& Config
)

 Opens a dialog to add code files to the current project. GameProjectGenerationModule.h  

virtual bool OpenProject ( const FString& InProjectFile,
FText& OutFailReason
)

 Opens the specified project, if it exists. GameProjectGenerationModule.h  

virtual bool ProjectHasCodeFiles()

 Gets the current projects source file count GameProjectGenerationModule.h  

virtual void TryMakeProjectFileWriteable ( const FString& ProjectFile
)

 Tries to make the project file writable. Prompts to check out as necessary. GameProjectGenerationModule.h  

virtual bool UpdateCodeProject ( FText& OutFailReason,
FText& OutFailLog
)

 Updates the current code project GameProjectGenerationModule.h  

virtual bool UpdateGameProject ( const FString& ProjectFile,
const FString& EngineIdentifier,
FText& OutFailReason
)

 Updates the currently loaded project. GameProjectGenerationModule.h  

virtual void UpdateSupportedTargetPlatforms ( const FName& InPlatformName,
const bool bIsSupported
)

 Update the list of supported target platforms based upon the parameters provided This will take care of checking out and saving the updated .uproject file automatically GameProjectGenerationModule.h  

Overridden from IModuleInterface

Name Remarks Include Path Unreal Specifiers

virtual void ShutdownModule()

 Called before the plugin is unloaded, right before the plugin object is destroyed. GameProjectGenerationModule.h  

virtual void StartupModule()

 Called right after the plugin DLL has been loaded and the plugin object has been created GameProjectGenerationModule.h  

Static

Name Remarks Include Path Unreal Specifiers
Singleton-like access to this module's interface. GameProjectGenerationModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page