1. Epic GamesDeveloper
  3. UTemplateProjectDefs

UTemplateProjectDefs

API > API/Editor > API/Editor/GameProjectGeneration

   
Name UTemplateProjectDefs
Type class
Header File /Engine/Source/Editor/GameProjectGeneration/Classes/TemplateProjectDefs.h
Include Path #include "TemplateProjectDefs.h"

Syntax

UCLASS (Abstract, Config=TemplateDefs, MinimalAPI)  
class UTemplateProjectDefs : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UTemplateProjectDefs ( const FObjectInitializer& ObjectInitializer
)

   TemplateProjectDefs.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetTypes FString   TemplateProjectDefs.h
  • Config
bAllowProjectCreation bool Should we allow creation of a project from this template. TemplateProjectDefs.h
  • Config
bIsBlank bool Is this a blank template? Determines whether we can override the default map when creating the project. TemplateProjectDefs.h
  • Config
bIsEnterprise bool Is this an enterprise template? TemplateProjectDefs.h
  • Config
bThumbnailAsIcon bool Is there a rendered thumbnail that should be treated as the project template icon. TemplateProjectDefs.h
  • Config
Categories TArray< FName >   TemplateProjectDefs.h
  • Config
ClassTypes FString   TemplateProjectDefs.h
  • Config
EditDetailLevelPreference EFeaturePackDetailLevel What detail level to edit when editing shared template resources TemplateProjectDefs.h
  • Config
FilenameReplacements TArray< FTemplateReplacement >   TemplateProjectDefs.h
  • Config
FilesToIgnore TArray< FString >   TemplateProjectDefs.h
  • Config
FolderRenames TArray< FTemplateFolderRename >   TemplateProjectDefs.h
  • Config
FoldersToIgnore TArray< FString >   TemplateProjectDefs.h
  • Config
HiddenSettings TArray< ETemplateSetting > Optional list of settings to hide. If none are specified, then all settings are shown. TemplateProjectDefs.h
  • Config
LocalizedDescriptions TArray< FLocalizedTemplateString >   TemplateProjectDefs.h
  • Config
LocalizedDisplayNames TArray< FLocalizedTemplateString >   TemplateProjectDefs.h
  • Config
PacksToInclude TArray< FString > Optional list of feature packs to include TemplateProjectDefs.h
  • Config
ReplacementsInFiles TArray< FTemplateReplacement >   TemplateProjectDefs.h
  • Config
SharedContentPacks TArray< FFeaturePackLevelSet > Shared feature packs. TemplateProjectDefs.h
  • Config
SortKey FString   TemplateProjectDefs.h
  • Config
Variants TArray< FTemplateVariant > List of variants for this template. TemplateProjectDefs.h
  • Config

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddConfigValues ( TArray< FTemplateConfigValue >& ConfigValuesToSet,
const FString& TemplateName,
const FString& ProjectName,
bool bShouldGenerateCode
) const

 Callback for adding config values TemplateProjectDefs.h  

const FTemplateVariant * FindVariant ( FName VariantName
) const

 Finds a Variant with the given name, returns null if not found TemplateProjectDefs.h  

void FixupStrings ( const FString& TemplateName,
const FString& ProjectName
)

 Fixes up all strings in this definitions object to replace %TEMPLATENAME% with the supplied template name and %PROJECTNAME% with the supplied project name TemplateProjectDefs.h  

virtual bool GeneratesCode ( const FString& ProjectTemplatePath
) const

 Does this template generate C++ source? TemplateProjectDefs.h  

FText GetDisplayNameText()

 Returns the display name for the current culture, or English if the current culture has no translation TemplateProjectDefs.h  

FText GetLocalizedDescription()

 Returns the display name for the current culture, or English if the current culture has no translation TemplateProjectDefs.h  

virtual bool IsClassRename ( const FString& DestFilename,
const FString& SrcFilename,
const FString& FileExtension
) const

 Callback for each file rename, so class renames can be extracted TemplateProjectDefs.h  

virtual bool PostGenerateProject ( const FString& DestFolder,
const FString& SrcFolder,
const FString& NewProjectFile,
const FString& TemplateFile,
bool bShouldGenerateCode,
FText& OutFailReason
)

 Callback after project generation is done, allowing for custom project generation behavior TemplateProjectDefs.h  

virtual bool PreGenerateProject ( const FString& DestFolder,
const FString& SrcFolder,
const FString& NewProjectFile,
const FString& TemplateFile,
bool bShouldGenerateCode,
FText& OutFailReason
)

 Callback before project generation is done, allowing for custom project generation behavior TemplateProjectDefs.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
StarterContent_DEPRECATED FString   TemplateProjectDefs.h
  • Config
  • Meta=(DeprecatedProperty, DeprecationMessage="Ability to add Starter Content has been removed")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page