FNewClassInfo

Information used when creating a new class via AddCodeToProject

Windows
MacOS
Linux

References

Module

GameProjectGeneration

Header

/Engine/Source/Editor/GameProjectGeneration/Public/AddToProjectConfig.h

Include

#include "AddToProjectConfig.h"

Syntax

struct FNewClassInfo

Remarks

Information used when creating a new class via AddCodeToProject

Variables

Name Description

Public variable

const UClass &#...

 

BaseClass

Base class information; if the ClassType is UObject

Public variable

EClassType

 

ClassType

The type of class we want to create

Constructors

Name Description

Public function

FNewClassInfo()

Default constructor; must produce an object which fails the IsSet check

Public function

FNewClassInfo

(
    const EClassType InClassType
)

Convenience constructor so you can construct from a EClassType

Public function

FNewClassInfo

(
    const UClass* InBaseClass
)

Convenience constructor so you can construct from a UClass

Functions

Name Description

Public function Const

FString

 

GetBaseClassHeaderFilename()

Gets header filename of the base class.

Public function Const

FText

 

GetClassDescription

(
    const bool bFullDescription
)

Get the class description to use in the UI

Public function Const

const FSlate...

 

GetClassIcon()

Get the class icon to use in the UI

Public function Const

FText

 

GetClassName()

Get the "friendly" class name to use in the UI

Public function Const

FString

 

GetClassNameCPP()

Get the C++ class name; this may or may not be prefixed, but will always produce a valid C++ name via GetClassPrefix() + GetClassName()

Public function Const

FString

 

GetClassPrefixCPP()

Get the C++ prefix used for this class type

Public function Const

FString

 

GetCleanClassName

(
    const FString& ClassName
)

Some classes may apply a particular suffix; this function returns the class name with those suffixes removed

Public function Const

FString

 

GetFinalClassName

(
    const FString& ClassName
)

Some classes may apply a particular suffix; this function returns the class name that will ultimately be used should that happen

Public function Const

FString

 

GetHeaderFilename

(
    const FString& ClassName
)

Given a class name, generate the header file (.h) that should be used for this class

Public function Const

FString

 

GetHeaderTemplateFilename()

Get the generation template filename to used based on the current class type

Public function Const

bool

 

GetIncludePath

(
    FString& OutIncludePath
)

Get the path needed to include this class into another file

Public function Const

FString

 

GetSourceFilename

(
    const FString& ClassName
)

Given a class name, generate the source file (.cpp) that should be used for this class

Public function Const

FString

 

GetSourceTemplateFilename()

Get the generation template filename to used based on the current class type

Public function Const

bool

 

IsSet()

Check to see if this struct is set to something that could be used to create a new class

Enums

Name

Description

Public enum

EClassType

The type of class we want to create

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