The main build class Unreal projects using Nuke.Unreal should inherit from. This class contains all base targets for use-cases which are relevant for 99% of Unreal project development tasks. More...

Inheritance diagram for Nuke.Unreal.UnrealBuild:

Public Member Functions
virtual AbsolutePath	GetOutput ()
	Get an output folder where the targets should store their artifacts. Override this function in your main build class to enforce your own.

virtual UbtConfig	UbtGlobal (UbtConfig _)
	UBT arguments to be applied globally for all UBT invocations. Override this function in your main build class if your project needs extra intricacies for everything what UBT may do through Nuke.Unreal.

virtual UatConfig	UatGlobal (UatConfig _)
	UAT arguments to be applied globally for all UAT invocations. Override this function in your main build class if your project needs extra intricacies for everything what UAT may do through Nuke.Unreal.

EngineVersion	GetEngineVersionFromProject ()
	Utility function to get the proper Engine version associated with current project. Rather use `Unreal.Version` static function, that looks nicer.

virtual void	PrintInfo ()
	Print some rudimentary information onto console about this project and it's environment. Override this function in your main build class if your project may have its own important info like this useful for debugging.

virtual IEnumerable< string >	GetArgumentBlock (string name="")
	Get optionally named argument block (section after `-->`) with contextual data substituted. `~p` Project file path `~pdir` Project folder `~ue` Unreal Engine folder

ConfigIni	ReadIniHierarchy (string shortName, IniHierarchyLevel lowestLevel=IniHierarchyLevel.Base, IniHierarchyLevel highestLevel=IniHierarchyLevel.Saved, bool considerPlugins=true, IEnumerable< string >? extraConfigSubfolder=null)
	Read INI configuration emulating the same hierarchy of importance as Unreal Engine also does.

virtual UatConfig	UatCook (UatConfig _)
	UAT arguments to be applied every time UAT is called for Cooking. Override this function in your main build class if your project needs extra intricacies for Cooking. For example specifying maps explicitly.

virtual bool	ForDistribution ()
	Enforce packaging for distribution when that is set from `Game` ini files. Override this function in your main build class if you want a different logic set for flagging packages for distribution.

Public Member Functions inherited from Nuke.Unreal.IUnrealBuild

Public Attributes
AbsolutePath?	Output

bool	IgnoreGlobalArgs = false

string?	Tool

string?	Cmd

Protected Member Functions
override void	OnBuildCreated ()

Properties
virtual ? string	UnrealVersion `[get, set]`

virtual UnrealPlatform	Platform = UnrealPlatform.FromFlag(Unreal.GetHostPlatformFlag()) `[get, set]`

virtual UnrealConfig[]	Config = [UnrealConfig.Development] `[get, set]`

virtual UnrealConfig[]	EditorConfig = [UnrealConfig.Development] `[get, set]`

virtual UnrealTargetType[]	TargetType = [UnrealTargetType.Game] `[get, set]`

virtual AndroidCookFlavor[]	AndroidTextureMode = [ AndroidCookFlavor.Multi ] `[get, set]`

AbsolutePath	UnrealEnginePath `[get]`
	Path to the root of the associated Unreal Engine installation/source.

virtual AbsolutePath	ProjectPath `[get]`

AbsolutePath	ProjectFolder `[get]`
	Path to folder containing the `.project` file.

AbsolutePath	PluginsFolder `[get]`
	Path to the Unreal plugins folder of this project.

string	ProjectName `[get]`
	Short name of the project.

ProjectDescriptor	ProjectDescriptor `[get, protected set]`
	"Immutable" C# representation of the `.uproject` contents

virtual Target	HelpNukeUnreal `[get]`

virtual Target	Info `[get]`

virtual Target	CleanDeployment `[get]`

virtual Target	CleanProject `[get]`

virtual Target	CleanPlugins `[get]`

virtual Target	Clean `[get]`

virtual Target	Switch `[get]`

virtual Target	Prepare `[get]`

virtual Target	Generate `[get]`

virtual Target	SetupPlatformSdk `[get]`

virtual Target	BuildEditor `[get]`

virtual Target	Build `[get]`

virtual Target	Cook `[get]`

virtual Target	EnsureBuildPluginSupport `[get]`

virtual Target	RunUat `[get]`

virtual Target	RunUbt `[get]`

virtual Target	RunShell `[get]`

virtual Target	Run `[get]`

virtual Target	RunEditorCmd `[get]`

virtual AbsolutePath	TemplatesPath = BoilerplateGenerator.DefaultTemplateFolder `[get, set]`

string[]	Name = [] `[get, set]`

virtual string[]	Spec = [] `[get, set]`

string?	Suffix `[get, set]`

LibraryType?	LibraryType `[get, set]`

bool	AddToTarget `[get, set]`

Target	NewModule `[get]`

Target	AddCode `[get]`

Target	NewPlugin `[get]`

Target	NewActor `[get]`

Target	NewInterface `[get]`

Target	NewObject `[get]`

Target	NewStruct `[get]`

Target	NewSpec `[get]`

Target	UseLibrary `[get]`

Target	UseXRepo `[get]`

Target	UseCMake `[get]`

Target	UseHeaderOnly `[get]`

Properties inherited from Nuke.Unreal.IUnrealBuild

Private Attributes
EngineVersion?	_engineVersionCache = null

AbsolutePath?	_projectCache = null

ProjectDescriptor?	_projectDescriptor

Detailed Description

The main build class Unreal projects using Nuke.Unreal should inherit from. This class contains all base targets for use-cases which are relevant for 99% of Unreal project development tasks.

Definition at line 10 of file UnrealBuild.Templating.cs.

Member Function Documentation

◆ ForDistribution()

virtual bool Nuke.Unreal.UnrealBuild.ForDistribution ( )

virtual

Enforce packaging for distribution when that is set from Game ini files. Override this function in your main build class if you want a different logic set for flagging packages for distribution.

ConfigIni Nuke.Unreal.UnrealBuild.ReadIniHierarchy	(	string	shortName,
		IniHierarchyLevel	lowestLevel = IniHierarchyLevel::Base,
		IniHierarchyLevel	highestLevel = IniHierarchyLevel::Saved,
		bool	considerPlugins = true,
		IEnumerable< string >?	extraConfigSubfolder = null )

shortName	The name of the configuration like `Game` or `Engine`
lowestLevel	The least important level of hierarchy for reading this config. Default is `Base`
highestLevel	The maximum important level of hierarchy for reading this config Default is `Saved`
considerPlugins	If true also consider config files found in plugins. Default if true.
extraConfigSubfolder	Manually add extra configuration subfolders which may be outside of the normal sources of config files.

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Private Attributes

Detailed Description

Member Function Documentation

◆ ForDistribution()

◆ GetArgumentBlock()

◆ GetEngineVersionFromProject()

◆ GetOutput()

◆ OnBuildCreated()

◆ PrintInfo()

◆ ReadIniHierarchy()

◆ UatCook()

◆ UatGlobal()

◆ UbtGlobal()

Member Data Documentation

◆ _engineVersionCache

◆ _projectCache

◆ _projectDescriptor

◆ Cmd

◆ IgnoreGlobalArgs

◆ Output

◆ Tool

Property Documentation

◆ AddCode

◆ AddToTarget

◆ AndroidTextureMode

◆ Build

◆ BuildEditor

◆ Clean

◆ CleanDeployment

◆ CleanPlugins

◆ CleanProject

◆ Config

◆ Cook

◆ EditorConfig

◆ EnsureBuildPluginSupport

◆ Generate

◆ HelpNukeUnreal

◆ Info

◆ LibraryType

◆ Name

◆ NewActor

◆ NewInterface

◆ NewModule

◆ NewObject

◆ NewPlugin

◆ NewSpec

◆ NewStruct

◆ Platform

◆ PluginsFolder

◆ Prepare

◆ ProjectDescriptor

◆ ProjectFolder

◆ ProjectName

◆ ProjectPath

◆ Run

◆ RunEditorCmd

◆ RunShell

◆ RunUat

◆ RunUbt

◆ SetupPlatformSdk

◆ Spec

◆ Suffix

◆ Switch

◆ TargetType

◆ TemplatesPath

◆ UnrealEnginePath

◆ UnrealVersion

◆ UseCMake

◆ UseHeaderOnly

◆ UseLibrary

◆ UseXRepo