// Copyright Epic Games, Inc. All Rights Reserved.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using UnrealBuildTool;
using System.IO;
using System.Reflection;
using EpicGames.Core;
using UnrealBuildBase;
namespace AutomationTool
{
[Help("targetplatform=PlatformName", "target platform for building, cooking and deployment (also -Platform)")]
[Help("servertargetplatform=PlatformName", "target platform for building, cooking and deployment of the dedicated server (also -ServerPlatform)")]
public class ProjectParams
{
///
/// Gets a parameter from the command line if it hasn't been specified in the constructor.
/// If the command line is not available, default value will be used.
///
/// Command to parse the command line for. Can be null.
/// Value specified in the constructor (or not)
/// Default value.
/// Command line parameter names to parse.
/// Parameter value.
bool GetParamValueIfNotSpecified(BuildCommand Command, bool? SpecifiedValue, bool Default, params string[] ParamNames)
{
if (SpecifiedValue.HasValue)
{
return SpecifiedValue.Value;
}
else if (Command != null)
{
foreach (var Param in ParamNames)
{
if (Command.ParseParam(Param))
{
return true;
}
}
}
return Default;
}
///
/// Gets optional parameter from the command line if it hasn't been specified in the constructor.
/// If the command line is not available or the command has not been specified in the command line, default value will be used.
///
/// Command to parse the command line for. Can be null.
/// Value specified in the constructor (or not)
/// Default value.
/// Name of a parameter that sets the value to 'true', for example: -clean
/// Name of a parameter that sets the value to 'false', for example: -noclean
/// Parameter value or default value if the paramater has not been specified
bool GetOptionalParamValueIfNotSpecified(BuildCommand Command, bool? SpecifiedValue, bool Default, string TrueParam, string FalseParam)
{
return GetOptionalParamValueIfNotSpecified(Command, SpecifiedValue, (bool?)Default, TrueParam, FalseParam).Value;
}
///
/// Gets optional parameter from the command line if it hasn't been specified in the constructor.
/// If the command line is not available or the command has not been specified in the command line, default value will be used.
///
/// Command to parse the command line for. Can be null.
/// Value specified in the constructor (or not)
/// Default value.
/// Name of a parameter that sets the value to 'true', for example: -clean
/// Name of a parameter that sets the value to 'false', for example: -noclean
/// Parameter value or default value if the paramater has not been specified
bool? GetOptionalParamValueIfNotSpecified(BuildCommand Command, bool? SpecifiedValue, bool? Default, string TrueParam, string FalseParam)
{
if (SpecifiedValue.HasValue)
{
return SpecifiedValue.Value;
}
else if (Command != null)
{
bool? Value = null;
if (!String.IsNullOrEmpty(TrueParam) && Command.ParseParam(TrueParam))
{
Value = true;
}
else if (!String.IsNullOrEmpty(FalseParam) && Command.ParseParam(FalseParam))
{
Value = false;
}
if (Value.HasValue)
{
return Value;
}
}
return Default;
}
///
/// Gets a parameter value from the command line if it hasn't been specified in the constructor.
/// If the command line is not available, default value will be used.
///
/// Command to parse the command line for. Can be null.
/// Value specified in the constructor (or not)
/// Command line parameter name to parse.
/// Default value
/// If set, the leading and trailing quotes will be removed, e.g. instead of "/home/User Name" it will return /home/User Name
/// Parameter value.
string ParseParamValueIfNotSpecified(BuildCommand Command, string SpecifiedValue, string ParamName, string Default = "", bool bTrimQuotes = false, string ObsoleteParamName = null, string ObsoleteSpecifiedValue = null)
{
string Result = Default;
if (ObsoleteSpecifiedValue != null)
{
if (SpecifiedValue == null)
{
Log.TraceWarning($"Value was provided for \"{ParamName}\" using obsolete name \"{ObsoleteParamName}\"");
Result = SpecifiedValue;
}
else
{
Log.TraceWarning($"Value provided for obsolete name \"{ObsoleteParamName}\" will be ignored as \"{ParamName}\" was provided");
}
}
else if (SpecifiedValue != null)
{
Result = SpecifiedValue;
}
else if (Command != null)
{
string Parsed = Command.ParseParamValue(ParamName, null);
if (ObsoleteParamName != null)
{
string ParsedObsolete = Command.ParseParamValue(ObsoleteParamName, null);
if (Parsed == null)
{
// Didn't find the new name on the command line. If the obsolete name was found, use it, and warn.
if (ParsedObsolete != null)
{
Log.TraceWarning($"Obsolete argument \"{ObsoleteParamName}\" on command line - use \"{ParamName}\" instead");
Parsed = ParsedObsolete;
}
}
else if (ParsedObsolete != null)
{
// Did find the new name on the command line - check for the obsolete name. If found, do not use it, and warn.
Log.TraceWarning($"Obsolete argument \"{ObsoleteParamName}\" will be ignored as \"{ParamName}\" was provided");
}
}
Result = Parsed ?? Default;
}
return bTrimQuotes ? Result.Trim( new char[]{'\"'} ) : Result;
}
///
/// Sets up platforms
///
/// Set with a mapping from source->destination if specified on command line
/// The command line to parse
/// If passed use this always
/// Use this if nothing is passed on command line
/// Allow raw -platform options
/// Possible -parameters to check for
/// List of platforms parsed from the command line
private List SetupTargetPlatforms(ref Dictionary DependentPlatformMap, BuildCommand Command, List OverrideTargetPlatforms, List DefaultTargetPlatforms, bool AllowPlatformParams, params string[] PlatformParamNames)
{
List TargetPlatforms = null;
if (CommandUtils.IsNullOrEmpty(OverrideTargetPlatforms))
{
if (Command != null)
{
// Parse the command line, we support the following params:
// -'PlatformParamNames[n]'=Platform_1+Platform_2+...+Platform_k
// or (if AllowPlatformParams is true)
// -Platform_1 -Platform_2 ... -Platform_k
string CmdLinePlatform = null;
foreach (string ParamName in PlatformParamNames)
{
string ParamValue = Command.ParseParamValue(ParamName);
if (!string.IsNullOrEmpty(ParamValue))
{
if (!string.IsNullOrEmpty(CmdLinePlatform))
{
CmdLinePlatform += "+";
}
CmdLinePlatform += ParamValue;
}
}
List CookFlavors = null;
{
string CmdLineCookFlavor = Command.ParseParamValue("cookflavor");
if (!String.IsNullOrEmpty(CmdLineCookFlavor))
{
CookFlavors = new List(CmdLineCookFlavor.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
}
}
if (!String.IsNullOrEmpty(CmdLinePlatform))
{
// Get all platforms from the param value: Platform_1+Platform_2+...+Platform_k
TargetPlatforms = new List();
List PlatformNames = (new HashSet(CmdLinePlatform.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries))).ToList();
foreach (string PlatformName in PlatformNames)
{
// Look for dependent platforms, Source_1.Dependent_1+Source_2.Dependent_2+Standalone_3
List SubPlatformNames = new List(PlatformName.Split(new char[] { '.' }, StringSplitOptions.RemoveEmptyEntries));
foreach (string SubPlatformName in SubPlatformNames)
{
// Require this to be a valid platform name
UnrealTargetPlatform NewPlatformType = UnrealTargetPlatform.Parse(SubPlatformName);
// generate all valid platform descriptions for this platform type + cook flavors
List PlatformDescriptors = Platform.GetValidTargetPlatforms(NewPlatformType, CookFlavors);
TargetPlatforms.AddRange(PlatformDescriptors);
if (SubPlatformName != SubPlatformNames[0])
{
// This is not supported with cook flavors
if (!CommandUtils.IsNullOrEmpty(CookFlavors))
{
throw new AutomationException("Cook flavors are not supported for dependent platforms!");
}
// We're a dependent platform so add ourselves to the map, pointing to the first element in the list
UnrealTargetPlatform SubPlatformType;
if (UnrealTargetPlatform.TryParse(SubPlatformNames[0], out SubPlatformType))
{
DependentPlatformMap.Add(new TargetPlatformDescriptor(NewPlatformType), new TargetPlatformDescriptor(SubPlatformType));
}
}
}
}
}
else if (AllowPlatformParams)
{
// Look up platform names in the command line: -Platform_1 -Platform_2 ... -Platform_k
TargetPlatforms = new List();
foreach (UnrealTargetPlatform PlatType in UnrealTargetPlatform.GetValidPlatforms())
{
if (Command.ParseParam(PlatType.ToString()))
{
List PlatformDescriptors = Platform.GetValidTargetPlatforms(PlatType, CookFlavors);
TargetPlatforms.AddRange(PlatformDescriptors);
}
}
}
}
}
else
{
TargetPlatforms = OverrideTargetPlatforms;
}
if (CommandUtils.IsNullOrEmpty(TargetPlatforms))
{
// Revert to single default platform - the current platform we're running
TargetPlatforms = DefaultTargetPlatforms;
}
return TargetPlatforms;
}
public ProjectParams(ProjectParams InParams)
{
//
//// Use this.Name with properties and fields!
//
this.RawProjectPath = InParams.RawProjectPath;
this.MapsToCook = InParams.MapsToCook;
this.MapIniSectionsToCook = InParams.MapIniSectionsToCook;
this.DirectoriesToCook = InParams.DirectoriesToCook;
this.DDCGraph = InParams.DDCGraph;
this.InternationalizationPreset = InParams.InternationalizationPreset;
this.CulturesToCook = InParams.CulturesToCook;
this.OriginalReleaseVersion = InParams.OriginalReleaseVersion;
this.BasedOnReleaseVersion = InParams.BasedOnReleaseVersion;
this.CreateReleaseVersion = InParams.CreateReleaseVersion;
this.GeneratePatch = InParams.GeneratePatch;
this.AddPatchLevel = InParams.AddPatchLevel;
this.StageBaseReleasePaks = InParams.StageBaseReleasePaks;
this.DLCFile = InParams.DLCFile;
this.DiscVersion = InParams.DiscVersion;
this.DLCIncludeEngineContent = InParams.DLCIncludeEngineContent;
this.DLCActLikePatch = InParams.DLCActLikePatch;
this.DLCPakPluginFile = InParams.DLCPakPluginFile;
this.DLCOverrideCookedSubDir = InParams.DLCOverrideCookedSubDir;
this.DLCOverrideStagedSubDir = InParams.DLCOverrideStagedSubDir;
this.DiffCookedContentPath = InParams.DiffCookedContentPath;
this.AdditionalCookerOptions = InParams.AdditionalCookerOptions;
this.ClientCookedTargets = InParams.ClientCookedTargets;
this.ServerCookedTargets = InParams.ServerCookedTargets;
this.EditorTargets = InParams.EditorTargets;
this.ProgramTargets = InParams.ProgramTargets;
this.TargetNames = new List(InParams.TargetNames);
this.ClientTargetPlatforms = InParams.ClientTargetPlatforms;
this.ClientDependentPlatformMap = InParams.ClientDependentPlatformMap;
this.ServerTargetPlatforms = InParams.ServerTargetPlatforms;
this.ServerDependentPlatformMap = InParams.ServerDependentPlatformMap;
this.Build = InParams.Build;
this.SkipBuildClient = InParams.SkipBuildClient;
this.SkipBuildEditor = InParams.SkipBuildEditor;
this.Run = InParams.Run;
this.Cook = InParams.Cook;
this.IterativeCooking = InParams.IterativeCooking;
this.IterateSharedCookedBuild = InParams.IterateSharedCookedBuild;
this.IterateSharedBuildUsePrecompiledExe = InParams.IterateSharedBuildUsePrecompiledExe;
this.CookAll = InParams.CookAll;
this.CookPartialGC = InParams.CookPartialGC;
this.CookInEditor = InParams.CookInEditor;
this.CookOutputDir = InParams.CookOutputDir;
this.CookMapsOnly = InParams.CookMapsOnly;
this.SkipCook = InParams.SkipCook;
this.SkipCookOnTheFly = InParams.SkipCookOnTheFly;
this.Prebuilt = InParams.Prebuilt;
this.RunTimeoutSeconds = InParams.RunTimeoutSeconds;
this.Clean = InParams.Clean;
this.Pak = InParams.Pak;
this.IgnorePaksFromDifferentCookSource = InParams.IgnorePaksFromDifferentCookSource;
this.IoStore = InParams.IoStore;
this.Cook4IoStore = InParams.Cook4IoStore;
this.ZenStore = InParams.ZenStore;
this.GenerateOptimizationData = InParams.GenerateOptimizationData;
this.SignPak = InParams.SignPak;
this.SignedPak = InParams.SignedPak;
this.PakAlignForMemoryMapping = InParams.PakAlignForMemoryMapping;
this.SkipPak = InParams.SkipPak;
this.PrePak = InParams.PrePak;
this.NoXGE = InParams.NoXGE;
this.CookOnTheFly = InParams.CookOnTheFly;
this.CookOnTheFlyStreaming = InParams.CookOnTheFlyStreaming;
this.UnversionedCookedContent = InParams.UnversionedCookedContent;
this.SkipCookingEditorContent = InParams.SkipCookingEditorContent;
this.NumCookersToSpawn = InParams.NumCookersToSpawn;
this.FileServer = InParams.FileServer;
this.DedicatedServer = InParams.DedicatedServer;
this.Client = InParams.Client;
this.NoClient = InParams.NoClient;
this.LogWindow = InParams.LogWindow;
this.Stage = InParams.Stage;
this.SkipStage = InParams.SkipStage;
this.StageDirectoryParam = InParams.StageDirectoryParam;
this.Manifests = InParams.Manifests;
this.CreateChunkInstall = InParams.CreateChunkInstall;
this.SkipEncryption = InParams.SkipEncryption;
this.UnrealExe = InParams.UnrealExe;
this.NoDebugInfo = InParams.NoDebugInfo;
this.SeparateDebugInfo = InParams.SeparateDebugInfo;
this.MapFile = InParams.MapFile;
this.NoCleanStage = InParams.NoCleanStage;
this.MapToRun = InParams.MapToRun;
this.AdditionalServerMapParams = InParams.AdditionalServerMapParams;
this.Foreign = InParams.Foreign;
this.ForeignCode = InParams.ForeignCode;
this.StageCommandline = InParams.StageCommandline;
this.BundleName = InParams.BundleName;
this.RunCommandline = InParams.RunCommandline;
this.ServerCommandline = InParams.ServerCommandline;
this.ClientCommandline = InParams.ClientCommandline;
this.Package = InParams.Package;
this.SkipPackage = InParams.SkipPackage;
this.ForcePackageData = InParams.ForcePackageData;
this.Deploy = InParams.Deploy;
this.DeployFolder = InParams.DeployFolder;
this.GetFile = InParams.GetFile;
this.IterativeDeploy = InParams.IterativeDeploy;
this.IgnoreCookErrors = InParams.IgnoreCookErrors;
this.FastCook = InParams.FastCook;
this.Devices = InParams.Devices;
this.DeviceNames = InParams.DeviceNames;
this.ServerDevice = InParams.ServerDevice;
this.NullRHI = InParams.NullRHI;
this.FakeClient = InParams.FakeClient;
this.EditorTest = InParams.EditorTest;
this.RunAutomationTests = InParams.RunAutomationTests;
this.RunAutomationTest = InParams.RunAutomationTest;
this.CrashIndex = InParams.CrashIndex;
this.Port = InParams.Port;
this.SkipServer = InParams.SkipServer;
this.Unattended = InParams.Unattended;
this.ServerDeviceAddress = InParams.ServerDeviceAddress;
this.DeviceUsername = InParams.DeviceUsername;
this.DevicePassword = InParams.DevicePassword;
this.CrashReporter = InParams.CrashReporter;
this.ClientConfigsToBuild = InParams.ClientConfigsToBuild;
this.ServerConfigsToBuild = InParams.ServerConfigsToBuild;
this.NumClients = InParams.NumClients;
this.Compressed = InParams.Compressed;
this.ForceUncompressed = InParams.ForceUncompressed;
this.AdditionalPakOptions = InParams.AdditionalPakOptions;
this.AdditionalIoStoreOptions = InParams.AdditionalIoStoreOptions;
this.Archive = InParams.Archive;
this.ArchiveDirectoryParam = InParams.ArchiveDirectoryParam;
this.ArchiveMetaData = InParams.ArchiveMetaData;
this.CreateAppBundle = InParams.CreateAppBundle;
this.Distribution = InParams.Distribution;
this.PackageEncryptionKeyFile = InParams.PackageEncryptionKeyFile;
this.Prereqs = InParams.Prereqs;
this.AppLocalDirectory = InParams.AppLocalDirectory;
this.NoBootstrapExe = InParams.NoBootstrapExe;
this.Prebuilt = InParams.Prebuilt;
this.RunTimeoutSeconds = InParams.RunTimeoutSeconds;
this.bIsCodeBasedProject = InParams.bIsCodeBasedProject;
this.bCodeSign = InParams.bCodeSign;
this.TitleID = InParams.TitleID;
this.bTreatNonShippingBinariesAsDebugFiles = InParams.bTreatNonShippingBinariesAsDebugFiles;
this.bUseExtraFlavor = InParams.bUseExtraFlavor;
this.AdditionalPackageOptions = InParams.AdditionalPackageOptions;
}
///
/// Constructor. Be sure to use this.ParamName to set the actual property name as parameter names and property names
/// overlap here.
/// If a parameter value is not set, it will be parsed from the command line; if the command is null, the default value will be used.
///
public ProjectParams(
FileReference RawProjectPath,
BuildCommand Command = null,
string Device = null,
string MapToRun = null,
string AdditionalServerMapParams = null,
ParamList Port = null,
string RunCommandline = null,
string StageCommandline = null,
string BundleName = null,
string StageDirectoryParam = null,
string UnrealExe = null,
string UE4Exe = null, // remove this when deprecated HostParams.UE4Exe is removed
string SignPak = null,
List ClientConfigsToBuild = null,
List ServerConfigsToBuild = null,
ParamList MapsToCook = null,
ParamList MapIniSectionsToCook = null,
ParamList DirectoriesToCook = null,
string DDCGraph = null,
string InternationalizationPreset = null,
ParamList CulturesToCook = null,
ParamList ClientCookedTargets = null,
ParamList EditorTargets = null,
ParamList ServerCookedTargets = null,
List ClientTargetPlatforms = null,
Dictionary ClientDependentPlatformMap = null,
List ServerTargetPlatforms = null,
Dictionary ServerDependentPlatformMap = null,
bool? Build = null,
bool? SkipBuildClient = null,
bool? SkipBuildEditor = null,
bool? Cook = null,
bool? Run = null,
bool? SkipServer = null,
bool? Clean = null,
bool? Compressed = null,
bool? ForceUncompressed = null,
string AdditionalPakOptions = null,
string AdditionalIoStoreOptions = null,
bool? IterativeCooking = null,
string IterateSharedCookedBuild = null,
bool? IterateSharedBuildUsePrecompiledExe = null,
bool? CookAll = null,
bool? CookPartialGC = null,
bool? CookInEditor = null,
string CookOutputDir = null,
bool? CookMapsOnly = null,
bool? CookOnTheFly = null,
bool? CookOnTheFlyStreaming = null,
bool? UnversionedCookedContent = null,
bool? EncryptIniFiles = null,
bool? EncryptPakIndex = null,
bool? EncryptEverything = null,
bool? SkipCookingEditorContent = null,
int? NumCookersToSpawn = null,
string AdditionalCookerOptions = null,
string OriginalReleaseVersion = null,
string BasedOnReleaseVersion = null,
string CreateReleaseVersion = null,
string CreateReleaseVersionBasePath = null,
string BasedOnReleaseVersionBasePath = null,
bool? GeneratePatch = null,
bool? AddPatchLevel = null,
bool? StageBaseReleasePaks = null,
string DiscVersion = null,
string DLCName = null,
string DLCOverrideCookedSubDir = null,
string DLCOverrideStagedSubDir = null,
string DiffCookedContentPath = null,
bool? DLCIncludeEngineContent = null,
bool? DLCPakPluginFile = null,
bool? DLCActLikePatch = null,
bool? CrashReporter = null,
bool? DedicatedServer = null,
bool? Client = null,
bool? Deploy = null,
string DeployFolder = null,
string GetFile = null,
bool? FileServer = null,
bool? Foreign = null,
bool? ForeignCode = null,
bool? LogWindow = null,
bool? NoCleanStage = null,
bool? NoClient = null,
bool? NoDebugInfo = null,
bool? SeparateDebugInfo = null,
bool? MapFile = null,
bool? NoXGE = null,
bool? SkipPackage = null,
bool? Package = null,
bool? Pak = null,
bool? IgnorePaksFromDifferentCookSource = null,
bool? IoStore = null,
bool? Cook4IoStore = null,
bool? ZenStore = null,
bool? SkipIoStore = null,
bool? GenerateOptimizationData = null,
bool? Prereqs = null,
string AppLocalDirectory = null,
bool? NoBootstrapExe = null,
bool? SignedPak = null,
bool? PakAlignForMemoryMapping = null,
bool? NullRHI = null,
bool? FakeClient = null,
bool? EditorTest = null,
bool? RunAutomationTests = null,
string RunAutomationTest = null,
int? CrashIndex = null,
bool? SkipCook = null,
bool? SkipCookOnTheFly = null,
bool? SkipPak = null,
bool? PrePak = null,
bool? SkipStage = null,
bool? Stage = null,
bool? Manifests = null,
bool? CreateChunkInstall = null,
bool? SkipEncryption = null,
bool? Unattended = null,
int? NumClients = null,
bool? Archive = null,
string ArchiveDirectoryParam = null,
bool? ArchiveMetaData = null,
bool? CreateAppBundle = null,
string SpecifiedClientTarget = null,
string SpecifiedServerTarget = null,
ParamList ProgramTargets = null,
bool? Distribution = null,
string PackageEncryptionKeyFile = null,
bool? Prebuilt = null,
int? RunTimeoutSeconds = null,
string SpecifiedArchitecture = null,
string UbtArgs = null,
string AdditionalPackageOptions = null,
bool? IterativeDeploy = null,
bool? FastCook = null,
bool? IgnoreCookErrors = null,
bool? CodeSign = null,
bool? TreatNonShippingBinariesAsDebugFiles = null,
bool? UseExtraFlavor = null,
string Provision = null,
string Certificate = null,
string Team = null,
bool AutomaticSigning = false,
ParamList InMapsToRebuildLightMaps = null,
ParamList InMapsToRebuildHLOD = null,
ParamList TitleID = null
)
{
//
//// Use this.Name with properties and fields!
//
this.RawProjectPath = RawProjectPath;
if (DirectoriesToCook != null)
{
this.DirectoriesToCook = DirectoriesToCook;
}
this.DDCGraph = ParseParamValueIfNotSpecified(Command, DDCGraph, "ddc");
this.InternationalizationPreset = ParseParamValueIfNotSpecified(Command, InternationalizationPreset, "i18npreset");
// If not specified in parameters, check commandline.
if (CulturesToCook == null)
{
if (Command != null)
{
var CookCulturesString = Command.ParseParamValue("CookCultures");
if (CookCulturesString != null)
{
this.CulturesToCook = new ParamList(CookCulturesString.Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries));
}
}
}
else
{
this.CulturesToCook = CulturesToCook;
}
if (ClientCookedTargets != null)
{
this.ClientCookedTargets = ClientCookedTargets;
}
if (ServerCookedTargets != null)
{
this.ServerCookedTargets = ServerCookedTargets;
}
if (EditorTargets != null)
{
this.EditorTargets = EditorTargets;
}
if (ProgramTargets != null)
{
this.ProgramTargets = ProgramTargets;
}
// Parse command line params for client platforms "-TargetPlatform=Win64+Mac", "-Platform=Win64+Mac" and also "-Win64", "-Mac" etc.
if (ClientDependentPlatformMap != null)
{
this.ClientDependentPlatformMap = ClientDependentPlatformMap;
}
List DefaultTargetPlatforms = new ParamList(new TargetPlatformDescriptor(HostPlatform.Current.HostEditorPlatform));
this.ClientTargetPlatforms = SetupTargetPlatforms(ref this.ClientDependentPlatformMap, Command, ClientTargetPlatforms, DefaultTargetPlatforms, true, "TargetPlatform", "Platform");
// Parse command line params for server platforms "-ServerTargetPlatform=Win64+Mac", "-ServerPlatform=Win64+Mac". "-Win64" etc is not allowed here
if (ServerDependentPlatformMap != null)
{
this.ServerDependentPlatformMap = ServerDependentPlatformMap;
}
this.ServerTargetPlatforms = SetupTargetPlatforms(ref this.ServerDependentPlatformMap, Command, ServerTargetPlatforms, this.ClientTargetPlatforms, false, "ServerTargetPlatform", "ServerPlatform");
this.Build = GetParamValueIfNotSpecified(Command, Build, this.Build, "build");
bool bSkipBuild = GetParamValueIfNotSpecified(Command, null, false, "skipbuild");
if (bSkipBuild)
{
this.Build = false;
}
this.SkipBuildClient = GetParamValueIfNotSpecified(Command, SkipBuildClient, this.SkipBuildClient, "skipbuildclient");
this.SkipBuildEditor = GetParamValueIfNotSpecified(Command, SkipBuildEditor, this.SkipBuildEditor, "skipbuildeditor", "nocompileeditor");
this.Run = GetParamValueIfNotSpecified(Command, Run, this.Run, "run");
this.Cook = GetParamValueIfNotSpecified(Command, Cook, this.Cook, "cook");
this.CreateReleaseVersionBasePath = ParseParamValueIfNotSpecified(Command, CreateReleaseVersionBasePath, "createreleaseversionroot", String.Empty);
this.BasedOnReleaseVersionBasePath = ParseParamValueIfNotSpecified(Command, BasedOnReleaseVersionBasePath, "basedonreleaseversionroot", String.Empty);
this.OriginalReleaseVersion = ParseParamValueIfNotSpecified(Command, OriginalReleaseVersion, "originalreleaseversion", String.Empty);
this.CreateReleaseVersion = ParseParamValueIfNotSpecified(Command, CreateReleaseVersion, "createreleaseversion", String.Empty);
this.BasedOnReleaseVersion = ParseParamValueIfNotSpecified(Command, BasedOnReleaseVersion, "basedonreleaseversion", String.Empty);
this.GeneratePatch = GetParamValueIfNotSpecified(Command, GeneratePatch, this.GeneratePatch, "GeneratePatch");
this.AddPatchLevel = GetParamValueIfNotSpecified(Command, AddPatchLevel, this.AddPatchLevel, "AddPatchLevel");
this.StageBaseReleasePaks = GetParamValueIfNotSpecified(Command, StageBaseReleasePaks, this.StageBaseReleasePaks, "StageBaseReleasePaks");
this.DiscVersion = ParseParamValueIfNotSpecified(Command, DiscVersion, "DiscVersion", String.Empty);
this.AdditionalCookerOptions = ParseParamValueIfNotSpecified(Command, AdditionalCookerOptions, "AdditionalCookerOptions", String.Empty);
DLCName = ParseParamValueIfNotSpecified(Command, DLCName, "DLCName", String.Empty);
if (!String.IsNullOrEmpty(DLCName))
{
// is it fully specified already (look for having a uplugin extension)
if (string.Equals(Path.GetExtension(DLCName), ".uplugin", StringComparison.InvariantCultureIgnoreCase))
{
this.DLCFile = new FileReference(DLCName);
}
else
{
List CandidatePlugins = Plugins.ReadAvailablePlugins(Unreal.EngineDirectory, DirectoryReference.FromFile(RawProjectPath), null);
PluginInfo DLCPlugin = CandidatePlugins.FirstOrDefault(x => String.Equals(x.Name, DLCName, StringComparison.InvariantCultureIgnoreCase));
if (DLCPlugin == null)
{
this.DLCFile = FileReference.Combine(RawProjectPath.Directory, "Plugins", DLCName, DLCName + ".uplugin");
}
else
{
this.DLCFile = DLCPlugin.File;
}
}
}
this.DiffCookedContentPath = ParseParamValueIfNotSpecified(Command, DiffCookedContentPath, "DiffCookedContentPath", String.Empty);
this.DLCIncludeEngineContent = GetParamValueIfNotSpecified(Command, DLCIncludeEngineContent, this.DLCIncludeEngineContent, "DLCIncludeEngineContent");
this.DLCPakPluginFile = GetParamValueIfNotSpecified(Command, DLCPakPluginFile, this.DLCPakPluginFile, "DLCPakPluginFile");
this.DLCActLikePatch = GetParamValueIfNotSpecified(Command, DLCActLikePatch, this.DLCActLikePatch, "DLCActLikePatch");
this.DLCOverrideCookedSubDir = ParseParamValueIfNotSpecified(Command, DLCOverrideCookedSubDir, "DLCOverrideCookedSubDir", null);
this.DLCOverrideStagedSubDir = ParseParamValueIfNotSpecified(Command, DLCOverrideCookedSubDir, "DLCOverrideStagedSubDir", null);
this.SkipCook = GetParamValueIfNotSpecified(Command, SkipCook, this.SkipCook, "skipcook");
if (this.SkipCook)
{
this.Cook = true;
}
this.Clean = GetOptionalParamValueIfNotSpecified(Command, Clean, this.Clean, "clean", null);
this.SignPak = ParseParamValueIfNotSpecified(Command, SignPak, "signpak", String.Empty);
this.SignedPak = !String.IsNullOrEmpty(this.SignPak) || GetParamValueIfNotSpecified(Command, SignedPak, this.SignedPak, "signedpak");
if (string.IsNullOrEmpty(this.SignPak))
{
this.SignPak = Path.Combine(RawProjectPath.Directory.FullName, @"Restricted\NoRedist\Build\Keys.txt");
if (!File.Exists(this.SignPak))
{
this.SignPak = null;
}
}
this.PakAlignForMemoryMapping = GetParamValueIfNotSpecified(Command, PakAlignForMemoryMapping, this.PakAlignForMemoryMapping, "PakAlignForMemoryMapping");
this.Pak = GetParamValueIfNotSpecified(Command, Pak, this.Pak, "pak");
this.IgnorePaksFromDifferentCookSource = GetParamValueIfNotSpecified(Command, IgnorePaksFromDifferentCookSource, this.IgnorePaksFromDifferentCookSource, "IgnorePaksFromDifferentCookSource");
this.IoStore = GetParamValueIfNotSpecified(Command, IoStore, this.IoStore, "iostore");
this.SkipIoStore = GetParamValueIfNotSpecified(Command, SkipIoStore, this.SkipIoStore, "skipiostore");
this.Cook4IoStore = GetParamValueIfNotSpecified(Command, Cook4IoStore, this.Cook4IoStore, "cook4iostore");
if (this.Cook4IoStore)
{
this.IoStore = true;
this.AdditionalCookerOptions += " -IoStore";
}
this.ZenStore = GetParamValueIfNotSpecified(Command, ZenStore, this.ZenStore, "zenstore");
if (this.ZenStore && this.Cook && !this.SkipCook)
{
this.AdditionalCookerOptions += " -ZenStore";
}
this.GenerateOptimizationData = GetParamValueIfNotSpecified(Command, GenerateOptimizationData, this.GenerateOptimizationData, "makebinaryconfig");
this.SkipPak = GetParamValueIfNotSpecified(Command, SkipPak, this.SkipPak, "skippak");
if (this.SkipPak)
{
this.Pak = true;
}
this.PrePak = GetParamValueIfNotSpecified(Command, PrePak, this.PrePak, "prepak");
if (this.PrePak)
{
this.Pak = true;
this.SkipCook = true;
}
this.NoXGE = GetParamValueIfNotSpecified(Command, NoXGE, this.NoXGE, "noxge");
this.CookOnTheFly = GetParamValueIfNotSpecified(Command, CookOnTheFly, this.CookOnTheFly, "cookonthefly");
if (this.CookOnTheFly && this.SkipCook)
{
this.Cook = false;
}
this.CookOnTheFlyStreaming = GetParamValueIfNotSpecified(Command, CookOnTheFlyStreaming, this.CookOnTheFlyStreaming, "cookontheflystreaming");
this.UnversionedCookedContent = GetOptionalParamValueIfNotSpecified(Command, UnversionedCookedContent, this.UnversionedCookedContent, "UnversionedCookedContent", "VersionCookedContent");
this.SkipCookingEditorContent = GetParamValueIfNotSpecified(Command, SkipCookingEditorContent, this.SkipCookingEditorContent, "SkipCookingEditorContent");
if (NumCookersToSpawn.HasValue)
{
this.NumCookersToSpawn = NumCookersToSpawn.Value;
}
else if (Command != null)
{
this.NumCookersToSpawn = Command.ParseParamInt("NumCookersToSpawn");
}
this.Compressed = GetParamValueIfNotSpecified(Command, Compressed, this.Compressed, "compressed");
this.ForceUncompressed = GetParamValueIfNotSpecified(Command, ForceUncompressed, this.ForceUncompressed, "ForceUncompressed");
this.AdditionalPakOptions = ParseParamValueIfNotSpecified(Command, AdditionalPakOptions, "AdditionalPakOptions");
this.AdditionalIoStoreOptions = ParseParamValueIfNotSpecified(Command, AdditionalIoStoreOptions, "AdditionalIoStoreOptions");
this.IterativeCooking = GetParamValueIfNotSpecified(Command, IterativeCooking, this.IterativeCooking, new string[] { "iterativecooking", "iterate" });
this.IterateSharedCookedBuild = GetParamValueIfNotSpecified(Command, false, false, "iteratesharedcookedbuild") ? "usesyncedbuild" : null;
this.IterateSharedCookedBuild = ParseParamValueIfNotSpecified(Command, IterateSharedCookedBuild, "IterateSharedCookedBuild", String.Empty);
this.IterateSharedBuildUsePrecompiledExe = GetParamValueIfNotSpecified(Command, IterateSharedBuildUsePrecompiledExe, this.IterateSharedBuildUsePrecompiledExe, new string[] { "IterateSharedBuildUsePrecompiledExe" });
this.SkipCookOnTheFly = GetParamValueIfNotSpecified(Command, SkipCookOnTheFly, this.SkipCookOnTheFly, "skipcookonthefly");
this.CookAll = GetParamValueIfNotSpecified(Command, CookAll, this.CookAll, "CookAll");
this.CookPartialGC = GetParamValueIfNotSpecified(Command, CookPartialGC, this.CookPartialGC, "CookPartialGC");
this.CookInEditor = GetParamValueIfNotSpecified(Command, CookInEditor, this.CookInEditor, "CookInEditor");
this.CookOutputDir = ParseParamValueIfNotSpecified(Command, CookOutputDir, "CookOutputDir", String.Empty, true);
this.CookMapsOnly = GetParamValueIfNotSpecified(Command, CookMapsOnly, this.CookMapsOnly, "CookMapsOnly");
this.FileServer = GetParamValueIfNotSpecified(Command, FileServer, this.FileServer, "fileserver");
this.DedicatedServer = GetParamValueIfNotSpecified(Command, DedicatedServer, this.DedicatedServer, "dedicatedserver", "server");
this.Client = GetParamValueIfNotSpecified(Command, Client, this.Client, "client");
/*if( this.Client )
{
this.DedicatedServer = true;
}*/
this.NoClient = GetParamValueIfNotSpecified(Command, NoClient, this.NoClient, "noclient");
if(Command != null)
{
if(TargetNames == null)
{
TargetNames = new List();
}
foreach(string TargetParam in Command.ParseParamValues("target"))
{
TargetNames.AddRange(TargetParam.Split('+'));
}
}
this.LogWindow = GetParamValueIfNotSpecified(Command, LogWindow, this.LogWindow, "logwindow");
string ExtraTargetsToStageWithClientString = null;
ExtraTargetsToStageWithClientString = ParseParamValueIfNotSpecified(Command, ExtraTargetsToStageWithClientString, "ExtraTargetsToStageWithClient", null);
if (!string.IsNullOrEmpty(ExtraTargetsToStageWithClientString))
{
this.ExtraTargetsToStageWithClient = new ParamList(ExtraTargetsToStageWithClientString.Split('+'));
}
this.Stage = GetParamValueIfNotSpecified(Command, Stage, this.Stage, "stage");
this.SkipStage = GetParamValueIfNotSpecified(Command, SkipStage, this.SkipStage, "skipstage");
if (this.SkipStage)
{
this.Stage = true;
}
this.StageDirectoryParam = ParseParamValueIfNotSpecified(Command, StageDirectoryParam, "stagingdirectory", String.Empty, true);
this.bCodeSign = GetOptionalParamValueIfNotSpecified(Command, CodeSign, CommandUtils.IsBuildMachine, "CodeSign", "NoCodeSign");
this.bTreatNonShippingBinariesAsDebugFiles = GetParamValueIfNotSpecified(Command, TreatNonShippingBinariesAsDebugFiles, false, "TreatNonShippingBinariesAsDebugFiles");
this.bUseExtraFlavor = GetParamValueIfNotSpecified(Command, UseExtraFlavor, false, "UseExtraFlavor");
this.Manifests = GetParamValueIfNotSpecified(Command, Manifests, this.Manifests, "manifests");
this.CreateChunkInstall = GetParamValueIfNotSpecified(Command, CreateChunkInstall, this.CreateChunkInstall, "createchunkinstall");
this.SkipEncryption = GetParamValueIfNotSpecified(Command, SkipEncryption, this.SkipEncryption, "skipencryption");
this.ChunkInstallDirectory = ParseParamValueIfNotSpecified(Command, ChunkInstallDirectory, "chunkinstalldirectory", String.Empty, true);
this.ChunkInstallVersionString = ParseParamValueIfNotSpecified(Command, ChunkInstallVersionString, "chunkinstallversion", String.Empty, true);
this.ChunkInstallReleaseString = ParseParamValueIfNotSpecified(Command, ChunkInstallReleaseString, "chunkinstallrelease", String.Empty, true);
if (string.IsNullOrEmpty(this.ChunkInstallReleaseString))
{
this.ChunkInstallReleaseString = this.ChunkInstallVersionString;
}
this.Archive = GetParamValueIfNotSpecified(Command, Archive, this.Archive, "archive");
this.ArchiveDirectoryParam = ParseParamValueIfNotSpecified(Command, ArchiveDirectoryParam, "archivedirectory", String.Empty, true);
this.ArchiveMetaData = GetParamValueIfNotSpecified(Command, ArchiveMetaData, this.ArchiveMetaData, "archivemetadata");
this.CreateAppBundle = GetParamValueIfNotSpecified(Command, CreateAppBundle, true, "createappbundle");
this.Distribution = GetParamValueIfNotSpecified(Command, Distribution, this.Distribution, "distribution");
this.PackageEncryptionKeyFile = ParseParamValueIfNotSpecified(Command, PackageEncryptionKeyFile, "packageencryptionkeyfile", null);
this.Prereqs = GetParamValueIfNotSpecified(Command, Prereqs, this.Prereqs, "prereqs");
this.AppLocalDirectory = ParseParamValueIfNotSpecified(Command, AppLocalDirectory, "applocaldirectory", String.Empty, true);
this.NoBootstrapExe = GetParamValueIfNotSpecified(Command, NoBootstrapExe, this.NoBootstrapExe, "nobootstrapexe");
this.Prebuilt = GetParamValueIfNotSpecified(Command, Prebuilt, this.Prebuilt, "prebuilt");
if (this.Prebuilt)
{
this.SkipCook = true;
/*this.SkipPak = true;
this.SkipStage = true;
this.Pak = true;
this.Stage = true;*/
this.Cook = true;
this.Archive = true;
this.Deploy = true;
this.Run = true;
//this.StageDirectoryParam = this.PrebuiltDir;
}
this.NoDebugInfo = GetParamValueIfNotSpecified(Command, NoDebugInfo, this.NoDebugInfo, "nodebuginfo");
this.SeparateDebugInfo = GetParamValueIfNotSpecified(Command, SeparateDebugInfo, this.SeparateDebugInfo, "separatedebuginfo");
this.MapFile = GetParamValueIfNotSpecified(Command, MapFile, this.MapFile, "mapfile");
this.NoCleanStage = GetParamValueIfNotSpecified(Command, NoCleanStage, this.NoCleanStage, "nocleanstage");
this.MapToRun = ParseParamValueIfNotSpecified(Command, MapToRun, "map", String.Empty);
this.AdditionalServerMapParams = ParseParamValueIfNotSpecified(Command, AdditionalServerMapParams, "AdditionalServerMapParams", String.Empty);
this.Foreign = GetParamValueIfNotSpecified(Command, Foreign, this.Foreign, "foreign");
this.ForeignCode = GetParamValueIfNotSpecified(Command, ForeignCode, this.ForeignCode, "foreigncode");
this.StageCommandline = ParseParamValueIfNotSpecified(Command, StageCommandline, "cmdline");
this.BundleName = ParseParamValueIfNotSpecified(Command, BundleName, "bundlename");
this.RunCommandline = ParseParamValueIfNotSpecified(Command, RunCommandline, "addcmdline");
this.RunCommandline = this.RunCommandline.Replace('\'', '\"'); // replace any single quotes with double quotes
this.ServerCommandline = ParseParamValueIfNotSpecified(Command, ServerCommandline, "servercmdline");
this.ServerCommandline = this.ServerCommandline.Replace('\'', '\"'); // replace any single quotes with double quotes
this.ClientCommandline = ParseParamValueIfNotSpecified(Command, ClientCommandline, "clientcmdline");
this.ClientCommandline = this.ClientCommandline.Replace('\'', '\"'); // replace any single quotes with double quotes
this.Package = GetParamValueIfNotSpecified(Command, Package, this.Package, "package");
this.SkipPackage = GetParamValueIfNotSpecified(Command, SkipPackage, this.SkipPackage, "skippackage");
this.ForcePackageData = GetParamValueIfNotSpecified(Command, Package, this.ForcePackageData, "forcepackagedata");
this.Deploy = GetParamValueIfNotSpecified(Command, Deploy, this.Deploy, "deploy");
this.DeployFolder = ParseParamValueIfNotSpecified(Command, DeployFolder, "deploy", null);
// if the user specified -deploy but no folder, set the default
if (this.Deploy && string.IsNullOrEmpty(this.DeployFolder))
{
this.DeployFolder = UnrealBuildTool.DeployExports.GetDefaultDeployFolder(this.ShortProjectName);
}
else if (string.IsNullOrEmpty(this.DeployFolder) == false)
{
// if the user specified a folder set deploy to true.
//@todo - remove 'deploy' var and check deployfolder != null?
this.Deploy = true;
}
// If the user specified archive without a param, set to the default. That way logging will be correct and other code doesn't
// need to do this check and fallback
if (this.Archive && string.IsNullOrEmpty(this.ArchiveDirectoryParam))
{
this.ArchiveDirectoryParam = BaseArchiveDirectory;
}
this.GetFile = ParseParamValueIfNotSpecified(Command, GetFile, "getfile", null);
this.IterativeDeploy = GetParamValueIfNotSpecified(Command, IterativeDeploy, this.IterativeDeploy, new string[] {"iterativedeploy", "iterate" } );
this.FastCook = GetParamValueIfNotSpecified(Command, FastCook, this.FastCook, "FastCook");
this.IgnoreCookErrors = GetParamValueIfNotSpecified(Command, IgnoreCookErrors, this.IgnoreCookErrors, "IgnoreCookErrors");
string DeviceString = ParseParamValueIfNotSpecified(Command, Device, "device", String.Empty).Trim(new char[] { '\"' });
if(DeviceString == "")
{
this.Devices = new ParamList("");
this.DeviceNames = new ParamList("");
}
else
{
this.Devices = new ParamList(DeviceString.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
this.DeviceNames = new ParamList();
foreach (var d in this.Devices)
{
// strip the platform prefix the specified device.
if (d.Contains("@"))
{
this.DeviceNames.Add(d.Substring(d.IndexOf("@") + 1));
}
else
{
this.DeviceNames.Add(d);
}
}
}
this.Provision = ParseParamValueIfNotSpecified(Command, Provision, "provision", String.Empty, true);
this.Certificate = ParseParamValueIfNotSpecified(Command, Certificate, "certificate", String.Empty, true);
this.Team = ParseParamValueIfNotSpecified(Command, Team, "team", String.Empty, true);
this.AutomaticSigning = GetParamValueIfNotSpecified(Command, AutomaticSigning, this.AutomaticSigning, "AutomaticSigning");
this.ServerDevice = ParseParamValueIfNotSpecified(Command, ServerDevice, "serverdevice", this.Devices.Count > 0 ? this.Devices[0] : "");
this.NullRHI = GetParamValueIfNotSpecified(Command, NullRHI, this.NullRHI, "nullrhi");
this.FakeClient = GetParamValueIfNotSpecified(Command, FakeClient, this.FakeClient, "fakeclient");
this.EditorTest = GetParamValueIfNotSpecified(Command, EditorTest, this.EditorTest, "editortest");
this.RunAutomationTest = ParseParamValueIfNotSpecified(Command, RunAutomationTest, "RunAutomationTest");
this.RunAutomationTests = this.RunAutomationTest != "" || GetParamValueIfNotSpecified(Command, RunAutomationTests, this.RunAutomationTests, "RunAutomationTests");
this.SkipServer = GetParamValueIfNotSpecified(Command, SkipServer, this.SkipServer, "skipserver");
this.UnrealExe = ParseParamValueIfNotSpecified(Command, UnrealExe, "unrealexe", "UnrealEditor-Cmd.exe", ObsoleteSpecifiedValue: UE4Exe, ObsoleteParamName: "ue4exe");
this.Unattended = GetParamValueIfNotSpecified(Command, Unattended, this.Unattended, "unattended");
this.DeviceUsername = ParseParamValueIfNotSpecified(Command, DeviceUsername, "deviceuser", String.Empty);
this.DevicePassword = ParseParamValueIfNotSpecified(Command, DevicePassword, "devicepass", String.Empty);
this.CrashReporter = GetParamValueIfNotSpecified(Command, CrashReporter, this.CrashReporter, "crashreporter");
this.SpecifiedArchitecture = ParseParamValueIfNotSpecified(Command, SpecifiedArchitecture, "specifiedarchitecture", String.Empty);
this.UbtArgs = ParseParamValueIfNotSpecified(Command, UbtArgs, "ubtargs", String.Empty);
this.AdditionalPackageOptions = ParseParamValueIfNotSpecified(Command, AdditionalPackageOptions, "AdditionalPackageOptions", String.Empty);
if (ClientConfigsToBuild == null)
{
if (Command != null)
{
string ClientConfig = Command.ParseParamValue("clientconfig");
if (ClientConfig == null)
ClientConfig = Command.ParseParamValue("config");
if (ClientConfig == null)
ClientConfig = Command.ParseParamValue("configuration");
if (ClientConfig != null)
{
this.ClientConfigsToBuild = new List();
ParamList Configs = new ParamList(ClientConfig.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
foreach (string ConfigName in Configs)
{
this.ClientConfigsToBuild.Add(ParseConfig(ConfigName));
}
}
}
}
else
{
this.ClientConfigsToBuild = ClientConfigsToBuild;
}
if (Port == null)
{
if( Command != null )
{
this.Port = new ParamList();
var PortString = Command.ParseParamValue("port");
if (String.IsNullOrEmpty(PortString) == false)
{
var Ports = new ParamList(PortString.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
foreach (var P in Ports)
{
this.Port.Add(P);
}
}
}
}
else
{
this.Port = Port;
}
if (MapsToCook == null)
{
if (Command != null)
{
this.MapsToCook = new ParamList();
var MapsString = Command.ParseParamValue("MapsToCook");
if (String.IsNullOrEmpty(MapsString) == false)
{
var MapNames = new ParamList(MapsString.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
foreach ( var M in MapNames )
{
this.MapsToCook.Add( M );
}
}
}
}
else
{
this.MapsToCook = MapsToCook;
}
if (MapIniSectionsToCook == null)
{
if (Command != null)
{
this.MapIniSectionsToCook = new ParamList();
var MapsString = Command.ParseParamValue("MapIniSectionsToCook");
if (String.IsNullOrEmpty(MapsString) == false)
{
var MapNames = new ParamList(MapsString.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
foreach (var M in MapNames)
{
this.MapIniSectionsToCook.Add(M);
}
}
}
}
else
{
this.MapIniSectionsToCook = MapIniSectionsToCook;
}
if (String.IsNullOrEmpty(this.MapToRun) == false)
{
this.MapsToCook.Add(this.MapToRun);
}
if (InMapsToRebuildLightMaps == null)
{
if (Command != null)
{
this.MapsToRebuildLightMaps = new ParamList();
var MapsString = Command.ParseParamValue("MapsToRebuildLightMaps");
if (String.IsNullOrEmpty(MapsString) == false)
{
var MapNames = new ParamList(MapsString.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
foreach (var M in MapNames)
{
this.MapsToRebuildLightMaps.Add(M);
}
}
}
}
else
{
this.MapsToRebuildLightMaps = InMapsToRebuildLightMaps;
}
if (InMapsToRebuildHLOD == null)
{
if (Command != null)
{
this.MapsToRebuildHLODMaps = new ParamList();
var MapsString = Command.ParseParamValue("MapsToRebuildHLODMaps");
if (String.IsNullOrEmpty(MapsString) == false)
{
var MapNames = new ParamList(MapsString.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
foreach (var M in MapNames)
{
this.MapsToRebuildHLODMaps.Add(M);
}
}
}
}
else
{
this.MapsToRebuildHLODMaps = InMapsToRebuildHLOD;
}
if (TitleID == null)
{
if (Command != null)
{
this.TitleID = new ParamList();
var TitleString = Command.ParseParamValue("TitleID");
if (String.IsNullOrEmpty(TitleString) == false)
{
var TitleIDs = new ParamList(TitleString.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
foreach (var T in TitleIDs)
{
this.TitleID.Add(T);
}
}
}
}
else
{
this.TitleID = TitleID;
}
if (ServerConfigsToBuild == null)
{
if (Command != null)
{
string ServerConfig = Command.ParseParamValue("serverconfig");
if (ServerConfig == null)
ServerConfig = Command.ParseParamValue("config");
if (ServerConfig == null)
ServerConfig = Command.ParseParamValue("configuration");
if (ServerConfig != null)
{
this.ServerConfigsToBuild = new List();
ParamList Configs = new ParamList(ServerConfig.Split(new char[] { '+' }, StringSplitOptions.RemoveEmptyEntries));
foreach (string ConfigName in Configs)
{
this.ServerConfigsToBuild.Add(ParseConfig(ConfigName));
}
}
}
}
else
{
this.ServerConfigsToBuild = ServerConfigsToBuild;
}
if (NumClients.HasValue)
{
this.NumClients = NumClients.Value;
}
else if (Command != null)
{
this.NumClients = Command.ParseParamInt("numclients");
}
if (CrashIndex.HasValue)
{
this.CrashIndex = CrashIndex.Value;
}
else if (Command != null)
{
this.CrashIndex = Command.ParseParamInt("CrashIndex");
}
if (RunTimeoutSeconds.HasValue)
{
this.RunTimeoutSeconds = RunTimeoutSeconds.Value;
}
else if (Command != null)
{
this.RunTimeoutSeconds = Command.ParseParamInt("runtimeoutseconds");
}
// Gather up any '-ini:' arguments and save them. We'll pass these along to other tools that may be spawned in a new process as part of the command.
if(Command != null)
{
foreach (string Param in Command.Params)
{
if (Param.StartsWith("ini:", StringComparison.InvariantCultureIgnoreCase))
{
this.ConfigOverrideParams.Add(Param);
}
}
}
AutodetectSettings(false);
ValidateAndLog();
if (this.PrePak)
{
if (!CommandUtils.P4Enabled)
{
throw new AutomationException("-PrePak requires -P4");
}
if (CommandUtils.P4Env.Changelist < 1000)
{
throw new AutomationException("-PrePak requires a CL from P4 and we have {0}", CommandUtils.P4Env.Changelist);
}
string SrcBuildPath = CommandUtils.CombinePaths(CommandUtils.RootBuildStorageDirectory(), ShortProjectName);
string SrcBuildPath2 = CommandUtils.CombinePaths(CommandUtils.RootBuildStorageDirectory(), ShortProjectName.Replace("Game", "").Replace("game", ""));
if (!InternalUtils.SafeDirectoryExists(SrcBuildPath))
{
if (!InternalUtils.SafeDirectoryExists(SrcBuildPath2))
{
throw new AutomationException("PrePak: Neither {0} nor {1} exists.", SrcBuildPath, SrcBuildPath2);
}
SrcBuildPath = SrcBuildPath2;
}
string SrcCLPath = CommandUtils.CombinePaths(SrcBuildPath, CommandUtils.EscapePath(CommandUtils.P4Env.Branch) + "-CL-" + CommandUtils.P4Env.Changelist.ToString());
if (!InternalUtils.SafeDirectoryExists(SrcCLPath))
{
throw new AutomationException("PrePak: {0} does not exist.", SrcCLPath);
}
}
}
static UnrealTargetConfiguration ParseConfig(string ConfigName)
{
UnrealTargetConfiguration ConfigValue;
if (!Enum.TryParse(ConfigName, true, out ConfigValue))
{
throw new AutomationException("Invalid configuration '{0}'. Valid configurations are '{1}'.", ConfigName, String.Join("', '", Enum.GetNames(typeof(UnrealTargetConfiguration)).Where(x => x != nameof(UnrealTargetConfiguration.Unknown))));
}
return ConfigValue;
}
///
/// Shared: Full path to the .uproject file
///
public FileReference RawProjectPath { private set; get; }
///
/// Shared: The current project is a foreign project, commandline: -foreign
///
[Help("foreign", "Generate a foreign uproject from blankproject and use that")]
public bool Foreign { private set; get; }
///
/// Shared: The current project is a foreign project, commandline: -foreign
///
[Help("foreigncode", "Generate a foreign code uproject from platformergame and use that")]
public bool ForeignCode { private set; get; }
///
/// Shared: true if we should build crash reporter
///
[Help("CrashReporter", "true if we should build crash reporter")]
public bool CrashReporter { private set; get; }
///
/// Shared: Determines if the build is going to use cooked data, commandline: -cook, -cookonthefly
///
[Help("cook, -cookonthefly", "Determines if the build is going to use cooked data")]
public bool Cook { private set; get; }
///
/// Shared: Determines if the build is going to use cooked data, commandline: -cook, -cookonthefly
///
[Help("skipcook", "use a cooked build, but we assume the cooked data is up to date and where it belongs, implies -cook")]
public bool SkipCook { private set; get; }
///
/// 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.
///
[Help("skipcookonthefly", "in a cookonthefly build, used solely to pass information to the package step")]
public bool SkipCookOnTheFly { private set; get; }
///
/// Shared: Determines if the intermediate folders will be wiped before building, commandline: -clean
///
[Help("clean", "wipe intermediate folders before building")]
public bool? Clean { private set; get; }
///
/// Shared: Assumes no user is sitting at the console, so for example kills clients automatically, commandline: -Unattended
///
[Help("unattended", "assumes no operator is present, always terminates without waiting for something.")]
public bool Unattended { private set; get; }
///
/// Shared: Sets platforms to build for non-dedicated servers. commandline: -TargetPlatform
///
public List ClientTargetPlatforms = new List();
///
/// Shared: Dictionary that maps client dependent platforms to "source" platforms that it should copy data from. commandline: -TargetPlatform=source.dependent
///
public Dictionary ClientDependentPlatformMap = new Dictionary();
///
/// Shared: Sets platforms to build for dedicated servers. commandline: -ServerTargetPlatform
///
public List ServerTargetPlatforms = new List();
///
/// Shared: Dictionary that maps server dependent platforms to "source" platforms that it should copy data from: -ServerTargetPlatform=source.dependent
///
public Dictionary ServerDependentPlatformMap = new Dictionary();
///
/// Shared: True if pak file should be generated.
///
[Help("pak", "generate a pak file")]
public bool Pak { private set; get; }
///
/// 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
///
[Help("pak", "disable reuse of pak files from the alternate cook source folder, if specified")]
public bool IgnorePaksFromDifferentCookSource { get; private set; }
///
/// Shared: True if container file(s) should be generated with ZenPak.
///
[Help("iostore", "generate I/O store container file(s)")]
public bool IoStore { private set; get; }
///
/// Shared: True if the cooker should write directly to container file(s)
///
[Help("cook4iostore", "generate I/O store container file(s)")]
public bool Cook4IoStore { private set; get; }
///
/// Shared: True if the cooker should store the cooked output to the Zen storage server
///
[Help("zenstore", "save cooked output data to the Zen storage server")]
public bool ZenStore { private set; get; }
///
/// Shared: True if optimization data is generated during staging that can improve loadtimes
///
[Help("makebinaryconfig", "generate optimized config data during staging to improve loadtimes")]
public bool GenerateOptimizationData { private set; get; }
///
///
///
public bool UsePak(Platform PlatformToCheck)
{
return Pak || PlatformToCheck.RequiresPak(this) == Platform.PakType.Always;
}
private string SignPakInternal { get; set; }
///
/// Shared: Encryption keys used for signing the pak file.
///
[Help("signpak=keys", "sign the generated pak file with the specified key, i.e. -signpak=C:\\Encryption.keys. Also implies -signedpak.")]
public string SignPak
{
private set
{
if (string.IsNullOrEmpty(value) || value.StartsWith("0x", StringComparison.InvariantCultureIgnoreCase))
{
SignPakInternal = value;
}
else
{
SignPakInternal = Path.GetFullPath(value);
}
}
get
{
return SignPakInternal;
}
}
///
/// Shared: true if this build is staged, command line: -stage
///
[Help("prepak", "attempt to avoid cooking and instead pull pak files from the network, implies pak and skipcook")]
public bool PrePak { private set; get; }
///
/// Shared: the game will use only signed content.
///
[Help("signed", "the game should expect to use a signed pak file.")]
public bool SignedPak { private set; get; }
///
/// Shared: The game will be set up for memory mapping bulk data.
///
[Help("PakAlignForMemoryMapping", "The game will be set up for memory mapping bulk data.")]
public bool PakAlignForMemoryMapping { private set; get; }
///
/// Shared: true if this build is staged, command line: -stage
///
[Help("skippak", "use a pak file, but assume it is already built, implies pak")]
public bool SkipPak { private set; get; }
///
/// Shared: true if we want to skip iostore, even if -iostore is specified
///
[Help("skipiostore", "override the -iostore commandline option to not run it")]
public bool SkipIoStore { private set; get; }
///
/// Shared: true if this build is staged, command line: -stage
///
[Help("stage", "put this build in a stage directory")]
public bool Stage { private set; get; }
///
/// Shared: true if this build is staged, command line: -stage
///
[Help("skipstage", "uses a stage directory, but assumes everything is already there, implies -stage")]
public bool SkipStage { private set; get; }
///
/// Shared: true if this build is using streaming install manifests, command line: -manifests
///
[Help("manifests", "generate streaming install manifests when cooking data")]
public bool Manifests { private set; get; }
///
/// Shared: true if this build chunk install streaming install data, command line: -createchunkinstalldata
///
[Help("createchunkinstall", "generate streaming install data from manifest when cooking data, requires -stage & -manifests")]
public bool CreateChunkInstall { private set; get; }
[Help("skipencryption", "skips encrypting pak files even if crypto keys are provided")]
public bool SkipEncryption { private set; get; }
///
/// Shared: Directory to use for built chunk install data, command line: -chunkinstalldirectory=
///
public string ChunkInstallDirectory { set; get; }
///
/// Shared: Version string to use for built chunk install data, command line: -chunkinstallversion=
///
public string ChunkInstallVersionString { set; get; }
///
/// Shared: Release string to use for built chunk install data, command line: -chunkinstallrelease=
///
public string ChunkInstallReleaseString { set; get; }
///
/// Shared: Directory to copy the client to, command line: -stagingdirectory=
///
public string BaseStageDirectory
{
get
{
if( !String.IsNullOrEmpty(StageDirectoryParam ) )
{
return Path.GetFullPath( StageDirectoryParam );
}
if ( HasDLCName )
{
return Path.GetFullPath( CommandUtils.CombinePaths( DLCFile.Directory.FullName, "Saved", "StagedBuilds" ) );
}
// default return the project saved\stagedbuilds directory
return Path.GetFullPath( CommandUtils.CombinePaths(Path.GetDirectoryName(RawProjectPath.FullName), "Saved", "StagedBuilds") );
}
}
[Help("stagingdirectory=Path", "Directory to copy the builds to, i.e. -stagingdirectory=C:\\Stage")]
public string StageDirectoryParam;
[Help("unrealexe=ExecutableName", "Name of the Unreal Editor executable, i.e. -unrealexe=UnrealEditor.exe")]
public string UnrealExe;
[Obsolete("Removed in 5.0; Use UnrealExe instead")]
public string UE4Exe
{
set => UnrealExe = value;
get => UnrealExe;
}
///
/// Shared: true if this build is archived, command line: -archive
///
[Help("archive", "put this build in an archive directory")]
public bool Archive { private set; get; }
///
/// Shared: Directory to archive the client to, command line: -archivedirectory=
///
public string BaseArchiveDirectory
{
get
{
return Path.GetFullPath(String.IsNullOrEmpty(ArchiveDirectoryParam) ? CommandUtils.CombinePaths(Path.GetDirectoryName(RawProjectPath.FullName), "ArchivedBuilds") : ArchiveDirectoryParam);
}
}
[Help("archivedirectory=Path", "Directory to archive the builds to, i.e. -archivedirectory=C:\\Archive")]
public string ArchiveDirectoryParam;
///
/// Whether the project should use non monolithic staging
///
[Help("archivemetadata", "Archive extra metadata files in addition to the build (e.g. build.properties)")]
public bool ArchiveMetaData;
///
/// When archiving for Mac, set this to true to package it in a .app bundle instead of normal loose files
///
[Help("createappbundle", "When archiving for Mac, set this to true to package it in a .app bundle instead of normal loose files")]
public bool CreateAppBundle;
///
/// Determines if Blueprint assets should be substituted with auto-generated code.
///
[Obsolete("The RunAssetNativization property has been deprecated in 5.0. This feature is no longer supported.")]
public bool RunAssetNativization
{
get { return false; }
}
///
/// Keeps track of any '-ini:type:[section]:value' arguments on the command line. These will override cached config settings for the current process, and can be passed along to other tools.
///
public List ConfigOverrideParams = new List();
///
/// Build: True if build step should be executed, command: -build
///
[Help("build", "True if build step should be executed")]
public bool Build { private set; get; }
///
/// SkipBuildClient if true then don't build the client exe
///
public bool SkipBuildClient { private set; get; }
///
/// SkipBuildEditor if true then don't build the editor exe
///
public bool SkipBuildEditor { private set; get; }
///
/// Build: True if XGE should NOT be used for building.
///
[Help("noxge", "True if XGE should NOT be used for building")]
public bool NoXGE { private set; get; }
///
/// Build: List of editor build targets.
///
private ParamList EditorTargetsList = null;
public ParamList EditorTargets
{
set { EditorTargetsList = value; }
get
{
if (EditorTargetsList == null)
{
// Lazy auto-initialization
AutodetectSettings(false);
}
return EditorTargetsList;
}
}
///
/// Build: List of program build targets.
///
private ParamList ProgramTargetsList = null;
public ParamList ProgramTargets
{
set { ProgramTargetsList = value; }
get
{
if (ProgramTargetsList == null)
{
// Lazy auto-initialization
AutodetectSettings(false);
}
return ProgramTargetsList;
}
}
///
/// Build: List of client configurations
///
public List ClientConfigsToBuild = new List() { UnrealTargetConfiguration.Development };
///
/// Build: List of Server configurations
///
public List ServerConfigsToBuild = new List() { UnrealTargetConfiguration.Development };
///
/// Build: List of client cooked build targets.
///
private ParamList ClientCookedTargetsList = null;
public ParamList ClientCookedTargets
{
set { ClientCookedTargetsList = value; }
get
{
if (ClientCookedTargetsList == null)
{
// Lazy auto-initialization
AutodetectSettings(false);
}
return ClientCookedTargetsList;
}
}
///
/// Build: List of Server cooked build targets.
///
private ParamList ServerCookedTargetsList = null;
public ParamList ServerCookedTargets
{
set { ServerCookedTargetsList = value; }
get
{
if (ServerCookedTargetsList == null)
{
// Lazy auto-initialization
AutodetectSettings(false);
}
return ServerCookedTargetsList;
}
}
///
/// Build: Specifies the names of targets to build
///
private List TargetNames;
///
/// Cook: List of maps to cook.
///
public ParamList MapsToCook = new ParamList();
///
/// Cook: List of map inisections to cook (see allmaps)
///
public ParamList MapIniSectionsToCook = new ParamList();
///
/// Cook: List of directories to cook.
///
public ParamList DirectoriesToCook = new ParamList();
///
/// Cook: Which ddc graph to use when cooking.
///
public string DDCGraph;
///
/// Cook: Internationalization preset to cook.
///
public string InternationalizationPreset;
///
/// 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
///
[Help("CookPartialgc", "while cooking clean up packages as we are done with them rather then cleaning everything up when we run out of space")]
public bool CookPartialGC { private set; get; }
///
/// Stage: Did we cook in the editor instead of from UAT (cook in editor uses a different staging directory)
///
[Help("CookInEditor", "Did we cook in the editor instead of in UAT")]
public bool CookInEditor { private set; get; }
///
/// Cook: Output directory for cooked data
///
public string CookOutputDir;
///
/// Cook: Create a cooked release version. Also, the version. e.g. 1.0
///
public string CreateReleaseVersion;
///
/// Cook: Base this cook of a already released version of the cooked data
///
public string BasedOnReleaseVersion;
///
/// The version of the originally released build. This is required by some platforms when generating patches.
///
public string OriginalReleaseVersion;
///
/// Cook: Path to the root of the directory where we store released versions of the game for a given version
///
public string BasedOnReleaseVersionBasePath;
///
/// Cook: Path to the root of the directory to create a new released version of the game.
///
public string CreateReleaseVersionBasePath;
///
/// 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
///
public bool GeneratePatch;
///
/// Required when building remaster package
///
public string DiscVersion;
///
///
public bool AddPatchLevel;
///
/// Are we staging the unmodified pak files from the base release
public bool StageBaseReleasePaks;
/// Name of dlc to cook and package (if this paramter is supplied cooks the dlc and packages it into the dlc directory)
///
public FileReference DLCFile;
///
/// Enable cooking of engine content when cooking dlc
/// not included in original release but is referenced by current cook
///
public bool DLCIncludeEngineContent;
///
/// Enable packaging up the uplugin file inside the dlc pak. This is sometimes desired if you want the plugin to be standalone
///
public bool DLCPakPluginFile;
///
/// 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
///
public bool DLCActLikePatch;
///
/// 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)
///
public string DLCOverrideCookedSubDir;
///
/// Controls where under the staged directory to output to (in case the plugin subdirectory is not desired under the StagingDirectory location)
///
public string DLCOverrideStagedSubDir;
///
/// After cook completes diff the cooked content against another cooked content directory.
/// report all errors to the log
///
public string DiffCookedContentPath;
///
/// Cook: Additional cooker options to include on the cooker commandline
///
public string AdditionalCookerOptions;
///
/// Cook: List of cultures to cook.
///
public ParamList CulturesToCook;
///
/// Compress packages during cook.
///
public bool Compressed;
///
/// Do not compress packages during cook, override game ProjectPackagingSettings to force it off
///
public bool ForceUncompressed;
///
/// Additional parameters when generating the PAK file
///
public string AdditionalPakOptions;
///
/// Additional parameters when generating iostore container files
///
public string AdditionalIoStoreOptions;
///
/// Cook: Do not include a version number in the cooked content
///
public bool UnversionedCookedContent = true;
///
/// Cook: Uses the iterative cooking, command line: -iterativecooking or -iterate
///
[Help( "iterativecooking", "Uses the iterative cooking, command line: -iterativecooking or -iterate" )]
public bool IterativeCooking;
///
/// Cook: Iterate from a build on the network
///
[Help("Iteratively cook from a shared cooked build")]
public string IterateSharedCookedBuild;
///
/// Build: Don't build the game instead use the prebuild exe (requires iterate shared cooked build
///
[Help("Iteratively cook from a shared cooked build")]
public bool IterateSharedBuildUsePrecompiledExe;
///
/// Cook: Only cook maps (and referenced content) instead of cooking everything only affects -cookall flag
///
[Help("CookMapsOnly", "Cook only maps this only affects usage of -cookall the flag")]
public bool CookMapsOnly;
///
/// Cook: Only cook maps (and referenced content) instead of cooking everything only affects cookall flag
///
[Help("CookAll", "Cook all the things in the content directory for this project")]
public bool CookAll;
///
/// Cook: Skip cooking editor content
///
[Help("SkipCookingEditorContent", "Skips content under /Engine/Editor when cooking")]
public bool SkipCookingEditorContent;
///
/// Cook: number of additional cookers to spawn while cooking
///
public int NumCookersToSpawn;
///
/// Cook: Uses the iterative deploy, command line: -iterativedeploy or -iterate
///
[Help("iterativecooking", "Uses the iterative cooking, command line: -iterativedeploy or -iterate")]
public bool IterativeDeploy;
[Help("FastCook", "Uses fast cook path if supported by target")]
public bool FastCook;
///
/// Cook: Ignores cook errors and continues with packaging etc.
///
[Help("IgnoreCookErrors", "Ignores cook errors and continues with packaging etc")]
public bool IgnoreCookErrors { private set; get; }
///
/// Stage: Commandline: -nodebuginfo
///
[Help("nodebuginfo", "do not copy debug files to the stage")]
public bool NoDebugInfo { private set; get; }
///
/// Stage: Commandline: -separatedebuginfo
///
[Help("separatedebuginfo", "output debug info to a separate directory")]
public bool SeparateDebugInfo { private set; get; }
///
/// Stage: Commandline: -mapfile
///
[Help("MapFile", "generates a *.map file")]
public bool MapFile { private set; get; }
///
/// true if the staging directory is to be cleaned: -cleanstage (also true if -clean is specified)
///
[Help("nocleanstage", "skip cleaning the stage directory")]
public bool NoCleanStage { set { bNoCleanStage = value; } get { return SkipStage || bNoCleanStage; } }
private bool bNoCleanStage;
///
/// Stage: If non-empty, the contents will be put into the stage
///
[Help("cmdline", "command line to put into the stage in UECommandLine.txt")]
public string StageCommandline;
///
/// Stage: If non-empty, the contents will be used for the bundle name
///
[Help("bundlename", "string to use as the bundle name when deploying to mobile device")]
public string BundleName;
//
/// Stage: Specifies a list of extra targets that should be staged along with a client
///
public ParamList ExtraTargetsToStageWithClient = new ParamList();
///
/// Stage: Optional callback that a build script can use to modify a deployment context immediately after it is created
///
public Action PreModifyDeploymentContextCallback = null;
///
/// Stage: Optional callback that a build script can use to modify a deployment context before it is applied
///
public Action ModifyDeploymentContextCallback = null;
///
/// 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.
///
public bool NoBootstrapExe { get; set; }
///
/// By default we don't code sign unless it is required or requested
///
public bool bCodeSign = false;
///
/// Provision to use
///
public string Provision = null;
///
/// Certificate to use
///
public string Certificate = null;
///
/// Team ID to use
///
public string Team = null;
///
/// true if provisioning is automatically managed
///
public bool AutomaticSigning = false;
///
/// TitleID to package
///
public ParamList TitleID = new ParamList();
///
/// If true, non-shipping binaries will be considered DebugUFS files and will appear on the debugfiles manifest
///
public bool bTreatNonShippingBinariesAsDebugFiles = false;
///
/// If true, use chunk manifest files generated for extra flavor
///
public bool bUseExtraFlavor = false;
///
/// Run: True if the Run step should be executed, command: -run
///
[Help("run", "run the game after it is built (including server, if -server)")]
public bool Run { private set; get; }
///
/// Run: The client runs with cooked data provided by cook on the fly server, command line: -cookonthefly
///
[Help("cookonthefly", "run the client with cooked data provided by cook on the fly server")]
public bool CookOnTheFly { private set; get; }
///
/// Run: The client should run in streaming mode when connecting to cook on the fly server
///
[Help("Cookontheflystreaming", "run the client in streaming cook on the fly mode (don't cache files locally instead force reget from server each file load)")]
public bool CookOnTheFlyStreaming { private set; get; }
///
/// Run: The client runs with cooked data provided by UnrealFileServer, command line: -fileserver
///
[Help("fileserver", "run the client with cooked data provided by UnrealFileServer")]
public bool FileServer { private set; get; }
///
/// Run: The client connects to dedicated server to get data, command line: -dedicatedserver
///
[Help("dedicatedserver", "build, cook and run both a client and a server (also -server)")]
public bool DedicatedServer { private set; get; }
///
/// Run: Uses a client target configuration, also implies -dedicatedserver, command line: -client
///
[Help( "client", "build, cook and run a client and a server, uses client target configuration" )]
public bool Client { private set; get; }
///
/// Run: Whether the client should start or not, command line (to disable): -noclient
///
[Help("noclient", "do not run the client, just run the server")]
public bool NoClient { private set; get; }
///
/// Run: Client should create its own log window, command line: -logwindow
///
[Help("logwindow", "create a log window for the client")]
public bool LogWindow { private set; get; }
///
/// Run: Map to run the game with.
///
[Help("map", "map to run the game with")]
public string MapToRun;
///
/// Run: Additional server map params.
///
[Help("AdditionalServerMapParams", "Additional server map params, i.e ?param=value")]
public string AdditionalServerMapParams;
///
/// Run: The target device to run the game on. Comes in the form platform@devicename.
///
[Help("device", "Devices to run the game on")]
public ParamList Devices;
///
/// Run: The target device to run the game on. No platform prefix.
///
[Help("device", "Device names without the platform prefix to run the game on")]
public ParamList DeviceNames;
///
/// Run: the target device to run the server on
///
[Help("serverdevice", "Device to run the server on")]
public string ServerDevice;
///
/// Run: The indicated server has already been started
///
[Help("skipserver", "Skip starting the server")]
public bool SkipServer;
///
/// Run: The indicated server has already been started
///
[Help("numclients=n", "Start extra clients, n should be 2 or more")]
public int NumClients;
///
/// Run: Additional command line arguments to pass to the program
///
[Help("addcmdline", "Additional command line arguments for the program")]
public string RunCommandline;
///
/// Run: Additional command line arguments to pass to the server
///
[Help("servercmdline", "Additional command line arguments for the program")]
public string ServerCommandline;
///
/// Run: Override command line arguments to pass to the client, if set it will not try to guess at IPs or settings
///
[Help("clientcmdline", "Override command line arguments to pass to the client")]
public string ClientCommandline;
///
/// Run:adds -nullrhi to the client commandline
///
[Help("nullrhi", "add -nullrhi to the client commandlines")]
public bool NullRHI;
///
/// Run:adds ?fake to the server URL
///
[Help("fakeclient", "adds ?fake to the server URL")]
public bool FakeClient;
///
/// Run:adds ?fake to the server URL
///
[Help("editortest", "rather than running a client, run the editor instead")]
public bool EditorTest;
///
/// Run:when running -editortest or a client, run all automation tests, not compatible with -server
///
[Help("RunAutomationTests", "when running -editortest or a client, run all automation tests, not compatible with -server")]
public bool RunAutomationTests;
///
/// Run:when running -editortest or a client, run all automation tests, not compatible with -server
///
[Help("RunAutomationTests", "when running -editortest or a client, run a specific automation tests, not compatible with -server")]
public string RunAutomationTest;
///
/// Run: Adds commands like debug crash, debug rendercrash, etc based on index
///
[Help("Crash=index", "when running -editortest or a client, adds commands like debug crash, debug rendercrash, etc based on index")]
public int CrashIndex;
public ParamList Port;
///
/// Run: Linux username for unattended key genereation
///
[Help("deviceuser", "Linux username for unattended key genereation")]
public string DeviceUsername;
///
/// Run: Linux password for unattended key genereation
///
[Help("devicepass", "Linux password")]
public string DevicePassword;
///
/// Run: Server device IP address
///
public string ServerDeviceAddress;
[Help("package", "package the project for the target platform")]
public bool Package { get; set; }
[Help("skippackage", "Skips packaging the project for the target platform")]
public bool SkipPackage { get; set; }
[Help("package", "Determine whether data is packaged. This can be an iteration optimization for platforms that require packages for deployment")]
public bool ForcePackageData { get; set; }
[Help("distribution", "package for distribution the project")]
public bool Distribution { get; set; }
[Help("PackageEncryptionKeyFile", "Path to file containing encryption key to use in packaging")]
public string PackageEncryptionKeyFile { get; set; }
[Help("prereqs", "stage prerequisites along with the project")]
public bool Prereqs { get; set; }
[Help("applocaldir", "location of prerequisites for applocal deployment")]
public string AppLocalDirectory { get; set; }
[Help("Prebuilt", "this is a prebuilt cooked and packaged build")]
public bool Prebuilt { get; private set; }
[Help("RunTimeoutSeconds", "timeout to wait after we lunch the game")]
public int RunTimeoutSeconds;
[Help("SpecifiedArchitecture", "Determine a specific Minimum OS")]
public string SpecifiedArchitecture;
[Help("UbtArgs", "extra options to pass to ubt")]
public string UbtArgs;
[Help("AdditionalPackageOptions", "extra options to pass to the platform's packager")]
public string AdditionalPackageOptions { get; set; }
[Help("deploy", "deploy the project for the target platform")]
public bool Deploy { get; set; }
[Help("deploy", "Location to deploy to on the target platform")]
public string DeployFolder { get; set; }
[Help("getfile", "download file from target after successful run")]
public string GetFile { get; set; }
[Help("MapsToRebuildLightMaps", "List of maps that need light maps rebuilding")]
public ParamList MapsToRebuildLightMaps = new ParamList();
[Help("MapsToRebuildHLODMaps", "List of maps that need HLOD rebuilding")]
public ParamList MapsToRebuildHLODMaps = new ParamList();
[Help("IgnoreLightMapErrors", "Whether Light Map errors should be treated as critical")]
public bool IgnoreLightMapErrors { get; set; }
private List DetectedTargets;
private Dictionary LoadedEngineConfigs;
private Dictionary LoadedGameConfigs;
private List TargetNamesOfType(TargetType DesiredType)
{
return DetectedTargets.FindAll(Target => Target.Rules.Type == DesiredType).ConvertAll(Target => Target.TargetName);
}
private String ChooseTarget(List Targets, TargetType Type)
{
switch (Targets.Count)
{
case 1:
return Targets.First();
case 0:
throw new AutomationException("{0} target not found!", Type);
default:
throw new AutomationException("More than one {0} target found. Specify which one to use with the -{1}= option.", Type, Type);
}
}
private void SelectDefaultEditorTarget(List AvailableEditorTargets, ref string EditorTarget)
{
string DefaultEditorTarget;
if (EngineConfigs[BuildHostPlatform.Current.Platform].GetString("/Script/BuildSettings.BuildSettings", "DefaultEditorTarget", out DefaultEditorTarget))
{
if (!AvailableEditorTargets.Contains(DefaultEditorTarget))
{
throw new AutomationException(string.Format("A default editor target '{0}' was specified in engine.ini but does not exist", DefaultEditorTarget));
}
EditorTarget = DefaultEditorTarget;
}
else
{
if (AvailableEditorTargets.Count > 1)
{
throw new AutomationException("Project contains multiple editor targets but no DefaultEditorTarget is set in the [/Script/BuildSettings.BuildSettings] section of DefaultEngine.ini");
}
if (AvailableEditorTargets.Count > 0)
{
EditorTarget = AvailableEditorTargets.First();
}
}
}
private void AutodetectSettings(bool bReset)
{
if (bReset)
{
EditorTargetsList = null;
ClientCookedTargetsList = null;
ServerCookedTargetsList = null;
ProgramTargetsList = null;
ProjectPlatformBinariesPaths = null;
ProjectExePaths = null;
}
List ClientTargetPlatformTypes = ClientTargetPlatforms.ConvertAll(x => x.Type).Distinct().ToList();
// @todo (wip) - Removing Blueprint nativization as a feature.
bool bRunAssetNativization = false;// this.RunAssetNativization;
var Properties = ProjectUtils.GetProjectProperties(RawProjectPath, ClientTargetPlatformTypes, ClientConfigsToBuild, bRunAssetNativization);
bIsCodeBasedProject = Properties.bIsCodeBasedProject;
DetectedTargets = Properties.Targets;
LoadedEngineConfigs = Properties.EngineConfigs;
LoadedGameConfigs = Properties.GameConfigs;
var GameTarget = String.Empty;
var EditorTarget = String.Empty;
var ServerTarget = String.Empty;
var ProgramTarget = String.Empty;
var ProjectType = TargetType.Game;
if (!bIsCodeBasedProject)
{
GameTarget = Client ? "UnrealClient" : "UnrealGame";
EditorTarget = "UnrealEditor";
ServerTarget = "UnrealServer";
}
else if (TargetNames.Count > 0)
{
// Resolve all the targets that need to be built
List Targets = new List();
foreach (string TargetName in TargetNames)
{
SingleTargetProperties Target = DetectedTargets.FirstOrDefault(x => String.Equals(x.TargetName, TargetName, StringComparison.OrdinalIgnoreCase));
if(Target == null)
{
throw new AutomationException("Unable to find target '{0}'", TargetName);
}
Targets.Add(Target);
}
// Make sure we haven't specified game and clients together
if (Targets.Any(x => x.Rules.Type == TargetType.Client) && Targets.Any(x => x.Rules.Type == TargetType.Game))
{
throw new AutomationException("Cannot specify client and game targets to be built together");
}
// Create the lists to receive all the target types
if (ClientCookedTargetsList == null)
{
ClientCookedTargetsList = new ParamList();
}
if (ServerCookedTargetsList == null)
{
ServerCookedTargetsList = new ParamList();
}
if (ProgramTargetsList == null)
{
ProgramTargetsList = new ParamList();
}
// Add them to the appropriate lists
bool bHasGameTarget = false;
foreach (SingleTargetProperties Target in Targets)
{
if (Target.Rules.Type == TargetType.Game)
{
ClientCookedTargetsList.Add(Target.TargetName);
bHasGameTarget = true;
}
else if (Target.Rules.Type == TargetType.Client)
{
ClientCookedTargetsList.Add(Target.TargetName);
Client = true;
}
else if (Target.Rules.Type == TargetType.Server)
{
ServerCookedTargetsList.Add(Target.TargetName);
DedicatedServer = true;
}
else
{
ProgramTargetsList.Add(Target.TargetName);
ProjectType = TargetType.Program;
}
}
// If we don't have any game/client targets, don't stage any client executable
if (ClientCookedTargetsList.Count == 0)
{
NoClient = true;
}
else
{
GameTarget = ClientCookedTargetsList[0];
}
// Validate all the settings
if (Client && bHasGameTarget)
{
throw new AutomationException("Cannot mix game and client targets");
}
// Find the editor target name
SelectDefaultEditorTarget(TargetNamesOfType(TargetType.Editor), ref EditorTarget);
}
else if (!CommandUtils.IsNullOrEmpty(Properties.Targets))
{
List AvailableGameTargets = TargetNamesOfType(TargetType.Game);
List AvailableClientTargets = TargetNamesOfType(TargetType.Client);
List AvailableServerTargets = TargetNamesOfType(TargetType.Server);
List AvailableEditorTargets = TargetNamesOfType(TargetType.Editor);
// That should cover all detected targets; Program targets are handled separately.
System.Diagnostics.Debug.Assert(DetectedTargets.Count == (AvailableGameTargets.Count + AvailableClientTargets.Count + AvailableServerTargets.Count + AvailableEditorTargets.Count));
if (Client)
{
GameTarget = ChooseTarget(AvailableClientTargets, TargetType.Client);
ProjectType = TargetType.Client;
}
else if (AvailableGameTargets.Count > 0)
{
if (AvailableGameTargets.Count > 1)
{
StringBuilder TargetMessage = new StringBuilder("Multiple game targets found for project. Specify the desired target using the -Target=... argument.");
List Targets = DetectedTargets.FindAll(Target => Target.Rules.Type == TargetType.Game);
foreach (SingleTargetProperties Target in Targets)
{
// search the list of script files to see if we can find a likely source for this class
// {TargetName}.Target.cs is expected to contain a definition for a class {TargetName}Target
// So we can do an imperfect reverse-lookup, and try to find a source file that has the expected pattern.
List PossibleScriptFiles = Properties.TargetScripts.FindAll(File => String.Equals(File.GetFileNameWithoutAnyExtensions(), Target.TargetName));
if (PossibleScriptFiles.Count > 0)
{
TargetMessage.Append($"\n Could be \"{Target.TargetName}\" ({String.Join(" or ", PossibleScriptFiles)})");
}
else
{
TargetMessage.Append($"\n Could be \"{Target.TargetName}\"");
}
}
throw new AutomationException(TargetMessage.ToString());
}
GameTarget = AvailableGameTargets.First();
}
SelectDefaultEditorTarget(AvailableEditorTargets, ref EditorTarget);
if (AvailableServerTargets.Count > 0 && (DedicatedServer || Cook || CookOnTheFly)) // only if server is needed
{
ServerTarget = ChooseTarget(AvailableServerTargets, TargetType.Server);
}
}
else if (!CommandUtils.IsNullOrEmpty(Properties.Programs))
{
SingleTargetProperties TargetData = Properties.Programs[0];
ProjectType = TargetType.Program;
ProgramTarget = TargetData.TargetName;
GameTarget = TargetData.TargetName;
}
else if (!this.Build)
{
var ShortName = ProjectUtils.GetShortProjectName(RawProjectPath);
GameTarget = Client ? (ShortName + "Client") : ShortName;
EditorTarget = ShortName + "Editor";
ServerTarget = ShortName + "Server";
}
else
{
throw new AutomationException("{0} does not look like uproject file but no targets have been found!", RawProjectPath);
}
IsProgramTarget = ProjectType == TargetType.Program;
if (String.IsNullOrEmpty(EditorTarget) && !IsProgramTarget && CommandUtils.IsNullOrEmpty(EditorTargetsList))
{
if (Properties.bWasGenerated)
{
EditorTarget = "UnrealEditor";
}
else
{
throw new AutomationException("Editor target not found!");
}
}
if (EditorTargetsList == null)
{
if (!IsProgramTarget && !String.IsNullOrEmpty(EditorTarget))
{
EditorTargetsList = new ParamList(EditorTarget);
}
}
if (ProgramTargetsList == null)
{
if (IsProgramTarget)
{
ProgramTargetsList = new ParamList(ProgramTarget);
}
else
{
ProgramTargetsList = new ParamList();
}
}
// Compile a client if it was asked for (-client) or we're cooking and require a client
if (ClientCookedTargetsList == null)
{
if (!NoClient && (Cook || CookOnTheFly || Prebuilt || Client))
{
if (String.IsNullOrEmpty(GameTarget))
{
throw new AutomationException("Game target not found. Game target is required with -cook or -cookonthefly");
}
ClientCookedTargetsList = new ParamList(GameTarget);
if (ExtraTargetsToStageWithClient != null)
{
ClientCookedTargetsList.AddRange(ExtraTargetsToStageWithClient);
}
}
else
{
ClientCookedTargetsList = new ParamList();
}
}
// Compile a server if it was asked for (-server) or we're cooking and require a server
if (ServerCookedTargetsList == null)
{
/* Simplified from previous version which makes less sense.
TODO: tease out the actual dependencies between -cook and -server options, fix properly
if (DedicatedServer && (Cook || CookOnTheFly || DedicatedServer)) */
if (DedicatedServer)
{
if (String.IsNullOrEmpty(ServerTarget))
{
throw new AutomationException("Server target not found. Server target is required with -server and -cook or -cookonthefly");
}
ServerCookedTargetsList = new ParamList(ServerTarget);
}
else
{
ServerCookedTargetsList = new ParamList();
}
}
if (ProjectPlatformBinariesPaths == null || ProjectExePaths == null)
{
ProjectPlatformBinariesPaths = new Dictionary();
ProjectExePaths = new Dictionary();
var ProjectClientBinariesPath = ProjectUtils.GetClientProjectBinariesRootPath(RawProjectPath, ProjectType, Properties.bIsCodeBasedProject);
foreach (TargetPlatformDescriptor TargetPlatform in ClientTargetPlatforms)
{
DirectoryReference BinariesPath = ProjectUtils.GetProjectClientBinariesFolder(ProjectClientBinariesPath, TargetPlatform.Type);
ProjectPlatformBinariesPaths[TargetPlatform.Type] = BinariesPath;
ProjectExePaths[TargetPlatform.Type] = FileReference.Combine(BinariesPath, GameTarget + Platform.GetExeExtension(TargetPlatform.Type));
}
}
}
public bool HasEditorTargets
{
get { return !CommandUtils.IsNullOrEmpty(EditorTargets); }
}
public bool HasCookedTargets
{
get { return !CommandUtils.IsNullOrEmpty(ClientCookedTargets) || !CommandUtils.IsNullOrEmpty(ServerCookedTargets); }
}
public bool HasServerCookedTargets
{
get { return !CommandUtils.IsNullOrEmpty(ServerCookedTargets); }
}
public bool HasClientCookedTargets
{
get { return !CommandUtils.IsNullOrEmpty(ClientCookedTargets); }
}
public bool HasProgramTargets
{
get { return !CommandUtils.IsNullOrEmpty(ProgramTargets); }
}
public bool HasMapsToCook
{
get { return !CommandUtils.IsNullOrEmpty(MapsToCook); }
}
public bool HasMapIniSectionsToCook
{
get { return !CommandUtils.IsNullOrEmpty(MapIniSectionsToCook); }
}
public bool HasDirectoriesToCook
{
get { return !CommandUtils.IsNullOrEmpty(DirectoriesToCook); }
}
public bool HasIterateSharedCookedBuild
{
get { return !String.IsNullOrEmpty(IterateSharedCookedBuild); }
}
public bool HasDDCGraph
{
get { return !String.IsNullOrEmpty(DDCGraph); }
}
public bool HasInternationalizationPreset
{
get { return !String.IsNullOrEmpty(InternationalizationPreset); }
}
public bool HasCreateReleaseVersion
{
get { return !String.IsNullOrEmpty(CreateReleaseVersion); }
}
public bool HasBasedOnReleaseVersion
{
get { return !String.IsNullOrEmpty(BasedOnReleaseVersion); }
}
public bool HasOriginalReleaseVersion
{
get { return !String.IsNullOrEmpty(OriginalReleaseVersion); }
}
public bool HasAdditionalCookerOptions
{
get { return !String.IsNullOrEmpty(AdditionalCookerOptions); }
}
public bool HasDLCName
{
get { return DLCFile != null; }
}
public bool HasDiffCookedContentPath
{
get { return !String.IsNullOrEmpty(DiffCookedContentPath); }
}
public bool HasCulturesToCook
{
get { return CulturesToCook != null; }
}
public bool HasGameTargetDetected
{
get { return ProjectTargets.Exists(Target => Target.Rules.Type == TargetType.Game); }
}
public bool HasClientTargetDetected
{
get { return ProjectTargets.Exists(Target => Target.Rules.Type == TargetType.Client); }
}
public bool HasDedicatedServerAndClient
{
get { return Client && DedicatedServer; }
}
///
/// Project name (name of the uproject file without extension or directory name where the project is localed)
///
public string ShortProjectName
{
get { return ProjectUtils.GetShortProjectName(RawProjectPath); }
}
///
/// True if this project contains source code.
///
public bool IsCodeBasedProject
{
get
{
return bIsCodeBasedProject;
}
}
private bool bIsCodeBasedProject;
public FileReference CodeBasedUprojectPath
{
get { return IsCodeBasedProject ? RawProjectPath : null; }
}
///
/// True if this project is a program.
///
public bool IsProgramTarget { get; private set; }
///
/// Path where the project's game (or program) binaries are built for the given target platform.
///
public DirectoryReference GetProjectBinariesPathForPlatform(UnrealTargetPlatform InPlatform)
{
DirectoryReference Result = null;
ProjectPlatformBinariesPaths.TryGetValue(InPlatform, out Result);
return Result;
}
private Dictionary ProjectPlatformBinariesPaths;
///
/// Filename of the target game exe (or program exe) for the given target platform
///
public FileReference GetProjectExeForPlatform(UnrealTargetPlatform InPlatform)
{
FileReference Result = null;
ProjectExePaths.TryGetValue(InPlatform, out Result);
return Result;
}
private Dictionary ProjectExePaths;
///
/// Override for the computed based on release version path
///
public string BasedOnReleaseVersionPathOverride = null;
///
/// Get the path to the directory of the version we are basing a diff or a patch on.
///
public String GetBasedOnReleaseVersionPath(DeploymentContext SC, bool bIsClientOnly)
{
if (!string.IsNullOrEmpty(BasedOnReleaseVersionPathOverride))
{
return BasedOnReleaseVersionPathOverride;
}
String BasePath = BasedOnReleaseVersionBasePath;
String Platform = SC.StageTargetPlatform.GetCookPlatform(SC.DedicatedServer, bIsClientOnly);
if (String.IsNullOrEmpty(BasePath))
{
BasePath = CommandUtils.CombinePaths(SC.ProjectRoot.FullName, "Releases", BasedOnReleaseVersion, Platform);
}
else
{
BasePath = CommandUtils.CombinePaths(BasePath, BasedOnReleaseVersion, Platform);
}
return BasePath;
}
///
/// Get the path to the target directory for creating a new release version
///
public String GetCreateReleaseVersionPath(DeploymentContext SC, bool bIsClientOnly)
{
String BasePath = CreateReleaseVersionBasePath;
String Platform = SC.StageTargetPlatform.GetCookPlatform(SC.DedicatedServer, bIsClientOnly);
if (String.IsNullOrEmpty(BasePath))
{
BasePath = CommandUtils.CombinePaths(SC.ProjectRoot.FullName, "Releases", CreateReleaseVersion, Platform);
}
else
{
BasePath = CommandUtils.CombinePaths(BasePath, CreateReleaseVersion, Platform);
}
return BasePath;
}
///
/// Get the path to the directory of the originally released version we're using to generate a patch.
/// Only required by some platforms.
///
public String GetOriginalReleaseVersionPath(DeploymentContext SC, bool bIsClientOnly)
{
String BasePath = BasedOnReleaseVersionBasePath;
String Platform = SC.StageTargetPlatform.GetCookPlatform(SC.DedicatedServer, bIsClientOnly);
if (String.IsNullOrEmpty(BasePath))
{
BasePath = CommandUtils.CombinePaths(SC.ProjectRoot.FullName, "Releases", OriginalReleaseVersion, Platform);
}
else
{
BasePath = CommandUtils.CombinePaths(BasePath, OriginalReleaseVersion, Platform);
}
return BasePath;
}
///
/// True if we are generating a patch
///
public bool IsGeneratingPatch
{
get { return GeneratePatch; }
}
///
/// True if we are generating a new patch pak tier
///
public bool ShouldAddPatchLevel
{
get { return AddPatchLevel; }
}
///
/// True if we should stage pak files from the base release
///
public bool ShouldStageBaseReleasePaks
{
get { return StageBaseReleasePaks; }
}
public List ClientTargetPlatformInstances
{
get
{
List ClientPlatformInstances = new List();
foreach ( var ClientPlatform in ClientTargetPlatforms )
{
ClientPlatformInstances.Add(Platform.Platforms[ClientPlatform]);
}
return ClientPlatformInstances;
}
}
public TargetPlatformDescriptor GetCookedDataPlatformForClientTarget(TargetPlatformDescriptor TargetPlatformDesc)
{
if (ClientDependentPlatformMap.ContainsKey(TargetPlatformDesc))
{
return ClientDependentPlatformMap[TargetPlatformDesc];
}
return TargetPlatformDesc;
}
public List ServerTargetPlatformInstances
{
get
{
List ServerPlatformInstances = new List();
foreach (var ServerPlatform in ServerTargetPlatforms)
{
ServerPlatformInstances.Add(Platform.Platforms[ServerPlatform]);
}
return ServerPlatformInstances;
}
}
public TargetPlatformDescriptor GetCookedDataPlatformForServerTarget(TargetPlatformDescriptor TargetPlatformType)
{
if (ServerDependentPlatformMap.ContainsKey(TargetPlatformType))
{
return ServerDependentPlatformMap[TargetPlatformType];
}
return TargetPlatformType;
}
///
/// All auto-detected targets for this project
///
public List ProjectTargets
{
get
{
if (DetectedTargets == null)
{
AutodetectSettings(false);
}
return DetectedTargets;
}
}
///
/// List of all Engine ini files for this project
///
public Dictionary EngineConfigs
{
get
{
if (LoadedEngineConfigs == null)
{
AutodetectSettings(false);
}
return LoadedEngineConfigs;
}
}
///
/// List of all Game ini files for this project
///
public Dictionary GameConfigs
{
get
{
if (LoadedGameConfigs == null)
{
AutodetectSettings(false);
}
return LoadedGameConfigs;
}
}
public void Validate()
{
if (RawProjectPath == null)
{
throw new AutomationException("RawProjectPath can't be empty.");
}
if (!RawProjectPath.HasExtension(".uproject"))
{
throw new AutomationException("RawProjectPath {0} must end with .uproject", RawProjectPath);
}
if (!CommandUtils.FileExists(RawProjectPath.FullName))
{
throw new AutomationException("RawProjectPath {0} file must exist", RawProjectPath);
}
if (FileServer && !Cook && !CookInEditor)
{
throw new AutomationException("Only cooked builds can use a fileserver, use -cook or -CookInEditor");
}
if (Stage && !SkipStage && !Cook && !CookOnTheFly && !IsProgramTarget)
{
throw new AutomationException("Only cooked builds or programs can be staged, use -cook or -cookonthefly.");
}
if (Manifests && !Cook && !Stage && !Pak)
{
throw new AutomationException("Only staged pakd and cooked builds can generate streaming install manifests");
}
if (Pak && !Stage)
{
throw new AutomationException("Only staged builds can be paked, use -stage or -skipstage.");
}
if (Deploy && !Stage)
{
throw new AutomationException("Only staged builds can be deployed, use -stage or -skipstage.");
}
if ((Pak || Stage || Cook || CookOnTheFly || FileServer || DedicatedServer) && EditorTest)
{
throw new AutomationException("None of pak, stage, cook, CookOnTheFly or DedicatedServer can be used with EditorTest");
}
if (DedicatedServer && RunAutomationTests)
{
throw new AutomationException("DedicatedServer cannot be used with RunAutomationTests");
}
if ((CookOnTheFly || FileServer) && DedicatedServer)
{
throw new AutomationException("Don't use either -cookonthefly or -fileserver with -server.");
}
if (NoClient && !DedicatedServer && !CookOnTheFly)
{
throw new AutomationException("-noclient can only be used with -server or -cookonthefly.");
}
if (Build && !HasCookedTargets && !HasEditorTargets && !HasProgramTargets)
{
throw new AutomationException("-build is specified but there are no targets to build.");
}
if (Pak && FileServer)
{
throw new AutomationException("Can't use -pak and -fileserver at the same time.");
}
if (Cook && CookOnTheFly)
{
throw new AutomationException("Can't use both -cook and -cookonthefly.");
}
if (!HasDLCName && DLCIncludeEngineContent)
{
throw new AutomationException("DLCIncludeEngineContent flag is only valid when building DLC.");
}
if (!HasDLCName && DLCPakPluginFile )
{
throw new AutomationException("DLCPakPluginFile flag is only valid when building DLC.");
}
if ((IsGeneratingPatch || HasDLCName || ShouldAddPatchLevel) && !HasBasedOnReleaseVersion)
{
throw new AutomationException("Require based on release version to build patches or dlc");
}
if (ShouldAddPatchLevel && !IsGeneratingPatch)
{
throw new AutomationException("Creating a new patch tier requires patch generation");
}
if (ShouldStageBaseReleasePaks && !HasBasedOnReleaseVersion)
{
throw new AutomationException("Staging pak files from the base release requires a base release version");
}
if (HasCreateReleaseVersion && HasDLCName)
{
throw new AutomationException("Can't create a release version at the same time as creating dlc.");
}
if (HasBasedOnReleaseVersion && (IterativeCooking || IterativeDeploy || HasIterateSharedCookedBuild))
{
throw new AutomationException("Can't use iterative cooking / deploy on dlc or patching or creating a release");
}
/*if (Compressed && !Pak)
{
throw new AutomationException("-compressed can only be used with -pak");
}*/
if (CreateChunkInstall && (!(Manifests || HasDLCName) || !Stage))
{
throw new AutomationException("-createchunkinstall can only be used with -manifests & -stage");
}
if (CreateChunkInstall && String.IsNullOrEmpty(ChunkInstallDirectory))
{
throw new AutomationException("-createchunkinstall must specify the chunk install data directory with -chunkinstalldirectory=");
}
if (CreateChunkInstall && String.IsNullOrEmpty(ChunkInstallVersionString))
{
throw new AutomationException("-createchunkinstall must specify the chunk install data version string with -chunkinstallversion=");
}
}
protected bool bLogged = false;
public virtual void ValidateAndLog()
{
// Avoid spamming, log only once
if (!bLogged)
{
// In alphabetical order.
CommandUtils.LogLog("Project Params **************");
CommandUtils.LogLog("AdditionalServerMapParams={0}", AdditionalServerMapParams);
CommandUtils.LogLog("Archive={0}", Archive);
CommandUtils.LogLog("ArchiveMetaData={0}", ArchiveMetaData);
CommandUtils.LogLog("CreateAppBundle={0}", CreateAppBundle);
CommandUtils.LogLog("BaseArchiveDirectory={0}", BaseArchiveDirectory);
CommandUtils.LogLog("BaseStageDirectory={0}", BaseStageDirectory);
CommandUtils.LogLog("Build={0}", Build);
CommandUtils.LogLog("SkipBuildClient={0}", SkipBuildClient);
CommandUtils.LogLog("SkipBuildEditor={0}", SkipBuildEditor);
CommandUtils.LogLog("Cook={0}", Cook);
CommandUtils.LogLog("Clean={0}", Clean);
CommandUtils.LogLog("Client={0}", Client);
CommandUtils.LogLog("ClientConfigsToBuild={0}", string.Join(",", ClientConfigsToBuild));
CommandUtils.LogLog("ClientCookedTargets={0}", ClientCookedTargets.ToString());
CommandUtils.LogLog("ClientTargetPlatform={0}", string.Join(",", ClientTargetPlatforms));
CommandUtils.LogLog("Compressed={0}", Compressed);
CommandUtils.LogLog("ForceUncompressed={0}", ForceUncompressed);
CommandUtils.LogLog("AdditionalPakOptions={0}", AdditionalPakOptions);
CommandUtils.LogLog("AdditionalIoStoreOptions={0}", AdditionalIoStoreOptions);
CommandUtils.LogLog("CookOnTheFly={0}", CookOnTheFly);
CommandUtils.LogLog("CookOnTheFlyStreaming={0}", CookOnTheFlyStreaming);
CommandUtils.LogLog("UnversionedCookedContent={0}", UnversionedCookedContent);
CommandUtils.LogLog("SkipCookingEditorContent={0}", SkipCookingEditorContent);
CommandUtils.LogLog("NumCookersToSpawn={0}", NumCookersToSpawn);
CommandUtils.LogLog("GeneratePatch={0}", GeneratePatch);
CommandUtils.LogLog("AddPatchLevel={0}", AddPatchLevel);
CommandUtils.LogLog("StageBaseReleasePaks={0}", StageBaseReleasePaks);
CommandUtils.LogLog("DiscVersion={0}", DiscVersion);
CommandUtils.LogLog("CreateReleaseVersion={0}", CreateReleaseVersion);
CommandUtils.LogLog("BasedOnReleaseVersion={0}", BasedOnReleaseVersion);
CommandUtils.LogLog("OriginalReleaseVersion={0}", OriginalReleaseVersion);
CommandUtils.LogLog("DLCFile={0}", DLCFile);
CommandUtils.LogLog("DLCIncludeEngineContent={0}", DLCIncludeEngineContent);
CommandUtils.LogLog("DLCPakPluginFile={0}", DLCPakPluginFile);
CommandUtils.LogLog("DLCOverrideCookedSubDir={0}", DLCOverrideCookedSubDir);
CommandUtils.LogLog("DLCOverrideStagedSubDir={0}", DLCOverrideStagedSubDir);
CommandUtils.LogLog("DiffCookedContentPath={0}", DiffCookedContentPath);
CommandUtils.LogLog("AdditionalCookerOptions={0}", AdditionalCookerOptions);
CommandUtils.LogLog("DedicatedServer={0}", DedicatedServer);
CommandUtils.LogLog("DirectoriesToCook={0}", DirectoriesToCook.ToString());
CommandUtils.LogLog("DDCGraph={0}", DDCGraph);
CommandUtils.LogLog("CulturesToCook={0}", CommandUtils.IsNullOrEmpty(CulturesToCook) ? " (Use Defaults)" : CulturesToCook.ToString());
CommandUtils.LogLog("EditorTargets={0}", EditorTargets.ToString());
CommandUtils.LogLog("Foreign={0}", Foreign);
CommandUtils.LogLog("IsCodeBasedProject={0}", IsCodeBasedProject.ToString());
CommandUtils.LogLog("IsProgramTarget={0}", IsProgramTarget.ToString());
CommandUtils.LogLog("IterativeCooking={0}", IterativeCooking);
CommandUtils.LogLog("IterateSharedCookedBuild={0}", IterateSharedCookedBuild);
CommandUtils.LogLog("IterateSharedBuildUsePrecompiledExe={0}", IterateSharedBuildUsePrecompiledExe);
CommandUtils.LogLog("CookAll={0}", CookAll);
CommandUtils.LogLog("CookPartialGC={0}", CookPartialGC);
CommandUtils.LogLog("CookInEditor={0}", CookInEditor);
CommandUtils.LogLog("CookMapsOnly={0}", CookMapsOnly);
CommandUtils.LogLog("Deploy={0}", Deploy);
CommandUtils.LogLog("IterativeDeploy={0}", IterativeDeploy);
CommandUtils.LogLog("FastCook={0}", FastCook);
CommandUtils.LogLog("LogWindow={0}", LogWindow);
CommandUtils.LogLog("Manifests={0}", Manifests);
CommandUtils.LogLog("MapToRun={0}", MapToRun);
CommandUtils.LogLog("NoClient={0}", NoClient);
CommandUtils.LogLog("NumClients={0}", NumClients);
CommandUtils.LogLog("NoDebugInfo={0}", NoDebugInfo);
CommandUtils.LogLog("SeparateDebugInfo={0}", SeparateDebugInfo);
CommandUtils.LogLog("MapFile={0}", MapFile);
CommandUtils.LogLog("NoCleanStage={0}", NoCleanStage);
CommandUtils.LogLog("NoXGE={0}", NoXGE);
CommandUtils.LogLog("MapsToCook={0}", MapsToCook.ToString());
CommandUtils.LogLog("MapIniSectionsToCook={0}", MapIniSectionsToCook.ToString());
CommandUtils.LogLog("Pak={0}", Pak);
CommandUtils.LogLog("IgnorePaksFromDifferentCookSource={0}", IgnorePaksFromDifferentCookSource);
CommandUtils.LogLog("IoStore={0}", IoStore);
CommandUtils.LogLog("SkipIoStore={0}", SkipIoStore);
CommandUtils.LogLog("Cook4IoStore={0}", Cook4IoStore);
CommandUtils.LogLog("ZenStore={0}", ZenStore);
CommandUtils.LogLog("SkipEncryption={0}", SkipEncryption);
CommandUtils.LogLog("GenerateOptimizationData={0}", GenerateOptimizationData);
CommandUtils.LogLog("SkipPackage={0}", SkipPackage);
CommandUtils.LogLog("Package={0}", Package);
CommandUtils.LogLog("ForcePackageData={0}", ForcePackageData);
CommandUtils.LogLog("NullRHI={0}", NullRHI);
CommandUtils.LogLog("FakeClient={0}", FakeClient);
CommandUtils.LogLog("EditorTest={0}", EditorTest);
CommandUtils.LogLog("RunAutomationTests={0}", RunAutomationTests);
CommandUtils.LogLog("RunAutomationTest={0}", RunAutomationTest);
CommandUtils.LogLog("RunTimeoutSeconds={0}", RunTimeoutSeconds);
CommandUtils.LogLog("CrashIndex={0}", CrashIndex);
CommandUtils.LogLog("ProgramTargets={0}", ProgramTargets.ToString());
CommandUtils.LogLog("ProjectPlatformBinariesPaths={0}", string.Join(",", ProjectPlatformBinariesPaths));
CommandUtils.LogLog("ProjectExePaths={0}", string.Join(",", ProjectExePaths));
CommandUtils.LogLog("Distribution={0}", Distribution);
CommandUtils.LogLog("PackageEncryptionKeyFile={0}", PackageEncryptionKeyFile);
CommandUtils.LogLog("Prebuilt={0}", Prebuilt);
CommandUtils.LogLog("Prereqs={0}", Prereqs);
CommandUtils.LogLog("AppLocalDirectory={0}", AppLocalDirectory);
CommandUtils.LogLog("NoBootstrapExe={0}", NoBootstrapExe);
CommandUtils.LogLog("RawProjectPath={0}", RawProjectPath);
CommandUtils.LogLog("Run={0}", Run);
CommandUtils.LogLog("ServerConfigsToBuild={0}", string.Join(",", ServerConfigsToBuild));
CommandUtils.LogLog("ServerCookedTargets={0}", ServerCookedTargets.ToString());
CommandUtils.LogLog("ServerTargetPlatform={0}", string.Join(",", ServerTargetPlatforms));
CommandUtils.LogLog("ShortProjectName={0}", ShortProjectName.ToString());
CommandUtils.LogLog("SignedPak={0}", SignedPak);
CommandUtils.LogLog("SignPak={0}", SignPak);
CommandUtils.LogLog("SkipCook={0}", SkipCook);
CommandUtils.LogLog("SkipCookOnTheFly={0}", SkipCookOnTheFly);
CommandUtils.LogLog("SkipPak={0}", SkipPak);
CommandUtils.LogLog("PrePak={0}", PrePak);
CommandUtils.LogLog("SkipStage={0}", SkipStage);
CommandUtils.LogLog("Stage={0}", Stage);
CommandUtils.LogLog("bTreatNonShippingBinariesAsDebugFiles={0}", bTreatNonShippingBinariesAsDebugFiles);
CommandUtils.LogLog("bUseExtraFlavor={0}", bUseExtraFlavor);
CommandUtils.LogLog("StageDirectoryParam={0}", StageDirectoryParam);
CommandUtils.LogLog("AdditionalPackageOptions={0}", AdditionalPackageOptions);
CommandUtils.LogLog("Project Params **************");
}
bLogged = true;
Validate();
}
}
}