1. Epic GamesDeveloper
  3. ILauncherProfile

ILauncherProfile

Interface for launcher profile.

API > API/Developer > API/Developer/LauncherServices

References

   
Module LauncherServices
Header /Engine/Source/Developer/LauncherServices/Public/ILauncherProfile.h
Include #include "ILauncherProfile.h"

Syntax

class ILauncherProfile

Remarks

Interface for launcher profile.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function void

AddCookedCulture ( const FString& CultureName
)

 Adds a culture to cook (only used if cooking by the book).
Public function void

AddCookedMap ( const FString& MapName
)

 Adds a map to cook (only used if cooking by the book).
Public function void

AddCookedPlatform ( const FString& PlatformName
)

 Adds a platform to cook (only used if cooking by the book).
Public function void Removes all cooked cultures.
Public function void Removes all cooked maps.
Public function void Removes all cooked platforms.
Public function ILauncherProfileLaunchRolePtr Creates a new launch role and adds it to the profile.
Public function void Notifies the profile that the fallback build target changed.
Public function void Notifies the profile that the fallback project path changed.
Public function Const FString Gets the additional command line parameters that will be used when the app launches.
Public function Const FString Gets the archive directory.
Public function Const FString  
Public function Const EBuildConfiguration Gets the name of the build configuration.
Public function Const ELauncherProfileBuildModes::Type Gets the current build mode.
Public function Const FString Gets the build target.Target name to build/run (it would match a .Target.cs file)
Public function Const EBuildConfiguration Gets the build configuration name of the cooker.
Public function Const const TArray< FString > & Gets the list of cooked culture.
Public function Const const TArray< FString > & Gets the list of cooked maps.
Public function Const const TArray< FString > & Gets the names of the platforms to build for.
Public function Const ELauncherProfileCookModes::Type Gets the selected cook mode.
Public function Const const FString & Gets the cooker command line options.
Public function Const FString  
Public function Const const FName Gets the default platforms to deploy if no specific devices were selected.
Public function Const const ILauncherProfileLaunchRoleRef & Gets the default launch role.
Public function ILauncherDeviceGroupPtr Gets the device group to deploy to.
Public function Const ELauncherProfileDeploymentModes::Type Gets the deployment mode.
Public function Const FString Gets the human readable description of the profile.
Public function Const FString  
Public function Const FString Gets the path to the editor executable.
Public function Const TArray< FString > Helper function to get all of the build targets available for this profile, based on its current project & cook platforms
Public function Const FString Gets the file name for serialization.
Public function Const FString Gets the full file path for serialization.
Public function Const bool Gets the close mode for the cook on the fly server
Public function Const FString Where generated http chunk install data will be stored.
Public function Const FString What name to tag the generated http chunk install data with.
Public function Const FGuid

GetId ()

 Gets the unique identifier of the profile.
Public function Const FString Gets the invalid platform, this is only valid when there is a platform centric validation error.
Public function Const ELauncherProfileLaunchModes::Type Gets the launch mode.
Public function Const const TArray< ILauncherProfileLaunchRolePtr > & Gets the profile's collection of launch roles.
Public function const int32 Gets the launch roles assigned to the specified device.
Public function Const FString

GetName ()

 Gets the human readable name of the profile.
Public function Const FString  
Public function Const FString Gets the packaging directory.
Public function Const ELauncherProfilePackagingModes::Type Gets the packaging mode.
Public function Const FString Gets the base project path for the project (e.g. Samples/Showcases/MyShowcase)
Public function Const FString Gets the name of the Unreal project to use.
Public function Const FString Gets the full path to the Unreal project to use.
Public function Const FString  
Public function Const FString Provides a database of compressed iostore chunks to reuse during the staging process.
Public function Const const bool  
Public function Const uint32 Gets the timeout time for the cook on the fly server.
Public function Const bool Checks whether the profile specifies a build target.
Public function Const bool Checks whether the profile specifies a project.
Public function Const bool Checks whether the last validation yielded any error.
Public function Const bool Checks whether the last validation yielded the specified error.
Public function Const bool Whether to archive build
Public function Const bool Checks whether UAT should be built.
Public function Const bool Checks if compression is enabled
Public function Const bool Checks whether incremental cooking is enabled.
Public function Const bool Checks whether unversioned cooking is enabled.
Public function Const bool  
Public function Const bool Creating a release version of the cooked content
Public function bool

IsDeployablePlatform ( const FString& PlatformName
)

 Checks whether devices of the specified platform can be deployed to.
Public function Const bool Checks whether incremental deployment is enabled.
Public function Const bool  
Public function Const bool Checks if encrypting ini files is enabled
Public function Const bool Checks whether the file server's console window should be hidden.
Public function Const bool Checks whether the file server is a streaming file server.
Public function Const bool Checks if encrypting ini files is enabled
Public function Const bool Return whether packaging will use chunk data to generate http chunk install data.
Public function Const bool Return whether packaging will generate chunk data.
Public function Const bool Are we going to generate a patch (Source content patch needs to be specified) GetPatchSourceContentPath * SetPatchSourceContentPath
Public function Const bool Checks whether to include an installer for prerequisites of packaged games, such as redistributable operating system components, on platforms that support it.
Public function Const bool  
Public function Const bool Checks whether packaging with UnrealPak is enabled.
Public function Const bool Whether or not to save the unaltered staged directory for platforms that modify i/o store containers for deployment.
Public function Const bool Using I/O store or not.
Public function Const bool Using Zen storage server or not.
Public function bool Checks whether this profile is valid to use when running a game instance.
Public function bool

Load ( const FJsonObject& Object
)

 Loads the profile from a JSON file
Public function Const bool Make binary config file during staging or not.
Public function FOnProfileBuildTargetOptionsChanged & Access delegate used when build target options change.
Public function FCookCanceledDelegate & Returns the cook delegate which should be called if the cook is canceled Used by cook by the book in the editor
Public function FIsCookFinishedDelegate & Returns the cook delegate which can be used to query if the cook is finished.
Public function FOnProfileProjectChanged & Accesses delegate used when the project changes.
Public function void

RemoveCookedCulture ( const FString& CultureName
)

 Removes a cooked culture.
Public function void

RemoveCookedMap ( const FString& MapName
)

 Removes a cooked map.
Public function void

RemoveCookedPlatform ( const FString& PlatformName
)

 Removes a platform from the cook list.
Public function void Removes the given launch role from the profile.
Public function Const bool Whether the profile will require an explicit -target=XXX parameter
Public function void

Save ( TJsonWriter<>& Writer
)

 Saves the profile into a JSON file
Public function bool

Serialize ( FArchive& Archive
)

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

SetAddPatchLevel ( bool InAddPatchLevel
)

  
Public function void

SetArchive ( bool bArchive
)

 Sets whether to archive build
Public function void

SetArchiveDirectory ( const FString& Dir
)

 Sets the archive directory.
Public function void

SetBasedOnReleaseVersionName ( const FString& InBasedOnReleaseVersion
)

  
Public function void

SetBuildConfiguration ( EBuildConfiguration Configuration
)

 Sets the build configuration.
Public function void Sets the current build mode
Public function void

SetBuildTarget ( const FString& TargetName
)

 Sets the build target.
Public function void

SetBuildTargetSpecified ( bool Specified
)

 Sets whether this profile specfies a build target.
Public function void

SetBuildUAT ( bool Build
)

 Sets whether to build UAT.
Public function void

SetCompressed ( bool Enable
)

 Sets Compression.
Public function void

SetCookConfiguration ( EBuildConfiguration Configuration
)

 Sets the build configuration of the cooker.
Public function void Sets the cook mode.
Public function void

SetCookOptions ( const FString& Options
)

 Sets the cook options.
Public function void

SetCreateDLC ( bool InBuildDLC
)

  
Public function void

SetCreateReleaseVersion ( bool InCreateReleaseVersion
)

  
Public function void

SetCreateReleaseVersionName ( const FString& InCreateReleaseVersionName
)

  
Public function void

SetDefaultDeployPlatform ( const FName PlatformName
)

 Adds a platform to deploy (only used if a specific device is not specified).
Public function void Sets all profile settings to their defaults.
Public function void Sets the device group to deploy to.
Public function void Sets the deployment mode.
Public function void

SetDeployWithUnrealPak ( bool UseUnrealPak
)

 Sets whether to pack with UnrealPak.
Public function void

SetDescription ( const FString& NewDescription
)

 Updates the description of the profile.
Public function void

SetDLCIncludeEngineContent ( bool InDLCIncludeEngineContent
)

  
Public function void

SetDLCName ( const FString& InDLCName
)

  
Public function void

SetEditorExe ( const FString& EditorExe
)

 Sets the path to the editor executable to use in UAT.
Public function void

SetEncryptingIniFiles ( bool Enabled
)

 Set encrypt ini files
Public function void

SetForceClose ( bool Close
)

 Sets the cook on the fly close mode
Public function void

SetForDistribution ( bool Enabled
)

 Set this build is for distribution to the public
Public function void

SetGenerateChunks ( bool bGenerateChunks
)

 Set whether packaging will generate chunk data.
Public function void

SetGenerateHttpChunkData ( bool bGenerateHttpChunkData
)

 Set whether packaging will use chunk data to generate http chunk install data.
Public function void

SetGeneratePatch ( bool InShouldGeneratePatch
)

 Sets if we are going to generate a patch
Public function void

SetHideFileServerWindow ( bool Hide
)

 Sets whether to hide the file server's console window.
Public function void

SetHttpChunkDataDirectory ( const FString& InHttpChunkDataDirectory
)

 Set where generated http chunk install data will be stored.
Public function void

SetHttpChunkDataReleaseName ( const FString& InHttpChunkDataReleaseName
)

 Set what name to tag the generated http chunk install data with.
Public function void

SetIncludePrerequisites ( bool InValue
)

 Sets whether to include game prerequisites.
Public function void

SetIncrementalCooking ( bool Incremental
)

 Sets incremental cooking.
Public function void

SetIncrementalDeploying ( bool Incremental
)

 Sets incremental deploying.
Public function void

SetIterateSharedCookedBuild ( bool IterateSharedCookedBuild
)

  
Public function void Sets the launch mode.
Public function void

SetMakeBinaryConfig ( bool bMakeBinaryConfig
)

 Sets whether to make a binary config file during packaging
Public function void

SetName ( const FString& NewName
)

 Updates the name of the profile.
Public function void Changes the save location to an internal project path.
Public function void

SetOriginalReleaseVersionName ( const FString& InOriginalReleaseVersion
)

  
Public function void

SetPackageDirectory ( const FString& Dir
)

 Sets the packaging directory.
Public function void Sets the packaging mode.
Public function void

SetProjectPath ( const FString& Path
)

 Sets the path to the Unreal project to use.
Public function void

SetProjectSpecified ( bool Specified
)

 Sets whether this profile specifies the a project.
Public function void

SetReferenceContainerCryptoKeysFileName ( const FString& InReferenceContainerCryptoKeysFileName
)

  
Public function void

SetReferenceContainerGlobalFileName ( const FString& InReferenceContainerGlobalFileName
)

  
Public function void

SetRetainStagedDirectory ( bool bInRetainStagedDirectory
)

  
Public function void

SetShouldUpdateDeviceFlash ( bool bInShouldUpdateFlash
)

 Sets whether or not the flash image/software on the device should attempt to be updated before running
Public function void

SetSkipCookingEditorContent ( const bool InSkipCookingEditorContent
)

 Skip editor content while cooking, This will strip editor content from final builds
Public function void

SetStageBaseReleasePaks ( bool InStageBaseReleasePaks
)

  
Public function void

SetStreamingFileServer ( bool Streaming
)

 Sets whether to use a streaming file server.
Public function void

SetTimeout ( uint32 InTime
)

 Sets the cook on the fly server timeout
Public function void

SetUnversionedCooking ( bool Unversioned
)

 Sets unversioned cooking.
Public function void

SetUseIoStore ( bool bUseIoStore
)

 Sets whether to use I/O store for optimized loading.
Public function void

SetUseZenStore ( bool bUseZenStore
)

 Sets whether to use the Zen storage server
Public function Const bool Are we going to generate a new patch tier
Public function bool Determines whether the current profile requires building
Public function Const bool Should we stage the pak files from the base release version this patch is built on
Public function Const bool Whether or not the flash image/software on the device should attempt to be updated before running
Public function Const bool Checks whether the profile's selected project supports Engine maps.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page