Add Cook&Run and Run cooked game utilities to Game menu list for multilayer games testing

Source/Editor/Cooker/CookingData.h

@@ -26,6 +26,16 @@ API_ENUM(Attributes="Flags") enum class BuildOptions
     /// Shows the output directory folder on building end.
     /// </summary>
     ShowOutput = 1 << 0,
+
+    /// <summary>
+    /// Starts the cooked game build on building end.
+    /// </summary>
+    AutoRun = 1 << 1,
+
+    /// <summary>
+    /// Skips cooking logic and uses already cooked data (eg. to only use AutoRun or ShowOutput feature).
+    /// </summary>
+    NoCook = 1 << 2,
 };
 
 DECLARE_ENUM_OPERATORS(BuildOptions);

Source/Editor/Cooker/GameCooker.cpp

@@ -430,6 +430,52 @@ void GameCooker::Cancel(bool waitForEnd)
     }
 }
 
+void GameCooker::GetCurrentPlatform(PlatformType& platform, BuildPlatform& buildPlatform, BuildConfiguration& buildConfiguration)
+{
+    platform = PLATFORM_TYPE;
+#if BUILD_DEBUG
+    buildConfiguration = BuildConfiguration::Debug;
+#elif BUILD_DEVELOPMENT
+    buildConfiguration = BuildConfiguration::Development;
+#elif BUILD_RELEASE
+    buildConfiguration = BuildConfiguration::Release;
+#endif
+    switch (PLATFORM_TYPE)
+    {
+    case PlatformType::Windows:
+        buildPlatform = PLATFORM_64BITS ? BuildPlatform::Windows64 : BuildPlatform::Windows32;
+        break;
+    case PlatformType::XboxOne:
+        buildPlatform = BuildPlatform::XboxOne;
+        break;
+    case PlatformType::UWP:
+        buildPlatform = BuildPlatform::UWPx64;
+        break;
+    case PlatformType::Linux:
+        buildPlatform = BuildPlatform::LinuxX64;
+        break;
+    case PlatformType::PS4:
+        buildPlatform = BuildPlatform::PS4;
+        break;
+    case PlatformType::XboxScarlett:
+        buildPlatform = BuildPlatform::XboxScarlett;
+        break;
+    case PlatformType::Android:
+        buildPlatform = BuildPlatform::AndroidARM64;
+        break;
+    case PlatformType::Switch:
+        buildPlatform = BuildPlatform::Switch;
+        break;
+    case PlatformType::PS5:
+        buildPlatform = BuildPlatform::PS5;
+        break;
+    case PlatformType::Mac:
+        buildPlatform = BuildPlatform::MacOSx64;
+        break;
+    default: ;
+    }
+}
+
 void GameCookerImpl::CallEvent(GameCooker::EventType type)
 {
     if (Internal_OnEvent == nullptr)
@@ -492,7 +538,6 @@ bool GameCookerImpl::Build()
     // Late init feature
     if (Steps.IsEmpty())
     {
-        // Create steps
         Steps.Add(New<ValidateStep>());
         Steps.Add(New<CompileScriptsStep>());
         Steps.Add(New<DeployDataStep>());
@@ -517,6 +562,8 @@ bool GameCookerImpl::Build()
     {
         if (GameCooker::IsCancelRequested())
             break;
+        if (data.Options & BuildOptions::NoCook)
+            continue;
         auto step = Steps[stepIndex];
         data.NextStep();
 
@@ -544,6 +591,24 @@ bool GameCookerImpl::Build()
         {
             FileSystem::ShowFileExplorer(data.OriginalOutputPath);
         }
+
+        if (data.Options & BuildOptions::AutoRun)
+        {
+            String executableFile, commandLineFormat, workingDir;
+            data.Tools->OnRun(data, executableFile, commandLineFormat, workingDir);
+            if (executableFile.HasChars())
+            {
+                const String gameArgs; // TODO: pass custom game run args from Editor? eg. starting map? or client info?
+                const String commandLine = commandLineFormat.HasChars() ? String::Format(*commandLineFormat, gameArgs) : gameArgs;
+                if (workingDir.IsEmpty())
+                    workingDir = data.NativeCodeOutputPath;
+                Platform::StartProcess(executableFile, commandLine, workingDir);
+            }
+            else
+            {
+                LOG(Warning, "Missing executable to run or platform doesn't support build&run.");
+            }
+        }
     }
     IsRunning = false;
     CancelFlag = 0;

Source/Editor/Cooker/GameCooker.h

@@ -90,6 +90,11 @@ public:
     /// <param name="waitForEnd">If set to <c>true</c> wait for the stopped building end.</param>
     API_FUNCTION() static void Cancel(bool waitForEnd = false);
 
+    /// <summary>
+    /// Gets the current Editor build info (platform, configuration, etc).
+    /// </summary>
+    API_FUNCTION() static void GetCurrentPlatform(API_PARAM(Out) PlatformType& platform, API_PARAM(Out) BuildPlatform& buildPlatform, API_PARAM(Out) BuildConfiguration& buildConfiguration);
+
     /// <summary>
     /// Building event type.
     /// </summary>

Source/Editor/Cooker/Platform/Windows/WindowsPlatformTools.cpp

@@ -36,11 +36,10 @@ ArchitectureType WindowsPlatformTools::GetArchitecture() const
 bool WindowsPlatformTools::OnDeployBinaries(CookingData& data)
 {
     const auto platformSettings = WindowsPlatformSettings::Get();
-    const auto& outputPath = data.NativeCodeOutputPath;
 
     // Apply executable icon
     Array<String> files;
-    FileSystem::DirectoryGetFiles(files, outputPath, TEXT("*.exe"), DirectorySearchOption::TopDirectoryOnly);
+    FileSystem::DirectoryGetFiles(files, data.NativeCodeOutputPath, TEXT("*.exe"), DirectorySearchOption::TopDirectoryOnly);
     if (files.HasItems())
     {
         TextureData iconData;
@@ -57,4 +56,15 @@ bool WindowsPlatformTools::OnDeployBinaries(CookingData& data)
     return false;
 }
 
+void WindowsPlatformTools::OnRun(CookingData& data, String& executableFile, String& commandLineFormat, String& workingDir)
+{
+    // Pick the first executable file
+    Array<String> files;
+    FileSystem::DirectoryGetFiles(files, data.NativeCodeOutputPath, TEXT("*.exe"), DirectorySearchOption::TopDirectoryOnly);
+    if (files.HasItems())
+    {
+        executableFile = files[0];
+    }
+}
+
 #endif

Source/Editor/Cooker/Platform/Windows/WindowsPlatformTools.h

@@ -30,6 +30,7 @@ public:
     PlatformType GetPlatform() const override;
     ArchitectureType GetArchitecture() const override;
     bool OnDeployBinaries(CookingData& data) override;
+    void OnRun(CookingData& data, String& executableFile, String& commandLineFormat, String& workingDir) override;
 };
 
 #endif

Source/Editor/Cooker/PlatformTools.h

@@ -203,4 +203,15 @@ public:
     {
         return false;
     }
+
+    /// <summary>
+    /// Called to run the cooked game build on device.
+    /// </summary>
+    /// <param name="data">The cooking data.</param>
+    /// <param name="executableFile">The game executable file path to run (or tool path to run if build should run on remote device). Empty if not supported.</param>
+    /// <param name="commandLineFormat">The command line for executable file. Use `{0}` to insert custom command line for passing to the cooked game.</param>
+    /// <param name="workingDir">Overriden custom working directory to use. Leave empty if use cooked data output folder.</param>
+    virtual void OnRun(CookingData& data, String& executableFile, String& commandLineFormat, String& workingDir)
+    {
+    }
 };