Files
UnrealEngineUWP/Engine/Source/Editor/TurnkeySupport/Private/TurnkeySupportModule.cpp
jeff newquist 5cb01d9cbd Disable sdk installation documentation menu item until we have URLs to go with
#jira UE-121554
#rb David.Harvey, Nuno.Leira
#preflight 621ee861147b1b1965e54871

#ROBOMERGE-OWNER: jeff.newquist
#ROBOMERGE-AUTHOR: jeff.newquist
#ROBOMERGE-SOURCE: CL 19221217 in //UE5/Release-5.0/... via CL 19224679
#ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v921-19075845)

[CL 19229240 by jeff newquist in ue5-main branch]
2022-03-02 16:11:57 -05:00

2230 lines
81 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#include "TurnkeySupportModule.h"
#include "TurnkeySupport.h"
#include "SlateOptMacros.h"
#include "Widgets/Images/SImage.h"
#include "Widgets/Layout/SBox.h"
#include "Widgets/Input/SButton.h"
#include "Widgets/SToolTip.h"
#include "MessageLogModule.h"
#include "Framework/Notifications/NotificationManager.h"
#include "Widgets/Notifications/SNotificationList.h"
#include "Widgets/Input/SEditableTextBox.h"
#include "Misc/MessageDialog.h"
#include "HAL/PlatformFileManager.h"
#include "ITargetDeviceServicesModule.h"
#include "Misc/DataDrivenPlatformInfoRegistry.h"
#include "Async/Async.h"
#include "HAL/Event.h"
#include "Misc/FileHelper.h"
#include "Misc/ConfigCacheIni.h"
#include "Delegates/Delegate.h"
#include "Interfaces/TargetDeviceId.h"
#include "Interfaces/ITargetPlatform.h"
#include "Interfaces/ITargetPlatformManagerModule.h"
#include "Interfaces/IProjectManager.h"
#include "SourceControlHelpers.h"
#include "ISourceControlModule.h"
#include "ITargetDeviceProxy.h"
#include "ITargetDeviceServicesModule.h"
#include "Settings/ProjectPackagingSettings.h" // can go away once turnkey menu handles Package
#include "IDesktopPlatform.h"
#include "DesktopPlatformModule.h"
#include "PlatformInfo.h"
#include "InstalledPlatformInfo.h"
#include "Framework/Commands/Commands.h"
#include "Framework/Docking/TabManager.h"
#include "Framework/MultiBox/MultiBoxBuilder.h"
#include "Developer/DerivedDataCache/Public/DerivedDataCacheInterface.h"
#include "Misc/MonitoredProcess.h"
#include "EditorStyleSet.h"
#include "CookerSettings.h"
#include "UObject/UObjectIterator.h"
#include "ToolMenus.h"
#include "TurnkeyEditorSupport.h"
#include "ITurnkeyIOModule.h"
#if WITH_EDITOR
#include "ZenServerInterface.h"
#endif
#include "Misc/App.h"
#include "Framework/Application/SlateApplication.h"
#if WITH_ENGINE
#include "RenderUtils.h"
#endif
DEFINE_LOG_CATEGORY(LogTurnkeySupport);
#define LOCTEXT_NAMESPACE "FTurnkeySupportModule"
namespace
{
FCriticalSection GTurnkeySection;
}
static FString GetProjectPathForTurnkey()
{
if (FPaths::IsProjectFilePathSet())
{
return FPaths::ConvertRelativePathToFull(FPaths::GetProjectFilePath());
}
if (FApp::HasProjectName())
{
FString ProjectPath = FPaths::ProjectDir() / FApp::GetProjectName() + TEXT(".uproject");
if (FPaths::FileExists(ProjectPath))
{
return ProjectPath;
}
ProjectPath = FPaths::RootDir() / FApp::GetProjectName() / FApp::GetProjectName() + TEXT(".uproject");
if (FPaths::FileExists(ProjectPath))
{
return ProjectPath;
}
}
return FString();
}
enum class EPrepareContentMode : uint8
{
CookOnly,
Package,
PrepareForDebugging,
};
class FTurnkeySupportCallbacks
{
protected:
static const TCHAR* GetUATCompilationFlags()
{
// We never want to compile editor targets when invoking UAT in this context.
// If we are installed or don't have a compiler, we must assume we have a precompiled UAT.
return TEXT("-nocompileeditor -skipbuildeditor");
}
static bool ShowBadSDKDialog(FName IniPlatformName)
{
// Don't show the warning during automation testing; the dlg is modal and blocks
if (!GIsAutomationTesting)
{
FFormatNamedArguments Args;
// Args.Add(TEXT("DisplayName"), PlatformInfo->DisplayName);
Args.Add(TEXT("DisplayName"), FText::FromName(IniPlatformName));
FText WarningText = FText::Format(LOCTEXT("BadSDK_Message", "The SDK for {DisplayName} is not installed properly, which is needed to generate data. Check the SDK section of the Launch On menu in the main toolbar to update SDK.\n\nWould you like to attempt to continue anyway?"), Args);
bool bClickedOK = FTurnkeyEditorSupport::ShowOKCancelDialog(WarningText, LOCTEXT("BadSDK_Title", "SDK Not Setup"));
return bClickedOK;
}
return true;
}
static bool ShouldBuildProject(UProjectPackagingSettings* PackagingSettings, const ITargetPlatform* TargetPlatform)
{
const UProjectPackagingSettings::FConfigurationInfo& ConfigurationInfo = UProjectPackagingSettings::ConfigurationInfo[(int)PackagingSettings->BuildConfiguration];
// Get the target to build
const FTargetInfo* Target = PackagingSettings->GetBuildTargetInfo();
// Only build if the user elects to do so
bool bBuild = false;
if (PackagingSettings->Build == EProjectPackagingBuild::Always)
{
bBuild = true;
}
else if (PackagingSettings->Build == EProjectPackagingBuild::Never)
{
bBuild = false;
}
else if (PackagingSettings->Build == EProjectPackagingBuild::IfProjectHasCode)
{
bBuild = true;
if (FApp::GetEngineIsPromotedBuild())
{
FString BaseDir;
// Get the target name
FString TargetName;
if (Target == nullptr)
{
TargetName = TEXT("UnrealGame");
}
else
{
TargetName = Target->Name;
}
// Get the directory containing the receipt for this target, depending on whether the project needs to be built or not
FString ProjectDir = FPaths::GetPath(FPaths::GetProjectFilePath());
if (Target != nullptr && FPaths::IsUnderDirectory(Target->Path, ProjectDir))
{
UE_LOG(LogTurnkeySupport, Log, TEXT("Selected target: %s"), *Target->Name);
BaseDir = ProjectDir;
}
else
{
FText Reason;
if (TargetPlatform->RequiresTempTarget(FTurnkeyEditorSupport::DoesProjectHaveCode(), ConfigurationInfo.Configuration, false, Reason))
{
UE_LOG(LogTurnkeySupport, Log, TEXT("Project requires temp target (%s)"), *Reason.ToString());
BaseDir = ProjectDir;
}
else
{
UE_LOG(LogTurnkeySupport, Log, TEXT("Project does not require temp target"));
BaseDir = FPaths::EngineDir();
}
}
// Check if the receipt is for a matching promoted target
FString UBTPlatformName = TargetPlatform->GetTargetPlatformInfo().DataDrivenPlatformInfo->UBTPlatformString;
extern LAUNCHERSERVICES_API bool HasPromotedTarget(const TCHAR * BaseDir, const TCHAR * TargetName, const TCHAR * Platform, EBuildConfiguration Configuration, const TCHAR * Architecture);
if (HasPromotedTarget(*BaseDir, *TargetName, *UBTPlatformName, ConfigurationInfo.Configuration, nullptr))
{
bBuild = false;
}
}
}
else if (PackagingSettings->Build == EProjectPackagingBuild::IfEditorWasBuiltLocally)
{
bBuild = !FApp::GetEngineIsPromotedBuild();
}
return bBuild;
}
public:
static void OpenProjectLauncher()
{
FGlobalTabmanager::Get()->TryInvokeTab(FTabId("ProjectLauncher"));
}
static void OpenDeviceManager()
{
FGlobalTabmanager::Get()->TryInvokeTab(FTabId("DeviceManager"));
}
static bool CanCookOrPackage(FName IniPlatformName, EPrepareContentMode Mode)
{
if (GetTargetPlatformManager()->FindTargetPlatform(IniPlatformName.ToString()) == nullptr)
{
return false;
}
// // PrepForDebugging needs the platform to specify how
// if (Mode == EPrepareContentMode::PrepareForDebugging)
// {
// return FDataDrivenPlatformInfoRegistry::GetPlatformInfo(IniPlatformName).PrepareForDebuggingOptions != TEXT("");
// }
return true;
}
static UProjectPackagingSettings* GetPackagingSettingsForPlatform(FName IniPlatformName)
{
FString PlatformString = IniPlatformName.ToString();
UProjectPackagingSettings* PackagingSettings = nullptr;
for (TObjectIterator<UProjectPackagingSettings> Itr; Itr; ++Itr)
{
if (Itr->GetConfigPlatform() == PlatformString)
{
PackagingSettings = *Itr;
break;
}
}
if (PackagingSettings == nullptr)
{
PackagingSettings = NewObject<UProjectPackagingSettings>(GetTransientPackage());
// Prevent object from being GCed.
PackagingSettings->AddToRoot();
// make sure any changes to DefaultGame are updated in this class
PackagingSettings->LoadSettingsForPlatform(PlatformString);
}
return PackagingSettings;
}
static void CookOrPackage(FName IniPlatformName, EPrepareContentMode Mode)
{
// get a in-memory defaults which will have the user-settings, like the per-platform config/target platform stuff
UProjectPackagingSettings* AllPlatformPackagingSettings = GetMutableDefault<UProjectPackagingSettings>();
// installed builds only support standard Game type builds (not Client, Server, etc) so instead of looking up a setting that the user can't set,
// always use the base PlatformInfo for Game builds, which will be named the same as the platform itself
const PlatformInfo::FTargetPlatformInfo* PlatformInfo = nullptr;
if(FApp::IsInstalled())
{
PlatformInfo = PlatformInfo::FindPlatformInfo(IniPlatformName);
}
else
{
PlatformInfo = PlatformInfo::FindPlatformInfo(AllPlatformPackagingSettings->GetTargetFlavorForPlatform(IniPlatformName));
}
// this is unexpected to be able to happen, but it could if there was a bad value saved in the UProjectPackagingSettings - if this trips, we should handle errors
check(PlatformInfo != nullptr);
const FString UBTPlatformString = PlatformInfo->DataDrivenPlatformInfo->UBTPlatformString;
const FString ProjectPath = GetProjectPathForTurnkey();
// check that we can proceed
{
if (FInstalledPlatformInfo::Get().IsPlatformMissingRequiredFile(UBTPlatformString))
{
if (!FInstalledPlatformInfo::OpenInstallerOptions())
{
FMessageDialog::Open(EAppMsgType::Ok, LOCTEXT("MissingPlatformFilesCook", "Missing required files to cook for this platform."));
}
return;
}
if (!FTurnkeyEditorSupport::CheckSupportedPlatforms(IniPlatformName))
{
return;
}
if (ITurnkeySupportModule::Get().GetSdkInfo(IniPlatformName).Status != ETurnkeyPlatformSdkStatus::Valid && ShowBadSDKDialog(IniPlatformName) == false)
{
return;
}
}
// force a save of dirty packages before proceeding to run UAT
// this may delete UProjectPackagingSettings , don't hold it across this call
FTurnkeyEditorSupport::SaveAll();
// get all the helper objects
UProjectPackagingSettings* PackagingSettings = GetPackagingSettingsForPlatform(IniPlatformName);
// basic BuildCookRun params we always want
FString BuildCookRunParams = FString::Printf(TEXT("-nop4 -utf8output %s -cook "), GetUATCompilationFlags());
// set locations to engine and project
if (!ProjectPath.IsEmpty())
{
BuildCookRunParams += FString::Printf(TEXT(" -project=\"%s\""), *ProjectPath);
}
bool bIsProjectBuildTarget = false;
const FTargetInfo* BuildTargetInfo = AllPlatformPackagingSettings->GetBuildTargetInfoForPlatform(IniPlatformName, bIsProjectBuildTarget);
// Only add the -Target=... argument for code projects. Content projects will return UnrealGame/UnrealClient/UnrealServer here, but
// may need a temporary target generated to enable/disable plugins. Specifying -Target in these cases will cause packaging to fail,
// since it'll have a different name.
if (BuildTargetInfo && bIsProjectBuildTarget)
{
BuildCookRunParams += FString::Printf(TEXT(" -target=%s"), *BuildTargetInfo->Name);
}
// let the editor add options (-unrealexe in particular)
{
BuildCookRunParams += FString::Printf(TEXT(" %s"), *FTurnkeyEditorSupport::GetUATOptions());
}
// set the platform we are preparing content for
{
BuildCookRunParams += FString::Printf(TEXT(" -platform=%s"), *UBTPlatformString);
}
// Append any extra UAT flags specified for this platform flavor
if (!PlatformInfo->UATCommandLine.IsEmpty())
{
BuildCookRunParams += FString::Printf(TEXT(" %s"), *PlatformInfo->UATCommandLine);
}
// optional settings
if (PackagingSettings->bSkipEditorContent)
{
BuildCookRunParams += TEXT(" -SkipCookingEditorContent");
}
if (FDerivedDataCacheInterface* DDC = GetDerivedDataCache())
{
BuildCookRunParams += FString::Printf(TEXT(" -ddc=%s"), DDC->GetGraphName());
}
if (FApp::IsEngineInstalled())
{
BuildCookRunParams += TEXT(" -installed");
}
if (PackagingSettings->bUseZenStore)
{
#if WITH_EDITOR && UE_WITH_ZEN
static UE::Zen::FScopeZenService TurnkeyStaticZenService;
#endif
BuildCookRunParams += TEXT(" -zenstore");
}
// per mode settings
FText ContentPrepDescription;
FText ContentPrepTaskName;
const FSlateBrush* ContentPrepIcon = nullptr;
if (Mode == EPrepareContentMode::Package)
{
ContentPrepDescription = LOCTEXT("PackagingProjectTaskName", "Packaging project");
ContentPrepTaskName = LOCTEXT("PackagingTaskName", "Packaging");
ContentPrepIcon = FEditorStyle::GetBrush(TEXT("MainFrame.PackageProject"));
// let the user pick a target directory
if (AllPlatformPackagingSettings->StagingDirectory.Path.IsEmpty())
{
AllPlatformPackagingSettings->StagingDirectory.Path = FPaths::ProjectDir();
}
FString OutFolderName;
if (!FDesktopPlatformModule::Get()->OpenDirectoryDialog(FSlateApplication::Get().FindBestParentWindowHandleForDialogs(nullptr), LOCTEXT("PackageDirectoryDialogTitle", "Package project...").ToString(), AllPlatformPackagingSettings->StagingDirectory.Path, OutFolderName))
{
return;
}
AllPlatformPackagingSettings->StagingDirectory.Path = OutFolderName;
AllPlatformPackagingSettings->SaveConfig();
BuildCookRunParams += TEXT(" -stage -archive -package");
const ITargetPlatform* TargetPlatform = GetTargetPlatformManager()->FindTargetPlatform(PlatformInfo->Name);
if (ShouldBuildProject(PackagingSettings, TargetPlatform))
{
BuildCookRunParams += TEXT(" -build");
}
if (PackagingSettings->FullRebuild)
{
BuildCookRunParams += TEXT(" -clean");
}
if (PackagingSettings->bCompressed)
{
BuildCookRunParams += TEXT(" -compressed");
}
if (PackagingSettings->bUseIoStore)
{
BuildCookRunParams += TEXT(" -iostore");
// Pak file(s) must be used when using container file(s)
PackagingSettings->UsePakFile = true;
}
if (PackagingSettings->UsePakFile)
{
BuildCookRunParams += TEXT(" -pak");
}
if (PackagingSettings->IncludePrerequisites)
{
BuildCookRunParams += TEXT(" -prereqs");
}
if (!PackagingSettings->ApplocalPrerequisitesDirectory.Path.IsEmpty())
{
BuildCookRunParams += FString::Printf(TEXT(" -applocaldirectory=\"%s\""), *(PackagingSettings->ApplocalPrerequisitesDirectory.Path));
}
else if (PackagingSettings->IncludeAppLocalPrerequisites)
{
BuildCookRunParams += TEXT(" -applocaldirectory=\"$(EngineDir)/Binaries/ThirdParty/AppLocalDependencies\"");
}
BuildCookRunParams += FString::Printf(TEXT(" -archivedirectory=\"%s\""), *AllPlatformPackagingSettings->StagingDirectory.Path);
if (PackagingSettings->ForDistribution)
{
BuildCookRunParams += TEXT(" -distribution");
}
if (PackagingSettings->bGenerateChunks)
{
BuildCookRunParams += TEXT(" -manifests");
}
// Whether to include the crash reporter.
if (PackagingSettings->IncludeCrashReporter && PlatformInfo->DataDrivenPlatformInfo->bCanUseCrashReporter)
{
BuildCookRunParams += TEXT(" -CrashReporter");
}
if (PackagingSettings->bBuildHttpChunkInstallData)
{
BuildCookRunParams += FString::Printf(TEXT(" -manifests -createchunkinstall -chunkinstalldirectory=\"%s\" -chunkinstallversion=%s"), *(PackagingSettings->HttpChunkInstallDataDirectory.Path), *(PackagingSettings->HttpChunkInstallDataVersion));
}
EProjectPackagingBuildConfigurations BuildConfig = AllPlatformPackagingSettings->GetBuildConfigurationForPlatform(IniPlatformName);
// if PPBC_MAX is set, then the project default should be used instead of the per platform build config
if (BuildConfig == EProjectPackagingBuildConfigurations::PPBC_MAX)
{
BuildConfig = AllPlatformPackagingSettings->BuildConfiguration;
}
// when distribution is set, always package in shipping, which overrides the per platform build config
if (PackagingSettings->ForDistribution)
{
BuildConfig = EProjectPackagingBuildConfigurations::PPBC_Shipping;
}
const UProjectPackagingSettings::FConfigurationInfo& ConfigurationInfo = UProjectPackagingSettings::ConfigurationInfo[(int)BuildConfig];
if (BuildTargetInfo)
{
if (BuildTargetInfo->Type == EBuildTargetType::Client)
{
BuildCookRunParams += FString::Printf(TEXT(" -client -clientconfig=%s"), LexToString(ConfigurationInfo.Configuration));
}
else if (BuildTargetInfo->Type == EBuildTargetType::Server)
{
BuildCookRunParams += FString::Printf(TEXT(" -server -noclient -serverconfig=%s"), LexToString(ConfigurationInfo.Configuration));
}
else
{
BuildCookRunParams += FString::Printf(TEXT(" -clientconfig=%s"), LexToString(ConfigurationInfo.Configuration));
}
}
if (ConfigurationInfo.Configuration == EBuildConfiguration::Shipping && !PackagingSettings->IncludeDebugFiles)
{
BuildCookRunParams += TEXT(" -nodebuginfo");
}
}
// else if (Mode == EPrepareContentMode::PrepareForDebugging)
// {
// const ITargetPlatform* TargetPlatform = GetTargetPlatformManager()->FindTargetPlatform(PlatformInfo->Name);
// if (ShouldBuildProject(PackagingSettings, TargetPlatform))
// {
// BuildCookRunParams += TEXT(" -build");
// }
//
// BuildCookRunParams += FString::Printf(TEXT(" %s"), *FDataDrivenPlatformInfoRegistry::GetPlatformInfo(IniPlatformName).PrepareForDebuggingOptions);
// }
else if (Mode == EPrepareContentMode::CookOnly)
{
ContentPrepDescription = LOCTEXT("CookingContentTaskName", "Cooking content");
ContentPrepTaskName = LOCTEXT("CookingTaskName", "Cooking");
ContentPrepIcon = FEditorStyle::GetBrush(TEXT("MainFrame.CookContent"));
UCookerSettings const* CookerSettings = GetDefault<UCookerSettings>();
if (CookerSettings->bIterativeCookingForFileCookContent)
{
BuildCookRunParams += TEXT(" -iterate");
}
BuildCookRunParams += TEXT(" -skipstage");
}
FString TurnkeyParams = FString::Printf(TEXT("-command=VerifySdk -platform=%s -UpdateIfNeeded %s"), *UBTPlatformString, *ITurnkeyIOModule::Get().GetUATParams());
if (!ProjectPath.IsEmpty())
{
TurnkeyParams.Appendf(TEXT(" -project=\"%s\""), *ProjectPath);
}
FString CommandLine;
if (!ProjectPath.IsEmpty())
{
CommandLine.Appendf(TEXT("-ScriptsForProject=\"%s\" "), *ProjectPath);
}
CommandLine.Appendf(TEXT("Turnkey %s BuildCookRun %s"), *TurnkeyParams, *BuildCookRunParams);
FTurnkeyEditorSupport::RunUAT(CommandLine, PlatformInfo->DisplayName, ContentPrepDescription, ContentPrepTaskName, ContentPrepIcon);
}
static bool CanExecuteCustomBuild(FName IniPlatformName, FProjectBuildSettings Build)
{
if (GetTargetPlatformManager()->FindTargetPlatform(IniPlatformName.ToString()) == nullptr)
{
return false;
}
return true;
}
static void ExecuteCustomBuild(FName IniPlatformName, FProjectBuildSettings Build)
{
const PlatformInfo::FTargetPlatformInfo* PlatformInfo = PlatformInfo::FindPlatformInfo(GetDefault<UProjectPackagingSettings>()->GetTargetFlavorForPlatform(IniPlatformName));
const FString ProjectPath = GetProjectPathForTurnkey();
FString CommandLine;
if (!ProjectPath.IsEmpty())
{
CommandLine.Appendf(TEXT("-ScriptsForProject=\"%s\" "), *ProjectPath);
}
CommandLine.Appendf(TEXT("Turnkey -command=ExecuteBuild -build=\"%s\" -platform=%s"),
*Build.Name, *IniPlatformName.ToString());
if (!ProjectPath.IsEmpty())
{
CommandLine.Appendf(TEXT(" -project=\"%s\""), *ProjectPath);
}
FTurnkeyEditorSupport::RunUAT(CommandLine, PlatformInfo->DisplayName, LOCTEXT("Turnkey_CustomTaskName", "Executing Custom Build"), LOCTEXT("Turnkey_CustomTaskName", "Custom"), FEditorStyle::GetBrush(TEXT("MainFrame.PackageProject")));
}
static void SetPackageBuildConfiguration(const PlatformInfo::FTargetPlatformInfo* Info, EProjectPackagingBuildConfigurations BuildConfiguration)
{
UProjectPackagingSettings* PackagingSettings = GetMutableDefault<UProjectPackagingSettings>();
PackagingSettings->SetBuildConfigurationForPlatform(Info->IniPlatformName, BuildConfiguration);
PackagingSettings->SaveConfig();
}
static bool PackageBuildConfigurationIsChecked(const PlatformInfo::FTargetPlatformInfo* Info, EProjectPackagingBuildConfigurations BuildConfiguration)
{
return GetDefault<UProjectPackagingSettings>()->GetBuildConfigurationForPlatform(Info->IniPlatformName) == BuildConfiguration;
}
static void SetActiveFlavor(const PlatformInfo::FTargetPlatformInfo* Info)
{
UProjectPackagingSettings* PackagingSettings = GetMutableDefault<UProjectPackagingSettings>();
PackagingSettings->SetTargetFlavorForPlatform(Info->IniPlatformName, Info->Name);
PackagingSettings->SaveConfig();
}
static bool CanSetActiveFlavor(const PlatformInfo::FTargetPlatformInfo* Info)
{
return true;
}
static bool SetActiveFlavorIsChecked(const PlatformInfo::FTargetPlatformInfo* Info)
{
return GetDefault<UProjectPackagingSettings>()->GetTargetFlavorForPlatform(Info->IniPlatformName) == Info->Name;
}
static void SetPackageBuildTarget(const PlatformInfo::FTargetPlatformInfo* Info, FString TargetName)
{
UProjectPackagingSettings* PackagingSettings = GetMutableDefault<UProjectPackagingSettings>();
PackagingSettings->SetBuildTargetForPlatform(Info->IniPlatformName, TargetName);
PackagingSettings->SaveConfig();
}
static bool PackageBuildTargetIsChecked(const PlatformInfo::FTargetPlatformInfo* Info, FString TargetName)
{
return GetDefault<UProjectPackagingSettings>()->GetBuildTargetForPlatform(Info->IniPlatformName) == TargetName;
}
static void SetLaunchOnBuildTarget(FString TargetName)
{
UProjectPackagingSettings* PackagingSettings = GetMutableDefault<UProjectPackagingSettings>();
PackagingSettings->LaunchOnTarget = TargetName;
PackagingSettings->SaveConfig();
}
static bool LaunchOnBuildTargetIsChecked(FString TargetName)
{
return GetDefault<UProjectPackagingSettings>()->GetLaunchOnTargetInfo()->Name == TargetName;
}
static void SetCookOnTheFly()
{
UCookerSettings* CookerSettings = GetMutableDefault<UCookerSettings>();
CookerSettings->bCookOnTheFlyForLaunchOn = !CookerSettings->bCookOnTheFlyForLaunchOn;
CookerSettings->Modify(true);
// Update source control
FString ConfigPath = FPaths::ConvertRelativePathToFull(CookerSettings->GetDefaultConfigFilename());
if (FPlatformFileManager::Get().GetPlatformFile().FileExists(*ConfigPath))
{
if (ISourceControlModule::Get().IsEnabled())
{
FText ErrorMessage;
if (!SourceControlHelpers::CheckoutOrMarkForAdd(ConfigPath, FText::FromString(ConfigPath), NULL, ErrorMessage))
{
FNotificationInfo Info(ErrorMessage);
Info.ExpireDuration = 3.0f;
FSlateNotificationManager::Get().AddNotification(Info);
}
}
else
{
if (!FPlatformFileManager::Get().GetPlatformFile().SetReadOnly(*ConfigPath, false))
{
FNotificationInfo Info(FText::Format(LOCTEXT("FailedToMakeWritable", "Could not make {0} writable."), FText::FromString(ConfigPath)));
Info.ExpireDuration = 3.0f;
FSlateNotificationManager::Get().AddNotification(Info);
}
}
}
// Save settings
CookerSettings->UpdateSinglePropertyInConfigFile(CookerSettings->GetClass()->FindPropertyByName(GET_MEMBER_NAME_CHECKED(UCookerSettings, bCookOnTheFlyForLaunchOn)), CookerSettings->GetDefaultConfigFilename());
}
static bool CanSetCookOnTheFly()
{
return true;
}
static bool SetCookOnTheFlyIsChecked()
{
return GetDefault<UCookerSettings>()->bCookOnTheFlyForLaunchOn;
}
static void SetRefreshPlatformStatus()
{
ITurnkeySupportModule::Get().UpdateSdkInfo();
}
static bool CanRefreshPlatformStatus()
{
return true;
}
};
class FTurnkeySupportCommands : public TCommands<FTurnkeySupportCommands>
{
public:
void RegisterCommands()
{
UI_COMMAND(PackagingSettings, "Packaging Settings...", "Opens the settings for project packaging", EUserInterfaceActionType::Button, FInputChord());
ActionList->MapAction(PackagingSettings, FExecuteAction::CreateLambda([] {} ));
}
TSharedPtr< FUICommandInfo > PackagingSettings;
private:
friend class TCommands<FTurnkeySupportCommands>;
FTurnkeySupportCommands()
: TCommands<FTurnkeySupportCommands>("TurnkeySupport", LOCTEXT("TurnkeySupport", "Turnkey and General Platform Options"), "MainFrame", FEditorStyle::GetStyleSetName())
{
}
public:
/** List of all of the main frame commands */
static TSharedRef<FUICommandList> ActionList;
};
TSharedRef<FUICommandList> FTurnkeySupportCommands::ActionList = MakeShareable(new FUICommandList);
static void ShowInstallationHelp(FName IniPlatformName)
{
// const ITargetPlatform* Platform = GetTargetPlatformManager()->FindTargetPlatform(IniPlatformName.ToString());
// bool bProjectHasCode;
// EBuildConfiguration Configuration;
// bool bRequiresAssetNativization;
// FString TutorialPath, DocumentationPath;
// FText LogMessage;
//
// Platform->CheckRequirements(bProjectHasCode, Configuration, bRequiresAssetNativization, TutorialPath, DocumentationPath, LogMessage);
FTurnkeyEditorSupport::ShowInstallationHelp(IniPlatformName, FDataDrivenPlatformInfoRegistry::GetPlatformInfo(IniPlatformName).SDKTutorial);
}
static void TurnkeyInstallSdk(FString IniPlatformName, bool bPreferFull, bool bForceInstall, FString DeviceId)
{
FString OptionalOptions;
if (bPreferFull)
{
OptionalOptions += TEXT(" -PreferFull");
}
if (bForceInstall)
{
OptionalOptions += DeviceId.Len() > 0 ? TEXT(" -ForceDeviceInstall") : TEXT(" -ForceSdkInstall");
}
if (DeviceId.Len() > 0)
{
OptionalOptions += FString::Printf(TEXT(" -Device=%s"), *DeviceId);
}
const FString ProjectPath = GetProjectPathForTurnkey();
FString CommandLine;
if (!ProjectPath.IsEmpty())
{
CommandLine.Appendf(TEXT("-ScriptsForProject=\"%s\" "), *ProjectPath);
}
CommandLine.Appendf(TEXT("Turnkey -command=VerifySdk -UpdateIfNeeded -platform=%s %s %s -noturnkeyvariables -utf8output -WaitForUATMutex"), *IniPlatformName, *OptionalOptions, *ITurnkeyIOModule::Get().GetUATParams());
FText TaskName = LOCTEXT("InstallingSdk", "Installing Sdk");
FTurnkeyEditorSupport::RunUAT(CommandLine, FText::FromString(IniPlatformName), TaskName, TaskName, FEditorStyle::GetBrush(TEXT("MainFrame.PackageProject")),
[IniPlatformName](FString, double)
{
AsyncTask(ENamedThreads::GameThread, [IniPlatformName]()
{
// read in env var changes
// @todo turnkey move this and make it mac/linux aware
FString TurnkeyEnvVarsFilename = FPaths::Combine(FPaths::EngineIntermediateDir(), TEXT("Turnkey/PostTurnkeyVariables.bat"));
if (IFileManager::Get().FileExists(*TurnkeyEnvVarsFilename))
{
TArray<FString> Contents;
if (FFileHelper::LoadFileToStringArray(Contents, *TurnkeyEnvVarsFilename))
{
for (const FString& Line : Contents)
{
if (Line.StartsWith(TEXT("set ")))
{
// split the line
FString VariableLine = Line.Mid(4);
int Equals;
if (VariableLine.FindChar('=', Equals))
{
// set the key/value
FString Key = VariableLine.Mid(0, Equals);
FString Value = VariableLine.Mid(Equals + 1);
FPlatformMisc::SetEnvironmentVar(*Key, *Value);
UE_LOG(LogTurnkeySupport, Log, TEXT("Turnkey setting env var: %s = %s"), *Key, *Value);
}
}
}
}
}
// update the Sdk status
// FDataDrivenPlatformInfoRegistry::UpdateSdkStatus();
GetTargetPlatformManager()->UpdateAfterSDKInstall(*IniPlatformName);
#if WITH_ENGINE
RenderUtilsInit();
#endif
FTurnkeyEditorSupport::ShowRestartToast();
});
}
);
}
static TAttribute<FText> MakeSdkStatusAttribute(FName IniPlatformName, TSharedPtr< ITargetDeviceProxy> DeviceProxy)
{
FString DisplayString = DeviceProxy ? DeviceProxy->GetName() : IniPlatformName.ToString();
FString DeviceId = DeviceProxy ? DeviceProxy->GetTargetDeviceId(NAME_None) : FString();
return TAttribute<FText>::Create(TAttribute<FText>::FGetter::CreateLambda([IniPlatformName, DisplayString, DeviceId]()
{
// get the status, or Unknown if it's not there
ETurnkeyPlatformSdkStatus Status = DeviceId.Len() ? ITurnkeySupportModule::Get().GetSdkInfoForDeviceId(DeviceId).Status : ITurnkeySupportModule::Get().GetSdkInfo(IniPlatformName, false).Status;
if (Status == ETurnkeyPlatformSdkStatus::Querying)
{
FFormatNamedArguments LabelArguments;
LabelArguments.Add(TEXT("DisplayName"), FText::FromString(DisplayString));
return FText::Format(LOCTEXT("SDKStatusLabel", "{DisplayName} (Querying...)"), LabelArguments);
}
return FText::FromString(DisplayString);
}));
}
//static TAttribute<FSlateIcon> MakePlatformSdkIconAttribute(FName IniPlatformName, TSharedPtr< ITargetDeviceProxy> DeviceProxy)
static FSlateIcon MakePlatformSdkIconAttribute(FName IniPlatformName, TSharedPtr< ITargetDeviceProxy> DeviceProxy)
{
FString DeviceId = DeviceProxy ? DeviceProxy->GetTargetDeviceId(NAME_None) : FString();
// return TAttribute<FSlateIcon>::Create(TAttribute<FSlateIcon>::FGetter::CreateLambda([IniPlatformName, DeviceId]()
{
// get the status, or Unknown if it's not there
ETurnkeyPlatformSdkStatus Status = DeviceId.Len() ? ITurnkeySupportModule::Get().GetSdkInfoForDeviceId(DeviceId).Status : ITurnkeySupportModule::Get().GetSdkInfo(IniPlatformName, false).Status;
bool bDeviceWarning = (DeviceId.Len() && ITurnkeySupportModule::Get().GetSdkInfoForDeviceId(DeviceId).DeviceStatus != ETurnkeyDeviceStatus::SoftwareValid);
if (Status == ETurnkeyPlatformSdkStatus::OutOfDate || Status == ETurnkeyPlatformSdkStatus::NoSdk || bDeviceWarning)
{
return FSlateIcon(FEditorStyle::GetStyleSetName(), TEXT("Icons.Warning"));
}
else if (Status == ETurnkeyPlatformSdkStatus::Error)
{
return FSlateIcon(FEditorStyle::GetStyleSetName(), TEXT("Icons.Error"));
}
else if (Status == ETurnkeyPlatformSdkStatus::Unknown)
{
return FSlateIcon(FEditorStyle::GetStyleSetName(), TEXT("Icons.Help"));
}
else
{
return FSlateIcon(FEditorStyle::GetStyleSetName(), FDataDrivenPlatformInfoRegistry::GetPlatformInfo(IniPlatformName).GetIconStyleName(EPlatformIconSize::Normal));
}
}
// ));
}
static void FormatSdkInfo(const FString& PlatformOrDevice, const FTurnkeySdkInfo& SdkInfo, bool bIncludeAutoSdk, FText& OutInfo, FText& OutToolTip)
{
FFormatOrderedArguments Args;
Args.Add(FText::FromString(SdkInfo.InstalledVersion));
Args.Add(FText::FromString(SdkInfo.AutoSDKVersion));
Args.Add(FText::FromString(SdkInfo.MinAllowedVersion));
Args.Add(FText::FromString(SdkInfo.MaxAllowedVersion));
Args.Add(SdkInfo.SdkErrorInformation);
Args.Add(FText::FromString(PlatformOrDevice));
TArray<FText> Lines;
Lines.Add(FText::Format(LOCTEXT("SdkInfo_Installed", "Installed SDK: {0}"), Args));
if (bIncludeAutoSdk)
{
Lines.Add(FText::Format(LOCTEXT("SdkInfo_AutoSDK", "AutoSDK: {1}"), Args));
}
if (SdkInfo.MinAllowedVersion == SdkInfo.MaxAllowedVersion)
{
Lines.Add(FText::Format(LOCTEXT("SdkInfo_AllowedSDK_Single", "Allowed Version: {2}"), Args));
}
else if (SdkInfo.MinAllowedVersion == TEXT(""))
{
Lines.Add(FText::Format(LOCTEXT("SdkInfo_AllowedSDK_MaxOnly", "Allowed Versions: Up to {3}"), Args));
}
else if (SdkInfo.MaxAllowedVersion == TEXT(""))
{
Lines.Add(FText::Format(LOCTEXT("SdkInfo_AllowedSDK_MinOnly", "Allowed Versions: {2} and up"), Args));
}
else
{
Lines.Add(FText::Format(LOCTEXT("SdkInfo_AllowedSDK_Range", "Allowed Versions: {2} through {3}"), Args));
}
if (!SdkInfo.SdkErrorInformation.IsEmpty())
{
Lines.Add(FText::Format(LOCTEXT("SdkInfo_Error", "Error Info:\n{4}"), Args));
}
// now make a single \n delimted text
OutInfo = FText::Join(FText::FromString(TEXT("\n")), Lines);
// make a tooltip
if (PlatformOrDevice.Contains(TEXT("@")))
{
OutToolTip = FText::Format(LOCTEXT("SdkInfo_ToolTip", "Information returned from:\nRunUAT Turnkey -command=VerifySdk -device={5}"), Args);
}
else
{
OutToolTip = FText::Format(LOCTEXT("SdkInfo_ToolTip", "Information returned from:\nRunUAT Turnkey -command=VerifySdk -platform={5}"), Args);
}
}
static void MakeTurnkeyPlatformMenu(UToolMenu* ToolMenu, FName IniPlatformName, ITargetDeviceServicesModule* TargetDeviceServicesModule)
{
const FDataDrivenPlatformInfo& DDPI = FDataDrivenPlatformInfoRegistry::GetPlatformInfo(IniPlatformName);
FString UBTPlatformString = DDPI.UBTPlatformString;
const PlatformInfo::FTargetPlatformInfo* VanillaInfo = PlatformInfo::FindVanillaPlatformInfo(IniPlatformName);
if (VanillaInfo != nullptr)
{
FToolMenuSection& Section = ToolMenu->AddSection("ContentManagement", LOCTEXT("TurnkeySection_Content", "Content Management"));
Section.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_PackageProject", "Package Project"),
LOCTEXT("TurnkeyTooltip_PackageProject", "Package this project and archive it to a user-selected directory. This can then be used to install and run."),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CookOrPackage, IniPlatformName, EPrepareContentMode::Package),
FCanExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CanCookOrPackage, IniPlatformName, EPrepareContentMode::Package)
)
);
Section.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_CookContent", "Cook Content"),
LOCTEXT("TurnkeyTooltip_CookContent", "Cook this project for the selected configuration and target"),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CookOrPackage, IniPlatformName, EPrepareContentMode::CookOnly),
FCanExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CanCookOrPackage, IniPlatformName, EPrepareContentMode::CookOnly)
)
);
//
// Section.AddMenuEntry(
// NAME_None,
// LOCTEXT("Turnkey_PrepareForDebugging", "Prepare For Debugging"),
// LOCTEXT("TurnkeyTooltip_PrepareForDebugging", "Prepare this project for debugging"),
// FSlateIcon(),
// FUIAction(
// FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CookOrPackage, IniPlatformName, EPrepareContentMode::PrepareForDebugging),
// FCanExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CanCookOrPackage, IniPlatformName, EPrepareContentMode::PrepareForDebugging)
// )
// );
//
FString PlatformString = IniPlatformName.ToString();
UProjectPackagingSettings* PackagingSettings = FTurnkeySupportCallbacks::GetPackagingSettingsForPlatform(IniPlatformName);
for (FProjectBuildSettings Build : PackagingSettings->EngineCustomBuilds)
{
if (Build.SpecificPlatforms.Num() == 0 || Build.SpecificPlatforms.Contains(PlatformString))
{
Section.AddMenuEntry(
NAME_None,
FText::FromString(Build.Name),
// @todo turnkey: add the build string to the tooltip
LOCTEXT("TurnkeyTooltip_EngineCustomBuild", "Execute a custom build"),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::ExecuteCustomBuild, IniPlatformName, Build),
FCanExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CanExecuteCustomBuild, IniPlatformName, Build)
)
);
}
}
for (FProjectBuildSettings Build : PackagingSettings->ProjectCustomBuilds)
{
if (Build.SpecificPlatforms.Num() == 0 || Build.SpecificPlatforms.Contains(PlatformString))
{
Section.AddMenuEntry(
NAME_None,
FText::FromString(Build.Name),
// @todo turnkey: add the build string to the tooltip
LOCTEXT("TurnkeyTooltip_ProjectCustomBuild", "Execute a custom build (this comes from Packaging Settings)"),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::ExecuteCustomBuild, IniPlatformName, Build),
FCanExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CanExecuteCustomBuild, IniPlatformName, Build)
)
);
}
}
UProjectPackagingSettings* AllPlatformPackagingSettings = GetMutableDefault<UProjectPackagingSettings>();
// Flavor Selection exists for Android to be able to package ASTC, DXT, ETC2, etc
{
// gather all valid flavors
const TArray<const PlatformInfo::FTargetPlatformInfo*> ValidFlavors = VanillaInfo->Flavors.FilterByPredicate([](const PlatformInfo::FTargetPlatformInfo* Target)
{
// Editor isn't a valid platform type that users can target
// The Build Target will choose client or server, so no need to show them as well
return Target->PlatformType != EBuildTargetType::Editor && Target->PlatformType != EBuildTargetType::Client && Target->PlatformType != EBuildTargetType::Server;
});
if (ValidFlavors.Num() > 1)
{
// Set the first flavor as the default if it hasn't been set
FName CurrentFlavor = AllPlatformPackagingSettings->GetTargetFlavorForPlatform(IniPlatformName);
if (CurrentFlavor == VanillaInfo->Name)
{
FTurnkeySupportCallbacks::SetActiveFlavor(ValidFlavors[0]);
}
FToolMenuSection& FlavorSection = ToolMenu->AddSection("FlavorSelection", LOCTEXT("TurnkeySection_FlavorSelection", "Flavor Selection"));
for (const PlatformInfo::FTargetPlatformInfo* Info : ValidFlavors)
{
FlavorSection.AddMenuEntry(
NAME_None,
Info->DisplayName,
FText(),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::SetActiveFlavor, Info),
FCanExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CanSetActiveFlavor, Info),
FIsActionChecked::CreateStatic(&FTurnkeySupportCallbacks::SetActiveFlavorIsChecked, Info)
),
EUserInterfaceActionType::RadioButton
);
}
}
}
FToolMenuSection& ConfigSection = ToolMenu->AddSection("BuildConfig", LOCTEXT("TurnkeySection_BuildConfig", "Binary Configuration"));
const UProjectPackagingSettings::FConfigurationInfo& ConfigInfo = UProjectPackagingSettings::ConfigurationInfo[static_cast<int32>(AllPlatformPackagingSettings->BuildConfiguration)];
ConfigSection.AddMenuEntry(
NAME_None,
FText::Format(LOCTEXT("DefaultConfiguration", "Use Project Setting ({0})"), ConfigInfo.Name),
ConfigInfo.ToolTip,
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::SetPackageBuildConfiguration, VanillaInfo, EProjectPackagingBuildConfigurations::PPBC_MAX),
FCanExecuteAction(),
FIsActionChecked::CreateStatic(&FTurnkeySupportCallbacks::PackageBuildConfigurationIsChecked, VanillaInfo, EProjectPackagingBuildConfigurations::PPBC_MAX)
),
EUserInterfaceActionType::RadioButton
);
EProjectType ProjectType = FTurnkeyEditorSupport::DoesProjectHaveCode() ? EProjectType::Code : EProjectType::Content;
TArray<EProjectPackagingBuildConfigurations> PackagingConfigurations = UProjectPackagingSettings::GetValidPackageConfigurations();
for (EProjectPackagingBuildConfigurations PackagingConfiguration : PackagingConfigurations)
{
const UProjectPackagingSettings::FConfigurationInfo& ConfigurationInfo = UProjectPackagingSettings::ConfigurationInfo[(int)PackagingConfiguration];
if (FInstalledPlatformInfo::Get().IsValid(TOptional<EBuildTargetType>(), TOptional<FString>(), ConfigurationInfo.Configuration, ProjectType, EInstalledPlatformState::Downloaded))
{
ConfigSection.AddMenuEntry(
NAME_None,
ConfigurationInfo.Name,
ConfigurationInfo.ToolTip,
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::SetPackageBuildConfiguration, VanillaInfo, PackagingConfiguration),
FCanExecuteAction(),
FIsActionChecked::CreateStatic(&FTurnkeySupportCallbacks::PackageBuildConfigurationIsChecked, VanillaInfo, PackagingConfiguration)
),
EUserInterfaceActionType::RadioButton
);
}
}
// Collect build targets. Content-only projects use Engine targets
FProjectStatus ProjectStatus;
bool bHasCode = IProjectManager::Get().QueryStatusForCurrentProject(ProjectStatus) && ProjectStatus.bCodeBasedProject;
IDesktopPlatform* DesktopPlatform = FDesktopPlatformModule::Get();
TArray<FTargetInfo> Targets = bHasCode ? DesktopPlatform->GetTargetsForCurrentProject() : DesktopPlatform->GetTargetsForProject(FString());
if (Targets.Num() > 0)
{
Targets.Sort([](const FTargetInfo& A, const FTargetInfo& B) { return A.Name < B.Name; });
const TArray<FTargetInfo> ValidTargets = Targets.FilterByPredicate([](const FTargetInfo& Target)
{
return Target.Type == EBuildTargetType::Game || Target.Type == EBuildTargetType::Client || Target.Type == EBuildTargetType::Server;
});
if (ValidTargets.Num() > 1)
{
// Set BuildTarget to default to Game if it hasn't been set
if(AllPlatformPackagingSettings->BuildTarget.IsEmpty())
{
const TArray<FTargetInfo> GameTarget = ValidTargets.FilterByPredicate([](const FTargetInfo& Target)
{
return Target.Type == EBuildTargetType::Game;
});
check(GameTarget.Num() > 0);
AllPlatformPackagingSettings->BuildTarget = GameTarget[0].Name;
AllPlatformPackagingSettings->SaveConfig();
}
FToolMenuSection& TargetSection = ToolMenu->AddSection("BuildTarget", LOCTEXT("TurnkeySection_BuildTarget", "Build Target"));
TargetSection.AddMenuEntry(
NAME_None,
FText::Format(LOCTEXT("DefaultPackageTarget", "Use Project Setting ({0})"), FText::FromString(AllPlatformPackagingSettings->BuildTarget)),
FText::Format(LOCTEXT("DefaultPackageTargetTooltip", "Package the {0} target"), FText::FromString(AllPlatformPackagingSettings->BuildTarget)),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::SetPackageBuildTarget, VanillaInfo, FString("")),
FCanExecuteAction(),
FIsActionChecked::CreateStatic(&FTurnkeySupportCallbacks::PackageBuildTargetIsChecked, VanillaInfo, FString(""))
),
EUserInterfaceActionType::RadioButton
);
for (const FTargetInfo& Target : ValidTargets)
{
TargetSection.AddMenuEntry(
NAME_None,
FText::FromString(Target.Name),
FText::Format(LOCTEXT("PackageTargetName", "Package the '{0}' target."), FText::FromString(Target.Name)),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::SetPackageBuildTarget, VanillaInfo, Target.Name),
FCanExecuteAction(),
FIsActionChecked::CreateStatic(&FTurnkeySupportCallbacks::PackageBuildTargetIsChecked, VanillaInfo, Target.Name)
),
EUserInterfaceActionType::RadioButton
);
}
}
}
FToolMenuSection& DevicesSection = ToolMenu->AddSection("AllDevices", LOCTEXT("TurnkeySection_AllDevices", "All Devices"));
TArray<TSharedPtr<ITargetDeviceProxy>> DeviceProxies;
TargetDeviceServicesModule->GetDeviceProxyManager()->GetAllProxies(IniPlatformName, DeviceProxies);
for (const TSharedPtr<ITargetDeviceProxy>& Proxy : DeviceProxies)
{
FString DeviceName = Proxy->GetName();
FString DeviceId = Proxy->GetTargetDeviceId(NAME_None);
DevicesSection.AddSubMenu(
NAME_None,
MakeSdkStatusAttribute(IniPlatformName, Proxy),
FText(),
FNewToolMenuDelegate::CreateLambda([IniPlatformName, DeviceName, DeviceId](UToolMenu* SubToolMenu)
{
FTurnkeySdkInfo SdkInfo = ITurnkeySupportModule::Get().GetSdkInfoForDeviceId(DeviceId);
FText SdkText, SdkToolTip;
FormatSdkInfo(DeviceId, SdkInfo, false, SdkText, SdkToolTip);
FToolMenuSection& Section = SubToolMenu->AddSection(NAME_None);
Section.AddEntry(
FToolMenuEntry::InitWidget(
NAME_None,
SNew(STextBlock)
.ColorAndOpacity(FSlateColor::UseSubduedForeground())
.Text(SdkText)
.ToolTip(SNew(SToolTip).Text(SdkToolTip)),
FText::GetEmpty()
)
);
if (SdkInfo.DeviceStatus == ETurnkeyDeviceStatus::SoftwareValid)
{
Section.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_ForceRepairDevice", "Force Update Device"),
LOCTEXT("TurnkeyTooltip_ForceRepairDevice", "Force repairing anything on the device needed (update firmware, etc). Will perform all steps possible, even if not needed."),
FSlateIcon(),
FExecuteAction::CreateStatic(TurnkeyInstallSdk, IniPlatformName.ToString(), false, true, DeviceId)
);
}
else
{
Section.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_RepairDevice", "Update Device"),
LOCTEXT("TurnkeyTooltip_RepairDevice", "Perform any fixup that may be needed on this device. If up to date already, nothing will be done."),
FSlateIcon(),
FExecuteAction::CreateStatic(TurnkeyInstallSdk, IniPlatformName.ToString(), false, false, DeviceId)
);
}
}),
false, MakePlatformSdkIconAttribute(IniPlatformName, Proxy)
);
}
}
FToolMenuSection& SdkSection = ToolMenu->AddSection("SdkManagement", LOCTEXT("TurnkeySection_Sdks", "Sdk Managment"));
const FTurnkeySdkInfo& SdkInfo = ITurnkeySupportModule::Get().GetSdkInfo(IniPlatformName, true);
FText SdkText, SdkToolTip;
FormatSdkInfo(IniPlatformName.ToString(), SdkInfo, true, SdkText, SdkToolTip);
SdkSection.AddEntry(
FToolMenuEntry::InitWidget(
NAME_None,
SNew(SBox)
.Padding(FMargin(16.0f, 3.0f))
[
SNew(STextBlock)
.ColorAndOpacity(FSlateColor::UseSubduedForeground())
.Text(SdkText)
.ToolTip(SNew(SToolTip).Text(SdkToolTip))
],
FText::GetEmpty()
)
);
FString NoDevice;
if (SdkInfo.bCanInstallFullSdk || SdkInfo.bCanInstallAutoSdk)
{
if (SdkInfo.Status == ETurnkeyPlatformSdkStatus::OutOfDate)
{
SdkSection.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_UpdateSdkMinimal", "Update Sdk"),
LOCTEXT("TurnkeyTooltip_InstallSdkMinimal", "Attempt to update an Sdk, as hosted by your studio. Will attempt to install a minimal Sdk (useful for building/running only)"),
FSlateIcon(),
FExecuteAction::CreateStatic(TurnkeyInstallSdk, IniPlatformName.ToString(), false, false, NoDevice)
);
if (SdkInfo.bCanInstallFullSdk && SdkInfo.bCanInstallAutoSdk)
{
SdkSection.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_UpdateSdkFull", "Update Sdk (Full Platform Installer)"),
LOCTEXT("TurnkeyTooltip_UpdateSdkFull", "Attempt to update an Sdk, as hosted by your studio. Will attempt to install a full Sdk (useful profiling or other use cases)"),
FSlateIcon(),
FExecuteAction::CreateStatic(TurnkeyInstallSdk, IniPlatformName.ToString(), true, false, NoDevice)
);
}
}
else if (SdkInfo.Status == ETurnkeyPlatformSdkStatus::Valid)
{
SdkSection.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_ForceSdkMinimal", "Force Reinstall Sdk"),
LOCTEXT("TurnkeyTooltip_ForceSdkMinimal", "Attempt to force re-install an Sdk, as hosted by your studio. Will attempt to install a minimal Sdk (useful for building/running only)"),
FSlateIcon(),
FExecuteAction::CreateStatic(TurnkeyInstallSdk, IniPlatformName.ToString(), false, true, NoDevice)
);
if (SdkInfo.bCanInstallFullSdk && SdkInfo.bCanInstallAutoSdk)
{
SdkSection.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_ForceSdkFull", "Force Reinstall (Full Platform Installer)"),
LOCTEXT("TurnkeyTooltip_ForceSdkForce", "Attempt to force re-install an Sdk, as hosted by your studio. Will attempt to install a full Sdk (useful profiling or other use cases)"),
FSlateIcon(),
FExecuteAction::CreateStatic(TurnkeyInstallSdk, IniPlatformName.ToString(), true, true, NoDevice)
);
}
}
else
{
SdkSection.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_InstallSdkMinimal", "Install Sdk"),
LOCTEXT("TurnkeyTooltip_InstallSdkMinimal", "Attempt to install an Sdk, as hosted by your studio. Will attempt to install a minimal Sdk (useful for building/running only)"),
FSlateIcon(),
FExecuteAction::CreateStatic(TurnkeyInstallSdk, IniPlatformName.ToString(), false, false, NoDevice)
);
SdkSection.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_InstallSdkFull", "Install Sdk (Full Platform Installer)"),
LOCTEXT("TurnkeyTooltip_InstallSdkFull", "Attempt to install an Sdk, as hosted by your studio. Will attempt to install a full Sdk (useful profiling or other use cases)"),
FSlateIcon(),
FExecuteAction::CreateStatic(TurnkeyInstallSdk, IniPlatformName.ToString(), true, false, NoDevice)
);
}
}
#if 0 // @todo turnkey enable and always show documentation for installation help when we have URLs in place
// Link to documentation
SdkSection.AddMenuEntry(
NAME_None,
LOCTEXT("Turnkey_ShowDocumentation", "Installation Help..."),
LOCTEXT("TurnkeyTooltip_ShowDocumentation", "Show documentation with help installing the SDK for this platform"),
FSlateIcon(),
FExecuteAction::CreateStatic(ShowInstallationHelp, IniPlatformName)
);
#endif
}
// Launch On
bool CanLaunchOnDevice(const FString& DeviceName)
{
static TWeakPtr<ITargetDeviceProxyManager> DeviceProxyManagerPtr;
if (!DeviceProxyManagerPtr.IsValid())
{
ITargetDeviceServicesModule* TargetDeviceServicesModule = FModuleManager::Get().LoadModulePtr<ITargetDeviceServicesModule>(TEXT("TargetDeviceServices"));
if (TargetDeviceServicesModule)
{
DeviceProxyManagerPtr = TargetDeviceServicesModule->GetDeviceProxyManager();
}
}
TSharedPtr<ITargetDeviceProxyManager> DeviceProxyManager = DeviceProxyManagerPtr.Pin();
if (DeviceProxyManager.IsValid())
{
TSharedPtr<ITargetDeviceProxy> DeviceProxy = DeviceProxyManager->FindProxy(DeviceName);
if (DeviceProxy.IsValid() && DeviceProxy->IsConnected() && DeviceProxy->IsAuthorized())
{
return true;
}
// check if this is an aggregate proxy
TArray<TSharedPtr<ITargetDeviceProxy>> Devices;
DeviceProxyManager->GetProxies(FName(*DeviceName), false, Devices);
// returns true if the game can be launched al least on 1 device
for (auto DevicesIt = Devices.CreateIterator(); DevicesIt; ++DevicesIt)
{
TSharedPtr<ITargetDeviceProxy> DeviceAggregateProxy = *DevicesIt;
if (DeviceAggregateProxy.IsValid() && DeviceAggregateProxy->IsConnected() && DeviceAggregateProxy->IsAuthorized())
{
return true;
}
}
}
return false;
}
static void LaunchOnDevice(const FString& DeviceId, const FString& DeviceName, bool bUseTurnkey)
{
FTurnkeyEditorSupport::LaunchRunningMap(DeviceId, DeviceName, GetProjectPathForTurnkey(), bUseTurnkey);
}
static void PrepareLaunchOn(FString DeviceId, FString DeviceName)
{
FTurnkeyEditorSupport::PrepareToLaunchRunningMap(DeviceId, DeviceName);
}
static void HandleLaunchOnDeviceActionExecute(FString DeviceId, FString DeviceName, bool bUseTurnkey)
{
PrepareLaunchOn(DeviceId, DeviceName);
LaunchOnDevice(DeviceId, DeviceName, bUseTurnkey);
}
static bool HandleLaunchOnDeviceActionCanExecute(FString DeviceName)
{
return CanLaunchOnDevice(DeviceName);
}
static void GenerateDeviceProxyMenuParams(TSharedPtr<ITargetDeviceProxy> DeviceProxy, FName PlatformName, FUIAction& OutAction, FText& OutTooltip, FOnQuickLaunchSelected ExternalOnClickDelegate)
{
// // create an All_<platform>_devices_on_<host> submenu
// if (DeviceProxy->IsAggregated())
// {
// FString AggregateDevicedName(FString::Printf(TEXT(" %s"), *DeviceProxy->GetName())); //align with the other menu entries
// FSlateIcon AggregateDeviceIcon(FEditorStyle::GetStyleSetName(), EditorPlatformInfo->GetIconStyleName(PlatformInfo::EPlatformIconSize::Normal));
//
// MenuBuilder.AddSubMenu(
// FText::FromString(AggregateDevicedName),
// FText::FromString(AggregateDevicedName),
// FNewMenuDelegate::CreateStatic(&MakeAllDevicesSubMenu, EditorPlatformInfo, DeviceProxy),
// false, AggregateDeviceIcon, true
// );
// continue;
// }
// ... create an action...
OutAction = FUIAction(
FExecuteAction::CreateLambda([DeviceProxy, PlatformName, ExternalOnClickDelegate]()
{
// only game and client devices are supported for launch on but devices only signal if they target client builds by their name e.g. "WindowsClient"
// if the user has a EBuildTargetType::Client target selected we will launch on a client device, otherwise we fall back to the default game device
// We need to use flavors to launch on correctly on Android_ASTC / Android_ETC2, etc
const PlatformInfo::FTargetPlatformInfo* PlatformInfo = nullptr;
if (FApp::IsInstalled())
{
PlatformInfo = PlatformInfo::FindPlatformInfo(PlatformName);
}
else
{
PlatformInfo = PlatformInfo::FindPlatformInfo(GetDefault<UProjectPackagingSettings>()->GetTargetFlavorForPlatform(PlatformName));
}
FString VariantName = PlatformInfo->Name.ToString();
// find out if the user selected a client build target
IDesktopPlatform* DesktopPlatform = FDesktopPlatformModule::Get();
if (DesktopPlatform->GetTargetsForCurrentProject().Num() > 0)
{
TArray<FTargetInfo> Targets = DesktopPlatform->GetTargetsForCurrentProject();
const TArray<FTargetInfo> ClientTargets = Targets.FilterByPredicate([](const FTargetInfo& Target)
{
return Target.Type == EBuildTargetType::Client;
});
// we just want to know if any client build is selected, the correct flavor was picked above
for (const auto& Target : ClientTargets)
{
if (GetDefault<UProjectPackagingSettings>()->GetBuildTargetForPlatform(PlatformName) == Target.Name)
{
VariantName += "Client";
break;
}
}
}
// If the variant is not found it will fall back to default (NAME_None)
FName DeviceVariantName = NAME_None;
if (DeviceProxy->HasVariant(*VariantName))
{
DeviceVariantName = *VariantName;
}
FString DeviceId = DeviceProxy->GetTargetDeviceId(DeviceVariantName);
HandleLaunchOnDeviceActionExecute(DeviceId, DeviceProxy->GetName(), true);
ExternalOnClickDelegate.ExecuteIfBound(DeviceId);
}
// , FCanExecuteAction::CreateStatic(&HandleLaunchOnDeviceActionCanExecute, DeviceProxy->GetName())
));
// ... generate tooltip text
FFormatNamedArguments TooltipArguments;
TooltipArguments.Add(TEXT("DeviceID"), FText::FromString(DeviceProxy->GetName()));
TooltipArguments.Add(TEXT("DisplayName"), FText::FromName(PlatformName));
OutTooltip = FText::Format(LOCTEXT("LaunchDeviceToolTipText_ThisDevice", "Launch the game on this {DisplayName} device ({DeviceID})"), TooltipArguments);
if (!DeviceProxy->IsAuthorized())
{
OutTooltip = FText::Format(LOCTEXT("LaunchDeviceToolTipText_UnauthorizedOrLocked", "{DisplayName} device ({DeviceID}) is unauthorized or locked"), TooltipArguments);
}
FProjectStatus ProjectStatus;
if (IProjectManager::Get().QueryStatusForCurrentProject(ProjectStatus) && !ProjectStatus.IsTargetPlatformSupported(PlatformName))
{
FText TooltipLine2 = FText::Format(LOCTEXT("LaunchDevicePlatformWarning", "{DisplayName} is not listed as a target platform for this project, so may not run as expected."), TooltipArguments);
OutTooltip = FText::Format(FText::FromString(TEXT("{0}\n\n{1}")), OutTooltip, TooltipLine2);
}
}
void FTurnkeySupportModule::MakeQuickLaunchItems(class UToolMenu* Menu, FOnQuickLaunchSelected ExternalOnClickDelegate) const
{
FToolMenuSection& MenuSection = Menu->AddSection("QuickLaunchDevices", LOCTEXT("QuickLaunch", "Quick Launch"));
MenuSection.AddDynamicEntry("PlatformsMenu", FNewToolMenuSectionDelegate::CreateLambda([ExternalOnClickDelegate](FToolMenuSection& DynamicSection)
{
TArray<FString> DeviceIdsToQuery;
ITargetDeviceServicesModule* TargetDeviceServicesModule = static_cast<ITargetDeviceServicesModule*>(FModuleManager::Get().LoadModule(TEXT("TargetDeviceServices")));
for (const auto& Pair : FDataDrivenPlatformInfoRegistry::GetAllPlatformInfos())
{
if (Pair.Value.bIsFakePlatform)
{
continue;
}
FName PlatformName = Pair.Key;
const FDataDrivenPlatformInfo& Info = Pair.Value;
if (FDataDrivenPlatformInfoRegistry::IsPlatformHiddenFromUI(PlatformName))
{
continue;
}
// look for devices for all platforms, even if the platform isn't installed - Turnkey can install Sdk after selecting LaunchOn
TArray<TSharedPtr<ITargetDeviceProxy>> DeviceProxies;
TargetDeviceServicesModule->GetDeviceProxyManager()->GetAllProxies(PlatformName, DeviceProxies);
if (DeviceProxies.Num() > 0)
{
// Algo::Sort(DeviceProxies, [](TSharedPtr<ITargetDeviceProxy> A, TSharedPtr<ITargetDeviceProxy> B)
// { return A->Name == LastChosen || B->Name != LastChosen && A->IsDefault(); });
// always use the first one, after sorting
FUIAction Action;
FText Tooltip;
GenerateDeviceProxyMenuParams(DeviceProxies[0], PlatformName, Action, Tooltip, ExternalOnClickDelegate);
if (DeviceProxies.Num() == 1)
{
UE_LOG(LogTurnkeySupport, Display, TEXT("Adding device menu item for %s"), *DeviceProxies[0]->GetName());
DynamicSection.AddMenuEntry(
NAME_None,
MakeSdkStatusAttribute(PlatformName, DeviceProxies[0]),
Tooltip,
MakePlatformSdkIconAttribute(PlatformName, DeviceProxies[0]),
Action
);
}
else
{
DynamicSection.AddSubMenu(
NAME_None,
MakeSdkStatusAttribute(PlatformName, DeviceProxies[0]),
Tooltip,
FNewToolMenuDelegate::CreateLambda([TargetDeviceServicesModule, PlatformName, ExternalOnClickDelegate](UToolMenu* SubToolMenu)
{
FToolMenuSection& Section = SubToolMenu->AddSection(NAME_None);
// re-get the proxies, just in case they changed
TArray<TSharedPtr<ITargetDeviceProxy>> DeviceProxies;
TargetDeviceServicesModule->GetDeviceProxyManager()->GetAllProxies(PlatformName, DeviceProxies);
// for each one, put an entry (even the one that was in the outer menu, for less confusion)
for (const TSharedPtr<ITargetDeviceProxy>& Proxy : DeviceProxies)
{
FUIAction SubAction;
FText SubTooltip;
GenerateDeviceProxyMenuParams(Proxy, PlatformName, SubAction, SubTooltip, ExternalOnClickDelegate);
Section.AddMenuEntry(
NAME_None,
MakeSdkStatusAttribute(PlatformName, Proxy),
SubTooltip,
MakePlatformSdkIconAttribute(PlatformName, Proxy),
SubAction,
EUserInterfaceActionType::Button
);
}
}),
Action,
EUserInterfaceActionType::Check,
false,
MakePlatformSdkIconAttribute(PlatformName, nullptr),
true
);
}
ITurnkeySupportModule& TurnkeySupport = ITurnkeySupportModule::Get();
// gath er any unknown status devices to query at the end
for (const TSharedPtr<ITargetDeviceProxy>& Proxy : DeviceProxies)
{
FString DeviceId = Proxy->GetTargetDeviceId(NAME_None);
if (TurnkeySupport.GetSdkInfoForDeviceId(DeviceId).Status == ETurnkeyPlatformSdkStatus::Unknown)
{
DeviceIdsToQuery.Add(DeviceId);
}
}
}
}
// if we don't have an external delegate to call, then this is the internally included items in the Platforms menu and we can add the extra option(s)
if (!ExternalOnClickDelegate.IsBound())
{
DynamicSection.AddMenuEntry(
NAME_None,
LOCTEXT("CookOnTheFlyOnLaunch", "Enable cooking on the fly"),
LOCTEXT("CookOnTheFlyOnLaunchDescription", "Cook on the fly instead of cooking upfront when launching"),
FSlateIcon(FAppStyle::GetAppStyleSetName(), "MainFrame.CookContent"),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::SetCookOnTheFly),
FCanExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CanSetCookOnTheFly),
FIsActionChecked::CreateStatic(&FTurnkeySupportCallbacks::SetCookOnTheFlyIsChecked)
),
EUserInterfaceActionType::ToggleButton
);
}
// now kick-off any devices that need to be updated
if (DeviceIdsToQuery.Num() > 0)
{
ITurnkeySupportModule::Get().UpdateSdkInfoForDevices(DeviceIdsToQuery);
}
}
));
FProjectStatus ProjectStatus;
bool bHasCode = IProjectManager::Get().QueryStatusForCurrentProject(ProjectStatus) && ProjectStatus.bCodeBasedProject;
IDesktopPlatform* DesktopPlatform = FDesktopPlatformModule::Get();
TArray<FTargetInfo> Targets = bHasCode ? DesktopPlatform->GetTargetsForCurrentProject() : DesktopPlatform->GetTargetsForProject(FString());
const TArray<FTargetInfo> ValidTargets = Targets.FilterByPredicate([](const FTargetInfo& Target)
{
return Target.Type == EBuildTargetType::Game;// || Target.Type == EBuildTargetType::Client || Target.Type == EBuildTargetType::Server;
});
if (ValidTargets.Num() > 1)
{
FToolMenuSection& LaunchTargetSection = Menu->AddSection("QuickLaunchTarget", LOCTEXT("QuickLaunchTarget", "Quick Launch Game Target"));
for (const FTargetInfo& Target : ValidTargets)
{
LaunchTargetSection.AddMenuEntry(
NAME_None,
FText::FromString(Target.Name),
FText::Format(LOCTEXT("PackageTargetName", "Package the '{0}' target."), FText::FromString(Target.Name)),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::SetLaunchOnBuildTarget, Target.Name),
FCanExecuteAction(),
FIsActionChecked::CreateStatic(&FTurnkeySupportCallbacks::LaunchOnBuildTargetIsChecked, Target.Name)
),
EUserInterfaceActionType::RadioButton
);
}
}
}
TSharedRef<SWidget> FTurnkeySupportModule::MakeTurnkeyMenuWidget() const
{
FTurnkeySupportCommands::Register();
const FTurnkeySupportCommands& Commands = FTurnkeySupportCommands::Get();
const bool bShouldCloseWindowAfterMenuSelection = true;
static const FName MenuName("UnrealEd.PlayWorldCommands.PlatformsMenu");
if (!UToolMenus::Get()->IsMenuRegistered(MenuName))
{
UToolMenu* Menu = UToolMenus::Get()->RegisterMenu(MenuName);
FOnQuickLaunchSelected EmptyFunc;
MakeQuickLaunchItems(Menu, EmptyFunc);
// need to make this dyamic so icons, etc can update with SDK
// shared devices section
FToolMenuSection& ManagePlatformsSection = Menu->AddSection("AllPlatforms", LOCTEXT("TurnkeyMenu_ManagePlatforms", "Content/Sdk/Device Management"));
ManagePlatformsSection.AddDynamicEntry(NAME_None, FNewToolMenuSectionDelegate::CreateLambda([](FToolMenuSection& PlatformsSection)
{
ITargetDeviceServicesModule* TargetDeviceServicesModule = static_cast<ITargetDeviceServicesModule*>(FModuleManager::Get().LoadModule(TEXT("TargetDeviceServices")));
TMap<FName, const FDataDrivenPlatformInfo*> UncompiledPlatforms;
TMap<FName, const FDataDrivenPlatformInfo*> UnsupportedPlatforms;
FProjectStatus ProjectStatus;
bool bProjectStatusIsValid = IProjectManager::Get().QueryStatusForCurrentProject(ProjectStatus);
for (const auto& Pair : FDataDrivenPlatformInfoRegistry::GetAllPlatformInfos())
{
if (Pair.Value.bIsFakePlatform || Pair.Value.bEnabledForUse == false)
{
continue;
}
FName PlatformName = Pair.Key;
const FDataDrivenPlatformInfo& Info = Pair.Value;
if (FDataDrivenPlatformInfoRegistry::IsPlatformHiddenFromUI(PlatformName))
{
continue;
}
if (!FDataDrivenPlatformInfoRegistry::HasCompiledSupportForPlatform(PlatformName, FDataDrivenPlatformInfoRegistry::EPlatformNameType::Ini))
{
UncompiledPlatforms.Add(PlatformName, &Info);
continue;
}
if (bProjectStatusIsValid && !ProjectStatus.IsTargetPlatformSupported(PlatformName))
{
UnsupportedPlatforms.Add(PlatformName, &Info);
continue;
}
PlatformsSection.AddSubMenu(
NAME_None,
MakeSdkStatusAttribute(PlatformName, nullptr),
FText::FromString(PlatformName.ToString()),
FNewToolMenuDelegate::CreateStatic(&MakeTurnkeyPlatformMenu, PlatformName, TargetDeviceServicesModule),
false,
MakePlatformSdkIconAttribute(PlatformName, nullptr),
true
);
}
PlatformsSection.AddMenuEntry(
NAME_None,
LOCTEXT("RefreshPlatformStatus", "Refresh platform status"),
LOCTEXT("RefreshPlatformStatusDescription", "Update all platforms and device information"),
FSlateIcon(FAppStyle::GetAppStyleSetName(), "SourceControl.Actions.Refresh"),
FUIAction(
FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::SetRefreshPlatformStatus),
FCanExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::CanRefreshPlatformStatus))
);
if (UnsupportedPlatforms.Num() != 0)
{
PlatformsSection.AddSeparator(NAME_None);
PlatformsSection.AddSubMenu(
NAME_None,
LOCTEXT("Turnkey_UnsupportedPlatforms", "Platforms Not Supported by Project"),
LOCTEXT("Turnkey_UnsupportedPlatformsToolTip", "List of platforms that are not marked as supported by this platform. Use the \"Supported Platforms...\""),
FNewToolMenuDelegate::CreateLambda([UnsupportedPlatforms, TargetDeviceServicesModule](UToolMenu* SubToolMenu)
{
FToolMenuSection& Section = SubToolMenu->AddSection(NAME_None);
for (const auto It : UnsupportedPlatforms)
{
Section.AddSubMenu(
NAME_None,
MakeSdkStatusAttribute(It.Key, nullptr),
FText::FromString(It.Key.ToString()),
FNewToolMenuDelegate::CreateStatic(&MakeTurnkeyPlatformMenu, It.Key, TargetDeviceServicesModule),
false,
MakePlatformSdkIconAttribute(It.Key, nullptr),
true
);
}
})
);
}
if (UncompiledPlatforms.Num() != 0)
{
PlatformsSection.AddSeparator(NAME_None);
PlatformsSection.AddSubMenu(
NAME_None,
LOCTEXT("Turnkey_UncompiledPlatforms", "Platforms With No Compiled Support"),
LOCTEXT("Turnkey_UncompiledPlatformsToolTip", "List of platforms that you have access to, but support is not compiled in to the editor. It may be caused by missing an SDK, so you attempt to install an SDK here."),
FNewToolMenuDelegate::CreateLambda([UncompiledPlatforms, TargetDeviceServicesModule](UToolMenu* SubToolMenu)
{
FToolMenuSection& Section = SubToolMenu->AddSection(NAME_None);
for (const auto It : UncompiledPlatforms)
{
Section.AddSubMenu(
NAME_None,
MakeSdkStatusAttribute(It.Key, nullptr),
FText::FromString(It.Key.ToString()),
FNewToolMenuDelegate::CreateStatic(&MakeTurnkeyPlatformMenu, It.Key, TargetDeviceServicesModule),
false,
MakePlatformSdkIconAttribute(It.Key, nullptr),
true
);
}
})
);
}
}));
// options section
FToolMenuSection& OptionsSection = Menu->AddSection("TurnkeyOptions", LOCTEXT("TurnkeySection_Options", "Options and Settings"));
{
OptionsSection.AddMenuEntry(
NAME_None,
LOCTEXT("OpenProjectLauncher", "Project Launcher..."),
LOCTEXT("OpenProjectLauncher_ToolTip", "Open the Project Launcher for advanced packaging, deploying and launching of your projects"),
FSlateIcon(FEditorStyle::GetStyleSetName(), "Launcher.TabIcon"),
FUIAction(FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::OpenProjectLauncher))
);
OptionsSection.AddMenuEntry(
NAME_None,
LOCTEXT("OpenDeviceManager", "Device Manager..."),
LOCTEXT("OpenDeviceManager_ToolTip", "View and manage connected devices."),
FSlateIcon(FEditorStyle::GetStyleSetName(), "DeviceDetails.TabIcon"),
FUIAction(FExecuteAction::CreateStatic(&FTurnkeySupportCallbacks::OpenDeviceManager))
);
FTurnkeyEditorSupport::AddEditorOptions(OptionsSection);
}
}
FToolMenuContext MenuContext(FTurnkeySupportCommands::ActionList);
return UToolMenus::Get()->GenerateWidget(MenuName, MenuContext);
}
void FTurnkeySupportModule::MakeTurnkeyMenu(FToolMenuSection& MenuSection) const
{
// make sure the DeviceProxyManager is going _before_ we create the menu contents dynamically, so that devices will show up
ITargetDeviceServicesModule* TargetDeviceServicesModule = static_cast<ITargetDeviceServicesModule*>(FModuleManager::Get().LoadModule(TEXT("TargetDeviceServices")));
TargetDeviceServicesModule->GetDeviceProxyManager();
// hide during PIE
FUIAction PlatformMenuShownDelegate;
PlatformMenuShownDelegate.IsActionVisibleDelegate = FIsActionButtonVisible::CreateLambda([]()
{
return !FTurnkeyEditorSupport::IsPIERunning();
});
FToolMenuEntry Entry = FToolMenuEntry::InitComboButton(
"PlatformsMenu",
PlatformMenuShownDelegate,
FOnGetContent::CreateLambda([this] { return MakeTurnkeyMenuWidget(); }),
LOCTEXT("PlatformMenu", "Platforms"),
LOCTEXT("PlatformMenu_Tooltip", "Platform related actions and settings (Launching, Packaging, custom builds, etc)"),
FSlateIcon(FEditorStyle::GetStyleSetName(), "PlayWorld.RepeatLastLaunch"), // not great name for a good "platforms" icon
false,
"PlatformsMenu");
Entry.StyleNameOverride = "CalloutToolbar";
MenuSection.AddEntry(Entry);
}
static FString GetLogAndReportCommandline(FString& LogFilename, FString& ReportFilename)
{
static int ReportIndex = 0;
LogFilename = FPaths::ConvertRelativePathToFull(FPaths::Combine(FPaths::ProjectIntermediateDir(), *FString::Printf(TEXT("TurnkeyLog_%d.log"), ReportIndex)));
ReportFilename = FPaths::ConvertRelativePathToFull(FPaths::Combine(FPaths::ProjectIntermediateDir(), *FString::Printf(TEXT("TurnkeyReport_%d.log"), ReportIndex++)));
return FString::Printf(TEXT("-ReportFilename=\"%s\" -log=\"%s\""), *ReportFilename, *LogFilename);
}
// some shared functionality
static void PrepForTurnkeyReport(FString& BaseCommandline, FString& ReportFilename)
{
// make sure intermediate directory exists
IFileManager::Get().MakeDirectory(*FPaths::ProjectIntermediateDir());
const FString ProjectPath = GetProjectPathForTurnkey();
// now pass a project to UAT
if (!ProjectPath.IsEmpty())
{
BaseCommandline.Appendf(TEXT(" -ScriptsForProject=\"%s\" "), *ProjectPath);
}
FString LogFilename;
FString LogAndReportParams = GetLogAndReportCommandline(LogFilename, ReportFilename);
BaseCommandline = BaseCommandline.Appendf(TEXT("Turnkey -utf8output -WaitForUATMutex -command=VerifySdk %s"), *LogAndReportParams);
// now pass a project to Turnkey
if (!ProjectPath.IsEmpty())
{
BaseCommandline.Appendf(TEXT(" -project=\"%s\" "), *ProjectPath);
}
}
bool GetSdkInfoFromTurnkey(FString Line, FName& PlatformName, FString& DeviceId, FTurnkeySdkInfo& SdkInfo)
{
int32 Colon = Line.Find(TEXT(": "));
if (Colon < 0)
{
return false;
}
// break up the string
FString PlatformString = Line.Mid(0, Colon);
FString Info = Line.Mid(Colon + 2);
int32 AtSign = PlatformString.Find(TEXT("@"));
if (AtSign > 0)
{
// return the platform@name as the deviceId, then remove the @name part for the platform
DeviceId = ConvertToDDPIDeviceId(PlatformString);
PlatformString = PlatformString.Mid(0, AtSign);
}
// get the DDPI name
PlatformName = FName(*ConvertToDDPIPlatform(PlatformString));
// parse out the results from the (key=val, key=val) result from turnkey
FString StatusString;
FString FlagsString;
FParse::Value(*Info, TEXT("Status="), StatusString);
FParse::Value(*Info, TEXT("Flags="), FlagsString);
FParse::Value(*Info, TEXT("Installed="), SdkInfo.InstalledVersion);
FParse::Value(*Info, TEXT("AutoSDK="), SdkInfo.AutoSDKVersion);
FParse::Value(*Info, TEXT("MinAllowed="), SdkInfo.MinAllowedVersion);
FParse::Value(*Info, TEXT("MaxAllowed="), SdkInfo.MaxAllowedVersion);
FString ErrorString;
FParse::Value(*Info, TEXT("Error="), ErrorString);
SdkInfo.SdkErrorInformation = FText::FromString(ErrorString.Replace(TEXT("|"), TEXT("\n")));
SdkInfo.Status = ETurnkeyPlatformSdkStatus::Unknown;
if (StatusString == TEXT("Valid"))
{
SdkInfo.Status = ETurnkeyPlatformSdkStatus::Valid;
}
else
{
if (FlagsString.Contains(TEXT("AutoSdk_InvalidVersionExists")) || FlagsString.Contains(TEXT("InstalledSdk_InvalidVersionExists")))
{
SdkInfo.Status = ETurnkeyPlatformSdkStatus::OutOfDate;
}
else
{
SdkInfo.Status = ETurnkeyPlatformSdkStatus::NoSdk;
}
}
SdkInfo.bCanInstallFullSdk = FlagsString.Contains(TEXT("Support_FullSdk"));
SdkInfo.bCanInstallAutoSdk = FlagsString.Contains(TEXT("Support_AutoSdk"));
SdkInfo.DeviceStatus = ETurnkeyDeviceStatus::Unknown;
if (FlagsString.Contains(TEXT("Device_InvalidPrerequisites")))
{
SdkInfo.DeviceStatus = ETurnkeyDeviceStatus::InvalidPrerequisites;
}
else if (FlagsString.Contains(TEXT("Device_InstallSoftwareValid")))
{
SdkInfo.DeviceStatus = ETurnkeyDeviceStatus::SoftwareValid;
}
else if (FlagsString.Contains(TEXT("Device_InstallSoftwareInvalid")))
{
SdkInfo.DeviceStatus = ETurnkeyDeviceStatus::SoftwareInvalid;
}
return true;
}
static constexpr bool bDeleteTurnkeyProcessOnCompletion = (PLATFORM_WINDOWS);
void FTurnkeySupportModule::UpdateSdkInfo()
{
// make sure all known platforms are in the map
if (PerPlatformSdkInfo.Num() == 0)
{
for (auto& It : FDataDrivenPlatformInfoRegistry::GetAllPlatformInfos())
{
PerPlatformSdkInfo.Add(It.Key, FTurnkeySdkInfo());
}
}
// don't run UAT from commandlets (like the cooker) that are often launched from UAT and this will go poorly
if (IsRunningCommandlet() || FApp::IsUnattended())
{
return;
}
FString BaseCommandline, ReportFilename;
PrepForTurnkeyReport(BaseCommandline, ReportFilename);
// get status for all platforms
FString Commandline = BaseCommandline + TEXT(" -platform=all");
UE_LOG(LogTurnkeySupport, Log, TEXT("Running Turnkey SDK detection: '%s'"), *Commandline);
{
FScopeLock Lock(&GTurnkeySection);
// reset status to unknown
for (auto& It : PerPlatformSdkInfo)
{
It.Value.Status = ETurnkeyPlatformSdkStatus::Querying;
}
// reset the per-device status when querying general Sdk status
ClearDeviceStatus();
}
FSerializedUATProcess* TurnkeyProcess = new FSerializedUATProcess(Commandline);
// block the game thread on exit while TurnkeyProcess being cancelled
struct FEventDeleter { void operator()(FEvent* Event) { FPlatformProcess::ReturnSynchEventToPool(Event); } };
TSharedPtr<FEvent, ESPMode::ThreadSafe> Barrier{ FPlatformProcess::GetSynchEventFromPool(), FEventDeleter{} };
TurnkeyProcess->OnCanceled().BindLambda([Barrier] { Barrier->Trigger(); });
FDelegateHandle OnExitHandle = FCoreDelegates::OnExit.AddLambda([TurnkeyProcess, Barrier] { TurnkeyProcess->Cancel(); Barrier->Wait(); });
TurnkeyProcess->OnCompleted().BindLambda([this, ReportFilename, TurnkeyProcess, Barrier, OnExitHandle](int32 ExitCode)
{
UE_LOG(LogTurnkeySupport, Log, TEXT("Completed SDK detection: ExitCode = %d"), ExitCode);
AsyncTask(ENamedThreads::GameThread, [this, ReportFilename, ExitCode, TurnkeyProcess, OnExitHandle]()
{
FScopeLock Lock(&GTurnkeySection);
if (ExitCode == 0 || ExitCode == 10)
{
TArray<FString> Contents;
if (FFileHelper::LoadFileToStringArray(Contents, *ReportFilename))
{
for (FString& Line : Contents)
{
UE_LOG(LogTurnkeySupport, Log, TEXT("Turnkey Platform: %s"), *Line);
// parse a Turnkey line
FName PlatformName;
FString Unused;
FTurnkeySdkInfo SdkInfo;
if (GetSdkInfoFromTurnkey(Line, PlatformName, Unused, SdkInfo) == false)
{
continue;
}
// we received a platform from UAT that we don't know about in the editor. this can happen if you have a UBT/UAT that was compiled with platform access
// but then you are running without that platform synced. skip this platform and move on
if (!PerPlatformSdkInfo.Contains(PlatformName))
{
UE_LOG(LogTurnkeySupport, Log, TEXT("Received platform %s from Turnkey, but the engine doesn't know about it. Skipping..."), *PlatformName.ToString());
continue;
}
// check if we had already set a ManualSDK - and don't set it again. Because of the way AutoSDKs are activated in the editor after the first call to Turnkey,
// future calls to Turnkey will inherit the AutoSDK env vars, and it won't be able to determine the manual SDK versions anymore. If we use the editor to
// install an SDK via Turnkey, it will directly update the installed version based on the result of that command, not this Update operation
FString OriginalManualInstallValue = PerPlatformSdkInfo[PlatformName].InstalledVersion;
// set it into the platform
PerPlatformSdkInfo[PlatformName] = SdkInfo;
// restore the original installed version if it set after the first time
if (OriginalManualInstallValue.Len() > 0)
{
PerPlatformSdkInfo[PlatformName].InstalledVersion = OriginalManualInstallValue;
}
// UE_LOG(LogTurnkeySupport, Log, TEXT("[TEST] Turnkey Platform: %s - %d, Installed: %s, AudoSDK: %s, Allowed: %s-%s"), *PlatformName.ToString(), (int)SdkInfo.Status, *SdkInfo.InstalledVersion,
// *SdkInfo.AutoSDKVersion, *SdkInfo.MinAllowedVersion, *SdkInfo.MaxAllowedVersion);
}
}
}
else
{
for (auto& It : PerPlatformSdkInfo)
{
It.Value.Status = ETurnkeyPlatformSdkStatus::Error;
It.Value.SdkErrorInformation = FText::Format(NSLOCTEXT("Turnkey", "TurnkeyError_ReturnedError", "Turnkey returned an error, code {0}"), { ExitCode });
// @todo turnkey error description!
}
}
for (auto& It : PerPlatformSdkInfo)
{
if (It.Value.Status == ETurnkeyPlatformSdkStatus::Querying)
{
// fake platforms won't come back, just skip it
if (FDataDrivenPlatformInfoRegistry::GetPlatformInfo(It.Key).bIsFakePlatform)
{
It.Value.Status = ETurnkeyPlatformSdkStatus::Unknown;
}
else
{
It.Value.Status = ETurnkeyPlatformSdkStatus::Error;
It.Value.SdkErrorInformation = NSLOCTEXT("Turnkey", "TurnkeyError_NotReturned", "The platform's Sdk status was not returned from Turnkey");
}
}
}
// cleanup
FCoreDelegates::OnExit.Remove(OnExitHandle);
delete TurnkeyProcess;
IFileManager::Get().Delete(*ReportFilename);
});
Barrier->Trigger();
});
TurnkeyProcess->Launch();
}
void FTurnkeySupportModule::UpdateSdkInfoForDevices(TArray<FString> PlatformDeviceIds)
{
FString BaseCommandline, ReportFilename;
PrepForTurnkeyReport(BaseCommandline, ReportFilename);
// the platform part of the Id may need to be converted to be turnkey (ie UBT) proper
FString Commandline = BaseCommandline + FString(TEXT(" -Device=")) + FString::JoinBy(PlatformDeviceIds, TEXT("+"), [](FString Id) { return ConvertToUATDeviceId(Id); });
UE_LOG(LogTurnkeySupport, Log, TEXT("Running Turnkey device detection: '%s'"), *Commandline);
{
FScopeLock Lock(&GTurnkeySection);
// set status to querying
FTurnkeySdkInfo DefaultInfo;
DefaultInfo.Status = ETurnkeyPlatformSdkStatus::Querying;
for (const FString& Id : PlatformDeviceIds)
{
PerDeviceSdkInfo.Add(ConvertToDDPIDeviceId(Id), DefaultInfo);
}
}
FSerializedUATProcess* TurnkeyProcess = new FSerializedUATProcess(Commandline);
TurnkeyProcess->OnCompleted().BindLambda([this, ReportFilename, PlatformDeviceIds, TurnkeyProcess](int32 ExitCode)
{
UE_LOG(LogTurnkeySupport, Log, TEXT("Completed device detection: Code = %d"), ExitCode);
AsyncTask(ENamedThreads::GameThread, [this, ReportFilename, PlatformDeviceIds, ExitCode, TurnkeyProcess]()
{
FScopeLock Lock(&GTurnkeySection);
if (ExitCode == 0 || ExitCode == 10)
{
TArray<FString> Contents;
if (FFileHelper::LoadFileToStringArray(Contents, *ReportFilename))
{
for (FString& Line : Contents)
{
FName PlatformName;
FString DDPIDeviceId;
FTurnkeySdkInfo SdkInfo;
if (GetSdkInfoFromTurnkey(Line, PlatformName, DDPIDeviceId, SdkInfo) == false)
{
continue;
}
// skip over non-device lines
if (DDPIDeviceId.Len() == 0)
{
continue;
}
// we received a device from UAT that we don't know about in the editor. this should never happen since we pass a list of devices to Turnkey,
// so this is a logic error
if (!PerDeviceSdkInfo.Contains(DDPIDeviceId))
{
UE_LOG(LogTurnkeySupport, Error, TEXT("Received DeviceId %s from Turnkey, but the engine doesn't know about it."), *DDPIDeviceId);
}
UE_LOG(LogTurnkeySupport, Log, TEXT("Turnkey Device: %s"), *Line);
PerDeviceSdkInfo[DDPIDeviceId] = SdkInfo;
}
}
}
for (const FString& Id : PlatformDeviceIds)
{
FTurnkeySdkInfo& SdkInfo = PerDeviceSdkInfo[ConvertToDDPIDeviceId(Id)];
if (SdkInfo.Status == ETurnkeyPlatformSdkStatus::Querying)
{
SdkInfo.Status = ETurnkeyPlatformSdkStatus::Error;
SdkInfo.SdkErrorInformation = NSLOCTEXT("Turnkey", "TurnkeyError_DeviceNotReturned", "A device's Sdk status was not returned from Turnkey");
}
}
// cleanup
delete TurnkeyProcess;
IFileManager::Get().Delete(*ReportFilename);
});
});
TurnkeyProcess->Launch();
}
/**
* Runs Turnkey to get the Sdk information for all known platforms
*/
void FTurnkeySupportModule::RepeatQuickLaunch(FString DeviceId)
{
UE_LOG(LogTurnkeySupport, Display, TEXT("Launching on %s"), *DeviceId);
ITargetDeviceServicesModule* TargetDeviceServicesModule = static_cast<ITargetDeviceServicesModule*>(FModuleManager::Get().LoadModule(TEXT("TargetDeviceServices")));
TSharedPtr<ITargetDeviceProxy> Proxy = TargetDeviceServicesModule->GetDeviceProxyManager()->FindProxyDeviceForTargetDevice(DeviceId);
if (Proxy.IsValid())
{
HandleLaunchOnDeviceActionExecute(DeviceId, Proxy->GetName(), true);
}
else
{
// @todo show error toast
}
}
FTurnkeySdkInfo FTurnkeySupportModule::GetSdkInfo(FName PlatformName, bool bBlockIfQuerying) const
{
FScopeLock Lock(&GTurnkeySection);
// return the status, or Unknown info if not known
return PerPlatformSdkInfo.FindRef(ConvertToDDPIPlatform(PlatformName));
}
FTurnkeySdkInfo FTurnkeySupportModule::GetSdkInfoForDeviceId(const FString& DeviceId) const
{
FScopeLock Lock(&GTurnkeySection);
// return the status, or Unknown info if not known
return PerDeviceSdkInfo.FindRef(ConvertToDDPIDeviceId(DeviceId));
}
void FTurnkeySupportModule::ClearDeviceStatus(FName PlatformName)
{
FScopeLock Lock(&GTurnkeySection);
FString Prefix = ConvertToDDPIPlatform(PlatformName.ToString()) + "@";
for (auto& Pair : PerDeviceSdkInfo)
{
if (PlatformName == NAME_None || Pair.Key.StartsWith(Prefix))
{
Pair.Value.Status = ETurnkeyPlatformSdkStatus::Unknown;
}
}
}
#if WITH_EDITOR
bool FTurnkeySupportModule::Exec( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )
{
if (FParse::Command( &Cmd, TEXT("Turnkey")) )
{
// run Turnkey via UAT. The Cmd is added at the end in case the user wants to run additional commands
const FString CommandLine = FString::Printf( TEXT("Turnkey %s %s %s"), *ITurnkeyIOModule::Get().GetUATParams(), *FTurnkeyEditorSupport::GetUATOptions(), Cmd );
FTurnkeyEditorSupport::RunUAT(CommandLine, FText::GetEmpty(), LOCTEXT("Turnkey_CustomTurnkeyName", "Executing Turnkey"), LOCTEXT("Turnkey_CustomTurnkeyShortName", "Turnkey"), FEditorStyle::GetBrush(TEXT("MainFrame.PackageProject")));
return true;
}
else if ( FParse::Command( &Cmd, TEXT("RunUAT")) )
{
// run UAT directly. The Cmd is added at the start on the assumption that it contains the command to run
const FString CommandLine = FString::Printf( TEXT("%s %s %s"), Cmd, *ITurnkeyIOModule::Get().GetUATParams(), *FTurnkeyEditorSupport::GetUATOptions() );
FTurnkeyEditorSupport::RunUAT(CommandLine, FText::GetEmpty(), LOCTEXT("Turnkey_CustomUATName", "Executing Custom UAT Task"), LOCTEXT("Turnkey_CustomUATShortName", "UAT"), FEditorStyle::GetBrush(TEXT("MainFrame.PackageProject")));
return true;
}
return false;
}
#endif
void FTurnkeySupportModule::StartupModule( )
{
}
void FTurnkeySupportModule::ShutdownModule( )
{
}
IMPLEMENT_MODULE(FTurnkeySupportModule, TurnkeySupport);
#undef LOCTEXT_NAMESPACE