 |
Nuke.Unreal
Build Unreal apps in Style.
|
|
Nuke.Unreal
Build Unreal apps in Style.
|
Unreal Automation Tool is a vast collection of scripts solving all aspects of deploying a program made in Unreal Engine. More...
Public Member Functions | |
| virtual UatConfig | ScriptsForProject (params object[] values) |
| Path to the current project. May not be specified, in which case we compile scripts for all projects. | |
| override UatConfig | NoCompile (params object[] values) |
| Do not attempt to compile any script modules - attempts to run with whatever is up to date. | |
 Public Member Functions inherited from Nuke.Unreal.Tools.UatConfigGenerated | |
| virtual UatConfig | CompileOnly (params object[] values) |
| Does not run any commands, only compiles them. | |
| virtual UatConfig | Verbose (params object[] values) |
| Enables verbose logging. | |
| virtual UatConfig | TimeStamps (params object[] values) |
| virtual UatConfig | Submit (params object[] values) |
| Allows UAT command to submit changes. | |
| virtual UatConfig | NoSubmit (params object[] values) |
| Prevents any submit attempts. | |
| virtual UatConfig | NoP4 (params object[] values) |
| Disables Perforce functionality (default if not run on a build machine) Disables Perforce functionality {default if not run on a build machine}. | |
| virtual UatConfig | P4 (params object[] values) |
| Enables Perforce functionality (default if run on a build machine) Enables Perforce functionality {default if run on a build machine}. | |
| virtual UatConfig | Compile (params object[] values) |
| Dynamically compiles all commands (otherwise assumes they are already built) Force all script modules to be compiled. | |
| virtual UatConfig | IgnoreDependencies (params object[] values) |
| virtual UatConfig | NoCompileLegacyDontUse (params object[] values) |
| This command is LEGACY because we used to run UAT.exe to compile scripts by default. Now we only compile by default when run via RunUAT.bat, which still understands -nocompile. However, the batch file simply passes on all arguments, so UAT will choke when encountering -nocompile. Keep this CommandLineArg around so that doesn't happen. | |
| virtual UatConfig | NoCompileEditor (params object[] values) |
| virtual UatConfig | Help (params object[] values) |
| Displays help. | |
| virtual UatConfig | List (params object[] values) |
| Lists all available commands. | |
| virtual UatConfig | NoKill (params object[] values) |
| Does not kill any spawned processes on exit. | |
| virtual UatConfig | UTF8Output (params object[] values) |
| virtual UatConfig | AllowStdOutLogVerbosity (params object[] values) |
| virtual UatConfig | NoAutoSDK (params object[] values) |
| virtual UatConfig | UseLocalBuildStorage (params object[] values) |
| Allows you to use local storage for your root build storage dir (default of P:\Builds (on PC) is changed to Engine\Saved\LocalBuilds). Used for local testing. Allows you to use local storage for your root build storage dir {default of P:\Builds {on PC} is changed to Engine\Saved\LocalBuilds}. Used for local testing. | |
| virtual UatConfig | Ignorejunk (params object[] values) |
| Prevents UBT from cleaning junk files. | |
| virtual UatConfig | Telemetry (params object[] values) |
| virtual UatConfig | VeryVerbose (params object[] values) |
| Enables very verbose logging. | |
| virtual UatConfig | Targetplatform (params object[] values) |
| target platform for building, cooking and deployment (also -Platform) | |
| virtual UatConfig | Servertargetplatform (params object[] values) |
| target platform for building, cooking and deployment of the dedicated server (also -ServerPlatform) | |
| virtual UatConfig | Foreign (params object[] values) |
| Generate a foreign uproject from blankproject and use that Shared: The current project is a foreign project, commandline: -foreign. | |
| virtual UatConfig | 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 UatConfig | CrashReporter (params object[] values) |
| true if we should build crash reporter Shared: true if we should build crash reporter | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | Clean (params object[] values) |
| wipe intermediate folders before building Shared: Determines if the intermediate folders will be wiped before building, commandline: -clean | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | Iostore (params object[] values) |
| generate I/O store container file(s) Shared: True if container file(s) should be generated with ZenPak. | |
| virtual UatConfig | Makebinaryconfig (params object[] values) |
| generate optimized config data during staging to improve loadtimes | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | Signed (params object[] values) |
| the game should expect to use a signed pak file. | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | Stage (params object[] values) |
| put this build in a stage directory Shared: true if this build is staged, command line: -stage | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | Skipencryption (params object[] values) |
| skips encrypting pak files even if crypto keys are provided | |
| virtual UatConfig | Stagingdirectory (params object[] values) |
| Directory to copy the builds to, i.e. -stagingdirectory=C:\Stage. | |
| virtual UatConfig | Ue4exe (params object[] values) |
| Name of the UE4 Editor executable, i.e. -ue4exe=UE4Editor.exe. | |
| virtual UatConfig | Archive (params object[] values) |
| put this build in an archive directory Shared: true if this build is archived, command line: -archive | |
| virtual UatConfig | Archivedirectory (params object[] values) |
| Directory to archive the builds to, i.e. -archivedirectory=C:\Archive. | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | Build (params object[] values) |
| True if build step should be executed Build: True if build step should be executed, command: -build. | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | SkipCookingEditorContent (params object[] values) |
| Skips content under /Engine/Editor when cooking Cook: Skip cooking editor content. | |
| virtual UatConfig | FastCook (params object[] values) |
| Uses fast cook path if supported by target. | |
| virtual UatConfig | IgnoreCookErrors (params object[] values) |
| Ignores cook errors and continues with packaging etc Cook: Ignores cook errors and continues with packaging etc. | |
| virtual UatConfig | Nodebuginfo (params object[] values) |
| do not copy debug files to the stage Stage: Commandline: -nodebuginfo | |
| virtual UatConfig | Separatedebuginfo (params object[] values) |
| output debug info to a separate directory Stage: Commandline: -separatedebuginfo | |
| virtual UatConfig | MapFile (params object[] values) |
| generates a *.map file Stage: Commandline: -mapfile | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | 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 UatConfig | Logwindow (params object[] values) |
| create a log window for the client Run: Client should create its own log window, command line: -logwindow | |
| virtual UatConfig | Map (params object[] values) |
| map to run the game with | |
| virtual UatConfig | AdditionalServerMapParams (params object[] values) |
| Additional server map params, i.e ?param=value Run: Additional server map params. | |
| virtual UatConfig | Device (params object[] values) |
| Devices to run the game on Device names without the platform prefix to run the game on. | |
| virtual UatConfig | Serverdevice (params object[] values) |
| Device to run the server on Run: the target device to run the server on. | |
| virtual UatConfig | Skipserver (params object[] values) |
| Skip starting the server Run: The indicated server has already been started. | |
| virtual UatConfig | Numclients (params object[] values) |
| Start extra clients, n should be 2 or more Run: The indicated server has already been started. | |
| virtual UatConfig | 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 UatConfig | Servercmdline (params object[] values) |
| Additional command line arguments for the program. | |
| virtual UatConfig | Clientcmdline (params object[] values) |
| Override command line arguments to pass to the client. | |
| virtual UatConfig | Nullrhi (params object[] values) |
| add -nullrhi to the client commandlines Run:adds -nullrhi to the client commandline | |
| virtual UatConfig | Fakeclient (params object[] values) |
| adds ?fake to the server URL Run:adds ?fake to the server URL | |
| virtual UatConfig | Editortest (params object[] values) |
| rather than running a client, run the editor instead Run:adds ?fake to the server URL | |
| virtual UatConfig | 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 UatConfig | Crash (params object[] values) |
| when running -editortest or a client, adds commands like debug crash, debug rendercrash, etc based on index | |
| virtual UatConfig | Deviceuser (params object[] values) |
| Linux username for unattended key genereation. | |
| virtual UatConfig | Devicepass (params object[] values) |
| Linux password. | |
| virtual UatConfig | 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 UatConfig | Skippackage (params object[] values) |
| Skips packaging the project for the target platform. | |
| virtual UatConfig | Distribution (params object[] values) |
| package for distribution the project | |
| virtual UatConfig | Prereqs (params object[] values) |
| stage prerequisites along with the project | |
| virtual UatConfig | Applocaldir (params object[] values) |
| location of prerequisites for applocal deployment | |
| virtual UatConfig | Prebuilt (params object[] values) |
| this is a prebuilt cooked and packaged build | |
| virtual UatConfig | RunTimeoutSeconds (params object[] values) |
| timeout to wait after we lunch the game | |
| virtual UatConfig | 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 UatConfig | UbtArgs (params object[] values) |
| extra options to pass to ubt | |
| virtual UatConfig | AdditionalPackageOptions (params object[] values) |
| extra options to pass to the platform's packager | |
| virtual UatConfig | Deploy (params object[] values) |
| deploy the project for the target platform Location to deploy to on the target platform | |
| virtual UatConfig | Getfile (params object[] values) |
| download file from target after successful run | |
| virtual UatConfig | MapsToRebuildLightMaps (params object[] values) |
| List of maps that need light maps rebuilding. | |
| virtual UatConfig | MapsToRebuildHLODMaps (params object[] values) |
| List of maps that need HLOD rebuilding. | |
| virtual UatConfig | IgnoreLightMapErrors (params object[] values) |
| Whether Light Map errors should be treated as critical. | |
| virtual UatConfig | Cookflavor (params object[] values) |
| virtual UatConfig | Ddc (params object[] values) |
| virtual UatConfig | I18npreset (params object[] values) |
| virtual UatConfig | CookCultures (params object[] values) |
| virtual UatConfig | Skipbuild (params object[] values) |
| virtual UatConfig | SkipBuildClient (params object[] values) |
| SkipBuildClient if true then don't build the client exe. | |
| virtual UatConfig | SkipBuildEditor (params object[] values) |
| SkipBuildEditor if true then don't build the editor exe. | |
| virtual UatConfig | Createreleaseversionroot (params object[] values) |
| virtual UatConfig | Basedonreleaseversionroot (params object[] values) |
| virtual UatConfig | OriginalReleaseVersion (params object[] values) |
| The version of the originally released build. This is required by some platforms when generating patches. | |
| virtual UatConfig | CreateReleaseVersion (params object[] values) |
| Cook: Create a cooked release version. Also, the version. e.g. 1.0. | |
| virtual UatConfig | BasedOnReleaseVersion (params object[] values) |
| Cook: Base this cook of a already released version of the cooked data. | |
| virtual UatConfig | 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 UatConfig | AddPatchLevel (params object[] values) |
| virtual UatConfig | StageBaseReleasePaks (params object[] values) |
| Are we staging the unmodified pak files from the base release. | |
| virtual UatConfig | DiscVersion (params object[] values) |
| Required when building remaster package. | |
| virtual UatConfig | AdditionalCookerOptions (params object[] values) |
| Cook: Additional cooker options to include on the cooker commandline. | |
| virtual UatConfig | DLCName (params object[] values) |
| virtual UatConfig | DiffCookedContentPath (params object[] values) |
| After cook completes diff the cooked content against another cooked content directory. report all errors to the log. | |
| virtual UatConfig | DLCIncludeEngineContent (params object[] values) |
| Enable cooking of engine content when cooking dlc not included in original release but is referenced by current cook. | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | SignedPak (params object[] values) |
| Shared: the game will use only signed content. | |
| virtual UatConfig | 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 UatConfig | UnversionedCookedContent (params object[] values) |
| Cook: Do not include a version number in the cooked content. | |
| virtual UatConfig | NumCookersToSpawn (params object[] values) |
| Cook: number of additional cookers to spawn while cooking. | |
| virtual UatConfig | Compressed (params object[] values) |
| Compress packages during cook. | |
| virtual UatConfig | ForceUncompressed (params object[] values) |
| Do not compress packages during cook, override game ProjectPackagingSettings to force it off. | |
| virtual UatConfig | AdditionalPakOptions (params object[] values) |
| Additional parameters when generating the PAK file. | |
| virtual UatConfig | AdditionalIoStoreOptions (params object[] values) |
| Additional parameters when generating iostore container files. | |
| virtual UatConfig | Iteratesharedcookedbuild (params object[] values) |
| Cook: Iterate from a build on the network. | |
| virtual UatConfig | IterateSharedBuildUsePrecompiledExe (params object[] values) |
| Build: Don't build the game instead use the prebuild exe (requires iterate shared cooked build. | |
| virtual UatConfig | CookOutputDir (params object[] values) |
| Cook: Output directory for cooked data. | |
| virtual UatConfig | Target (params object[] values) |
| virtual UatConfig | ExtraTargetsToStageWithClient (params object[] values) |
| Stage: Specifies a list of extra targets that should be staged along with a client. | |
| virtual UatConfig | CodeSign (params object[] values) |
| By default we don't code sign unless it is required or requested. | |
| virtual UatConfig | TreatNonShippingBinariesAsDebugFiles (params object[] values) |
| If true, non-shipping binaries will be considered DebugUFS files and will appear on the debugfiles manifest. | |
| virtual UatConfig | UseExtraFlavor (params object[] values) |
| If true, use chunk manifest files generated for extra flavor. | |
| virtual UatConfig | ChunkInstallDirectory (params object[] values) |
| Shared: Directory to use for built chunk install data, command line: -chunkinstalldirectory=. | |
| virtual UatConfig | Chunkinstallversion (params object[] values) |
| virtual UatConfig | Chunkinstallrelease (params object[] values) |
| virtual UatConfig | AppLocalDirectory (params object[] values) |
| virtual UatConfig | 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 UatConfig | ForcePackageData (params object[] values) |
| virtual UatConfig | IterativeDeploy (params object[] values) |
| Cook: Uses the iterative deploy, command line: -iterativedeploy or -iterate. | |
| virtual UatConfig | Provision (params object[] values) |
| Provision to use. | |
| virtual UatConfig | Certificate (params object[] values) |
| Certificate to use. | |
| virtual UatConfig | Team (params object[] values) |
| Team ID to use. | |
| virtual UatConfig | AutomaticSigning (params object[] values) |
| true if provisioning is automatically managed | |
| virtual UatConfig | RunAutomationTest (params object[] values) |
| Run:when running -editortest or a client, run all automation tests, not compatible with -server. | |
| virtual UatConfig | UnrealExe (params object[] values) |
| Name of the Unreal Editor executable, i.e. -unrealexe=UnrealEditor.exe. | |
| virtual UatConfig | Clientconfig (params object[] values) |
| virtual UatConfig | Config (params object[] values) |
| virtual UatConfig | Configuration (params object[] values) |
| virtual UatConfig | Port (params object[] values) |
| virtual UatConfig | MapsToCook (params object[] values) |
| Cook: List of maps to cook. | |
| virtual UatConfig | MapIniSectionsToCook (params object[] values) |
| Cook: List of map inisections to cook (see allmaps) | |
| virtual UatConfig | TitleID (params object[] values) |
| TitleID to package. | |
| virtual UatConfig | Serverconfig (params object[] values) |
| virtual UatConfig | CrashIndex (params object[] values) |
| Run: Adds commands like debug crash, debug rendercrash, etc based on index. | |
| virtual UatConfig | IgnoreBuildRecords (params object[] values) |
| Ignore build records (Intermediate/ScriptModule/ProjectName.json) files when determining if script modules are up to date. | |
| virtual UatConfig | WaitForDebugger (params object[] values) |
| Waits for a debugger to be attached, and breaks once debugger successfully attached. | |
| virtual UatConfig | BuildMachine (params object[] values) |
| virtual UatConfig | WaitForUATMutex (params object[] values) |
| virtual UatConfig | Cook4iostore (params object[] values) |
| generate I/O store container file(s) Shared: True if the cooker should write directly to container file(s) | |
| virtual UatConfig | 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 UatConfig | PackageEncryptionKeyFile (params object[] values) |
| Path to file containing encryption key to use in packaging. | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | Nozenautolaunch (params object[] values) |
| URL to a running Zen server Shared: URL to a running Zen server. | |
| virtual UatConfig | Rehydrateassets (params object[] values) |
| Should virtualized assets be rehydrated? Shared: true if we want to rehydrate virtualized assets when staging. | |
| virtual UatConfig | Optionalfilestagingdirectory (params object[] values) |
| Directory to copy the optional files to, i.e. -optionalfilestagingdirectory=C:\StageOptional. | |
| virtual UatConfig | Optionalfileinputdirectory (params object[] values) |
| Directory to read the optional files from, i.e. -optionalfileinputdirectory=C:\StageOptional. | |
| virtual UatConfig | CookerSupportFilesSubdirectory (params object[] values) |
| Subdirectory under staging to copy CookerSupportFiles (as set in Build.cs files). -CookerSupportFilesSubdirectory=SDK. | |
| virtual UatConfig | 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 UatConfig | Trace (params object[] values) |
| The list of trace channels to enable. | |
| virtual UatConfig | Tracehost (params object[] values) |
| The host address of the trace recorder. | |
| virtual UatConfig | Tracefile (params object[] values) |
| The file where the trace will be recorded. | |
| virtual UatConfig | Sessionlabel (params object[] values) |
| A label to pass to analytics. | |
| virtual UatConfig | 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 UatConfig | 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 UatConfig | Editoroptional (params object[] values) |
| virtual UatConfig | WriteBackMetadataToAssetRegistry (params object[] values) |
| Passthru to iostore staging, see IoStoreUtilities.cpp. | |
| virtual UatConfig | 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 UatConfig | EditorArchitecture (params object[] values) |
| Architecture to use for building editor executables. | |
| virtual UatConfig | ServerArchitecture (params object[] values) |
| Architecture to use for building server executables. | |
| virtual UatConfig | ClientArchitecture (params object[] values) |
| Architecture to use for building client/game executables. | |
| virtual UatConfig | ProgramArchitecture (params object[] values) |
| Architecture to use for building program executables. | |
| virtual UatConfig | 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 UatConfig | WaitForStdStreams (params object[] values) |
| Time in milliseconds to wait for std streams to close in child processes. | |
| virtual UatConfig | KeepFileOpenLog (params object[] values) |
| Keeps a log of all files opened, commandline: -fileopenlog Cook: Commandline: -fileopenlog. | |
| virtual UatConfig | Upload (params object[] values) |
| Arguments for uploading on demand content. | |
| virtual UatConfig | Customdeployment (params object[] values) |
| virtual UatConfig | Applyiostoreondemand (params object[] values) |
| Forces IoStoreOnDemand to be enabled for the project even if it is not set up for it. | |
| virtual UatConfig | XcodeBuildOptions (params object[] values) |
| Extra options to pass to xcodebuild. | |
| virtual UatConfig | ReferenceContainerAdditionalPath (params object[] values) |
| Stage: A directory to look for additional IoStore containers to use during staging (e.g. optional segment containers) | |
| virtual UatConfig | ReferenceContainerChangesCSVFileName (params object[] values) |
| Stage: If ReferenceContainerChangesCSVFileName is specified, this provides a file name to write the list of changed packages/chunks to. | |
| virtual UatConfig | Snapshot (params object[] values) |
| Imports the most recently published project snapshot (if cooking, this forces the use of -cookincremental) | |
| virtual UatConfig | Cookincremental (params object[] values) |
| Cooks incrementally using previously-cooked data or a published snapshot as a base. | |
| virtual UatConfig | Macnative (params object[] values) |
| Generate a "Designed for iPad" .app that can be run natively on a silicon Mac. | |
| virtual UatConfig | ZenWorkspaceSharePath (params object[] values) |
| Shared: Global path to a Zen workspace share to be passed to the client. Used for Zen pak streaming. | |
| virtual UatConfig | ZenOmitPakFiles (params object[] values) |
| Should omit pak files when deploying build to target for Zen pak streaming. | |
| virtual UatConfig | UseMergedModules (params object[] values) |
| Assume that executables will be built with merged modules. | |
| virtual UatConfig | StageTagMappingConfigFiles (params object[] values) |
| Include all tag mapping ini files when staging. | |
| virtual UatConfig | SkipCookingErrorSummary (params object[] values) |
| Skips error summary when cooking. | |
| virtual UatConfig | 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 UatConfig | GenerateOptionalPakForNonChunkedBuild (params object[] values) |
| When true non chunked builds will attempt to generate an optional pak for optional bulk data. | |
| virtual UatConfig | GenerateOnDemandPakForNonChunkedBuild (params object[] values) |
| When true non chunked builds will attempt to generate an OnDemand pak. Will also force ApplyIoStoreOnDemand to true. | |
| virtual UatConfig | DLCSkipNamedPak (params object[] values) |
| When true the DLC Name will not be added to the generated pak files. | |
| virtual UatConfig | 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. | |
| UatConfig | Program (Action< ProgramConfig > configurator) |
| UatConfig | Automation (Action< AutomationConfig > configurator) |
| Executes scripted commands. | |
| UatConfig | CodeSign (Action< CodeSignConfig > configurator) |
| UatConfig | McpConfigMapper (Action< McpConfigMapperConfig > configurator) |
| UatConfig | P4Environment (Action< P4EnvironmentConfig > configurator) |
| UatConfig | P4WriteConfig (Action< P4WriteConfigConfig > configurator) |
| Auto-detects P4 settings based on the current path and creates a p4config file with the relevant settings. | |
| UatConfig | ProjectParams (Action< ProjectParamsConfig > configurator) |
| Iteratively cook from a shared cooked build Iteratively cook from a shared cooked build. | |
| UatConfig | UnrealBuild (Action< UnrealBuildConfig > configurator) |
| UatConfig | BuildTarget (Action< BuildTargetConfig > configurator) |
| Builds the specified targets and configurations for the specified project. Example BuildTarget -project=QAGame -target=Editor+Game -platform=PS4+XboxOne -configuration=Development. Note: Editor will only ever build for the current platform in a Development config and required tools will be included Builds the specified targets and configurations for the specified project. Example BuildTarget -project=QAGame -target=Editor+Game -platform=Win64+Android -configuration=Development. Note: Editor will only ever build for the current platform in a Development config and required tools will be included. | |
| UatConfig | BuildGraph (Action< BuildGraphConfig > configurator) |
| Tool for creating extensible build processes in UE4 which can be run locally or in parallel across a build farm. Tool for creating extensible build processes in UE which can be run locally or in parallel across a build farm. | |
| UatConfig | Build (Action< BuildConfig > configurator) |
| UatConfig | TempStorageTests (Action< TempStorageTestsConfig > configurator) |
| UatConfig | CleanTempStorage (Action< CleanTempStorageConfig > configurator) |
| Removes folders in a given temp storage directory that are older than a certain time. | |
| UatConfig | TestGauntlet (Action< TestGauntletConfig > configurator) |
| UatConfig | RunUnreal (Action< RunUnrealConfig > configurator) |
| Run Unreal tests using Gauntlet. | |
| UatConfig | ExportIPAFromArchive (Action< ExportIPAFromArchiveConfig > configurator) |
| Creates an IPA from an xarchive file. | |
| UatConfig | MakeIPA (Action< MakeIPAConfig > configurator) |
| Creates an IPA from an xarchive file. | |
| UatConfig | WriteIniValueToPlist (Action< WriteIniValueToPlistConfig > configurator) |
| Pulls a value from an ini file and inserts it into a plist. Note currently only looks at values irrespective of sections! | |
| UatConfig | OneSkyLocalizationProvider (Action< OneSkyLocalizationProviderConfig > configurator) |
| UatConfig | AnalyzeThirdPartyLibs (Action< AnalyzeThirdPartyLibsConfig > configurator) |
| Analyzes third party libraries. | |
| UatConfig | BlameKeyword (Action< BlameKeywordConfig > configurator) |
| BlameKeyword command. Looks for the specified keywords in all files at the specified path and finds who added them based on P4 history. | |
| UatConfig | BuildCMakeLib (Action< BuildCMakeLibConfig > configurator) |
| Builds a third party library using the CMake build system. | |
| UatConfig | XcodeTargetPlatform_IOS (Action< XcodeTargetPlatform_IOSConfig > configurator) |
| UatConfig | MakefileTargetPlatform_IOS (Action< MakefileTargetPlatform_IOSConfig > configurator) |
| UatConfig | BuildCommonTools (Action< BuildCommonToolsConfig > configurator) |
| Builds common tools used by the engine which are not part of typical editor or game builds. Useful when syncing source-only on GitHub. | |
| UatConfig | ZipProjectUp (Action< ZipProjectUpConfig > configurator) |
| UatConfig | BuildCookRun (Action< BuildCookRunConfig > configurator) |
| Builds/Cooks/Runs a project. | |
| UatConfig | BuildDerivedDataCache (Action< BuildDerivedDataCacheConfig > configurator) |
| UatConfig | BuildForUGS (Action< BuildForUGSConfig > configurator) |
| UatConfig | BuildHlslcc (Action< BuildHlslccConfig > configurator) |
| Builds Hlslcc using CMake build system. | |
| UatConfig | BuildPhysX (Action< BuildPhysXConfig > configurator) |
| Builds PhysX/APEX libraries using CMake build system. | |
| UatConfig | BuildPhysX_Android (Action< BuildPhysX_AndroidConfig > configurator) |
| UatConfig | BuildPhysX_IOS (Action< BuildPhysX_IOSConfig > configurator) |
| UatConfig | BuildPhysX_Linux (Action< BuildPhysX_LinuxConfig > configurator) |
| UatConfig | BuildPhysX_Mac_x86_64 (Action< BuildPhysX_Mac_x86_64Config > configurator) |
| UatConfig | BuildPhysX_Mac_arm64 (Action< BuildPhysX_Mac_arm64Config > configurator) |
| UatConfig | BuildPhysX_Mac (Action< BuildPhysX_MacConfig > configurator) |
| UatConfig | BuildPhysX_TVOS (Action< BuildPhysX_TVOSConfig > configurator) |
| UatConfig | BuildPhysX_Win32 (Action< BuildPhysX_Win32Config > configurator) |
| UatConfig | BuildPhysX_Win64 (Action< BuildPhysX_Win64Config > configurator) |
| UatConfig | BuildPlugin (Action< BuildPluginConfig > configurator) |
| Builds a plugin, and packages it for distribution. | |
| UatConfig | BuildEditor (Action< BuildEditorConfig > configurator) |
| Builds the editor for the specified project. Example BuildEditor -project=QAGame Note: Editor will only ever build for the current platform in a Development config and required tools will be included. | |
| UatConfig | BuildGame (Action< BuildGameConfig > configurator) |
| Builds the game for the specified project. Example BuildGame -project=QAGame -platform=PS4+XboxOne -configuration=Development. Builds the game for the specified project. Example BuildGame -project=QAGame -platform=Win64+Android -configuration=Development. | |
| UatConfig | BuildServer (Action< BuildServerConfig > configurator) |
| Builds the server for the specified project. Example BuildServer -project=QAGame -platform=Win64 -configuration=Development. | |
| UatConfig | BuildThirdPartyLibs (Action< BuildThirdPartyLibsConfig > configurator) |
| Builds third party libraries, and puts them all into a changelist. | |
| UatConfig | CheckBalancedMacros (Action< CheckBalancedMacrosConfig > configurator) |
| Checks that all source files have balanced macros for enabling/disabling optimization, warnings, etc... | |
| UatConfig | CheckCsprojDotNetVersion (Action< CheckCsprojDotNetVersionConfig > configurator) |
| UatConfig | CheckForHacks (Action< CheckForHacksConfig > configurator) |
| Audits the current branch for comments denoting a hack that was not meant to leave another branch, following a given format ("BEGIN XXXX HACK", where XXXX is one or more tags separated by spaces). Allowed tags may be specified manually on the command line. At least one must match, otherwise it will print a warning. The current branch name and fragments of the branch path will also be added by default, so running from //UE4/Main will add "//UE4/Main", "UE4", and "Main". Audits the current branch for comments denoting a hack that was not meant to leave another branch, following a given format ("BEGIN XXXX HACK", where XXXX is one or more tags separated by spaces). Allowed tags may be specified manually on the command line. At least one must match, otherwise it will print a warning. The current branch name and fragments of the branch path will also be added by default, so running from //UE5/Main will add "//UE5/Main", "UE5", and "Main". | |
| UatConfig | CheckPerforceCase (Action< CheckPerforceCaseConfig > configurator) |
| Checks that the casing of files within a path on a case-insensitive Perforce server is correct. | |
| UatConfig | CheckRestrictedFolders (Action< CheckRestrictedFoldersConfig > configurator) |
| Checks a directory for folders which should not be distributed. | |
| UatConfig | CheckTargetExists (Action< CheckTargetExistsConfig > configurator) |
| Checks that the given target exists, by looking for the relevant receipt. | |
| UatConfig | CheckXcodeVersion (Action< CheckXcodeVersionConfig > configurator) |
| Checks that the installed Xcode version is the version specified. | |
| UatConfig | CleanAutomationReports (Action< CleanAutomationReportsConfig > configurator) |
| Removes folders in an automation report directory that are older than a certain time. | |
| UatConfig | CleanFormalBuilds (Action< CleanFormalBuildsConfig > configurator) |
| Removes folders matching a pattern in a given directory that are older than a certain time. | |
| UatConfig | CodeSurgery (Action< CodeSurgeryConfig > configurator) |
| custom code to restructure C++ source code for the new stats system. | |
| UatConfig | CopySharedCookedBuild (Action< CopySharedCookedBuildConfig > configurator) |
| Copies the current shared cooked build from the network to the local PC. | |
| UatConfig | CopyUAT (Action< CopyUATConfig > configurator) |
| UatConfig | CryptoKeys (Action< CryptoKeysConfig > configurator) |
| UatConfig | ExtractPaks (Action< ExtractPaksConfig > configurator) |
| UatConfig | FinalizeInstalledBuild (Action< FinalizeInstalledBuildConfig > configurator) |
| Command to perform additional steps to prepare an installed build. | |
| UatConfig | FixPerforceCase (Action< FixPerforceCaseConfig > configurator) |
| Fixes the case of files on a case-insensitive Perforce server by removing and re-adding them. | |
| UatConfig | FixupRedirects (Action< FixupRedirectsConfig > configurator) |
| UatConfig | GenerateDSYM (Action< GenerateDSYMConfig > configurator) |
| Generates IOS debug symbols for a remote project. | |
| UatConfig | IPhonePackager (Action< IPhonePackagerConfig > configurator) |
| UAT command to call into the integrated IPhonePackager code. | |
| UatConfig | LauncherLocalization (Action< LauncherLocalizationConfig > configurator) |
| UatConfig | ListMobileDevices (Action< ListMobileDevicesConfig > configurator) |
| UatConfig | ListThirdPartySoftware (Action< ListThirdPartySoftwareConfig > configurator) |
| Lists TPS files associated with any source used to build a specified target(s). Grabs TPS files associated with source modules, content, and engine shaders. | |
| UatConfig | Localize (Action< LocalizeConfig > configurator) |
| Updates the external localization data using the arguments provided. | |
| UatConfig | ExportMcpTemplates (Action< ExportMcpTemplatesConfig > configurator) |
| UatConfig | Localise (Action< LocaliseConfig > configurator) |
| UatConfig | OpenEditor (Action< OpenEditorConfig > configurator) |
| Opens the specified project. | |
| UatConfig | ParseMsvcTimingInfo (Action< ParseMsvcTimingInfoConfig > configurator) |
| Parses Visual C++ timing information (as generated by UBT with the -Timing flag), and converts it into JSON format which can be visualized using the chrome://tracing tab. | |
| UatConfig | RebasePublicIncludePaths (Action< RebasePublicIncludePathsConfig > configurator) |
| Rewrites include directives for headers in public include paths to make them relative to the 'Public' folder. | |
| UatConfig | RebuildHLOD (Action< RebuildHLODConfig > configurator) |
| UatConfig | RebuildLightMaps (Action< RebuildLightMapsConfig > configurator) |
| Helper command used for rebuilding a projects light maps. | |
| UatConfig | RecordPerformance (Action< RecordPerformanceConfig > configurator) |
| UAT command to run performance test demo using different RHIs and compare results. | |
| UatConfig | ReplaceAssetsUsingManifest (Action< ReplaceAssetsUsingManifestConfig > configurator) |
| UatConfig | ResavePackages (Action< ResavePackagesConfig > configurator) |
| UatConfig | ResavePluginDescriptors (Action< ResavePluginDescriptorsConfig > configurator) |
| Re-save all the plugin descriptors under a given path, optionally applying standard metadata to them. | |
| UatConfig | ResaveProjectDescriptors (Action< ResaveProjectDescriptorsConfig > configurator) |
| Re-save all the project descriptors under a given path. | |
| UatConfig | RunP4Reconcile (Action< RunP4ReconcileConfig > configurator) |
| UatConfig | StashTarget (Action< StashTargetConfig > configurator) |
| Copy all the binaries for a target into a different folder. Can be restored using the UnstashTarget command. Useful for A/B testing. | |
| UatConfig | UnstashTarget (Action< UnstashTargetConfig > configurator) |
| Copy all the binaries from a target back into the root directory. Use in combination with the StashTarget command. | |
| UatConfig | SubmitUtilizationReportToEC (Action< SubmitUtilizationReportToECConfig > configurator) |
| Submits a generated Utilization report to EC. | |
| UatConfig | SyncBinariesFromUGS (Action< SyncBinariesFromUGSConfig > configurator) |
| Attempts to sync UGS binaries for the specified project at the currently synced CL of the project/engine folders. | |
| UatConfig | SyncDDC (Action< SyncDDCConfig > configurator) |
| Merge one or more remote DDC shares into a local share, taking files with the newest timestamps and keeping the size below a certain limit. | |
| UatConfig | SyncDepotPath (Action< SyncDepotPathConfig > configurator) |
| Creates a temporary client and syncs a path from Perforce. | |
| UatConfig | SyncProject (Action< SyncProjectConfig > configurator) |
| Syncs and builds all the binaries required for a project. | |
| UatConfig | TestP4_Info (Action< TestP4_InfoConfig > configurator) |
| Tests P4 functionality. Runs 'p4 info'. | |
| UatConfig | GitPullRequest (Action< GitPullRequestConfig > configurator) |
| GitPullRequest. | |
| UatConfig | TestFail (Action< TestFailConfig > configurator) |
| Throws an automation exception. | |
| UatConfig | TestSuccess (Action< TestSuccessConfig > configurator) |
| Prints a message and returns success. | |
| UatConfig | TestMessage (Action< TestMessageConfig > configurator) |
| Prints a message and returns success. | |
| UatConfig | TestRecursion (Action< TestRecursionConfig > configurator) |
| Calls UAT recursively with a given command line. | |
| UatConfig | TestRecursionAuto (Action< TestRecursionAutoConfig > configurator) |
| Calls UAT recursively with a given command line. | |
| UatConfig | TestMacZip (Action< TestMacZipConfig > configurator) |
| Makes a zip file in Rocket/QFE. | |
| UatConfig | TestP4_CreateChangelist (Action< TestP4_CreateChangelistConfig > configurator) |
| Tests P4 functionality. Creates a new changelist under the workspace P4CLIENT%. | |
| UatConfig | TestP4_StrandCheckout (Action< TestP4_StrandCheckoutConfig > configurator) |
| UatConfig | TestP4_LabelDescription (Action< TestP4_LabelDescriptionConfig > configurator) |
| UatConfig | TestP4_ClientOps (Action< TestP4_ClientOpsConfig > configurator) |
| UatConfig | CleanDDC (Action< CleanDDCConfig > configurator) |
| UatConfig | TestTestFarm (Action< TestTestFarmConfig > configurator) |
| UatConfig | TestArguments (Action< TestArgumentsConfig > configurator) |
| Test command line argument parsing functions. | |
| UatConfig | TestCombinePaths (Action< TestCombinePathsConfig > configurator) |
| Checks if combine paths works as excpected. | |
| UatConfig | TestFileUtility (Action< TestFileUtilityConfig > configurator) |
| Tests file utility functions. | |
| UatConfig | TestLog (Action< TestLogConfig > configurator) |
| UatConfig | TestChangeFileType (Action< TestChangeFileTypeConfig > configurator) |
| Tests P4 change filetype functionality. | |
| UatConfig | TestUATBuildProducts (Action< TestUATBuildProductsConfig > configurator) |
| Tests if UE4Build properly copies all relevent UAT build products to the Binaries folder. | |
| UatConfig | TestOSSCommands (Action< TestOSSCommandsConfig > configurator) |
| UatConfig | UBT (Action< UBTConfig > configurator) |
| Builds a project using UBT. Syntax is similar to UBT with the exception of '-', i.e. UBT -QAGame -Development -Win32. | |
| UatConfig | SyncSource (Action< SyncSourceConfig > configurator) |
| Helper command to sync only source code + engine files from P4. | |
| UatConfig | GenerateAutomationProject (Action< GenerateAutomationProjectConfig > configurator) |
| Generates automation project based on a template. | |
| UatConfig | DumpBranch (Action< DumpBranchConfig > configurator) |
| UatConfig | DebugSleep (Action< DebugSleepConfig > configurator) |
| Sleeps for 20 seconds and then exits. | |
| UatConfig | TestMcpConfigs (Action< TestMcpConfigsConfig > configurator) |
| Tests if Mcp configs loaded properly. | |
| UatConfig | TestBlame (Action< TestBlameConfig > configurator) |
| Test Blame P4 command. | |
| UatConfig | TestChanges (Action< TestChangesConfig > configurator) |
| Test P4 changes. | |
| UatConfig | TestKillAll (Action< TestKillAllConfig > configurator) |
| Spawns a process to test if UAT kills it automatically. | |
| UatConfig | TestCleanFormalBuilds (Action< TestCleanFormalBuildsConfig > configurator) |
| Tests CleanFormalBuilds. | |
| UatConfig | TestStopProcess (Action< TestStopProcessConfig > configurator) |
| Spawns a process to test if it can be killed. | |
| UatConfig | LookForOverlappingBuildProducts (Action< LookForOverlappingBuildProductsConfig > configurator) |
| Looks through an XGE xml for overlapping obj files. | |
| UatConfig | TestThreadedCopyFiles (Action< TestThreadedCopyFilesConfig > configurator) |
| Copies all files from source directory to destination directory using ThreadedCopyFiles. | |
| UatConfig | UnrealBuildUtilDummyBuildCommand (Action< UnrealBuildUtilDummyBuildCommandConfig > configurator) |
| UatConfig | UpdateLocalVersion (Action< UpdateLocalVersionConfig > configurator) |
| Updates your local versions based on your P4 sync. | |
| UatConfig | UploadDDCToAWS (Action< UploadDDCToAWSConfig > configurator) |
| UatConfig | ZipUtils (Action< ZipUtilsConfig > configurator) |
| ZipUtils is used to zip/unzip (i.e:RunUAT.bat ZipUtils -archive=D:/Content.zip -add=D:/UE/Pojects/SampleGame/Content/) or (i.e:RunUAT.bat ZipUtils -archive=D:/Content.zip -extract=D:/UE/Pojects/SampleGame/Content/) | |
| UatConfig | BenchmarkBuild (Action< BenchmarkBuildConfig > configurator) |
| Runs benchmarks and reports overall results Example1: RunUAT BenchmarkBuild -all -project=UE4 Example2: RunUAT BenchmarkBuild -allcompile -project=UE4+EngineTest -platform=PS4 Example3: RunUAT BenchmarkBuild -editor -client -cook -cooknoshaderddc -cooknoddc -xge -noxge -singlecompile -nopcompile -project=UE4+QAGame+EngineTest -platform=WIn64+PS4+XboxOne+Switch -iterations=3 Runs benchmarks and reports overall results Example1: RunUAT BenchmarkBuild -all -project=Unreal Example2: RunUAT BenchmarkBuild -allcompile -project=Unreal+EngineTest -platform=PS4 Example3: RunUAT BenchmarkBuild -editor -client -cook -cooknoshaderddc -cooknoddc -xge -noxge -singlecompile -nopcompile -project=Unreal+QAGame+EngineTest -platform=Win64+PS4+XboxOne+Switch -iterations=3 Runs benchmarks and reports overall results Example1: RunUAT BenchmarkBuild -all -project=Unreal Example2: RunUAT BenchmarkBuild -allcompile -project=Unreal+EngineTest -platform=PS4 Example3: RunUAT BenchmarkBuild -editor -client -cook -cooknoshaderddc -cooknoddc -xge -noxge -singlecompile -nopcompile -project=Unreal+QAGame+EngineTest -platform=WIn64+PS4+XboxOne+Switch -iterations=3. | |
| UatConfig | BenchmarkOptions (Action< BenchmarkOptionsConfig > configurator) |
| UatConfig | MakeCookedEditor (Action< MakeCookedEditorConfig > configurator) |
| UatConfig | RunUnrealTests (Action< RunUnrealTestsConfig > configurator) |
| UatConfig | PublishUnrealAutomationTelemetry (Action< PublishUnrealAutomationTelemetryConfig > configurator) |
| UatConfig | RunLowLevelTests (Action< RunLowLevelTestsConfig > configurator) |
| UatConfig | VS2017TargetPlatform_Win64 (Action< VS2017TargetPlatform_Win64Config > configurator) |
| UatConfig | VS2019TargetPlatform_Win64 (Action< VS2019TargetPlatform_Win64Config > configurator) |
| UatConfig | NMakeTargetPlatform_Win64 (Action< NMakeTargetPlatform_Win64Config > configurator) |
| UatConfig | MakefileTargetPlatform_Win64 (Action< MakefileTargetPlatform_Win64Config > configurator) |
| UatConfig | VS2019TargetPlatform_HoloLens (Action< VS2019TargetPlatform_HoloLensConfig > configurator) |
| UatConfig | NMakeTargetPlatform_Linux (Action< NMakeTargetPlatform_LinuxConfig > configurator) |
| UatConfig | MakefileTargetPlatform_Linux (Action< MakefileTargetPlatform_LinuxConfig > configurator) |
| UatConfig | XcodeTargetPlatform_Mac (Action< XcodeTargetPlatform_MacConfig > configurator) |
| UatConfig | MakefileTargetPlatform_Mac (Action< MakefileTargetPlatform_MacConfig > configurator) |
| UatConfig | XcodeTargetPlatform_TVOS (Action< XcodeTargetPlatform_TVOSConfig > configurator) |
| UatConfig | MakefileTargetPlatform_TVOS (Action< MakefileTargetPlatform_TVOSConfig > configurator) |
| UatConfig | NMakeTargetPlatform_Android (Action< NMakeTargetPlatform_AndroidConfig > configurator) |
| UatConfig | MakefileTargetPlatform_Android (Action< MakefileTargetPlatform_AndroidConfig > configurator) |
| UatConfig | CreateComponentZips (Action< CreateComponentZipsConfig > configurator) |
| UatConfig | CreatePlatformExtension (Action< CreatePlatformExtensionConfig > configurator) |
| Create stub code for platform extension. | |
| UatConfig | DownloadJupiterBuild (Action< DownloadJupiterBuildConfig > configurator) |
| Downloads a build from Jupiter. | |
| UatConfig | GeneratePlatformReport (Action< GeneratePlatformReportConfig > configurator) |
| Generates a report about all platforms and their configuration settings. | |
| UatConfig | MemreportHelper (Action< MemreportHelperConfig > configurator) |
| MemreportToHelper is used to take a memreport file, extract the CSV sections and generate a GSheet from them (i.e:RunUAT.bat MemReportToGSheet -report=myFile.memreport -name=SheetName (optional) | |
| UatConfig | WorldPartitionBuilder (Action< WorldPartitionBuilderConfig > configurator) |
| Execute a World Partition builder. | |
| UatConfig | Turnkey (Action< TurnkeyConfig > configurator) |
| UatConfig | FetchUnrealAutomationTelemetry (Action< FetchUnrealAutomationTelemetryConfig > configurator) |
| UatConfig | VS2022TargetPlatform_Win64 (Action< VS2022TargetPlatform_Win64Config > configurator) |
| UatConfig | NMakeTargetPlatform_Unix (Action< NMakeTargetPlatform_UnixConfig > configurator) |
| UatConfig | MakefileTargetPlatform_Unix (Action< MakefileTargetPlatform_UnixConfig > configurator) |
| UatConfig | VS2019TargetPlatform_Android (Action< VS2019TargetPlatform_AndroidConfig > configurator) |
| UatConfig | MultiShelve (Action< MultiShelveConfig > configurator) |
| Shelves multiple changelists into one (useful for preflighting multiple changes together. | |
| UatConfig | SyncPerforceServers (Action< SyncPerforceServersConfig > configurator) |
| Syncs a clean clientspec (should NOT be the client you are running this out of), and mirrors it into another p4 server via 3 streams. See the SyncPerforceServers.cs for details. | |
| UatConfig | WrangleContentForDebugging (Action< WrangleContentForDebuggingConfig > configurator) |
| UatConfig | InstallUnrealBuild (Action< InstallUnrealBuildConfig > configurator) |
| Install Unreal Build onto one or more connected devices using Gauntlet. | |
| UatConfig | UpdateGraphsLowLevelTests (Action< UpdateGraphsLowLevelTestsConfig > configurator) |
| Perforce helper to checkout all related LowLevelTest Build.xml files into perforce. | |
| UatConfig | SetSecondaryRemoteMac (Action< SetSecondaryRemoteMacConfig > configurator) |
| UatConfig | RehydrateProject (Action< RehydrateProjectConfig > configurator) |
| Rehydrates all eligible packages in the given project Usage: RehydrateProject -Project="???" -ProjectP4Client="???" -Submit. | |
| UatConfig | VirtualizeProject (Action< VirtualizeProjectConfig > configurator) |
| Virtualizes all eligible packages in the given project Usage: VirtualizeProject -Project="???" -ProjectP4Client="???" -Submit. | |
| UatConfig | LocalizationTargetEditor (Action< LocalizationTargetEditorConfig > configurator) |
| Allows users to create, update, delete or query localization targets for the Engine or projects. This command has sub-commands and more info for each command can be retrieved with the -Info flag. | |
| UatConfig | Bisect (Action< BisectConfig > configurator) |
| Bisects a range of changelists between 'good' and 'bad' (exclusive). If a failed-build is reported, then bisection expands outwards from the active changelist until bisection resumed. | |
| UatConfig | MakefileTargetPlatform_LinuxArm64 (Action< MakefileTargetPlatform_LinuxArm64Config > configurator) |
| UatConfig | MultiClientLauncher (Action< MultiClientLauncherConfig > configurator) |
| Run many game clients, a server, and connect them. | |
| UatConfig | ReportItemizedExecutableCode (Action< ReportItemizedExecutableCodeConfig > configurator) |
| Reports itemized binary size in a format consumed by PerfReportServer. | |
| UatConfig | StageLiveLinkHub (Action< StageLiveLinkHubConfig > configurator) |
| Command to stage livelink hub plugin dependencies for an installed build. | |
| UatConfig | UnsignedFilesViolationCheck (Action< UnsignedFilesViolationCheckConfig > configurator) |
| UatConfig | ExportAppleBuild (Action< ExportAppleBuildConfig > configurator) |
| UatConfig | GeneratePsyms (Action< GeneratePsymsConfig > configurator) |
| UatConfig | CheckBuildSize (Action< CheckBuildSizeConfig > configurator) |
| UatConfig | MakeLiveLinkHubEditor (Action< MakeLiveLinkHubEditorConfig > configurator) |
| UatConfig | LaunchMultiServer (Action< LaunchMultiServerConfig > configurator) |
| Launches multiple server processes for a project using the MultiServerReplication plugin. Launches multiple server processes for a project using the MultiServerReplication plugin. | |
| UatConfig | RunInsightsTests (Action< RunInsightsTestsConfig > configurator) |
| UatConfig | AddAutomatedPerfTestToProject (Action< AddAutomatedPerfTestToProjectConfig > configurator) |
| UAT command to enable PerfTesting hook ups for a project. | |
| UatConfig | NinjaBuildTargetPlatform_Win64 (Action< NinjaBuildTargetPlatform_Win64Config > configurator) |
| UatConfig | NinjaBuildTargetPlatform_Unix (Action< NinjaBuildTargetPlatform_UnixConfig > configurator) |
| UatConfig | NinjaBuildTargetPlatform_Linux (Action< NinjaBuildTargetPlatform_LinuxConfig > configurator) |
| UatConfig | NinjaBuildTargetPlatform_LinuxArm64 (Action< NinjaBuildTargetPlatform_LinuxArm64Config > configurator) |
| UatConfig | NinjaBuildTargetPlatform_Mac (Action< NinjaBuildTargetPlatform_MacConfig > configurator) |
| UatConfig | NinjaBuildTargetPlatform_IOS (Action< NinjaBuildTargetPlatform_IOSConfig > configurator) |
| UatConfig | NinjaBuildTargetPlatform_TVOS (Action< NinjaBuildTargetPlatform_TVOSConfig > configurator) |
| UatConfig | NinjaBuildTargetPlatform_Android (Action< NinjaBuildTargetPlatform_AndroidConfig > configurator) |
| UatConfig | CookDiffReportHelper (Action< CookDiffReportHelperConfig > configurator) |
| CookDiffReportHelper analyses the json files created by -run=cook -diffonly -cookdiffjson=path/to/my.json ... | |
| UatConfig | DedupeAutomationScripts (Action< DedupeAutomationScriptsConfig > configurator) |
| Removes duplicate binaries in UAT script directories that exist in AutomationTool or AutomationUtils. | |
| UatConfig | ExportTimerStatisticsFromUtrace (Action< ExportTimerStatisticsFromUtraceConfig > configurator) |
| Runs UnrealInsights to export timers from a utrace file to CSV file. | |
| 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. | |
Unreal Automation Tool is a vast collection of scripts solving all aspects of deploying a program made in Unreal Engine.
Definition at line 12 of file UatConfig.cs.
|
virtual |
Do not attempt to compile any script modules - attempts to run with whatever is up to date.
Reimplemented from Nuke.Unreal.Tools.UatConfigGenerated.
Definition at line 25 of file UatConfig.cs.
|
virtual |
Path to the current project. May not be specified, in which case we compile scripts for all projects.
Definition at line 17 of file UatConfig.cs.
1.12.0