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

Iteratively cook from a shared cooked build Iteratively cook from a shared cooked build. More...

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

Public Member Functions

virtual ProjectParamsConfig Targetplatform (params object[] values)
 target platform for building, cooking and deployment (also -Platform)
 
virtual ProjectParamsConfig Servertargetplatform (params object[] values)
 target platform for building, cooking and deployment of the dedicated server (also -ServerPlatform)
 
virtual ProjectParamsConfig Foreign (params object[] values)
 Generate a foreign uproject from blankproject and use that Shared: The current project is a foreign project, commandline: -foreign.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig CrashReporter (params object[] values)
 true if we should build crash reporter Shared: true if we should build crash reporter
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig Clean (params object[] values)
 wipe intermediate folders before building Shared: Determines if the intermediate folders will be wiped before building, commandline: -clean
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig Iostore (params object[] values)
 generate I/O store container file(s) Shared: True if container file(s) should be generated with ZenPak.
 
virtual ProjectParamsConfig Makebinaryconfig (params object[] values)
 generate optimized config data during staging to improve loadtimes
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig Signed (params object[] values)
 the game should expect to use a signed pak file.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig Stage (params object[] values)
 put this build in a stage directory Shared: true if this build is staged, command line: -stage
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig Skipencryption (params object[] values)
 skips encrypting pak files even if crypto keys are provided
 
virtual ProjectParamsConfig Stagingdirectory (params object[] values)
 Directory to copy the builds to, i.e. -stagingdirectory=C:\Stage.
 
virtual ProjectParamsConfig Ue4exe (params object[] values)
 Name of the UE4 Editor executable, i.e. -ue4exe=UE4Editor.exe.
 
virtual ProjectParamsConfig Archive (params object[] values)
 put this build in an archive directory Shared: true if this build is archived, command line: -archive
 
virtual ProjectParamsConfig Archivedirectory (params object[] values)
 Directory to archive the builds to, i.e. -archivedirectory=C:\Archive.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig Build (params object[] values)
 True if build step should be executed Build: True if build step should be executed, command: -build.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig SkipCookingEditorContent (params object[] values)
 Skips content under /Engine/Editor when cooking Cook: Skip cooking editor content.
 
virtual ProjectParamsConfig FastCook (params object[] values)
 Uses fast cook path if supported by target.
 
virtual ProjectParamsConfig IgnoreCookErrors (params object[] values)
 Ignores cook errors and continues with packaging etc Cook: Ignores cook errors and continues with packaging etc.
 
virtual ProjectParamsConfig Nodebuginfo (params object[] values)
 do not copy debug files to the stage Stage: Commandline: -nodebuginfo
 
virtual ProjectParamsConfig Separatedebuginfo (params object[] values)
 output debug info to a separate directory Stage: Commandline: -separatedebuginfo
 
virtual ProjectParamsConfig MapFile (params object[] values)
 generates a *.map file Stage: Commandline: -mapfile
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig Logwindow (params object[] values)
 create a log window for the client Run: Client should create its own log window, command line: -logwindow
 
virtual ProjectParamsConfig Map (params object[] values)
 map to run the game with
 
virtual ProjectParamsConfig AdditionalServerMapParams (params object[] values)
 Additional server map params, i.e ?param=value Run: Additional server map params.
 
virtual ProjectParamsConfig Device (params object[] values)
 Devices to run the game on Device names without the platform prefix to run the game on.
 
virtual ProjectParamsConfig Serverdevice (params object[] values)
 Device to run the server on Run: the target device to run the server on.
 
virtual ProjectParamsConfig Skipserver (params object[] values)
 Skip starting the server Run: The indicated server has already been started.
 
virtual ProjectParamsConfig Numclients (params object[] values)
 Start extra clients, n should be 2 or more Run: The indicated server has already been started.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig Servercmdline (params object[] values)
 Additional command line arguments for the program.
 
virtual ProjectParamsConfig Clientcmdline (params object[] values)
 Override command line arguments to pass to the client.
 
virtual ProjectParamsConfig Nullrhi (params object[] values)
 add -nullrhi to the client commandlines Run:adds -nullrhi to the client commandline
 
virtual ProjectParamsConfig Fakeclient (params object[] values)
 adds ?fake to the server URL Run:adds ?fake to the server URL
 
virtual ProjectParamsConfig Editortest (params object[] values)
 rather than running a client, run the editor instead Run:adds ?fake to the server URL
 
virtual ProjectParamsConfig 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 ProjectParamsConfig Crash (params object[] values)
 when running -editortest or a client, adds commands like debug crash, debug rendercrash, etc based on index
 
virtual ProjectParamsConfig Deviceuser (params object[] values)
 Linux username for unattended key genereation.
 
virtual ProjectParamsConfig Devicepass (params object[] values)
 Linux password.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig Skippackage (params object[] values)
 Skips packaging the project for the target platform.
 
virtual ProjectParamsConfig Distribution (params object[] values)
 package for distribution the project
 
virtual ProjectParamsConfig Prereqs (params object[] values)
 stage prerequisites along with the project
 
virtual ProjectParamsConfig Applocaldir (params object[] values)
 location of prerequisites for applocal deployment
 
virtual ProjectParamsConfig Prebuilt (params object[] values)
 this is a prebuilt cooked and packaged build
 
virtual ProjectParamsConfig RunTimeoutSeconds (params object[] values)
 timeout to wait after we lunch the game
 
virtual ProjectParamsConfig 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 ProjectParamsConfig UbtArgs (params object[] values)
 extra options to pass to ubt
 
virtual ProjectParamsConfig AdditionalPackageOptions (params object[] values)
 extra options to pass to the platform's packager
 
virtual ProjectParamsConfig Deploy (params object[] values)
 deploy the project for the target platform Location to deploy to on the target platform
 
virtual ProjectParamsConfig Getfile (params object[] values)
 download file from target after successful run
 
virtual ProjectParamsConfig MapsToRebuildLightMaps (params object[] values)
 List of maps that need light maps rebuilding.
 
virtual ProjectParamsConfig MapsToRebuildHLODMaps (params object[] values)
 List of maps that need HLOD rebuilding.
 
virtual ProjectParamsConfig IgnoreLightMapErrors (params object[] values)
 Whether Light Map errors should be treated as critical.
 
virtual ProjectParamsConfig Cookflavor (params object[] values)
 
virtual ProjectParamsConfig Ddc (params object[] values)
 
virtual ProjectParamsConfig I18npreset (params object[] values)
 
virtual ProjectParamsConfig CookCultures (params object[] values)
 
virtual ProjectParamsConfig Skipbuild (params object[] values)
 
virtual ProjectParamsConfig SkipBuildClient (params object[] values)
 SkipBuildClient if true then don't build the client exe.
 
virtual ProjectParamsConfig SkipBuildEditor (params object[] values)
 SkipBuildEditor if true then don't build the editor exe.
 
virtual ProjectParamsConfig Createreleaseversionroot (params object[] values)
 
virtual ProjectParamsConfig Basedonreleaseversionroot (params object[] values)
 
virtual ProjectParamsConfig OriginalReleaseVersion (params object[] values)
 The version of the originally released build. This is required by some platforms when generating patches.
 
virtual ProjectParamsConfig CreateReleaseVersion (params object[] values)
 Cook: Create a cooked release version. Also, the version. e.g. 1.0.
 
virtual ProjectParamsConfig BasedOnReleaseVersion (params object[] values)
 Cook: Base this cook of a already released version of the cooked data.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig AddPatchLevel (params object[] values)
 
virtual ProjectParamsConfig StageBaseReleasePaks (params object[] values)
 Are we staging the unmodified pak files from the base release.
 
virtual ProjectParamsConfig DiscVersion (params object[] values)
 Required when building remaster package.
 
virtual ProjectParamsConfig AdditionalCookerOptions (params object[] values)
 Cook: Additional cooker options to include on the cooker commandline.
 
virtual ProjectParamsConfig DLCName (params object[] values)
 
virtual ProjectParamsConfig DiffCookedContentPath (params object[] values)
 After cook completes diff the cooked content against another cooked content directory. report all errors to the log.
 
virtual ProjectParamsConfig DLCIncludeEngineContent (params object[] values)
 Enable cooking of engine content when cooking dlc not included in original release but is referenced by current cook.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig SignedPak (params object[] values)
 Shared: the game will use only signed content.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig UnversionedCookedContent (params object[] values)
 Cook: Do not include a version number in the cooked content.
 
virtual ProjectParamsConfig NumCookersToSpawn (params object[] values)
 Cook: number of additional cookers to spawn while cooking.
 
virtual ProjectParamsConfig Compressed (params object[] values)
 Compress packages during cook.
 
virtual ProjectParamsConfig ForceUncompressed (params object[] values)
 Do not compress packages during cook, override game ProjectPackagingSettings to force it off.
 
virtual ProjectParamsConfig AdditionalPakOptions (params object[] values)
 Additional parameters when generating the PAK file.
 
virtual ProjectParamsConfig AdditionalIoStoreOptions (params object[] values)
 Additional parameters when generating iostore container files.
 
virtual ProjectParamsConfig Iteratesharedcookedbuild (params object[] values)
 Cook: Iterate from a build on the network.
 
virtual ProjectParamsConfig IterateSharedBuildUsePrecompiledExe (params object[] values)
 Build: Don't build the game instead use the prebuild exe (requires iterate shared cooked build.
 
virtual ProjectParamsConfig CookOutputDir (params object[] values)
 Cook: Output directory for cooked data.
 
virtual ProjectParamsConfig Target (params object[] values)
 
virtual ProjectParamsConfig ExtraTargetsToStageWithClient (params object[] values)
 Stage: Specifies a list of extra targets that should be staged along with a client.
 
virtual ProjectParamsConfig CodeSign (params object[] values)
 By default we don't code sign unless it is required or requested.
 
virtual ProjectParamsConfig TreatNonShippingBinariesAsDebugFiles (params object[] values)
 If true, non-shipping binaries will be considered DebugUFS files and will appear on the debugfiles manifest.
 
virtual ProjectParamsConfig UseExtraFlavor (params object[] values)
 If true, use chunk manifest files generated for extra flavor.
 
virtual ProjectParamsConfig ChunkInstallDirectory (params object[] values)
 Shared: Directory to use for built chunk install data, command line: -chunkinstalldirectory=.
 
virtual ProjectParamsConfig Chunkinstallversion (params object[] values)
 
virtual ProjectParamsConfig Chunkinstallrelease (params object[] values)
 
virtual ProjectParamsConfig AppLocalDirectory (params object[] values)
 
virtual ProjectParamsConfig 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 ProjectParamsConfig ForcePackageData (params object[] values)
 
virtual ProjectParamsConfig IterativeDeploy (params object[] values)
 Cook: Uses the iterative deploy, command line: -iterativedeploy or -iterate.
 
virtual ProjectParamsConfig Provision (params object[] values)
 Provision to use.
 
virtual ProjectParamsConfig Certificate (params object[] values)
 Certificate to use.
 
virtual ProjectParamsConfig Team (params object[] values)
 Team ID to use.
 
virtual ProjectParamsConfig AutomaticSigning (params object[] values)
 true if provisioning is automatically managed
 
virtual ProjectParamsConfig RunAutomationTest (params object[] values)
 Run:when running -editortest or a client, run all automation tests, not compatible with -server.
 
virtual ProjectParamsConfig UnrealExe (params object[] values)
 Name of the Unreal Editor executable, i.e. -unrealexe=UnrealEditor.exe.
 
virtual ProjectParamsConfig Clientconfig (params object[] values)
 
virtual ProjectParamsConfig Config (params object[] values)
 
virtual ProjectParamsConfig Configuration (params object[] values)
 
virtual ProjectParamsConfig Port (params object[] values)
 
virtual ProjectParamsConfig MapsToCook (params object[] values)
 Cook: List of maps to cook.
 
virtual ProjectParamsConfig MapIniSectionsToCook (params object[] values)
 Cook: List of map inisections to cook (see allmaps)
 
virtual ProjectParamsConfig TitleID (params object[] values)
 TitleID to package.
 
virtual ProjectParamsConfig Serverconfig (params object[] values)
 
virtual ProjectParamsConfig CrashIndex (params object[] values)
 Run: Adds commands like debug crash, debug rendercrash, etc based on index.
 
virtual ProjectParamsConfig Cook4iostore (params object[] values)
 generate I/O store container file(s) Shared: True if the cooker should write directly to container file(s)
 
virtual ProjectParamsConfig 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 ProjectParamsConfig PackageEncryptionKeyFile (params object[] values)
 Path to file containing encryption key to use in packaging.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig Nozenautolaunch (params object[] values)
 URL to a running Zen server Shared: URL to a running Zen server.
 
virtual ProjectParamsConfig Rehydrateassets (params object[] values)
 Should virtualized assets be rehydrated? Shared: true if we want to rehydrate virtualized assets when staging.
 
virtual ProjectParamsConfig Optionalfilestagingdirectory (params object[] values)
 Directory to copy the optional files to, i.e. -optionalfilestagingdirectory=C:\StageOptional.
 
virtual ProjectParamsConfig Optionalfileinputdirectory (params object[] values)
 Directory to read the optional files from, i.e. -optionalfileinputdirectory=C:\StageOptional.
 
virtual ProjectParamsConfig CookerSupportFilesSubdirectory (params object[] values)
 Subdirectory under staging to copy CookerSupportFiles (as set in Build.cs files). -CookerSupportFilesSubdirectory=SDK.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig Trace (params object[] values)
 The list of trace channels to enable.
 
virtual ProjectParamsConfig Tracehost (params object[] values)
 The host address of the trace recorder.
 
virtual ProjectParamsConfig Tracefile (params object[] values)
 The file where the trace will be recorded.
 
virtual ProjectParamsConfig Sessionlabel (params object[] values)
 A label to pass to analytics.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig 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 ProjectParamsConfig Editoroptional (params object[] values)
 
virtual ProjectParamsConfig WriteBackMetadataToAssetRegistry (params object[] values)
 Passthru to iostore staging, see IoStoreUtilities.cpp.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig EditorArchitecture (params object[] values)
 Architecture to use for building editor executables.
 
virtual ProjectParamsConfig ServerArchitecture (params object[] values)
 Architecture to use for building server executables.
 
virtual ProjectParamsConfig ClientArchitecture (params object[] values)
 Architecture to use for building client/game executables.
 
virtual ProjectParamsConfig ProgramArchitecture (params object[] values)
 Architecture to use for building program executables.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig KeepFileOpenLog (params object[] values)
 Keeps a log of all files opened, commandline: -fileopenlog Cook: Commandline: -fileopenlog.
 
virtual ProjectParamsConfig Upload (params object[] values)
 Arguments for uploading on demand content.
 
virtual ProjectParamsConfig Customdeployment (params object[] values)
 
virtual ProjectParamsConfig Applyiostoreondemand (params object[] values)
 Forces IoStoreOnDemand to be enabled for the project even if it is not set up for it.
 
virtual ProjectParamsConfig XcodeBuildOptions (params object[] values)
 Extra options to pass to xcodebuild.
 
virtual ProjectParamsConfig ReferenceContainerAdditionalPath (params object[] values)
 Stage: A directory to look for additional IoStore containers to use during staging (e.g. optional segment containers)
 
virtual ProjectParamsConfig ReferenceContainerChangesCSVFileName (params object[] values)
 Stage: If ReferenceContainerChangesCSVFileName is specified, this provides a file name to write the list of changed packages/chunks to.
 
virtual ProjectParamsConfig Snapshot (params object[] values)
 Imports the most recently published project snapshot (if cooking, this forces the use of -cookincremental)
 
virtual ProjectParamsConfig Cookincremental (params object[] values)
 Cooks incrementally using previously-cooked data or a published snapshot as a base.
 
virtual ProjectParamsConfig Macnative (params object[] values)
 Generate a "Designed for iPad" .app that can be run natively on a silicon Mac.
 
virtual ProjectParamsConfig ZenWorkspaceSharePath (params object[] values)
 Shared: Global path to a Zen workspace share to be passed to the client. Used for Zen pak streaming.
 
virtual ProjectParamsConfig ZenOmitPakFiles (params object[] values)
 Should omit pak files when deploying build to target for Zen pak streaming.
 
virtual ProjectParamsConfig UseMergedModules (params object[] values)
 Assume that executables will be built with merged modules.
 
virtual ProjectParamsConfig StageTagMappingConfigFiles (params object[] values)
 Include all tag mapping ini files when staging.
 
virtual ProjectParamsConfig SkipCookingErrorSummary (params object[] values)
 Skips error summary when cooking.
 
virtual ProjectParamsConfig 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 ProjectParamsConfig GenerateOptionalPakForNonChunkedBuild (params object[] values)
 When true non chunked builds will attempt to generate an optional pak for optional bulk data.
 
virtual ProjectParamsConfig GenerateOnDemandPakForNonChunkedBuild (params object[] values)
 When true non chunked builds will attempt to generate an OnDemand pak. Will also force ApplyIoStoreOnDemand to true.
 
virtual ProjectParamsConfig DLCSkipNamedPak (params object[] values)
 When true the DLC Name will not be added to the generated pak files.
 
virtual ProjectParamsConfig 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

Iteratively cook from a shared cooked build Iteratively cook from a shared cooked build.

Definition at line 5278 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Addcmdline()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6479 of file UatConfigGenerated.cs.

◆ AdditionalCookerOptions()

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

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

Definition at line 7285 of file UatConfigGenerated.cs.

◆ AdditionalIoStoreOptions()

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

Additional parameters when generating iostore container files.

Definition at line 7559 of file UatConfigGenerated.cs.

◆ AdditionalPackageOptions()

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

extra options to pass to the platform's packager

Definition at line 6847 of file UatConfigGenerated.cs.

◆ AdditionalPakOptions()

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

Additional parameters when generating the PAK file.

Definition at line 7538 of file UatConfigGenerated.cs.

◆ AdditionalServerMapParams()

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

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

Definition at line 6379 of file UatConfigGenerated.cs.

◆ AddPatchLevel()

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

Definition at line 7223 of file UatConfigGenerated.cs.

◆ Applocaldir()

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

location of prerequisites for applocal deployment

Definition at line 6751 of file UatConfigGenerated.cs.

◆ AppLocalDirectory()

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

Definition at line 7802 of file UatConfigGenerated.cs.

◆ Applyiostoreondemand()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8734 of file UatConfigGenerated.cs.

◆ Archive()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5800 of file UatConfigGenerated.cs.

◆ Archivedirectory()

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

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

Definition at line 5819 of file UatConfigGenerated.cs.

◆ Archivemetadata()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5839 of file UatConfigGenerated.cs.

◆ AutomaticSigning()

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

true if provisioning is automatically managed

Definition at line 7948 of file UatConfigGenerated.cs.

◆ BasedOnReleaseVersion()

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

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

Definition at line 7181 of file UatConfigGenerated.cs.

◆ Basedonreleaseversionroot()

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

Definition at line 7118 of file UatConfigGenerated.cs.

◆ Build()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5878 of file UatConfigGenerated.cs.

◆ Bundlename()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6179 of file UatConfigGenerated.cs.

◆ Certificate()

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

Certificate to use.

Definition at line 7906 of file UatConfigGenerated.cs.

◆ ChunkInstallDirectory()

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

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

Definition at line 7745 of file UatConfigGenerated.cs.

◆ Chunkinstallrelease()

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

Definition at line 7783 of file UatConfigGenerated.cs.

◆ Chunkinstallversion()

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

Definition at line 7764 of file UatConfigGenerated.cs.

◆ Clean()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5444 of file UatConfigGenerated.cs.

◆ Client()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6300 of file UatConfigGenerated.cs.

◆ ClientArchitecture()

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

Architecture to use for building client/game executables.

Definition at line 8617 of file UatConfigGenerated.cs.

◆ Clientcmdline()

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

Override command line arguments to pass to the client.

Definition at line 6517 of file UatConfigGenerated.cs.

◆ Clientconfig()

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

Definition at line 8007 of file UatConfigGenerated.cs.

◆ Cmdline()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6159 of file UatConfigGenerated.cs.

◆ CodeSign()

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

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

Definition at line 7682 of file UatConfigGenerated.cs.

◆ Compressed()

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

Compress packages during cook.

Definition at line 7496 of file UatConfigGenerated.cs.

◆ Config()

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

Definition at line 8026 of file UatConfigGenerated.cs.

◆ Configuration()

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

Definition at line 8045 of file UatConfigGenerated.cs.

◆ Cook()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5384 of file UatConfigGenerated.cs.

◆ Cook4iostore()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8187 of file UatConfigGenerated.cs.

◆ CookAll()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6000 of file UatConfigGenerated.cs.

◆ CookCultures()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.CookCultures ( params object[] values)
virtual

Definition at line 7019 of file UatConfigGenerated.cs.

◆ CookerSupportFilesSubdirectory()

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

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

Definition at line 8366 of file UatConfigGenerated.cs.

◆ Cookflavor()

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

Definition at line 6962 of file UatConfigGenerated.cs.

◆ Cookincremental()

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

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

Definition at line 8834 of file UatConfigGenerated.cs.

◆ CookInEditor()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5939 of file UatConfigGenerated.cs.

◆ CookMapsOnly()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5980 of file UatConfigGenerated.cs.

◆ Cookonthefly()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6219 of file UatConfigGenerated.cs.

◆ Cookontheflystreaming()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6239 of file UatConfigGenerated.cs.

◆ CookOutputDir()

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

Cook: Output directory for cooked data.

Definition at line 7622 of file UatConfigGenerated.cs.

◆ CookPartialgc()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5919 of file UatConfigGenerated.cs.

◆ Crash()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6617 of file UatConfigGenerated.cs.

◆ CrashIndex()

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

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

Definition at line 8167 of file UatConfigGenerated.cs.

◆ CrashReporter()

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

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

Definition at line 5364 of file UatConfigGenerated.cs.

◆ Createappbundle()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5858 of file UatConfigGenerated.cs.

◆ Createchunkinstall()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5723 of file UatConfigGenerated.cs.

◆ Createdefaultondemandpakrule()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8973 of file UatConfigGenerated.cs.

◆ CreateReleaseVersion()

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

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

Definition at line 7160 of file UatConfigGenerated.cs.

◆ Createreleaseversionroot()

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

Definition at line 7099 of file UatConfigGenerated.cs.

◆ Customdeployment()

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

Definition at line 8715 of file UatConfigGenerated.cs.

◆ Ddc()

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

Definition at line 6981 of file UatConfigGenerated.cs.

◆ Dedicatedserver()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6280 of file UatConfigGenerated.cs.

◆ Deploy()

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

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

Definition at line 6867 of file UatConfigGenerated.cs.

◆ Device()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6399 of file UatConfigGenerated.cs.

◆ Devicepass()

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

Linux password.

Definition at line 6655 of file UatConfigGenerated.cs.

◆ Deviceuser()

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

Linux username for unattended key genereation.

Definition at line 6636 of file UatConfigGenerated.cs.

◆ DiffCookedContentPath()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 7326 of file UatConfigGenerated.cs.

◆ DiscVersion()

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

Required when building remaster package.

Definition at line 7264 of file UatConfigGenerated.cs.

◆ Distribution()

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

package for distribution the project

Definition at line 6713 of file UatConfigGenerated.cs.

◆ DLCActLikePatch()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 7391 of file UatConfigGenerated.cs.

◆ DLCIncludeEngineContent()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 7348 of file UatConfigGenerated.cs.

◆ DLCName()

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

Definition at line 7304 of file UatConfigGenerated.cs.

◆ DLCOverrideCookedSubDir()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8248 of file UatConfigGenerated.cs.

◆ DLCOverrideStagedSubDir()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8269 of file UatConfigGenerated.cs.

◆ DLCPakPluginFile()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 7369 of file UatConfigGenerated.cs.

◆ DLCSkipNamedPak()

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

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

Definition at line 9032 of file UatConfigGenerated.cs.

◆ EditorArchitecture()

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

Architecture to use for building editor executables.

Definition at line 8579 of file UatConfigGenerated.cs.

◆ Editoroptional()

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

Definition at line 8522 of file UatConfigGenerated.cs.

◆ Editortest()

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

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

Definition at line 6577 of file UatConfigGenerated.cs.

◆ ExtraTargetsToStageWithClient()

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

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

Definition at line 7661 of file UatConfigGenerated.cs.

◆ Fakeclient()

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

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

Definition at line 6557 of file UatConfigGenerated.cs.

◆ FastCook()

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

Uses fast cook path if supported by target.

Definition at line 6039 of file UatConfigGenerated.cs.

◆ Fileserver()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6260 of file UatConfigGenerated.cs.

◆ ForceOodleDllVersion()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8657 of file UatConfigGenerated.cs.

◆ ForcePackageData()

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

Definition at line 7843 of file UatConfigGenerated.cs.

◆ ForceUncompressed()

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

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

Definition at line 7517 of file UatConfigGenerated.cs.

◆ Foreign()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5324 of file UatConfigGenerated.cs.

◆ Foreigncode()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5344 of file UatConfigGenerated.cs.

◆ GenerateOnDemandPakForNonChunkedBuild()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 9011 of file UatConfigGenerated.cs.

◆ GenerateOptionalPakForNonChunkedBuild()

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

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

Definition at line 8992 of file UatConfigGenerated.cs.

◆ GeneratePatch()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 7204 of file UatConfigGenerated.cs.

◆ Getfile()

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

download file from target after successful run

Definition at line 6886 of file UatConfigGenerated.cs.

◆ I18npreset()

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

Definition at line 7000 of file UatConfigGenerated.cs.

◆ IgnoreCookErrors()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6059 of file UatConfigGenerated.cs.

◆ IgnoreLightMapErrors()

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

Whether Light Map errors should be treated as critical.

Definition at line 6943 of file UatConfigGenerated.cs.

◆ IgnorePaksFromDifferentCookSource()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 7433 of file UatConfigGenerated.cs.

◆ Iostore()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5505 of file UatConfigGenerated.cs.

◆ IterateSharedBuildUsePrecompiledExe()

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

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

Definition at line 7601 of file UatConfigGenerated.cs.

◆ Iteratesharedcookedbuild()

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

Cook: Iterate from a build on the network.

Definition at line 7580 of file UatConfigGenerated.cs.

◆ Iterativecooking()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5960 of file UatConfigGenerated.cs.

◆ IterativeDeploy()

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

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

Definition at line 7864 of file UatConfigGenerated.cs.

◆ KeepFileOpenLog()

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

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

Definition at line 8677 of file UatConfigGenerated.cs.

◆ Logwindow()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6340 of file UatConfigGenerated.cs.

◆ Macnative()

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

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

Definition at line 8853 of file UatConfigGenerated.cs.

◆ Makebinaryconfig()

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

generate optimized config data during staging to improve loadtimes

Definition at line 5524 of file UatConfigGenerated.cs.

◆ Manifests()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5703 of file UatConfigGenerated.cs.

◆ Map()

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

map to run the game with

Definition at line 6359 of file UatConfigGenerated.cs.

◆ MapFile()

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

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

Definition at line 6119 of file UatConfigGenerated.cs.

◆ MapIniSectionsToCook()

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

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

Definition at line 8106 of file UatConfigGenerated.cs.

◆ MapsToCook()

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

Cook: List of maps to cook.

Definition at line 8085 of file UatConfigGenerated.cs.

◆ MapsToRebuildHLODMaps()

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

List of maps that need HLOD rebuilding.

Definition at line 6924 of file UatConfigGenerated.cs.

◆ MapsToRebuildLightMaps()

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

List of maps that need light maps rebuilding.

Definition at line 6905 of file UatConfigGenerated.cs.

◆ Neverpackage()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8385 of file UatConfigGenerated.cs.

◆ NoBootstrapExe()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 7824 of file UatConfigGenerated.cs.

◆ Nocleanstage()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6139 of file UatConfigGenerated.cs.

◆ Noclient()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6320 of file UatConfigGenerated.cs.

◆ Nodebuginfo()

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

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

Definition at line 6079 of file UatConfigGenerated.cs.

◆ Noxge()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5899 of file UatConfigGenerated.cs.

◆ Nozenautolaunch()

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

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

Definition at line 8289 of file UatConfigGenerated.cs.

◆ Nullrhi()

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

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

Definition at line 6537 of file UatConfigGenerated.cs.

◆ Numclients()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6459 of file UatConfigGenerated.cs.

◆ NumCookersToSpawn()

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

Cook: number of additional cookers to spawn while cooking.

Definition at line 7475 of file UatConfigGenerated.cs.

◆ Optionalfileinputdirectory()

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

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

Definition at line 8347 of file UatConfigGenerated.cs.

◆ Optionalfilestagingdirectory()

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

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

Definition at line 8328 of file UatConfigGenerated.cs.

◆ OriginalReleaseVersion()

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

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

Definition at line 7139 of file UatConfigGenerated.cs.

◆ Package()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6675 of file UatConfigGenerated.cs.

◆ PackageEncryptionKeyFile()

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

Path to file containing encryption key to use in packaging.

Definition at line 8226 of file UatConfigGenerated.cs.

◆ Pak()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5485 of file UatConfigGenerated.cs.

◆ PakAlignForMemoryMapping()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5603 of file UatConfigGenerated.cs.

◆ Port()

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

Definition at line 8064 of file UatConfigGenerated.cs.

◆ Prebuilt()

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

this is a prebuilt cooked and packaged build

Definition at line 6770 of file UatConfigGenerated.cs.

◆ Prepak()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5564 of file UatConfigGenerated.cs.

◆ Prereqs()

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

stage prerequisites along with the project

Definition at line 6732 of file UatConfigGenerated.cs.

◆ ProgramArchitecture()

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

Architecture to use for building program executables.

Definition at line 8636 of file UatConfigGenerated.cs.

◆ Provision()

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

Provision to use.

Definition at line 7885 of file UatConfigGenerated.cs.

◆ ReferenceContainerAdditionalPath()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8774 of file UatConfigGenerated.cs.

◆ ReferenceContainerChangesCSVFileName()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8796 of file UatConfigGenerated.cs.

◆ ReferenceContainerCryptoKeys()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8503 of file UatConfigGenerated.cs.

◆ ReferenceContainerGlobalFileName()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8483 of file UatConfigGenerated.cs.

◆ Rehydrateassets()

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

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

Definition at line 8309 of file UatConfigGenerated.cs.

◆ RetainStagedDirectory()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8560 of file UatConfigGenerated.cs.

◆ Run()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6199 of file UatConfigGenerated.cs.

◆ RunAutomationTest()

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

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

Definition at line 7969 of file UatConfigGenerated.cs.

◆ RunAutomationTests()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6598 of file UatConfigGenerated.cs.

◆ RunTimeoutSeconds()

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

timeout to wait after we lunch the game

Definition at line 6789 of file UatConfigGenerated.cs.

◆ Separatedebuginfo()

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

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

Definition at line 6099 of file UatConfigGenerated.cs.

◆ ServerArchitecture()

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

Architecture to use for building server executables.

Definition at line 8598 of file UatConfigGenerated.cs.

◆ Servercmdline()

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

Additional command line arguments for the program.

Definition at line 6498 of file UatConfigGenerated.cs.

◆ Serverconfig()

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

Definition at line 8146 of file UatConfigGenerated.cs.

◆ Serverdevice()

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

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

Definition at line 6419 of file UatConfigGenerated.cs.

◆ Servertargetplatform()

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

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

Definition at line 5304 of file UatConfigGenerated.cs.

◆ Sessionlabel()

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

A label to pass to analytics.

Definition at line 8461 of file UatConfigGenerated.cs.

◆ Signed()

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

the game should expect to use a signed pak file.

Definition at line 5583 of file UatConfigGenerated.cs.

◆ SignedPak()

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

Shared: the game will use only signed content.

Definition at line 7412 of file UatConfigGenerated.cs.

◆ Signpak()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5544 of file UatConfigGenerated.cs.

◆ Skipbuild()

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

Definition at line 7038 of file UatConfigGenerated.cs.

◆ SkipBuildClient()

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

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

Definition at line 7059 of file UatConfigGenerated.cs.

◆ SkipBuildEditor()

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

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

Definition at line 7080 of file UatConfigGenerated.cs.

◆ Skipcook()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5404 of file UatConfigGenerated.cs.

◆ SkipCookingEditorContent()

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

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

Definition at line 6020 of file UatConfigGenerated.cs.

◆ SkipCookingErrorSummary()

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

Skips error summary when cooking.

Definition at line 8954 of file UatConfigGenerated.cs.

◆ Skipcookonthefly()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5424 of file UatConfigGenerated.cs.

◆ Skipencryption()

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

skips encrypting pak files even if crypto keys are provided

Definition at line 5742 of file UatConfigGenerated.cs.

◆ Skipiostore()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5643 of file UatConfigGenerated.cs.

◆ Skippackage()

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

Skips packaging the project for the target platform.

Definition at line 6694 of file UatConfigGenerated.cs.

◆ Skippak()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5623 of file UatConfigGenerated.cs.

◆ Skipserver()

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

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

Definition at line 6439 of file UatConfigGenerated.cs.

◆ Skipstage()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5683 of file UatConfigGenerated.cs.

◆ Snapshot()

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

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

Definition at line 8815 of file UatConfigGenerated.cs.

◆ SpecifiedArchitecture()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 6809 of file UatConfigGenerated.cs.

◆ Stage()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5663 of file UatConfigGenerated.cs.

◆ StageBaseReleasePaks()

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

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

Definition at line 7243 of file UatConfigGenerated.cs.

◆ StageOnlyCookedLocalizationForGameFeatures()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 9054 of file UatConfigGenerated.cs.

◆ StageTagMappingConfigFiles()

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

Include all tag mapping ini files when staging.

Definition at line 8935 of file UatConfigGenerated.cs.

◆ Stagingdirectory()

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

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

Definition at line 5761 of file UatConfigGenerated.cs.

◆ Target()

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

Definition at line 7641 of file UatConfigGenerated.cs.

◆ Targetplatform()

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

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

Definition at line 5285 of file UatConfigGenerated.cs.

◆ Team()

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

Team ID to use.

Definition at line 7927 of file UatConfigGenerated.cs.

◆ TitleID()

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

TitleID to package.

Definition at line 8127 of file UatConfigGenerated.cs.

◆ Trace()

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

The list of trace channels to enable.

Definition at line 8404 of file UatConfigGenerated.cs.

◆ Tracefile()

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

The file where the trace will be recorded.

Definition at line 8442 of file UatConfigGenerated.cs.

◆ Tracehost()

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

The host address of the trace recorder.

Definition at line 8423 of file UatConfigGenerated.cs.

◆ TreatNonShippingBinariesAsDebugFiles()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 7703 of file UatConfigGenerated.cs.

◆ UbtArgs()

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

extra options to pass to ubt

Definition at line 6828 of file UatConfigGenerated.cs.

◆ Ue4exe()

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

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

Definition at line 5780 of file UatConfigGenerated.cs.

◆ Unattended()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 5464 of file UatConfigGenerated.cs.

◆ UnrealExe()

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

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

Definition at line 7988 of file UatConfigGenerated.cs.

◆ UnversionedCookedContent()

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

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

Definition at line 7454 of file UatConfigGenerated.cs.

◆ Upload()

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

Arguments for uploading on demand content.

Definition at line 8696 of file UatConfigGenerated.cs.

◆ UseExtraFlavor()

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

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

Definition at line 7724 of file UatConfigGenerated.cs.

◆ UseMergedModules()

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

Assume that executables will be built with merged modules.

Definition at line 8916 of file UatConfigGenerated.cs.

◆ WriteBackMetadataToAssetRegistry()

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

Passthru to iostore staging, see IoStoreUtilities.cpp.

Definition at line 8541 of file UatConfigGenerated.cs.

◆ XcodeBuildOptions()

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

Extra options to pass to xcodebuild.

Definition at line 8753 of file UatConfigGenerated.cs.

◆ ZenOmitPakFiles()

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

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

Definition at line 8895 of file UatConfigGenerated.cs.

◆ Zenstore()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8207 of file UatConfigGenerated.cs.

◆ ZenWorkspaceSharePath()

virtual ProjectParamsConfig Nuke.Unreal.Tools.UatConfigGenerated.ProjectParamsConfig.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 8874 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

Definition at line 9072 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

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

Definition at line 5281 of file UatConfigGenerated.cs.

◆ Compatibility

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

Definition at line 5282 of file UatConfigGenerated.cs.

◆ Configs

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

Definition at line 9073 of file UatConfigGenerated.cs.

◆ Name

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

Definition at line 5280 of file UatConfigGenerated.cs.


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