1. Epic GamesDeveloper
  3. ILauncherProfile

ILauncherProfile

Interface for launcher profile.

API > API/Developer > API/Developer/LauncherServices

Interface for launcher profile.

   
Name ILauncherProfile
Type class
Header File /Engine/Source/Developer/LauncherServices/Public/ILauncherProfile.h
Include Path #include "ILauncherProfile.h"

Syntax

class ILauncherProfile

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ILauncherProfile()

 Virtual destructor. ILauncherProfile.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCookedCulture ( const FString& CultureName
)

 Adds a culture to cook (only used if cooking by the book). ILauncherProfile.h  

void AddCookedMap ( const FString& MapName
)

 Adds a map to cook (only used if cooking by the book). ILauncherProfile.h  

void AddCookedPlatform ( const FString& PlatformName
)

 Adds a platform to cook (only used if cooking by the book). ILauncherProfile.h  

void AddCustomError ( const FString& UniqueId,
const FText& Text
)

 Add a custom error. This will prevent launching ILauncherProfile.h  

void AddCustomWarning ( const FString& UniqueId,
const FText& Text
)

 Add a custom warning. This does not prevent launching. ILauncherProfile.h  

void AssignId ( bool bOverrideExisting
)

 Ensures this profile has an Id, if it doesn't already have one ILauncherProfile.h  
Removes all cooked cultures. ILauncherProfile.h  

void ClearCookedMaps ()

 Removes all cooked maps. ILauncherProfile.h  
Removes all cooked platforms. ILauncherProfile.h  

ILauncherProfileLaunchRolePtr CreateLaunchRole ()

 Creates a new launch role and adds it to the profile. ILauncherProfile.h  

void FallbackBuildTargetUpdated()

 Notifies the profile that the fallback build target changed. ILauncherProfile.h  

void FallbackProjectUpdated()

 Notifies the profile that the fallback project path changed. ILauncherProfile.h  

ILauncherProfileAutomatedTestRef FindOrAddAutomatedTest ( const TCHAR* InternalName
)

 Returns an automated test by internal name, creating it if it doesn't already exist ILauncherProfile.h  
Gets the additional command line parameters that will be used when the app launches. ILauncherProfile.h  

TArray< FString > GetAllCustomErrors()

 Gets all custom errors in this profile ILauncherProfile.h  

TArray< FString > GetAllCustomWarnings()

 Gets all custom warnings in this profile ILauncherProfile.h  
Gets the archive directory. ILauncherProfile.h  

ILauncherProfileAutomatedTestPtr GetAutomatedTest ( const TCHAR* InternalName
) const

 Returns an existing automated test by internal name ILauncherProfile.h  

const FString & GetAutomatedTestBuildPath()

 Returns the current automated test build path ILauncherProfile.h  

const TArray< ILauncherProfileAutomatedTestRef > & GetAutomatedTests()

 Returns a list of all automated tests in the profile ILauncherProfile.h  

FString GetBasedOnReleaseVersionName()

   ILauncherProfile.h  
Gets the name of the build configuration. ILauncherProfile.h  
Gets the current build mode. ILauncherProfile.h  
Gets the build target.@Return Target name to build/run (it would match a .Target.cs file) ILauncherProfile.h  

const TArray< FString > & GetClientArchitectures()

 Returns the client architecture(s) that will be build. empty means the default will be used ILauncherProfile.h  
Gets the build configuration name of the cooker. ILauncherProfile.h  
Gets the list of cooked culture. ILauncherProfile.h  

const TArray< FString > & GetCookedMaps ()

 Gets the list of cooked maps. ILauncherProfile.h  
Gets the names of the platforms to build for. ILauncherProfile.h  
Gets the selected cook mode. ILauncherProfile.h  

const FString & GetCookOptions()

 Gets the cooker command line options. ILauncherProfile.h  

FString GetCreateReleaseVersionName()

   ILauncherProfile.h  

TMap< FString, bool > & GetCustomBoolProperties()

 Key-Value pairs for extsibility. Not user-facing. ILauncherProfile.h  

FText GetCustomErrorText ( const FString& UniqueId
) const

 Gets the localized string representation of the given error ILauncherProfile.h  

TMap< FString, FString > & GetCustomStringProperties()

 Key-Value pairs for extsibility. Not user-facing. ILauncherProfile.h  

FText GetCustomWarningText ( const FString& UniqueId
) const

 Gets the localized string representation of the given warning ILauncherProfile.h  

const FName GetDefaultDeployPlatform()

 Gets the default platforms to deploy if no specific devices were selected. ILauncherProfile.h  

const ILauncherProfileLaunchRoleRef & GetDefaultLaunchRole()

 Gets the default launch role. ILauncherProfile.h  

ILauncherDeviceGroupPtr GetDeployedDeviceGroup ()

 Gets the device group to deploy to. ILauncherProfile.h  
Gets the deployment mode. ILauncherProfile.h  

FString GetDescription()

 Gets the human readable description of the profile. ILauncherProfile.h  

FString GetDLCName()

   ILauncherProfile.h  

const TArray< FString > & GetEditorArchitectures()

 Returns the editor architecture(s) that will be build. empty means the default will be used ILauncherProfile.h  

FString GetEditorExe()

 Gets the path to the editor executable. ILauncherProfile.h  

TArray< FString > GetExplicitBuildTargetNames()

 Helper function to get all of the build targets available for this profile, based on its current project & cook platforms ILauncherProfile.h  

FString GetFileName()

 Gets the file name for serialization. ILauncherProfile.h  

FString GetFilePath()

 Gets the full file path for serialization. ILauncherProfile.h  

bool GetForceClose ()

 Gets the close mode for the cook on the fly server ILauncherProfile.h  

FString GetHttpChunkDataDirectory()

 Where generated http chunk install data will be stored. ILauncherProfile.h  

FString GetHttpChunkDataReleaseName()

 What name to tag the generated http chunk install data with. ILauncherProfile.h  

FGuid GetId()

 Gets the unique identifier of the profile. ILauncherProfile.h  
Get the current incremental cook mode ILauncherProfile.h  

FString GetInvalidPlatform()

 Gets the invalid platform, this is only valid when there is a platform centric validation error. ILauncherProfile.h  
Gets the launch mode. ILauncherProfile.h  

const TArray< ILauncherProfileLaunchRolePtr > & GetLaunchRoles ()

 Gets the profile's collection of launch roles. ILauncherProfile.h  

const int32 GetLaunchRolesFor ( const FString& DeviceId,
TArray< ILauncherProfileLaunchRolePtr >& OutRoles
)

 Gets the launch roles assigned to the specified device. ILauncherProfile.h  

FString GetName()

 Gets the human readable name of the profile. ILauncherProfile.h  

FString GetOriginalReleaseVersionName()

   ILauncherProfile.h  
Gets the packaging directory. ILauncherProfile.h  
Gets the packaging mode. ILauncherProfile.h  

FString GetProjectBasePath()

 Gets the base project path for the project (e.g. Samples/Showcases/MyShowcase) ILauncherProfile.h  

FString GetProjectName()

 Gets the name of the Unreal project to use. ILauncherProfile.h  
Gets the full path to the Unreal project to use. ILauncherProfile.h  

FString GetReferenceContainerCryptoKeysFileName()

   ILauncherProfile.h  
Provides a database of compressed iostore chunks to reuse during the staging process. ILauncherProfile.h  

const TArray< FString > & GetServerArchitectures()

 Returns the server architecture(s) that will be build. empty means the default will be used ILauncherProfile.h  

const bool GetSkipCookingEditorContent()

   ILauncherProfile.h  

uint32 GetTimeout ()

 Gets the timeout time for the cook on the fly server. ILauncherProfile.h  

FString GetZenPakStreamingPath()

 Get the current Zen pak streaming path, if it is being used. ILauncherProfile.h  

int32 GetZenSnapshot()

 Get the Zen snapshot build number used for import. ILauncherProfile.h  

bool HasBuildTargetSpecified()

 Checks whether the profile specifies a build target. ILauncherProfile.h  

bool HasCustomError ( const FString& UniqueId
) const

 Checks whether this profile has the given custom error ILauncherProfile.h  

bool HasCustomWarning ( const FString& UniqueId
) const

 Checks whether this profile has the given custom warning ILauncherProfile.h  
Checks whether the profile specifies a project. ILauncherProfile.h  
Checks whether the last validation yielded any error. ILauncherProfile.h  
Checks whether the last validation yielded the specified error. ILauncherProfile.h  

bool IsArchiving ()

 Whether to archive build ILauncherProfile.h  

bool IsBuildingUAT ()

 Checks whether UAT should be built. ILauncherProfile.h  

bool IsCompressed ()

 Checks if compression is enabled ILauncherProfile.h  
Checks whether legacy incremental cooking is enabled. ILauncherProfile.h  
Checks whether unversioned cooking is enabled. ILauncherProfile.h  

bool IsCreatingDLC()

   ILauncherProfile.h  

bool IsCreatingReleaseVersion()

 Creating a release version of the cooked content ILauncherProfile.h  

bool IsDeployablePlatform ( const FString& PlatformName
)

 Checks whether devices of the specified platform can be deployed to. ILauncherProfile.h  
Checks whether incremental deployment is enabled. ILauncherProfile.h  

bool IsDeviceASimulator()

 Whether or not the Device is a Simulator ILauncherProfile.h  

bool IsDLCIncludingEngineContent()

   ILauncherProfile.h  

bool IsEncryptingIniFiles()

 Checks if encrypting ini files is enabled ILauncherProfile.h  

bool IsFastIterate ()

 Checks if fast iterate is enabled. ILauncherProfile.h  
Checks whether the file server's console window should be hidden. ILauncherProfile.h  
Checks whether the file server is a streaming file server. ILauncherProfile.h  

bool IsForDistribution()

 Checks if encrypting ini files is enabled ILauncherProfile.h  

bool IsGenerateHttpChunkData()

 Return whether packaging will use chunk data to generate http chunk install data. ILauncherProfile.h  

bool IsGeneratingChunks()

 Return whether packaging will generate chunk data. ILauncherProfile.h  

bool IsGeneratingPatch()

 Are we going to generate a patch (Source content patch needs to be specified) @Seealso GetPatchSourceContentPath * @Seealso SetPatchSourceContentPath ILauncherProfile.h  

bool IsImportingZenSnapshot()

 Checks whether a Zen snapshot will be imported before cooking. ILauncherProfile.h  
Checks whether to include an installer for prerequisites of packaged games, such as redistributable operating system components, on platforms that support it. ILauncherProfile.h  

bool IsIterateSharedCookedBuild()

   ILauncherProfile.h  
Checks whether packaging with UnrealPak is enabled. ILauncherProfile.h  

bool IsUsingAutomatedTestBuild()

 Returns whether we are using the specified automated test build or not. ILauncherProfile.h  

bool IsUsingIoStore()

 Using I/O store or not. ILauncherProfile.h  

bool IsUsingZenPakStreaming()

 Checks whether Zen pak streaming will be used. ILauncherProfile.h  

bool IsUsingZenStore()

 Using Zen storage server or not. ILauncherProfile.h  

bool IsValidForLaunch()

 Checks whether this profile is valid to use when running a game instance. ILauncherProfile.h  

bool Load ( const FJsonObject& Object
)

 Loads the profile from a JSON file ILauncherProfile.h  

bool MakeBinaryConfig()

 Make binary config file during staging or not. ILauncherProfile.h  

FOnProfileBuildTargetOptionsChanged & OnBuildTargetOptionsChanged()

 Access delegate used when build target options change. ILauncherProfile.h  

FCookCanceledDelegate & OnCookCanceled()

 Returns the cook delegate which should be called if the cook is canceled Used by cook by the book in the editor ILauncherProfile.h  

FOnProfileCustomValidation & OnCustomValidation()

 Access delegate used when validation changes to gather custom warnings and errors ILauncherProfile.h  

FIsCookFinishedDelegate & OnIsCookFinished ()

 Returns the cook delegate which can be used to query if the cook is finished. ILauncherProfile.h  

FOnProfileProjectChanged & OnProjectChanged()

 Accesses delegate used when the project changes. ILauncherProfile.h  

void RefreshCustomWarningsAndErrors()

 Refreshes the custom warnings and errors. Resets the lists and triggers the OnValidation callback. ILauncherProfile.h  

void RemoveAutomatedTest ( const TCHAR* InternalName
)

 Removes an automated test by internal name ILauncherProfile.h  

void RemoveCookedCulture ( const FString& CultureName
)

 Removes a cooked culture. ILauncherProfile.h  

void RemoveCookedMap ( const FString& MapName
)

 Removes a cooked map. ILauncherProfile.h  

void RemoveCookedPlatform ( const FString& PlatformName
)

 Removes a platform from the cook list. ILauncherProfile.h  

void RemoveLaunchRole ( const ILauncherProfileLaunchRoleRef& Role
)

 Removes the given launch role from the profile. ILauncherProfile.h  

bool RequiresExplicitBuildTargetName()

 Whether the profile will require an explicit -target=XXX parameter ILauncherProfile.h  

void Save ( TJsonWriter<>& Writer
)

 Saves the profile into a JSON file ILauncherProfile.h  

bool Serialize ( FArchive& Archive
)

 Serializes the profile from or into the specified archive. ILauncherProfile.h  
Sets the additional command line parameters for the application to use at launch. ILauncherProfile.h  

void SetAddPatchLevel ( bool InAddPatchLevel
)

   ILauncherProfile.h  

void SetArchive ( bool bArchive
)

 Sets whether to archive build ILauncherProfile.h  

void SetArchiveDirectory ( const FString& Dir
)

 Sets the archive directory. ILauncherProfile.h  

void SetAutomatedTestBuildPath ( const FString& AutomatedTestBuildPath
)

 Sets the build to use for ALL automated tests, equivalent to the -build parameter on RunUnreal etc. ILauncherProfile.h  

void SetBasedOnReleaseVersionName ( const FString& InBasedOnReleaseVersion
)

   ILauncherProfile.h  
Sets the build configuration. ILauncherProfile.h  
Sets the current build mode ILauncherProfile.h  

void SetBuildTarget ( const FString& TargetName
)

 Sets the build target. ILauncherProfile.h  

void SetBuildTargetSpecified ( bool Specified
)

 Sets whether this profile specfies a build target. ILauncherProfile.h  

void SetBuildUAT ( bool Build
)

 Sets whether to build UAT. ILauncherProfile.h  

void SetClientArchitectures ( const TArray< FString >& InArchitectures
)

 Sets the client architecture(s) to build (x64, arm64 etc). Leave empty to use the default ILauncherProfile.h  

void SetCompressed ( bool Enable
)

 Sets Compression. ILauncherProfile.h  

void SetCookConfiguration ( EBuildConfiguration Configuration
)

 Sets the build configuration of the cooker. ILauncherProfile.h  
Sets the cook mode. ILauncherProfile.h  

void SetCookOptions ( const FString& Options
)

 Sets the cook options. ILauncherProfile.h  

void SetCreateDLC ( bool InBuildDLC
)

   ILauncherProfile.h  

void SetCreateReleaseVersion ( bool InCreateReleaseVersion
)

   ILauncherProfile.h  

void SetCreateReleaseVersionName ( const FString& InCreateReleaseVersionName
)

   ILauncherProfile.h  

void SetDefaultDeployPlatform ( const FName PlatformName
)

 Adds a platform to deploy (only used if a specific device is not specified). ILauncherProfile.h  

void SetDefaults()

 Sets all profile settings to their defaults. ILauncherProfile.h  

void SetDeployedDeviceGroup ( const ILauncherDeviceGroupPtr& DeviceGroup
)

 Sets the device group to deploy to. ILauncherProfile.h  
Sets the deployment mode. ILauncherProfile.h  

void SetDeployWithUnrealPak ( bool UseUnrealPak
)

 Sets whether to pack with UnrealPak. ILauncherProfile.h  

void SetDescription ( const FString& NewDescription
)

 Updates the description of the profile. ILauncherProfile.h  

void SetDeviceIsASimulator ( bool bInIsDeviceASimualtor
)

 Sets whether or not the Device is a Simulator ILauncherProfile.h  

void SetDLCIncludeEngineContent ( bool InDLCIncludeEngineContent
)

   ILauncherProfile.h  

void SetDLCName ( const FString& InDLCName
)

   ILauncherProfile.h  

void SetEditorArchitectures ( const TArray< FString >& InArchitectures
)

 Sets the editor architecture(s) to build (x64, arm64 etc). Leave empty to use the default ILauncherProfile.h  

void SetEditorExe ( const FString& EditorExe
)

 Sets the path to the editor executable to use in UAT. ILauncherProfile.h  

void SetEncryptingIniFiles ( bool Enabled
)

 Set encrypt ini files ILauncherProfile.h  

void SetFastIterate ( bool Enable
)

 Sets fast iterate. ILauncherProfile.h  

void SetForceClose ( bool Close
)

 Sets the cook on the fly close mode ILauncherProfile.h  

void SetForDistribution ( bool Enabled
)

 Set this build is for distribution to the public ILauncherProfile.h  

void SetGenerateChunks ( bool bGenerateChunks
)

 Set whether packaging will generate chunk data. ILauncherProfile.h  

void SetGenerateHttpChunkData ( bool bGenerateHttpChunkData
)

 Set whether packaging will use chunk data to generate http chunk install data. ILauncherProfile.h  

void SetGeneratePatch ( bool InShouldGeneratePatch
)

 Sets if we are going to generate a patch ILauncherProfile.h  

void SetHideFileServerWindow ( bool Hide
)

 Sets whether to hide the file server's console window. ILauncherProfile.h  

void SetHttpChunkDataDirectory ( const FString& InHttpChunkDataDirectory
)

 Set where generated http chunk install data will be stored. ILauncherProfile.h  

void SetHttpChunkDataReleaseName ( const FString& InHttpChunkDataReleaseName
)

 Set what name to tag the generated http chunk install data with. ILauncherProfile.h  

void SetImportingZenSnapshot ( bool Import
)

 Set whether to import a Zen snapshot before cooking. ILauncherProfile.h  

void SetIncludePrerequisites ( bool InValue
)

 Sets whether to include game prerequisites. ILauncherProfile.h  

void SetIncrementalCooking ( bool Incremental
)

 Sets legacy incremental cooking. ILauncherProfile.h  
Set the incremental cook mode. ILauncherProfile.h  

void SetIncrementalDeploying ( bool Incremental
)

 Sets incremental deploying. ILauncherProfile.h  

void SetIsUsingAutomatedTestBuild ( bool bWantAutomatedTestBuild
)

 Set whether to use the specified automated test build or the current launch build. ILauncherProfile.h  

void SetIterateSharedCookedBuild ( bool IterateSharedCookedBuild
)

   ILauncherProfile.h  
Sets the launch mode. ILauncherProfile.h  

void SetMakeBinaryConfig ( bool bMakeBinaryConfig
)

 Sets whether to make a binary config file during packaging ILauncherProfile.h  

void SetName ( const FString& NewName
)

 Updates the name of the profile. ILauncherProfile.h  

void SetNotForLicensees()

 Changes the save location to an internal project path. ILauncherProfile.h  

void SetOriginalReleaseVersionName ( const FString& InOriginalReleaseVersion
)

   ILauncherProfile.h  

void SetPackageDirectory ( const FString& Dir
)

 Sets the packaging directory. ILauncherProfile.h  
Sets the packaging mode. ILauncherProfile.h  

void SetProjectPath ( const FString& Path
)

 Sets the path to the Unreal project to use. ILauncherProfile.h  

void SetProjectSpecified ( bool Specified
)

 Sets whether this profile specifies the a project. ILauncherProfile.h  

void SetReferenceContainerCryptoKeysFileName ( const FString& InReferenceContainerCryptoKeysFileName
)

   ILauncherProfile.h  

void SetReferenceContainerGlobalFileName ( const FString& InReferenceContainerGlobalFileName
)

   ILauncherProfile.h  

void SetServerArchitectures ( const TArray< FString >& InArchitectures
)

 Sets the server architecture(s) to build (x64, arm64 etc). Leave empty to use the default ILauncherProfile.h  

void SetShouldUpdateDeviceFlash ( bool bInShouldUpdateFlash
)

 Sets whether or not the flash image/software on the device should attempt to be updated before running ILauncherProfile.h  

void SetSkipCookingEditorContent ( const bool InSkipCookingEditorContent
)

 Skip editor content while cooking, This will strip editor content from final builds ILauncherProfile.h  

void SetStageBaseReleasePaks ( bool InStageBaseReleasePaks
)

   ILauncherProfile.h  

void SetStreamingFileServer ( bool Streaming
)

 Sets whether to use a streaming file server. ILauncherProfile.h  

void SetTimeout ( uint32 InTime
)

 Sets the cook on the fly server timeout ILauncherProfile.h  

void SetUnversionedCooking ( bool Unversioned
)

 Sets unversioned cooking. ILauncherProfile.h  

void SetUseIoStore ( bool bUseIoStore
)

 Sets whether to use I/O store for optimized loading. ILauncherProfile.h  

void SetUseZenPakStreaming ( bool UseZenPakStreaming
)

 Set whether to use Zen pak streaming. ILauncherProfile.h  

void SetUseZenStore ( bool bUseZenStore
)

 Sets whether to use the Zen storage server. ILauncherProfile.h  

void SetZenPakStreamingPath ( const FString& Path
)

 Sets whether to use Zen pak streaming from the given path. ILauncherProfile.h  

bool ShouldAddPatchLevel()

 Are we going to generate a new patch tier ILauncherProfile.h  

bool ShouldBuild ()

 Determines whether the current profile requires building ILauncherProfile.h  

bool ShouldStageBaseReleasePaks()

 Should we stage the pak files from the base release version this patch is built on ILauncherProfile.h  

bool ShouldUpdateDeviceFlash()

 Whether or not the flash image/software on the device should attempt to be updated before running ILauncherProfile.h  

bool SupportsEngineMaps()

 Checks whether the profile's selected project supports Engine maps. ILauncherProfile.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page