ILauncherProfileBuildCookRun

Interface for BuildCookRun UAT command.

API > API/Developer > API/Developer/LauncherServices

Interface for BuildCookRun UAT command.

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

Syntax

class ILauncherProfileBuildCookRun : public ILauncherProfileUATCommand

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ILauncherProfileBuildCookRun()

 Virtual destructor. ILauncherProfileBuildCookRun.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBuildTarget ( const FString& InBuildTarget
)

 Add a build target to the list ILauncherProfileBuildCookRun.h  

void AddCookedCulture ( const FString& CultureName
)

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

void AddCookedMap ( const FString& MapName
)

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

void AddCookedPlatform ( const FString& PlatformName
)

 Adds a platform to cook (only used if cooking by the book). ILauncherProfileBuildCookRun.h  
Clears the list of build targets ILauncherProfileBuildCookRun.h  
Removes all cooked cultures. ILauncherProfileBuildCookRun.h  

void ClearCookedMaps ()

 Removes all cooked maps. ILauncherProfileBuildCookRun.h  
Removes all cooked platforms. ILauncherProfileBuildCookRun.h  

ILauncherProfileLaunchRolePtr CreateLaunchRole ()

 Creates a new launch role and adds it to the profile. ILauncherProfileBuildCookRun.h  
Gets the additional command line parameters that will be used when the app launches. ILauncherProfileBuildCookRun.h  
Gets the additional command line parameters that will be used for the given target type when the app launches. ILauncherProfileBuildCookRun.h  
Gets the archive directory. ILauncherProfileBuildCookRun.h  

FString GetBasedOnReleaseVersionName()

   ILauncherProfileBuildCookRun.h  
Gets the name of the build configuration. ILauncherProfileBuildCookRun.h  
Gets the current build mode. ILauncherProfileBuildCookRun.h  
Gets the names of the build targets ILauncherProfileBuildCookRun.h  

const TArray< FString > & GetClientArchitectures()

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

const TArray< FString > & GetCookedMaps ()

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

const FString & GetCookOptions()

 Gets the cooker command line options. ILauncherProfileBuildCookRun.h  

FString GetCreateReleaseVersionName()

   ILauncherProfileBuildCookRun.h  

const FName GetDefaultDeployPlatform()

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

const ILauncherProfileLaunchRoleRef & GetDefaultLaunchRole()

 Gets the default launch role. ILauncherProfileBuildCookRun.h  

ILauncherDeviceGroupPtr GetDeployedDeviceGroup ( bool bRefreshDevices
)

 Gets the device group to deploy to. ILauncherProfileBuildCookRun.h  
Gets the identifier of the device group to deploy to. ILauncherProfileBuildCookRun.h  
Gets the deployment mode. ILauncherProfileBuildCookRun.h  

FString GetDLCName()

   ILauncherProfileBuildCookRun.h  

const TArray< FString > & GetEditorArchitectures()

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

bool GetForceClose ()

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

FString GetHttpChunkDataDirectory()

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

FString GetHttpChunkDataReleaseName()

 What name to tag the generated http chunk install data with. ILauncherProfileBuildCookRun.h  
Gets the launch mode. ILauncherProfileBuildCookRun.h  

const TArray< ILauncherProfileLaunchRolePtr > & GetLaunchRoles ()

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

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

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

FString GetOriginalReleaseVersionName()

   ILauncherProfileBuildCookRun.h  
Gets the packaging directory. ILauncherProfileBuildCookRun.h  
Gets the packaging mode. ILauncherProfileBuildCookRun.h  

FString GetReferenceContainerCryptoKeysFileName()

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

const TArray< FString > & GetServerArchitectures()

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

const bool GetSkipCookingEditorContent()

   ILauncherProfileBuildCookRun.h  

uint32 GetTimeout ()

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

FString GetZenPakStreamingPath()

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

bool HasBuildTargetSpecified()

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

bool IsArchiving ()

 Whether to archive build ILauncherProfileBuildCookRun.h  

bool IsCompressed ()

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

bool IsCreatingDLC()

   ILauncherProfileBuildCookRun.h  

bool IsCreatingReleaseVersion()

 Creating a release version of the cooked content ILauncherProfileBuildCookRun.h  

bool IsDeployablePlatform ( const FString& PlatformName
)

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

bool IsDeviceASimulator()

 Whether or not the Device is a Simulator ILauncherProfileBuildCookRun.h  

bool IsDLCIncludingEngineContent()

   ILauncherProfileBuildCookRun.h  

bool IsEncryptingIniFiles()

 Checks if encrypting ini files is enabled ILauncherProfileBuildCookRun.h  

bool IsFastIterate ()

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

bool IsForDistribution()

 Checks if encrypting ini files is enabled ILauncherProfileBuildCookRun.h  

bool IsGenerateHttpChunkData()

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

bool IsGeneratingChunks()

 Return whether packaging will generate chunk data. ILauncherProfileBuildCookRun.h  

bool IsGeneratingPatch()

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

bool IsImportingZenSnapshot()

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

bool IsIterateSharedCookedBuild()

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

bool IsUsingIoStore()

 Using I/O store or not. ILauncherProfileBuildCookRun.h  

bool IsUsingPreStagedBuild()

 Checks whether a pre-staged build willbe used ILauncherProfileBuildCookRun.h  

bool IsUsingZenPakStreaming()

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

bool IsUsingZenStore()

 Using Zen storage server or not. ILauncherProfileBuildCookRun.h  

bool IsUsingZenStreaming()

 Checks whether Zen streaming will be used. ILauncherProfileBuildCookRun.h  

bool MakeBinaryConfig()

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

void RemoveBuildTarget ( const FString& InBuildTarget
)

 Remove a build target from the list ILauncherProfileBuildCookRun.h  

void RemoveCookedCulture ( const FString& CultureName
)

 Removes a cooked culture. ILauncherProfileBuildCookRun.h  

void RemoveCookedMap ( const FString& MapName
)

 Removes a cooked map. ILauncherProfileBuildCookRun.h  

void RemoveCookedPlatform ( const FString& PlatformName
)

 Removes a platform from the cook list. ILauncherProfileBuildCookRun.h  

void RemoveLaunchRole ( const ILauncherProfileLaunchRoleRef& Role
)

 Removes the given launch role from the profile. ILauncherProfileBuildCookRun.h  
Sets the additional command line parameters for the application to use at launch. ILauncherProfileBuildCookRun.h  

void SetAdditionalTargetCommandLineParameters ( const FString& Params,
EBuildTargetType BuildTargetType
)

 Sets the additional command line parameters that will be used for the given target type when the app launches. ILauncherProfileBuildCookRun.h  

void SetAddPatchLevel ( bool InAddPatchLevel
)

   ILauncherProfileBuildCookRun.h  

void SetArchive ( bool bArchive
)

 Sets whether to archive build ILauncherProfileBuildCookRun.h  

void SetArchiveDirectory ( const FString& Dir
)

 Sets the archive directory. ILauncherProfileBuildCookRun.h  

void SetBasedOnReleaseVersionName ( const FString& InBasedOnReleaseVersion
)

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

void SetBuildTargetSpecified ( bool Specified
)

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

void SetClientArchitectures ( const TArray< FString >& InArchitectures
)

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

void SetCompressed ( bool Enable
)

 Sets Compression. ILauncherProfileBuildCookRun.h  

void SetCookConfiguration ( EBuildConfiguration Configuration
)

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

void SetCookOptions ( const FString& Options
)

 Sets the cook options. ILauncherProfileBuildCookRun.h  

void SetCreateDLC ( bool InBuildDLC
)

   ILauncherProfileBuildCookRun.h  

void SetCreateReleaseVersion ( bool InCreateReleaseVersion
)

   ILauncherProfileBuildCookRun.h  

void SetCreateReleaseVersionName ( const FString& InCreateReleaseVersionName
)

   ILauncherProfileBuildCookRun.h  

void SetDefaultDeployPlatform ( const FName PlatformName
)

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

void SetDefaults()

 Sets all profile settings to their defaults. ILauncherProfileBuildCookRun.h  

void SetDeployedDeviceGroup ( const ILauncherDeviceGroupPtr& DeviceGroup
)

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

void SetDeployWithUnrealPak ( bool UseUnrealPak
)

 Sets whether to pack with UnrealPak. ILauncherProfileBuildCookRun.h  

void SetDeviceIsASimulator ( bool bInIsDeviceASimualtor
)

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

void SetDLCIncludeEngineContent ( bool InDLCIncludeEngineContent
)

   ILauncherProfileBuildCookRun.h  

void SetDLCName ( const FString& InDLCName
)

   ILauncherProfileBuildCookRun.h  

void SetEditorArchitectures ( const TArray< FString >& InArchitectures
)

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

void SetEncryptingIniFiles ( bool Enabled
)

 Set encrypt ini files ILauncherProfileBuildCookRun.h  

void SetFastIterate ( bool Enable
)

 Sets fast iterate. ILauncherProfileBuildCookRun.h  

void SetForceClose ( bool Close
)

 Sets the cook on the fly close mode ILauncherProfileBuildCookRun.h  

void SetForDistribution ( bool Enabled
)

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

void SetGenerateChunks ( bool bGenerateChunks
)

 Set whether packaging will generate chunk data. ILauncherProfileBuildCookRun.h  

void SetGenerateHttpChunkData ( bool bGenerateHttpChunkData
)

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

void SetGeneratePatch ( bool InShouldGeneratePatch
)

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

void SetHideFileServerWindow ( bool Hide
)

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

void SetHttpChunkDataDirectory ( const FString& InHttpChunkDataDirectory
)

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

void SetHttpChunkDataReleaseName ( const FString& InHttpChunkDataReleaseName
)

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

void SetImportingZenSnapshot ( bool Import
)

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

void SetIncludePrerequisites ( bool InValue
)

 Sets whether to include game prerequisites. ILauncherProfileBuildCookRun.h  

void SetIncrementalCooking ( bool Incremental
)

 Sets legacy incremental cooking. ILauncherProfileBuildCookRun.h  

void SetIncrementalDeploying ( bool Incremental
)

 Sets incremental deploying. ILauncherProfileBuildCookRun.h  

void SetIterateSharedCookedBuild ( bool IterateSharedCookedBuild
)

   ILauncherProfileBuildCookRun.h  
Sets the launch mode. ILauncherProfileBuildCookRun.h  

void SetMakeBinaryConfig ( bool bMakeBinaryConfig
)

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

void SetOriginalReleaseVersionName ( const FString& InOriginalReleaseVersion
)

   ILauncherProfileBuildCookRun.h  

void SetPackageDirectory ( const FString& Dir
)

 Sets the packaging directory. ILauncherProfileBuildCookRun.h  
Sets the packaging mode. ILauncherProfileBuildCookRun.h  

void SetReferenceContainerCryptoKeysFileName ( const FString& InReferenceContainerCryptoKeysFileName
)

   ILauncherProfileBuildCookRun.h  

void SetReferenceContainerGlobalFileName ( const FString& InReferenceContainerGlobalFileName
)

   ILauncherProfileBuildCookRun.h  

void SetServerArchitectures ( const TArray< FString >& InArchitectures
)

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

void SetSkipCookingEditorContent ( const bool InSkipCookingEditorContent
)

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

void SetStreamingFileServer ( bool Streaming
)

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

void SetTimeout ( uint32 InTime
)

 Sets the cook on the fly server timeout ILauncherProfileBuildCookRun.h  

void SetUnversionedCooking ( bool Unversioned
)

 Sets unversioned cooking. ILauncherProfileBuildCookRun.h  

void SetUseIoStore ( bool bUseIoStore
)

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

void SetUsePreStagedBuild ( bool UsePreStagedBuild
)

 Set whether to use a pre-staged build ILauncherProfileBuildCookRun.h  

void SetUseZenPakStreaming ( bool UseZenPakStreaming
)

 Set whether to use Zen pak streaming. ILauncherProfileBuildCookRun.h  

void SetUseZenStore ( bool bUseZenStore
)

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

void SetUseZenStreaming ( bool UseZenStreaming
)

 Set whether to use Zen streaming. ILauncherProfileBuildCookRun.h  

void SetZenPakStreamingPath ( const FString& Path
)

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

bool ShouldAddPatchLevel()

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

bool ShouldBuild ()

 Determines whether the current profile requires building ILauncherProfileBuildCookRun.h  

Overridden from ILauncherProfileUATCommand

Name Remarks Include Path Unreal Specifiers

bool Load ( const FJsonObject& Object
)

 Loads the profile from a JSON file ILauncherProfileBuildCookRun.h  

void Save ( TJsonWriter<>& Writer
)

 Saves the profile into a JSON file ILauncherProfileBuildCookRun.h  

Public Virtual

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page