Targets

Table of Contents

• Global targets (UnrealBuild)
• UnrealBuild.Templating
• Packaging (IPackageTargets)
• Android (IAndroidTargets)

In Nuke (and consequently in Nuke.Unreal) a target is a delegate which can build a dependency execution graph with other targets. Nuke's main selling point is how these targets allow complex build compositions and how that can be controlled via command line, environment variables (NUKE_ prefix) or parameter profile files (parameters.json / parameters-myProfile.json).

Nuke.Unreal provides couple of universally useful targets associated with regular chores regarding Unreal Engine development. The above figure shows all convenience targets available and their relationship to each other. This also includes optional targets (coming from IPackageTargets and IAndroidTargets)

Note

All parameters are optional and have a "sensible" default, unless they're marked required (req.).

Global targets (UnrealBuild)

They're available for all project types just from using UnrealBuild as base class (UnrealBuild.Targets.cs or UnrealBuild.Templating.cs).

• Info
• Switch
  • --unreal
  • Depends on Clean
  • Before Prepare
  • Before Generate
  • Before BuildEditor
  • Before Build
  • Before Cook
• Prepare
• Generate
  • Depends on Prepare
• BuildEditor
  • --EditorConfig
  • -->ubt
  • After Prepare
• Build
  • --TargetType
  • --Config
  • --Platform
  • -->ubt
  • After Cook
  • After Prepare
• Cook
  • --Config
  • --Platform
  • --AndroidTextureMode
  • -->ubt
  • -->uat
  • Depends on BuildEditor
• Clean
  • Depends on CleanProject
  • Depends on CleanPlugins
  • [ ] TODO: it may be too aggressive, use rather UAT?
• Run
  • --Tool
  • -->
• RunUat
  • --IgnoreGlobalArgs
  • -->
• RunUbt
  • --IgnoreGlobalArgs
  • -->
• RunShell
• RunEditorCmd
  • --Cmd
  • -->

UnrealBuild.Templating

These targets are used as a development aid for generating boilerplates. See Using third-party C++ libraries and Unreal boilerplate templates for full explanation.

• NewModule
  • --Name
• AddCode
  • --Name
• NewPlugin
  • --Name
• NewActor
  • --Name
• NewInterface
  • --Name
• NewObject
  • --Name
• NewStruct
  • --Name
• NewSpec
  • --Name
• UseXRepo
  • --Spec
• UseCMake
  • --Spec
• UseHeaderOnly
  • --Spec

Packaging (IPackageTargets)

• Package
  • --Config
  • --Platform
  • --AndroidTextureMode
  • -->ubt
  • -->uat
  • Depends on BuildEditor
  • After CleanDeployment
  • After Prepare
  • After Cook

Android (IAndroidTargets)

• CleanIntermediateAndroid
  • Only when Android platform is set
  • Dependent for Build
  • Dependent for Package
• SignApk
  • Only when Android platform is set
  • Triggered by Package
  • After Build
• InstallOnAndroid
  • Only when Android platform is set
  • --NoUninstall
  • After Package
  • After Build
• DebugOnAndroid
  • Only when Android platform is set
  • After InstallOnAndroid