Nuke.Unreal
Build Unreal apps in Style.
Loading...
Searching...
No Matches
Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig Class Reference

Builds/Cooks/Runs a project. More...

Inheritance diagram for Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig:
Nuke.Unreal.Tools.ToolConfig

Public Member Functions

virtual BuildCookRunConfig Project (params object[] values)
 Project path (required), i.e: -project=QAGame, -project=Samples\BlackJack\BlackJack.uproject, -project=D:\Projects\MyProject.uproject.
 
virtual BuildCookRunConfig Destsample (params object[] values)
 Destination Sample name.
 
virtual BuildCookRunConfig Foreigndest (params object[] values)
 Foreign Destination.
 
virtual BuildCookRunConfig Foreign (params object[] values)
 Generate a foreign uproject from blankproject and use that Shared: The current project is a foreign project, commandline: -foreign.
 
virtual BuildCookRunConfig Foreigncode (params object[] values)
 Generate a foreign code uproject from platformergame and use that Shared: The current project is a foreign project, commandline: -foreign.
 
virtual BuildCookRunConfig Cookdir (params object[] values)
 
virtual BuildCookRunConfig Ddc (params object[] values)
 
virtual BuildCookRunConfig I18npreset (params object[] values)
 
virtual BuildCookRunConfig Cookcultures (params object[] values)
 
virtual BuildCookRunConfig Targetplatform (params object[] values)
 target platform for building, cooking and deployment (also -Platform)
 
virtual BuildCookRunConfig Servertargetplatform (params object[] values)
 target platform for building, cooking and deployment of the dedicated server (also -ServerPlatform)
 
virtual BuildCookRunConfig CrashReporter (params object[] values)
 true if we should build crash reporter Shared: true if we should build crash reporter
 
virtual BuildCookRunConfig Cook (params object[] values)
 Determines if the build is going to use cooked data Shared: Determines if the build is going to use cooked data, commandline: -cook, -cookonthefly.
 
virtual BuildCookRunConfig Skipcook (params object[] values)
 use a cooked build, but we assume the cooked data is up to date and where it belongs, implies -cook Shared: Determines if the build is going to use cooked data, commandline: -cook, -cookonthefly
 
virtual BuildCookRunConfig Skipcookonthefly (params object[] values)
 in a cookonthefly build, used solely to pass information to the package step Shared: In a cookonthefly build, used solely to pass information to the package step. This is necessary because you can't set cookonthefly and cook at the same time, and skipcook sets cook.
 
virtual BuildCookRunConfig Clean (params object[] values)
 wipe intermediate folders before building Shared: Determines if the intermediate folders will be wiped before building, commandline: -clean
 
virtual BuildCookRunConfig Unattended (params object[] values)
 assumes no operator is present, always terminates without waiting for something. Shared: Assumes no user is sitting at the console, so for example kills clients automatically, commandline: -Unattended
 
virtual BuildCookRunConfig Pak (params object[] values)
 generate a pak file disable reuse of pak files from the alternate cook source folder, if specified Shared: True if pak file should be generated.
 
virtual BuildCookRunConfig Iostore (params object[] values)
 generate I/O store container file(s) Shared: True if container file(s) should be generated with ZenPak.
 
virtual BuildCookRunConfig Makebinaryconfig (params object[] values)
 generate optimized config data during staging to improve loadtimes
 
virtual BuildCookRunConfig Signpak (params object[] values)
 sign the generated pak file with the specified key, i.e. -signpak=C:\Encryption.keys. Also implies -signedpak. Shared: Encryption keys used for signing the pak file.
 
virtual BuildCookRunConfig Prepak (params object[] values)
 attempt to avoid cooking and instead pull pak files from the network, implies pak and skipcook Shared: true if this build is staged, command line: -stage
 
virtual BuildCookRunConfig Signed (params object[] values)
 the game should expect to use a signed pak file.
 
virtual BuildCookRunConfig PakAlignForMemoryMapping (params object[] values)
 The game will be set up for memory mapping bulk data. Shared: The game will be set up for memory mapping bulk data.
 
virtual BuildCookRunConfig Skippak (params object[] values)
 use a pak file, but assume it is already built, implies pak Shared: true if this build is staged, command line: -stage
 
virtual BuildCookRunConfig Skipiostore (params object[] values)
 override the -iostore commandline option to not run it Shared: true if we want to skip iostore, even if -iostore is specified
 
virtual BuildCookRunConfig Stage (params object[] values)
 put this build in a stage directory Shared: true if this build is staged, command line: -stage
 
virtual BuildCookRunConfig Skipstage (params object[] values)
 uses a stage directory, but assumes everything is already there, implies -stage Shared: true if this build is staged, command line: -stage
 
virtual BuildCookRunConfig Manifests (params object[] values)
 generate streaming install manifests when cooking data Shared: true if this build is using streaming install manifests, command line: -manifests
 
virtual BuildCookRunConfig Createchunkinstall (params object[] values)
 generate streaming install data from manifest when cooking data, requires -stage & -manifests Shared: true if this build chunk install streaming install data, command line: -createchunkinstalldata
 
virtual BuildCookRunConfig Skipencryption (params object[] values)
 skips encrypting pak files even if crypto keys are provided
 
virtual BuildCookRunConfig Stagingdirectory (params object[] values)
 Directory to copy the builds to, i.e. -stagingdirectory=C:\Stage.
 
virtual BuildCookRunConfig Ue4exe (params object[] values)
 Name of the UE4 Editor executable, i.e. -ue4exe=UE4Editor.exe.
 
virtual BuildCookRunConfig Archive (params object[] values)
 put this build in an archive directory Shared: true if this build is archived, command line: -archive
 
virtual BuildCookRunConfig Archivedirectory (params object[] values)
 Directory to archive the builds to, i.e. -archivedirectory=C:\Archive.
 
virtual BuildCookRunConfig Archivemetadata (params object[] values)
 Archive extra metadata files in addition to the build (e.g. build.properties) Whether the project should use non monolithic staging.
 
virtual BuildCookRunConfig Createappbundle (params object[] values)
 When archiving for Mac, set this to true to package it in a .app bundle instead of normal loose files.
 
virtual BuildCookRunConfig Build (params object[] values)
 True if build step should be executed Build: True if build step should be executed, command: -build.
 
virtual BuildCookRunConfig Noxge (params object[] values)
 True if XGE should NOT be used for building Build: True if XGE should NOT be used for building. Toggle to disable the distributed build process.
 
virtual BuildCookRunConfig CookPartialgc (params object[] values)
 while cooking clean up packages as we are done with them rather then cleaning everything up when we run out of space Cook: While cooking clean up packages as we go along rather then cleaning everything (and potentially having to reload some of it) when we run out of space
 
virtual BuildCookRunConfig CookInEditor (params object[] values)
 Did we cook in the editor instead of in UAT Stage: Did we cook in the editor instead of from UAT (cook in editor uses a different staging directory)
 
virtual BuildCookRunConfig Iterativecooking (params object[] values)
 Uses the iterative cooking, command line: -iterativecooking or -iterate Uses the iterative cooking, command line: -iterativedeploy or -iterate Cook: Uses the iterative cooking, command line: -iterativecooking or -iterate.
 
virtual BuildCookRunConfig CookMapsOnly (params object[] values)
 Cook only maps this only affects usage of -cookall the flag Cook: Only cook maps (and referenced content) instead of cooking everything only affects -cookall flag.
 
virtual BuildCookRunConfig CookAll (params object[] values)
 Cook all the things in the content directory for this project Cook: Only cook maps (and referenced content) instead of cooking everything only affects cookall flag.
 
virtual BuildCookRunConfig SkipCookingEditorContent (params object[] values)
 Skips content under /Engine/Editor when cooking Cook: Skip cooking editor content.
 
virtual BuildCookRunConfig FastCook (params object[] values)
 Uses fast cook path if supported by target.
 
virtual BuildCookRunConfig IgnoreCookErrors (params object[] values)
 Ignores cook errors and continues with packaging etc Cook: Ignores cook errors and continues with packaging etc.
 
virtual BuildCookRunConfig Nodebuginfo (params object[] values)
 do not copy debug files to the stage Stage: Commandline: -nodebuginfo
 
virtual BuildCookRunConfig Separatedebuginfo (params object[] values)
 output debug info to a separate directory Stage: Commandline: -separatedebuginfo
 
virtual BuildCookRunConfig MapFile (params object[] values)
 generates a *.map file Stage: Commandline: -mapfile
 
virtual BuildCookRunConfig Nocleanstage (params object[] values)
 skip cleaning the stage directory true if the staging directory is to be cleaned: -cleanstage (also true if -clean is specified)
 
virtual BuildCookRunConfig Cmdline (params object[] values)
 command line to put into the stage in UE4CommandLine.txt command line to put into the stage in UECommandLine.txt
 
virtual BuildCookRunConfig Bundlename (params object[] values)
 string to use as the bundle name when deploying to mobile device Stage: If non-empty, the contents will be used for the bundle name
 
virtual BuildCookRunConfig Run (params object[] values)
 run the game after it is built (including server, if -server) Run: True if the Run step should be executed, command: -run
 
virtual BuildCookRunConfig Cookonthefly (params object[] values)
 run the client with cooked data provided by cook on the fly server Run: The client runs with cooked data provided by cook on the fly server, command line: -cookonthefly
 
virtual BuildCookRunConfig Cookontheflystreaming (params object[] values)
 run the client in streaming cook on the fly mode (don't cache files locally instead force reget from server each file load) Run: The client should run in streaming mode when connecting to cook on the fly server
 
virtual BuildCookRunConfig Fileserver (params object[] values)
 run the client with cooked data provided by UnrealFileServer Run: The client runs with cooked data provided by UnrealFileServer, command line: -fileserver Run: The client runs with cooked data provided by UnrealFileServer, command line: -fileserver = CookByTheBook with ZenServer (zenstore)
 
virtual BuildCookRunConfig Dedicatedserver (params object[] values)
 build, cook and run both a client and a server (also -server) Run: The client connects to dedicated server to get data, command line: -dedicatedserver
 
virtual BuildCookRunConfig Client (params object[] values)
 build, cook and run a client and a server, uses client target configuration Run: Uses a client target configuration, also implies -dedicatedserver, command line: -client
 
virtual BuildCookRunConfig Noclient (params object[] values)
 do not run the client, just run the server Run: Whether the client should start or not, command line (to disable): -noclient
 
virtual BuildCookRunConfig Logwindow (params object[] values)
 create a log window for the client Run: Client should create its own log window, command line: -logwindow
 
virtual BuildCookRunConfig Map (params object[] values)
 map to run the game with
 
virtual BuildCookRunConfig AdditionalServerMapParams (params object[] values)
 Additional server map params, i.e ?param=value Run: Additional server map params.
 
virtual BuildCookRunConfig Device (params object[] values)
 Devices to run the game on Device names without the platform prefix to run the game on.
 
virtual BuildCookRunConfig Serverdevice (params object[] values)
 Device to run the server on Run: the target device to run the server on.
 
virtual BuildCookRunConfig Skipserver (params object[] values)
 Skip starting the server Run: The indicated server has already been started.
 
virtual BuildCookRunConfig Numclients (params object[] values)
 Start extra clients, n should be 2 or more Run: The indicated server has already been started.
 
virtual BuildCookRunConfig Addcmdline (params object[] values)
 Additional command line arguments for the program Additional command line arguments for the program, which will not be staged in UECommandLine.txt in most cases.
 
virtual BuildCookRunConfig Servercmdline (params object[] values)
 Additional command line arguments for the program.
 
virtual BuildCookRunConfig Clientcmdline (params object[] values)
 Override command line arguments to pass to the client.
 
virtual BuildCookRunConfig Nullrhi (params object[] values)
 add -nullrhi to the client commandlines Run:adds -nullrhi to the client commandline
 
virtual BuildCookRunConfig Fakeclient (params object[] values)
 adds ?fake to the server URL Run:adds ?fake to the server URL
 
virtual BuildCookRunConfig Editortest (params object[] values)
 rather than running a client, run the editor instead Run:adds ?fake to the server URL
 
virtual BuildCookRunConfig RunAutomationTests (params object[] values)
 when running -editortest or a client, run all automation tests, not compatible with -server when running -editortest or a client, run a specific automation tests, not compatible with -server Run:when running -editortest or a client, run all automation tests, not compatible with -server
 
virtual BuildCookRunConfig Crash (params object[] values)
 when running -editortest or a client, adds commands like debug crash, debug rendercrash, etc based on index
 
virtual BuildCookRunConfig Deviceuser (params object[] values)
 Linux username for unattended key genereation.
 
virtual BuildCookRunConfig Devicepass (params object[] values)
 Linux password.
 
virtual BuildCookRunConfig Package (params object[] values)
 package the project for the target platform Determine whether data is packaged. This can be an iteration optimization for platforms that require packages for deployment
 
virtual BuildCookRunConfig Skippackage (params object[] values)
 Skips packaging the project for the target platform.
 
virtual BuildCookRunConfig Distribution (params object[] values)
 package for distribution the project
 
virtual BuildCookRunConfig Prereqs (params object[] values)
 stage prerequisites along with the project
 
virtual BuildCookRunConfig Applocaldir (params object[] values)
 location of prerequisites for applocal deployment
 
virtual BuildCookRunConfig Prebuilt (params object[] values)
 this is a prebuilt cooked and packaged build
 
virtual BuildCookRunConfig RunTimeoutSeconds (params object[] values)
 timeout to wait after we lunch the game
 
virtual BuildCookRunConfig SpecifiedArchitecture (params object[] values)
 Determine a specific Minimum OS Architecture to use for building any executables (see EditorArchitecture, etc for specific target type control)
 
virtual BuildCookRunConfig UbtArgs (params object[] values)
 extra options to pass to ubt
 
virtual BuildCookRunConfig AdditionalPackageOptions (params object[] values)
 extra options to pass to the platform's packager
 
virtual BuildCookRunConfig Deploy (params object[] values)
 deploy the project for the target platform Location to deploy to on the target platform
 
virtual BuildCookRunConfig Getfile (params object[] values)
 download file from target after successful run
 
virtual BuildCookRunConfig MapsToRebuildLightMaps (params object[] values)
 List of maps that need light maps rebuilding.
 
virtual BuildCookRunConfig MapsToRebuildHLODMaps (params object[] values)
 List of maps that need HLOD rebuilding.
 
virtual BuildCookRunConfig IgnoreLightMapErrors (params object[] values)
 Whether Light Map errors should be treated as critical.
 
virtual BuildCookRunConfig Cookflavor (params object[] values)
 
virtual BuildCookRunConfig Skipbuild (params object[] values)
 
virtual BuildCookRunConfig SkipBuildClient (params object[] values)
 SkipBuildClient if true then don't build the client exe.
 
virtual BuildCookRunConfig SkipBuildEditor (params object[] values)
 SkipBuildEditor if true then don't build the editor exe.
 
virtual BuildCookRunConfig Createreleaseversionroot (params object[] values)
 
virtual BuildCookRunConfig Basedonreleaseversionroot (params object[] values)
 
virtual BuildCookRunConfig OriginalReleaseVersion (params object[] values)
 The version of the originally released build. This is required by some platforms when generating patches.
 
virtual BuildCookRunConfig CreateReleaseVersion (params object[] values)
 Cook: Create a cooked release version. Also, the version. e.g. 1.0.
 
virtual BuildCookRunConfig BasedOnReleaseVersion (params object[] values)
 Cook: Base this cook of a already released version of the cooked data.
 
virtual BuildCookRunConfig GeneratePatch (params object[] values)
 Are we generating a patch, generate a patch from a previously released version of the game (use CreateReleaseVersion to create a release). this requires BasedOnReleaseVersion see also CreateReleaseVersion, BasedOnReleaseVersion.
 
virtual BuildCookRunConfig AddPatchLevel (params object[] values)
 
virtual BuildCookRunConfig StageBaseReleasePaks (params object[] values)
 Are we staging the unmodified pak files from the base release.
 
virtual BuildCookRunConfig DiscVersion (params object[] values)
 Required when building remaster package.
 
virtual BuildCookRunConfig AdditionalCookerOptions (params object[] values)
 Cook: Additional cooker options to include on the cooker commandline.
 
virtual BuildCookRunConfig DLCName (params object[] values)
 
virtual BuildCookRunConfig DiffCookedContentPath (params object[] values)
 After cook completes diff the cooked content against another cooked content directory. report all errors to the log.
 
virtual BuildCookRunConfig DLCIncludeEngineContent (params object[] values)
 Enable cooking of engine content when cooking dlc not included in original release but is referenced by current cook.
 
virtual BuildCookRunConfig DLCPakPluginFile (params object[] values)
 Enable packaging up the uplugin file inside the dlc pak. This is sometimes desired if you want the plugin to be standalone.
 
virtual BuildCookRunConfig DLCActLikePatch (params object[] values)
 DLC will remap it's files to the game directory and act like a patch. This is useful if you want to override content in the main game along side your main game. For example having different main game content in different DLCs.
 
virtual BuildCookRunConfig SignedPak (params object[] values)
 Shared: the game will use only signed content.
 
virtual BuildCookRunConfig IgnorePaksFromDifferentCookSource (params object[] values)
 Stage: True if we should disable trying to re-use pak files from another staged build when we've specified a different cook source platform.
 
virtual BuildCookRunConfig UnversionedCookedContent (params object[] values)
 Cook: Do not include a version number in the cooked content.
 
virtual BuildCookRunConfig NumCookersToSpawn (params object[] values)
 Cook: number of additional cookers to spawn while cooking.
 
virtual BuildCookRunConfig Compressed (params object[] values)
 Compress packages during cook.
 
virtual BuildCookRunConfig ForceUncompressed (params object[] values)
 Do not compress packages during cook, override game ProjectPackagingSettings to force it off.
 
virtual BuildCookRunConfig AdditionalPakOptions (params object[] values)
 Additional parameters when generating the PAK file.
 
virtual BuildCookRunConfig AdditionalIoStoreOptions (params object[] values)
 Additional parameters when generating iostore container files.
 
virtual BuildCookRunConfig Iteratesharedcookedbuild (params object[] values)
 Cook: Iterate from a build on the network.
 
virtual BuildCookRunConfig IterateSharedBuildUsePrecompiledExe (params object[] values)
 Build: Don't build the game instead use the prebuild exe (requires iterate shared cooked build.
 
virtual BuildCookRunConfig CookOutputDir (params object[] values)
 Cook: Output directory for cooked data.
 
virtual BuildCookRunConfig Target (params object[] values)
 
virtual BuildCookRunConfig ExtraTargetsToStageWithClient (params object[] values)
 Stage: Specifies a list of extra targets that should be staged along with a client.
 
virtual BuildCookRunConfig CodeSign (params object[] values)
 By default we don't code sign unless it is required or requested.
 
virtual BuildCookRunConfig TreatNonShippingBinariesAsDebugFiles (params object[] values)
 If true, non-shipping binaries will be considered DebugUFS files and will appear on the debugfiles manifest.
 
virtual BuildCookRunConfig UseExtraFlavor (params object[] values)
 If true, use chunk manifest files generated for extra flavor.
 
virtual BuildCookRunConfig ChunkInstallDirectory (params object[] values)
 Shared: Directory to use for built chunk install data, command line: -chunkinstalldirectory=.
 
virtual BuildCookRunConfig Chunkinstallversion (params object[] values)
 
virtual BuildCookRunConfig Chunkinstallrelease (params object[] values)
 
virtual BuildCookRunConfig AppLocalDirectory (params object[] values)
 
virtual BuildCookRunConfig NoBootstrapExe (params object[] values)
 On Windows, adds an executable to the root of the staging directory which checks for prerequisites being installed and launches the game with a path to the .uproject file.
 
virtual BuildCookRunConfig ForcePackageData (params object[] values)
 
virtual BuildCookRunConfig IterativeDeploy (params object[] values)
 Cook: Uses the iterative deploy, command line: -iterativedeploy or -iterate.
 
virtual BuildCookRunConfig Provision (params object[] values)
 Provision to use.
 
virtual BuildCookRunConfig Certificate (params object[] values)
 Certificate to use.
 
virtual BuildCookRunConfig Team (params object[] values)
 Team ID to use.
 
virtual BuildCookRunConfig AutomaticSigning (params object[] values)
 true if provisioning is automatically managed
 
virtual BuildCookRunConfig RunAutomationTest (params object[] values)
 Run:when running -editortest or a client, run all automation tests, not compatible with -server.
 
virtual BuildCookRunConfig UnrealExe (params object[] values)
 Name of the Unreal Editor executable, i.e. -unrealexe=UnrealEditor.exe.
 
virtual BuildCookRunConfig Clientconfig (params object[] values)
 
virtual BuildCookRunConfig Config (params object[] values)
 
virtual BuildCookRunConfig Configuration (params object[] values)
 
virtual BuildCookRunConfig Port (params object[] values)
 
virtual BuildCookRunConfig MapsToCook (params object[] values)
 Cook: List of maps to cook.
 
virtual BuildCookRunConfig MapIniSectionsToCook (params object[] values)
 Cook: List of map inisections to cook (see allmaps)
 
virtual BuildCookRunConfig TitleID (params object[] values)
 TitleID to package.
 
virtual BuildCookRunConfig Serverconfig (params object[] values)
 
virtual BuildCookRunConfig CrashIndex (params object[] values)
 Run: Adds commands like debug crash, debug rendercrash, etc based on index.
 
virtual BuildCookRunConfig ForceMonolithic (params object[] values)
 Toggle to combined the result into one executable.
 
virtual BuildCookRunConfig ForceDebugInfo (params object[] values)
 Forces debug info even in development builds.
 
virtual BuildCookRunConfig ForceNonUnity (params object[] values)
 Toggle to disable the unity build system.
 
virtual BuildCookRunConfig ForceUnity (params object[] values)
 Toggle to force enable the unity build system.
 
virtual BuildCookRunConfig Licensee (params object[] values)
 If set, this build is being compiled by a licensee.
 
virtual BuildCookRunConfig Promoted (params object[] values)
 
virtual BuildCookRunConfig Branch (params object[] values)
 
virtual BuildCookRunConfig StopOnErrors (params object[] values)
 
virtual BuildCookRunConfig NoSign (params object[] values)
 Skips signing of code/content files.
 
virtual BuildCookRunConfig Cook4iostore (params object[] values)
 generate I/O store container file(s) Shared: True if the cooker should write directly to container file(s)
 
virtual BuildCookRunConfig Zenstore (params object[] values)
 save cooked output data to the Zen storage server Shared: True if the cooker should store the cooked output to the Zen storage server
 
virtual BuildCookRunConfig PackageEncryptionKeyFile (params object[] values)
 Path to file containing encryption key to use in packaging.
 
virtual BuildCookRunConfig DLCOverrideCookedSubDir (params object[] values)
 Sometimes a DLC may get cooked to a subdirectory of where is expected, so this can tell the staging what the subdirectory of the cooked out to find the DLC files (for instance Metadata)
 
virtual BuildCookRunConfig DLCOverrideStagedSubDir (params object[] values)
 Controls where under the staged directory to output to (in case the plugin subdirectory is not desired under the StagingDirectory location)
 
virtual BuildCookRunConfig ReferenceContainerGlobalFileName (params object[] values)
 Stage: Path to the global.utoc file for a directory of iostore containers to use as a source of compressed chunks when writing new containers. See -ReferenceContainerGlobalFileName in IoStoreUtilities.cpp.
 
virtual BuildCookRunConfig ReferenceContainerCryptoKeys (params object[] values)
 Stage: Path to the crypto.json file to use for decrypting ReferenceContainerFlobalFileName, if needed. Stage: Path to the crypto.json file to use for decrypting ReferenceContainerGlobalFileName, if needed.
 
virtual BuildCookRunConfig Nozenautolaunch (params object[] values)
 URL to a running Zen server Shared: URL to a running Zen server.
 
virtual BuildCookRunConfig Rehydrateassets (params object[] values)
 Should virtualized assets be rehydrated? Shared: true if we want to rehydrate virtualized assets when staging.
 
virtual BuildCookRunConfig Optionalfilestagingdirectory (params object[] values)
 Directory to copy the optional files to, i.e. -optionalfilestagingdirectory=C:\StageOptional.
 
virtual BuildCookRunConfig Optionalfileinputdirectory (params object[] values)
 Directory to read the optional files from, i.e. -optionalfileinputdirectory=C:\StageOptional.
 
virtual BuildCookRunConfig CookerSupportFilesSubdirectory (params object[] values)
 Subdirectory under staging to copy CookerSupportFiles (as set in Build.cs files). -CookerSupportFilesSubdirectory=SDK.
 
virtual BuildCookRunConfig Neverpackage (params object[] values)
 Skips preparing data that would be used during packaging, in earlier stages. Different from skippackage which is used to optimize later stages like archive, which still was packaged at some point.
 
virtual BuildCookRunConfig Trace (params object[] values)
 The list of trace channels to enable.
 
virtual BuildCookRunConfig Tracehost (params object[] values)
 The host address of the trace recorder.
 
virtual BuildCookRunConfig Tracefile (params object[] values)
 The file where the trace will be recorded.
 
virtual BuildCookRunConfig Sessionlabel (params object[] values)
 A label to pass to analytics.
 
virtual BuildCookRunConfig Editoroptional (params object[] values)
 
virtual BuildCookRunConfig WriteBackMetadataToAssetRegistry (params object[] values)
 Passthru to iostore staging, see IoStoreUtilities.cpp.
 
virtual BuildCookRunConfig RetainStagedDirectory (params object[] values)
 If set, retain the staged directory for platforms that modify the I/O store containers for deployment. This is necessary for using the reference container for patch preventing on such platforms.
 
virtual BuildCookRunConfig EditorArchitecture (params object[] values)
 Architecture to use for building editor executables.
 
virtual BuildCookRunConfig ServerArchitecture (params object[] values)
 Architecture to use for building server executables.
 
virtual BuildCookRunConfig ClientArchitecture (params object[] values)
 Architecture to use for building client/game executables.
 
virtual BuildCookRunConfig ProgramArchitecture (params object[] values)
 Architecture to use for building program executables.
 
virtual BuildCookRunConfig EnablePlugins (params object[] values)
 
virtual BuildCookRunConfig ForceOodleDllVersion (params object[] values)
 If not empty, this is the dll file to use for Oodle compression. Can be "Latest" to use latest version.
 
virtual BuildCookRunConfig KeepFileOpenLog (params object[] values)
 Keeps a log of all files opened, commandline: -fileopenlog Cook: Commandline: -fileopenlog.
 
virtual BuildCookRunConfig Upload (params object[] values)
 Arguments for uploading on demand content.
 
virtual BuildCookRunConfig Customdeployment (params object[] values)
 
virtual BuildCookRunConfig Projectprogramoverride (params object[] values)
 
virtual BuildCookRunConfig ReferenceContainerAdditionalPath (params object[] values)
 Stage: A directory to look for additional IoStore containers to use during staging (e.g. optional segment containers)
 
virtual BuildCookRunConfig ReferenceContainerChangesCSVFileName (params object[] values)
 Stage: If ReferenceContainerChangesCSVFileName is specified, this provides a file name to write the list of changed packages/chunks to.
 
virtual BuildCookRunConfig Applyiostoreondemand (params object[] values)
 Forces IoStoreOnDemand to be enabled for the project even if it is not set up for it.
 
virtual BuildCookRunConfig XcodeBuildOptions (params object[] values)
 Extra options to pass to xcodebuild.
 
virtual BuildCookRunConfig Snapshot (params object[] values)
 Imports the most recently published project snapshot (if cooking, this forces the use of -cookincremental)
 
virtual BuildCookRunConfig Cookincremental (params object[] values)
 Cooks incrementally using previously-cooked data or a published snapshot as a base.
 
virtual BuildCookRunConfig Macnative (params object[] values)
 Generate a "Designed for iPad" .app that can be run natively on a silicon Mac.
 
virtual BuildCookRunConfig ZenWorkspaceSharePath (params object[] values)
 Shared: Global path to a Zen workspace share to be passed to the client. Used for Zen pak streaming.
 
virtual BuildCookRunConfig ZenOmitPakFiles (params object[] values)
 Should omit pak files when deploying build to target for Zen pak streaming.
 
virtual BuildCookRunConfig UseMergedModules (params object[] values)
 Assume that executables will be built with merged modules.
 
virtual BuildCookRunConfig WithTagFilter (params object[] values)
 
virtual BuildCookRunConfig StageTagMappingConfigFiles (params object[] values)
 Include all tag mapping ini files when staging.
 
virtual BuildCookRunConfig SkipCookingErrorSummary (params object[] values)
 Skips error summary when cooking.
 
virtual BuildCookRunConfig Createdefaultondemandpakrule (params object[] values)
 Creates a default pakfile rule for OnDemand data if no other such rule exists. The default rule will include all bulkdata types.
 
virtual BuildCookRunConfig GenerateOptionalPakForNonChunkedBuild (params object[] values)
 When true non chunked builds will attempt to generate an optional pak for optional bulk data.
 
virtual BuildCookRunConfig GenerateOnDemandPakForNonChunkedBuild (params object[] values)
 When true non chunked builds will attempt to generate an OnDemand pak. Will also force ApplyIoStoreOnDemand to true.
 
virtual BuildCookRunConfig DLCSkipNamedPak (params object[] values)
 When true the DLC Name will not be added to the generated pak files.
 
virtual BuildCookRunConfig StageOnlyCookedLocalizationForGameFeatures (params object[] values)
 When true only the GameFeaturePlugins that are cooked will have thier GameFeaturePlugin data staged. This check is performed by looking for a cooked GameFeatureData asset within the GameFeaturePlugin expected folder.
 
- Public Member Functions inherited from Nuke.Unreal.Tools.ToolConfig
virtual void AppendArgument (UnrealToolArgument arg)
 
virtual void AppendArgument (string arg, UnrealToolArgumentMeta? meta=null)
 
virtual void AppendSubtool (ToolConfig subtool)
 
virtual string Gather (EngineVersion ueVersion)
 Gether the arguments and subtools and render a command line output.
 

Properties

override string Name [get]
 
override string CliName [get]
 
override UnrealCompatibility Compatibility [get]
 
override ToolConfig[] Configs [get]
 
- Properties inherited from Nuke.Unreal.Tools.ToolConfig
string Name [get]
 The C# friendly name of the tool which will be used inside configurators.
 
string CliName [get]
 The name which will be rendered onto command line.
 
UnrealCompatibility Compatibility [get]
 Compatibility with either Unreal Engine 4 or 5 or both. If tool is configured to run with an incompatible engine its entire configuration will be ignored.
 
virtual ToolConfig[] Configs [get]
 

Private Attributes

ToolConfig[] _configs = null
 

Additional Inherited Members

- Protected Attributes inherited from Nuke.Unreal.Tools.ToolConfig
List< UnrealToolArgumentUsingArguments = []
 
readonly Dictionary< string, ToolConfigUsingSubtools = []
 

Detailed Description

Builds/Cooks/Runs a project.

For non-uprojects project targets are discovered by compiling target rule files found in the project folder. If -map is not specified, the command looks for DefaultMap entry in the project's DefaultEngine.ini and if not found, in BaseEngine.ini. If no DefaultMap can be found, the command falls back to /Engine/Maps/Entry.

Definition at line 12571 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Addcmdline()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Addcmdline ( params object[] values)
virtual

Additional command line arguments for the program Additional command line arguments for the program, which will not be staged in UECommandLine.txt in most cases.

Definition at line 13905 of file UatConfigGenerated.cs.

◆ AdditionalCookerOptions()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.AdditionalCookerOptions ( params object[] values)
virtual

Cook: Additional cooker options to include on the cooker commandline.

Definition at line 14654 of file UatConfigGenerated.cs.

◆ AdditionalIoStoreOptions()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.AdditionalIoStoreOptions ( params object[] values)
virtual

Additional parameters when generating iostore container files.

Definition at line 14928 of file UatConfigGenerated.cs.

◆ AdditionalPackageOptions()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.AdditionalPackageOptions ( params object[] values)
virtual

extra options to pass to the platform's packager

Definition at line 14273 of file UatConfigGenerated.cs.

◆ AdditionalPakOptions()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.AdditionalPakOptions ( params object[] values)
virtual

Additional parameters when generating the PAK file.

Definition at line 14907 of file UatConfigGenerated.cs.

◆ AdditionalServerMapParams()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.AdditionalServerMapParams ( params object[] values)
virtual

Additional server map params, i.e ?param=value Run: Additional server map params.

Definition at line 13805 of file UatConfigGenerated.cs.

◆ AddPatchLevel()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.AddPatchLevel ( params object[] values)
virtual

Definition at line 14592 of file UatConfigGenerated.cs.

◆ Applocaldir()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Applocaldir ( params object[] values)
virtual

location of prerequisites for applocal deployment

Definition at line 14177 of file UatConfigGenerated.cs.

◆ AppLocalDirectory()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.AppLocalDirectory ( params object[] values)
virtual

Definition at line 15171 of file UatConfigGenerated.cs.

◆ Applyiostoreondemand()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Applyiostoreondemand ( params object[] values)
virtual

Forces IoStoreOnDemand to be enabled for the project even if it is not set up for it.

Definition at line 16355 of file UatConfigGenerated.cs.

◆ Archive()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Archive ( params object[] values)
virtual

put this build in an archive directory Shared: true if this build is archived, command line: -archive

Definition at line 13226 of file UatConfigGenerated.cs.

◆ Archivedirectory()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Archivedirectory ( params object[] values)
virtual

Directory to archive the builds to, i.e. -archivedirectory=C:\Archive.

Definition at line 13245 of file UatConfigGenerated.cs.

◆ Archivemetadata()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Archivemetadata ( params object[] values)
virtual

Archive extra metadata files in addition to the build (e.g. build.properties) Whether the project should use non monolithic staging.

Definition at line 13265 of file UatConfigGenerated.cs.

◆ AutomaticSigning()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.AutomaticSigning ( params object[] values)
virtual

true if provisioning is automatically managed

Definition at line 15317 of file UatConfigGenerated.cs.

◆ BasedOnReleaseVersion()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.BasedOnReleaseVersion ( params object[] values)
virtual

Cook: Base this cook of a already released version of the cooked data.

Definition at line 14550 of file UatConfigGenerated.cs.

◆ Basedonreleaseversionroot()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Basedonreleaseversionroot ( params object[] values)
virtual

Definition at line 14487 of file UatConfigGenerated.cs.

◆ Branch()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Branch ( params object[] values)
virtual

Definition at line 15669 of file UatConfigGenerated.cs.

◆ Build()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Build ( params object[] values)
virtual

True if build step should be executed Build: True if build step should be executed, command: -build.

Definition at line 13304 of file UatConfigGenerated.cs.

◆ Bundlename()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Bundlename ( params object[] values)
virtual

string to use as the bundle name when deploying to mobile device Stage: If non-empty, the contents will be used for the bundle name

Definition at line 13605 of file UatConfigGenerated.cs.

◆ Certificate()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Certificate ( params object[] values)
virtual

Certificate to use.

Definition at line 15275 of file UatConfigGenerated.cs.

◆ ChunkInstallDirectory()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ChunkInstallDirectory ( params object[] values)
virtual

Shared: Directory to use for built chunk install data, command line: -chunkinstalldirectory=.

Definition at line 15114 of file UatConfigGenerated.cs.

◆ Chunkinstallrelease()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Chunkinstallrelease ( params object[] values)
virtual

Definition at line 15152 of file UatConfigGenerated.cs.

◆ Chunkinstallversion()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Chunkinstallversion ( params object[] values)
virtual

Definition at line 15133 of file UatConfigGenerated.cs.

◆ Clean()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Clean ( params object[] values)
virtual

wipe intermediate folders before building Shared: Determines if the intermediate folders will be wiped before building, commandline: -clean

Definition at line 12870 of file UatConfigGenerated.cs.

◆ Client()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Client ( params object[] values)
virtual

build, cook and run a client and a server, uses client target configuration Run: Uses a client target configuration, also implies -dedicatedserver, command line: -client

Definition at line 13726 of file UatConfigGenerated.cs.

◆ ClientArchitecture()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ClientArchitecture ( params object[] values)
virtual

Architecture to use for building client/game executables.

Definition at line 16157 of file UatConfigGenerated.cs.

◆ Clientcmdline()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Clientcmdline ( params object[] values)
virtual

Override command line arguments to pass to the client.

Definition at line 13943 of file UatConfigGenerated.cs.

◆ Clientconfig()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Clientconfig ( params object[] values)
virtual

Definition at line 15376 of file UatConfigGenerated.cs.

◆ Cmdline()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Cmdline ( params object[] values)
virtual

command line to put into the stage in UE4CommandLine.txt command line to put into the stage in UECommandLine.txt

Definition at line 13585 of file UatConfigGenerated.cs.

◆ CodeSign()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CodeSign ( params object[] values)
virtual

By default we don't code sign unless it is required or requested.

Definition at line 15051 of file UatConfigGenerated.cs.

◆ Compressed()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Compressed ( params object[] values)
virtual

Compress packages during cook.

Definition at line 14865 of file UatConfigGenerated.cs.

◆ Config()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Config ( params object[] values)
virtual

Definition at line 15395 of file UatConfigGenerated.cs.

◆ Configuration()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Configuration ( params object[] values)
virtual

Definition at line 15414 of file UatConfigGenerated.cs.

◆ Cook()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Cook ( params object[] values)
virtual

Determines if the build is going to use cooked data Shared: Determines if the build is going to use cooked data, commandline: -cook, -cookonthefly.

Definition at line 12810 of file UatConfigGenerated.cs.

◆ Cook4iostore()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Cook4iostore ( params object[] values)
virtual

generate I/O store container file(s) Shared: True if the cooker should write directly to container file(s)

Definition at line 15727 of file UatConfigGenerated.cs.

◆ CookAll()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CookAll ( params object[] values)
virtual

Cook all the things in the content directory for this project Cook: Only cook maps (and referenced content) instead of cooking everything only affects cookall flag.

Definition at line 13426 of file UatConfigGenerated.cs.

◆ Cookcultures()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Cookcultures ( params object[] values)
virtual

Definition at line 12732 of file UatConfigGenerated.cs.

◆ Cookdir()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Cookdir ( params object[] values)
virtual

Definition at line 12675 of file UatConfigGenerated.cs.

◆ CookerSupportFilesSubdirectory()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CookerSupportFilesSubdirectory ( params object[] values)
virtual

Subdirectory under staging to copy CookerSupportFiles (as set in Build.cs files). -CookerSupportFilesSubdirectory=SDK.

Definition at line 15948 of file UatConfigGenerated.cs.

◆ Cookflavor()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Cookflavor ( params object[] values)
virtual

Definition at line 14388 of file UatConfigGenerated.cs.

◆ Cookincremental()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Cookincremental ( params object[] values)
virtual

Cooks incrementally using previously-cooked data or a published snapshot as a base.

Definition at line 16412 of file UatConfigGenerated.cs.

◆ CookInEditor()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CookInEditor ( params object[] values)
virtual

Did we cook in the editor instead of in UAT Stage: Did we cook in the editor instead of from UAT (cook in editor uses a different staging directory)

Definition at line 13365 of file UatConfigGenerated.cs.

◆ CookMapsOnly()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CookMapsOnly ( params object[] values)
virtual

Cook only maps this only affects usage of -cookall the flag Cook: Only cook maps (and referenced content) instead of cooking everything only affects -cookall flag.

Definition at line 13406 of file UatConfigGenerated.cs.

◆ Cookonthefly()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Cookonthefly ( params object[] values)
virtual

run the client with cooked data provided by cook on the fly server Run: The client runs with cooked data provided by cook on the fly server, command line: -cookonthefly

Definition at line 13645 of file UatConfigGenerated.cs.

◆ Cookontheflystreaming()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Cookontheflystreaming ( params object[] values)
virtual

run the client in streaming cook on the fly mode (don't cache files locally instead force reget from server each file load) Run: The client should run in streaming mode when connecting to cook on the fly server

Definition at line 13665 of file UatConfigGenerated.cs.

◆ CookOutputDir()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CookOutputDir ( params object[] values)
virtual

Cook: Output directory for cooked data.

Definition at line 14991 of file UatConfigGenerated.cs.

◆ CookPartialgc()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CookPartialgc ( params object[] values)
virtual

while cooking clean up packages as we are done with them rather then cleaning everything up when we run out of space Cook: While cooking clean up packages as we go along rather then cleaning everything (and potentially having to reload some of it) when we run out of space

Definition at line 13345 of file UatConfigGenerated.cs.

◆ Crash()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Crash ( params object[] values)
virtual

when running -editortest or a client, adds commands like debug crash, debug rendercrash, etc based on index

Definition at line 14043 of file UatConfigGenerated.cs.

◆ CrashIndex()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CrashIndex ( params object[] values)
virtual

Run: Adds commands like debug crash, debug rendercrash, etc based on index.

Definition at line 15536 of file UatConfigGenerated.cs.

◆ CrashReporter()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CrashReporter ( params object[] values)
virtual

true if we should build crash reporter Shared: true if we should build crash reporter

Definition at line 12790 of file UatConfigGenerated.cs.

◆ Createappbundle()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Createappbundle ( params object[] values)
virtual

When archiving for Mac, set this to true to package it in a .app bundle instead of normal loose files.

Definition at line 13284 of file UatConfigGenerated.cs.

◆ Createchunkinstall()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Createchunkinstall ( params object[] values)
virtual

generate streaming install data from manifest when cooking data, requires -stage & -manifests Shared: true if this build chunk install streaming install data, command line: -createchunkinstalldata

Definition at line 13149 of file UatConfigGenerated.cs.

◆ Createdefaultondemandpakrule()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Createdefaultondemandpakrule ( params object[] values)
virtual

Creates a default pakfile rule for OnDemand data if no other such rule exists. The default rule will include all bulkdata types.

Definition at line 16570 of file UatConfigGenerated.cs.

◆ CreateReleaseVersion()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CreateReleaseVersion ( params object[] values)
virtual

Cook: Create a cooked release version. Also, the version. e.g. 1.0.

Definition at line 14529 of file UatConfigGenerated.cs.

◆ Createreleaseversionroot()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Createreleaseversionroot ( params object[] values)
virtual

Definition at line 14468 of file UatConfigGenerated.cs.

◆ Customdeployment()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Customdeployment ( params object[] values)
virtual

Definition at line 16274 of file UatConfigGenerated.cs.

◆ Ddc()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Ddc ( params object[] values)
virtual

Definition at line 12694 of file UatConfigGenerated.cs.

◆ Dedicatedserver()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Dedicatedserver ( params object[] values)
virtual

build, cook and run both a client and a server (also -server) Run: The client connects to dedicated server to get data, command line: -dedicatedserver

Definition at line 13706 of file UatConfigGenerated.cs.

◆ Deploy()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Deploy ( params object[] values)
virtual

deploy the project for the target platform Location to deploy to on the target platform

Definition at line 14293 of file UatConfigGenerated.cs.

◆ Destsample()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Destsample ( params object[] values)
virtual

Destination Sample name.

Definition at line 12597 of file UatConfigGenerated.cs.

◆ Device()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Device ( params object[] values)
virtual

Devices to run the game on Device names without the platform prefix to run the game on.

Definition at line 13825 of file UatConfigGenerated.cs.

◆ Devicepass()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Devicepass ( params object[] values)
virtual

Linux password.

Definition at line 14081 of file UatConfigGenerated.cs.

◆ Deviceuser()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Deviceuser ( params object[] values)
virtual

Linux username for unattended key genereation.

Definition at line 14062 of file UatConfigGenerated.cs.

◆ DiffCookedContentPath()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.DiffCookedContentPath ( params object[] values)
virtual

After cook completes diff the cooked content against another cooked content directory. report all errors to the log.

Definition at line 14695 of file UatConfigGenerated.cs.

◆ DiscVersion()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.DiscVersion ( params object[] values)
virtual

Required when building remaster package.

Definition at line 14633 of file UatConfigGenerated.cs.

◆ Distribution()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Distribution ( params object[] values)
virtual

package for distribution the project

Definition at line 14139 of file UatConfigGenerated.cs.

◆ DLCActLikePatch()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.DLCActLikePatch ( params object[] values)
virtual

DLC will remap it's files to the game directory and act like a patch. This is useful if you want to override content in the main game along side your main game. For example having different main game content in different DLCs.

Definition at line 14760 of file UatConfigGenerated.cs.

◆ DLCIncludeEngineContent()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.DLCIncludeEngineContent ( params object[] values)
virtual

Enable cooking of engine content when cooking dlc not included in original release but is referenced by current cook.

Definition at line 14717 of file UatConfigGenerated.cs.

◆ DLCName()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.DLCName ( params object[] values)
virtual

Definition at line 14673 of file UatConfigGenerated.cs.

◆ DLCOverrideCookedSubDir()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.DLCOverrideCookedSubDir ( params object[] values)
virtual

Sometimes a DLC may get cooked to a subdirectory of where is expected, so this can tell the staging what the subdirectory of the cooked out to find the DLC files (for instance Metadata)

Definition at line 15788 of file UatConfigGenerated.cs.

◆ DLCOverrideStagedSubDir()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.DLCOverrideStagedSubDir ( params object[] values)
virtual

Controls where under the staged directory to output to (in case the plugin subdirectory is not desired under the StagingDirectory location)

Definition at line 15809 of file UatConfigGenerated.cs.

◆ DLCPakPluginFile()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.DLCPakPluginFile ( params object[] values)
virtual

Enable packaging up the uplugin file inside the dlc pak. This is sometimes desired if you want the plugin to be standalone.

Definition at line 14738 of file UatConfigGenerated.cs.

◆ DLCSkipNamedPak()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.DLCSkipNamedPak ( params object[] values)
virtual

When true the DLC Name will not be added to the generated pak files.

Definition at line 16629 of file UatConfigGenerated.cs.

◆ EditorArchitecture()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.EditorArchitecture ( params object[] values)
virtual

Architecture to use for building editor executables.

Definition at line 16119 of file UatConfigGenerated.cs.

◆ Editoroptional()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Editoroptional ( params object[] values)
virtual

Definition at line 16062 of file UatConfigGenerated.cs.

◆ Editortest()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Editortest ( params object[] values)
virtual

rather than running a client, run the editor instead Run:adds ?fake to the server URL

Definition at line 14003 of file UatConfigGenerated.cs.

◆ EnablePlugins()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.EnablePlugins ( params object[] values)
virtual

Definition at line 16195 of file UatConfigGenerated.cs.

◆ ExtraTargetsToStageWithClient()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ExtraTargetsToStageWithClient ( params object[] values)
virtual

Stage: Specifies a list of extra targets that should be staged along with a client.

Definition at line 15030 of file UatConfigGenerated.cs.

◆ Fakeclient()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Fakeclient ( params object[] values)
virtual

adds ?fake to the server URL Run:adds ?fake to the server URL

Definition at line 13983 of file UatConfigGenerated.cs.

◆ FastCook()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.FastCook ( params object[] values)
virtual

Uses fast cook path if supported by target.

Definition at line 13465 of file UatConfigGenerated.cs.

◆ Fileserver()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Fileserver ( params object[] values)
virtual

run the client with cooked data provided by UnrealFileServer Run: The client runs with cooked data provided by UnrealFileServer, command line: -fileserver Run: The client runs with cooked data provided by UnrealFileServer, command line: -fileserver = CookByTheBook with ZenServer (zenstore)

Definition at line 13686 of file UatConfigGenerated.cs.

◆ ForceDebugInfo()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ForceDebugInfo ( params object[] values)
virtual

Forces debug info even in development builds.

Definition at line 15574 of file UatConfigGenerated.cs.

◆ ForceMonolithic()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ForceMonolithic ( params object[] values)
virtual

Toggle to combined the result into one executable.

Definition at line 15555 of file UatConfigGenerated.cs.

◆ ForceNonUnity()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ForceNonUnity ( params object[] values)
virtual

Toggle to disable the unity build system.

Definition at line 15593 of file UatConfigGenerated.cs.

◆ ForceOodleDllVersion()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ForceOodleDllVersion ( params object[] values)
virtual

If not empty, this is the dll file to use for Oodle compression. Can be "Latest" to use latest version.

Definition at line 16216 of file UatConfigGenerated.cs.

◆ ForcePackageData()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ForcePackageData ( params object[] values)
virtual

Definition at line 15212 of file UatConfigGenerated.cs.

◆ ForceUncompressed()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ForceUncompressed ( params object[] values)
virtual

Do not compress packages during cook, override game ProjectPackagingSettings to force it off.

Definition at line 14886 of file UatConfigGenerated.cs.

◆ ForceUnity()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ForceUnity ( params object[] values)
virtual

Toggle to force enable the unity build system.

Definition at line 15612 of file UatConfigGenerated.cs.

◆ Foreign()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Foreign ( params object[] values)
virtual

Generate a foreign uproject from blankproject and use that Shared: The current project is a foreign project, commandline: -foreign.

Definition at line 12636 of file UatConfigGenerated.cs.

◆ Foreigncode()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Foreigncode ( params object[] values)
virtual

Generate a foreign code uproject from platformergame and use that Shared: The current project is a foreign project, commandline: -foreign.

Definition at line 12656 of file UatConfigGenerated.cs.

◆ Foreigndest()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Foreigndest ( params object[] values)
virtual

Foreign Destination.

Definition at line 12616 of file UatConfigGenerated.cs.

◆ GenerateOnDemandPakForNonChunkedBuild()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.GenerateOnDemandPakForNonChunkedBuild ( params object[] values)
virtual

When true non chunked builds will attempt to generate an OnDemand pak. Will also force ApplyIoStoreOnDemand to true.

Definition at line 16608 of file UatConfigGenerated.cs.

◆ GenerateOptionalPakForNonChunkedBuild()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.GenerateOptionalPakForNonChunkedBuild ( params object[] values)
virtual

When true non chunked builds will attempt to generate an optional pak for optional bulk data.

Definition at line 16589 of file UatConfigGenerated.cs.

◆ GeneratePatch()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.GeneratePatch ( params object[] values)
virtual

Are we generating a patch, generate a patch from a previously released version of the game (use CreateReleaseVersion to create a release). this requires BasedOnReleaseVersion see also CreateReleaseVersion, BasedOnReleaseVersion.

Definition at line 14573 of file UatConfigGenerated.cs.

◆ Getfile()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Getfile ( params object[] values)
virtual

download file from target after successful run

Definition at line 14312 of file UatConfigGenerated.cs.

◆ I18npreset()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.I18npreset ( params object[] values)
virtual

Definition at line 12713 of file UatConfigGenerated.cs.

◆ IgnoreCookErrors()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.IgnoreCookErrors ( params object[] values)
virtual

Ignores cook errors and continues with packaging etc Cook: Ignores cook errors and continues with packaging etc.

Definition at line 13485 of file UatConfigGenerated.cs.

◆ IgnoreLightMapErrors()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.IgnoreLightMapErrors ( params object[] values)
virtual

Whether Light Map errors should be treated as critical.

Definition at line 14369 of file UatConfigGenerated.cs.

◆ IgnorePaksFromDifferentCookSource()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.IgnorePaksFromDifferentCookSource ( params object[] values)
virtual

Stage: True if we should disable trying to re-use pak files from another staged build when we've specified a different cook source platform.

Definition at line 14802 of file UatConfigGenerated.cs.

◆ Iostore()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Iostore ( params object[] values)
virtual

generate I/O store container file(s) Shared: True if container file(s) should be generated with ZenPak.

Definition at line 12931 of file UatConfigGenerated.cs.

◆ IterateSharedBuildUsePrecompiledExe()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.IterateSharedBuildUsePrecompiledExe ( params object[] values)
virtual

Build: Don't build the game instead use the prebuild exe (requires iterate shared cooked build.

Definition at line 14970 of file UatConfigGenerated.cs.

◆ Iteratesharedcookedbuild()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Iteratesharedcookedbuild ( params object[] values)
virtual

Cook: Iterate from a build on the network.

Definition at line 14949 of file UatConfigGenerated.cs.

◆ Iterativecooking()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Iterativecooking ( params object[] values)
virtual

Uses the iterative cooking, command line: -iterativecooking or -iterate Uses the iterative cooking, command line: -iterativedeploy or -iterate Cook: Uses the iterative cooking, command line: -iterativecooking or -iterate.

Definition at line 13386 of file UatConfigGenerated.cs.

◆ IterativeDeploy()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.IterativeDeploy ( params object[] values)
virtual

Cook: Uses the iterative deploy, command line: -iterativedeploy or -iterate.

Definition at line 15233 of file UatConfigGenerated.cs.

◆ KeepFileOpenLog()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.KeepFileOpenLog ( params object[] values)
virtual

Keeps a log of all files opened, commandline: -fileopenlog Cook: Commandline: -fileopenlog.

Definition at line 16236 of file UatConfigGenerated.cs.

◆ Licensee()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Licensee ( params object[] values)
virtual

If set, this build is being compiled by a licensee.

Definition at line 15631 of file UatConfigGenerated.cs.

◆ Logwindow()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Logwindow ( params object[] values)
virtual

create a log window for the client Run: Client should create its own log window, command line: -logwindow

Definition at line 13766 of file UatConfigGenerated.cs.

◆ Macnative()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Macnative ( params object[] values)
virtual

Generate a "Designed for iPad" .app that can be run natively on a silicon Mac.

Definition at line 16431 of file UatConfigGenerated.cs.

◆ Makebinaryconfig()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Makebinaryconfig ( params object[] values)
virtual

generate optimized config data during staging to improve loadtimes

Definition at line 12950 of file UatConfigGenerated.cs.

◆ Manifests()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Manifests ( params object[] values)
virtual

generate streaming install manifests when cooking data Shared: true if this build is using streaming install manifests, command line: -manifests

Definition at line 13129 of file UatConfigGenerated.cs.

◆ Map()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Map ( params object[] values)
virtual

map to run the game with

Definition at line 13785 of file UatConfigGenerated.cs.

◆ MapFile()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.MapFile ( params object[] values)
virtual

generates a *.map file Stage: Commandline: -mapfile

Definition at line 13545 of file UatConfigGenerated.cs.

◆ MapIniSectionsToCook()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.MapIniSectionsToCook ( params object[] values)
virtual

Cook: List of map inisections to cook (see allmaps)

Definition at line 15475 of file UatConfigGenerated.cs.

◆ MapsToCook()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.MapsToCook ( params object[] values)
virtual

Cook: List of maps to cook.

Definition at line 15454 of file UatConfigGenerated.cs.

◆ MapsToRebuildHLODMaps()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.MapsToRebuildHLODMaps ( params object[] values)
virtual

List of maps that need HLOD rebuilding.

Definition at line 14350 of file UatConfigGenerated.cs.

◆ MapsToRebuildLightMaps()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.MapsToRebuildLightMaps ( params object[] values)
virtual

List of maps that need light maps rebuilding.

Definition at line 14331 of file UatConfigGenerated.cs.

◆ Neverpackage()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Neverpackage ( params object[] values)
virtual

Skips preparing data that would be used during packaging, in earlier stages. Different from skippackage which is used to optimize later stages like archive, which still was packaged at some point.

Definition at line 15967 of file UatConfigGenerated.cs.

◆ NoBootstrapExe()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.NoBootstrapExe ( params object[] values)
virtual

On Windows, adds an executable to the root of the staging directory which checks for prerequisites being installed and launches the game with a path to the .uproject file.

Definition at line 15193 of file UatConfigGenerated.cs.

◆ Nocleanstage()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Nocleanstage ( params object[] values)
virtual

skip cleaning the stage directory true if the staging directory is to be cleaned: -cleanstage (also true if -clean is specified)

Definition at line 13565 of file UatConfigGenerated.cs.

◆ Noclient()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Noclient ( params object[] values)
virtual

do not run the client, just run the server Run: Whether the client should start or not, command line (to disable): -noclient

Definition at line 13746 of file UatConfigGenerated.cs.

◆ Nodebuginfo()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Nodebuginfo ( params object[] values)
virtual

do not copy debug files to the stage Stage: Commandline: -nodebuginfo

Definition at line 13505 of file UatConfigGenerated.cs.

◆ NoSign()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.NoSign ( params object[] values)
virtual

Skips signing of code/content files.

Definition at line 15707 of file UatConfigGenerated.cs.

◆ Noxge()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Noxge ( params object[] values)
virtual

True if XGE should NOT be used for building Build: True if XGE should NOT be used for building. Toggle to disable the distributed build process.

Definition at line 13325 of file UatConfigGenerated.cs.

◆ Nozenautolaunch()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Nozenautolaunch ( params object[] values)
virtual

URL to a running Zen server Shared: URL to a running Zen server.

Definition at line 15871 of file UatConfigGenerated.cs.

◆ Nullrhi()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Nullrhi ( params object[] values)
virtual

add -nullrhi to the client commandlines Run:adds -nullrhi to the client commandline

Definition at line 13963 of file UatConfigGenerated.cs.

◆ Numclients()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Numclients ( params object[] values)
virtual

Start extra clients, n should be 2 or more Run: The indicated server has already been started.

Definition at line 13885 of file UatConfigGenerated.cs.

◆ NumCookersToSpawn()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.NumCookersToSpawn ( params object[] values)
virtual

Cook: number of additional cookers to spawn while cooking.

Definition at line 14844 of file UatConfigGenerated.cs.

◆ Optionalfileinputdirectory()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Optionalfileinputdirectory ( params object[] values)
virtual

Directory to read the optional files from, i.e. -optionalfileinputdirectory=C:\StageOptional.

Definition at line 15929 of file UatConfigGenerated.cs.

◆ Optionalfilestagingdirectory()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Optionalfilestagingdirectory ( params object[] values)
virtual

Directory to copy the optional files to, i.e. -optionalfilestagingdirectory=C:\StageOptional.

Definition at line 15910 of file UatConfigGenerated.cs.

◆ OriginalReleaseVersion()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.OriginalReleaseVersion ( params object[] values)
virtual

The version of the originally released build. This is required by some platforms when generating patches.

Definition at line 14508 of file UatConfigGenerated.cs.

◆ Package()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Package ( params object[] values)
virtual

package the project for the target platform Determine whether data is packaged. This can be an iteration optimization for platforms that require packages for deployment

Definition at line 14101 of file UatConfigGenerated.cs.

◆ PackageEncryptionKeyFile()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.PackageEncryptionKeyFile ( params object[] values)
virtual

Path to file containing encryption key to use in packaging.

Definition at line 15766 of file UatConfigGenerated.cs.

◆ Pak()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Pak ( params object[] values)
virtual

generate a pak file disable reuse of pak files from the alternate cook source folder, if specified Shared: True if pak file should be generated.

Definition at line 12911 of file UatConfigGenerated.cs.

◆ PakAlignForMemoryMapping()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.PakAlignForMemoryMapping ( params object[] values)
virtual

The game will be set up for memory mapping bulk data. Shared: The game will be set up for memory mapping bulk data.

Definition at line 13029 of file UatConfigGenerated.cs.

◆ Port()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Port ( params object[] values)
virtual

Definition at line 15433 of file UatConfigGenerated.cs.

◆ Prebuilt()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Prebuilt ( params object[] values)
virtual

this is a prebuilt cooked and packaged build

Definition at line 14196 of file UatConfigGenerated.cs.

◆ Prepak()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Prepak ( params object[] values)
virtual

attempt to avoid cooking and instead pull pak files from the network, implies pak and skipcook Shared: true if this build is staged, command line: -stage

Definition at line 12990 of file UatConfigGenerated.cs.

◆ Prereqs()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Prereqs ( params object[] values)
virtual

stage prerequisites along with the project

Definition at line 14158 of file UatConfigGenerated.cs.

◆ ProgramArchitecture()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ProgramArchitecture ( params object[] values)
virtual

Architecture to use for building program executables.

Definition at line 16176 of file UatConfigGenerated.cs.

◆ Project()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Project ( params object[] values)
virtual

Project path (required), i.e: -project=QAGame, -project=Samples\BlackJack\BlackJack.uproject, -project=D:\Projects\MyProject.uproject.

Definition at line 12578 of file UatConfigGenerated.cs.

◆ Projectprogramoverride()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Projectprogramoverride ( params object[] values)
virtual

Definition at line 16293 of file UatConfigGenerated.cs.

◆ Promoted()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Promoted ( params object[] values)
virtual

Definition at line 15650 of file UatConfigGenerated.cs.

◆ Provision()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Provision ( params object[] values)
virtual

Provision to use.

Definition at line 15254 of file UatConfigGenerated.cs.

◆ ReferenceContainerAdditionalPath()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ReferenceContainerAdditionalPath ( params object[] values)
virtual

Stage: A directory to look for additional IoStore containers to use during staging (e.g. optional segment containers)

Definition at line 16314 of file UatConfigGenerated.cs.

◆ ReferenceContainerChangesCSVFileName()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ReferenceContainerChangesCSVFileName ( params object[] values)
virtual

Stage: If ReferenceContainerChangesCSVFileName is specified, this provides a file name to write the list of changed packages/chunks to.

Definition at line 16336 of file UatConfigGenerated.cs.

◆ ReferenceContainerCryptoKeys()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ReferenceContainerCryptoKeys ( params object[] values)
virtual

Stage: Path to the crypto.json file to use for decrypting ReferenceContainerFlobalFileName, if needed. Stage: Path to the crypto.json file to use for decrypting ReferenceContainerGlobalFileName, if needed.

Definition at line 15851 of file UatConfigGenerated.cs.

◆ ReferenceContainerGlobalFileName()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ReferenceContainerGlobalFileName ( params object[] values)
virtual

Stage: Path to the global.utoc file for a directory of iostore containers to use as a source of compressed chunks when writing new containers. See -ReferenceContainerGlobalFileName in IoStoreUtilities.cpp.

Definition at line 15831 of file UatConfigGenerated.cs.

◆ Rehydrateassets()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Rehydrateassets ( params object[] values)
virtual

Should virtualized assets be rehydrated? Shared: true if we want to rehydrate virtualized assets when staging.

Definition at line 15891 of file UatConfigGenerated.cs.

◆ RetainStagedDirectory()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.RetainStagedDirectory ( params object[] values)
virtual

If set, retain the staged directory for platforms that modify the I/O store containers for deployment. This is necessary for using the reference container for patch preventing on such platforms.

Definition at line 16100 of file UatConfigGenerated.cs.

◆ Run()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Run ( params object[] values)
virtual

run the game after it is built (including server, if -server) Run: True if the Run step should be executed, command: -run

Definition at line 13625 of file UatConfigGenerated.cs.

◆ RunAutomationTest()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.RunAutomationTest ( params object[] values)
virtual

Run:when running -editortest or a client, run all automation tests, not compatible with -server.

Definition at line 15338 of file UatConfigGenerated.cs.

◆ RunAutomationTests()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.RunAutomationTests ( params object[] values)
virtual

when running -editortest or a client, run all automation tests, not compatible with -server when running -editortest or a client, run a specific automation tests, not compatible with -server Run:when running -editortest or a client, run all automation tests, not compatible with -server

Definition at line 14024 of file UatConfigGenerated.cs.

◆ RunTimeoutSeconds()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.RunTimeoutSeconds ( params object[] values)
virtual

timeout to wait after we lunch the game

Definition at line 14215 of file UatConfigGenerated.cs.

◆ Separatedebuginfo()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Separatedebuginfo ( params object[] values)
virtual

output debug info to a separate directory Stage: Commandline: -separatedebuginfo

Definition at line 13525 of file UatConfigGenerated.cs.

◆ ServerArchitecture()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ServerArchitecture ( params object[] values)
virtual

Architecture to use for building server executables.

Definition at line 16138 of file UatConfigGenerated.cs.

◆ Servercmdline()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Servercmdline ( params object[] values)
virtual

Additional command line arguments for the program.

Definition at line 13924 of file UatConfigGenerated.cs.

◆ Serverconfig()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Serverconfig ( params object[] values)
virtual

Definition at line 15515 of file UatConfigGenerated.cs.

◆ Serverdevice()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Serverdevice ( params object[] values)
virtual

Device to run the server on Run: the target device to run the server on.

Definition at line 13845 of file UatConfigGenerated.cs.

◆ Servertargetplatform()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Servertargetplatform ( params object[] values)
virtual

target platform for building, cooking and deployment of the dedicated server (also -ServerPlatform)

Definition at line 12770 of file UatConfigGenerated.cs.

◆ Sessionlabel()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Sessionlabel ( params object[] values)
virtual

A label to pass to analytics.

Definition at line 16043 of file UatConfigGenerated.cs.

◆ Signed()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Signed ( params object[] values)
virtual

the game should expect to use a signed pak file.

Definition at line 13009 of file UatConfigGenerated.cs.

◆ SignedPak()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.SignedPak ( params object[] values)
virtual

Shared: the game will use only signed content.

Definition at line 14781 of file UatConfigGenerated.cs.

◆ Signpak()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Signpak ( params object[] values)
virtual

sign the generated pak file with the specified key, i.e. -signpak=C:\Encryption.keys. Also implies -signedpak. Shared: Encryption keys used for signing the pak file.

Definition at line 12970 of file UatConfigGenerated.cs.

◆ Skipbuild()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Skipbuild ( params object[] values)
virtual

Definition at line 14407 of file UatConfigGenerated.cs.

◆ SkipBuildClient()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.SkipBuildClient ( params object[] values)
virtual

SkipBuildClient if true then don't build the client exe.

Definition at line 14428 of file UatConfigGenerated.cs.

◆ SkipBuildEditor()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.SkipBuildEditor ( params object[] values)
virtual

SkipBuildEditor if true then don't build the editor exe.

Definition at line 14449 of file UatConfigGenerated.cs.

◆ Skipcook()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Skipcook ( params object[] values)
virtual

use a cooked build, but we assume the cooked data is up to date and where it belongs, implies -cook Shared: Determines if the build is going to use cooked data, commandline: -cook, -cookonthefly

Definition at line 12830 of file UatConfigGenerated.cs.

◆ SkipCookingEditorContent()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.SkipCookingEditorContent ( params object[] values)
virtual

Skips content under /Engine/Editor when cooking Cook: Skip cooking editor content.

Definition at line 13446 of file UatConfigGenerated.cs.

◆ SkipCookingErrorSummary()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.SkipCookingErrorSummary ( params object[] values)
virtual

Skips error summary when cooking.

Definition at line 16551 of file UatConfigGenerated.cs.

◆ Skipcookonthefly()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Skipcookonthefly ( params object[] values)
virtual

in a cookonthefly build, used solely to pass information to the package step Shared: In a cookonthefly build, used solely to pass information to the package step. This is necessary because you can't set cookonthefly and cook at the same time, and skipcook sets cook.

Definition at line 12850 of file UatConfigGenerated.cs.

◆ Skipencryption()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Skipencryption ( params object[] values)
virtual

skips encrypting pak files even if crypto keys are provided

Definition at line 13168 of file UatConfigGenerated.cs.

◆ Skipiostore()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Skipiostore ( params object[] values)
virtual

override the -iostore commandline option to not run it Shared: true if we want to skip iostore, even if -iostore is specified

Definition at line 13069 of file UatConfigGenerated.cs.

◆ Skippackage()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Skippackage ( params object[] values)
virtual

Skips packaging the project for the target platform.

Definition at line 14120 of file UatConfigGenerated.cs.

◆ Skippak()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Skippak ( params object[] values)
virtual

use a pak file, but assume it is already built, implies pak Shared: true if this build is staged, command line: -stage

Definition at line 13049 of file UatConfigGenerated.cs.

◆ Skipserver()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Skipserver ( params object[] values)
virtual

Skip starting the server Run: The indicated server has already been started.

Definition at line 13865 of file UatConfigGenerated.cs.

◆ Skipstage()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Skipstage ( params object[] values)
virtual

uses a stage directory, but assumes everything is already there, implies -stage Shared: true if this build is staged, command line: -stage

Definition at line 13109 of file UatConfigGenerated.cs.

◆ Snapshot()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Snapshot ( params object[] values)
virtual

Imports the most recently published project snapshot (if cooking, this forces the use of -cookincremental)

Definition at line 16393 of file UatConfigGenerated.cs.

◆ SpecifiedArchitecture()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.SpecifiedArchitecture ( params object[] values)
virtual

Determine a specific Minimum OS Architecture to use for building any executables (see EditorArchitecture, etc for specific target type control)

Definition at line 14235 of file UatConfigGenerated.cs.

◆ Stage()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Stage ( params object[] values)
virtual

put this build in a stage directory Shared: true if this build is staged, command line: -stage

Definition at line 13089 of file UatConfigGenerated.cs.

◆ StageBaseReleasePaks()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.StageBaseReleasePaks ( params object[] values)
virtual

Are we staging the unmodified pak files from the base release.

Definition at line 14612 of file UatConfigGenerated.cs.

◆ StageOnlyCookedLocalizationForGameFeatures()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.StageOnlyCookedLocalizationForGameFeatures ( params object[] values)
virtual

When true only the GameFeaturePlugins that are cooked will have thier GameFeaturePlugin data staged. This check is performed by looking for a cooked GameFeatureData asset within the GameFeaturePlugin expected folder.

Definition at line 16651 of file UatConfigGenerated.cs.

◆ StageTagMappingConfigFiles()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.StageTagMappingConfigFiles ( params object[] values)
virtual

Include all tag mapping ini files when staging.

Definition at line 16532 of file UatConfigGenerated.cs.

◆ Stagingdirectory()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Stagingdirectory ( params object[] values)
virtual

Directory to copy the builds to, i.e. -stagingdirectory=C:\Stage.

Definition at line 13187 of file UatConfigGenerated.cs.

◆ StopOnErrors()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.StopOnErrors ( params object[] values)
virtual

Definition at line 15688 of file UatConfigGenerated.cs.

◆ Target()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Target ( params object[] values)
virtual

Definition at line 15010 of file UatConfigGenerated.cs.

◆ Targetplatform()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Targetplatform ( params object[] values)
virtual

target platform for building, cooking and deployment (also -Platform)

Definition at line 12751 of file UatConfigGenerated.cs.

◆ Team()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Team ( params object[] values)
virtual

Team ID to use.

Definition at line 15296 of file UatConfigGenerated.cs.

◆ TitleID()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.TitleID ( params object[] values)
virtual

TitleID to package.

Definition at line 15496 of file UatConfigGenerated.cs.

◆ Trace()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Trace ( params object[] values)
virtual

The list of trace channels to enable.

Definition at line 15986 of file UatConfigGenerated.cs.

◆ Tracefile()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Tracefile ( params object[] values)
virtual

The file where the trace will be recorded.

Definition at line 16024 of file UatConfigGenerated.cs.

◆ Tracehost()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Tracehost ( params object[] values)
virtual

The host address of the trace recorder.

Definition at line 16005 of file UatConfigGenerated.cs.

◆ TreatNonShippingBinariesAsDebugFiles()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.TreatNonShippingBinariesAsDebugFiles ( params object[] values)
virtual

If true, non-shipping binaries will be considered DebugUFS files and will appear on the debugfiles manifest.

Definition at line 15072 of file UatConfigGenerated.cs.

◆ UbtArgs()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.UbtArgs ( params object[] values)
virtual

extra options to pass to ubt

Definition at line 14254 of file UatConfigGenerated.cs.

◆ Ue4exe()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Ue4exe ( params object[] values)
virtual

Name of the UE4 Editor executable, i.e. -ue4exe=UE4Editor.exe.

Definition at line 13206 of file UatConfigGenerated.cs.

◆ Unattended()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Unattended ( params object[] values)
virtual

assumes no operator is present, always terminates without waiting for something. Shared: Assumes no user is sitting at the console, so for example kills clients automatically, commandline: -Unattended

Definition at line 12890 of file UatConfigGenerated.cs.

◆ UnrealExe()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.UnrealExe ( params object[] values)
virtual

Name of the Unreal Editor executable, i.e. -unrealexe=UnrealEditor.exe.

Definition at line 15357 of file UatConfigGenerated.cs.

◆ UnversionedCookedContent()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.UnversionedCookedContent ( params object[] values)
virtual

Cook: Do not include a version number in the cooked content.

Definition at line 14823 of file UatConfigGenerated.cs.

◆ Upload()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Upload ( params object[] values)
virtual

Arguments for uploading on demand content.

Definition at line 16255 of file UatConfigGenerated.cs.

◆ UseExtraFlavor()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.UseExtraFlavor ( params object[] values)
virtual

If true, use chunk manifest files generated for extra flavor.

Definition at line 15093 of file UatConfigGenerated.cs.

◆ UseMergedModules()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.UseMergedModules ( params object[] values)
virtual

Assume that executables will be built with merged modules.

Definition at line 16494 of file UatConfigGenerated.cs.

◆ WithTagFilter()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.WithTagFilter ( params object[] values)
virtual

Definition at line 16513 of file UatConfigGenerated.cs.

◆ WriteBackMetadataToAssetRegistry()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.WriteBackMetadataToAssetRegistry ( params object[] values)
virtual

Passthru to iostore staging, see IoStoreUtilities.cpp.

Definition at line 16081 of file UatConfigGenerated.cs.

◆ XcodeBuildOptions()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.XcodeBuildOptions ( params object[] values)
virtual

Extra options to pass to xcodebuild.

Definition at line 16374 of file UatConfigGenerated.cs.

◆ ZenOmitPakFiles()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ZenOmitPakFiles ( params object[] values)
virtual

Should omit pak files when deploying build to target for Zen pak streaming.

Definition at line 16473 of file UatConfigGenerated.cs.

◆ Zenstore()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Zenstore ( params object[] values)
virtual

save cooked output data to the Zen storage server Shared: True if the cooker should store the cooked output to the Zen storage server

Definition at line 15747 of file UatConfigGenerated.cs.

◆ ZenWorkspaceSharePath()

virtual BuildCookRunConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.ZenWorkspaceSharePath ( params object[] values)
virtual

Shared: Global path to a Zen workspace share to be passed to the client. Used for Zen pak streaming.

Definition at line 16452 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig._configs = null
private

Definition at line 16669 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.CliName
get

Definition at line 12574 of file UatConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Compatibility
get

Definition at line 12575 of file UatConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Configs
getprotected

Definition at line 16670 of file UatConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UatConfigGenerated.BuildCookRunConfig.Name
get

Definition at line 12573 of file UatConfigGenerated.cs.


The documentation for this class was generated from the following file: