UTemplateProjectDefs

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

GameProjectGeneration

Header

/Engine/Source/Editor/GameProjectGeneration/Classes/TemplateProjectDefs.h

Include

#include "TemplateProjectDefs.h"

Syntax

class UTemplateProjectDefs : public UObject

Variables

Name Description

Public variable

FString

 

AssetTypes

Public variable

bool

 

bAllowProjectCreation

Should we allow creation of a project from this template.

Public variable

bool

 

bIsBlank

Is this a blank template? Determines whether we can override the default map when creating the project.

Public variable

bool

 

bIsEnterprise

Is this an enterprise template?

Public variable

TArray< FName >

 

Categories

Public variable

FString

 

ClassTypes

Public variable

EFeaturePackDet...

 

EditDetailLevelPreference

What detail level to edit when editing shared template resources

Public variable

TArray< FTempla...

 

FilenameReplacements

Public variable

TArray< FString...

 

FilesToIgnore

Public variable

TArray< FTempla...

 

FolderRenames

Public variable

TArray< FString...

 

FoldersToIgnore

Public variable

TArray< ETempla...

 

HiddenSettings

Optional list of settings to hide. If none are specified, then all settings are shown.

Public variable

TArray< FLocali...

 

LocalizedDescriptions

Public variable

TArray< FLocali...

 

LocalizedDisplayNames

Public variable

TArray< FString...

 

PacksToInclude

Optional list of feature packs to include

Public variable

TArray< FTempla...

 

ReplacementsInFiles

Public variable

TArray< FFeatur...

 

SharedContentPacks

Shared feature packs.

Public variable

FString

 

SortKey

Public variable

FString

 

StarterContent

Constructors

Name Description

Public function

UTemplateProjectDefs

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual Const

void

 

AddConfigValues

(
    TArray< FTemplateConfigValue >& Co...,
    const FString& TemplateName,
    const FString& ProjectName,
    bool bShouldGenerateCode
)

Callback for adding config values

Public function

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

Public function Virtual Const

bool

 

GeneratesCode

(
    const FString& ProjectTemplatePath
)

Does this template generate C++ source?

Public function

FText

 

GetDisplayNameText()

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

Public function

FText

 

GetLocalizedDescription()

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

Public function Virtual Const

bool

 

IsClassRename

(
    const FString& DestFilename,
    const FString& SrcFilename,
    const FString& FileExtension
)

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

Public function 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

Public function 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

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