void |
AddCookedCulture ( const FString& CultureName ) |
Adds a culture to cook (only used if cooking by the book). |
void |
AddCookedMap ( const FString& MapName ) |
Adds a map to cook (only used if cooking by the book). |
void |
AddCookedPlatform ( const FString& PlatformName ) |
Adds a platform to cook (only used if cooking by the book). |
void |
ClearCookedCultures () |
Removes all cooked cultures. |
void |
ClearCookedMaps () |
Removes all cooked maps. |
void |
ClearCookedPlatforms () |
Removes all cooked platforms. |
ILauncherPro... |
CreateLaunchRole () |
Creates a new launch role and adds it to the profile. |
void |
FallbackBuildTargetUpdated () |
Notifies the profile that the fallback build target changed. |
void |
FallbackProjectUpdated () |
Notifies the profile that the fallback project path changed. |
FString |
GetAdditionalCommandLineParameters () |
Gets the additional command line parameters that will be used when the app launches. |
FString |
GetArchiveDirectory () |
Gets the archive directory. |
FString |
GetBasedOnReleaseVersionName () |
|
EBuildConfig... |
GetBuildConfiguration () |
Gets the name of the build configuration. |
ELauncherPro... |
GetBuildMode () |
Gets the current build mode. |
FString |
GetBuildTarget () |
Gets the build target.Target name to build/run (it would match a .Target.cs file) |
EBuildConfig... |
GetCookConfiguration () |
Gets the build configuration name of the cooker. |
const TArray... |
GetCookedCultures () |
Gets the list of cooked culture. |
const TArray... |
GetCookedMaps () |
Gets the list of cooked maps. |
const TArray... |
GetCookedPlatforms () |
Gets the names of the platforms to build for. |
ELauncherPro... |
GetCookMode () |
Gets the selected cook mode. |
const FStrin... |
GetCookOptions () |
Gets the cooker command line options. |
FString |
GetCreateReleaseVersionName () |
|
const FName |
GetDefaultDeployPlatform () |
Gets the default platforms to deploy if no specific devices were selected. |
const ILaunc... |
GetDefaultLaunchRole () |
Gets the default launch role. |
ILauncherDev... |
GetDeployedDeviceGroup () |
Gets the device group to deploy to. |
ELauncherPro... |
GetDeploymentMode () |
Gets the deployment mode. |
FString |
GetDescription () |
Gets the human readable description of the profile. |
FString |
GetDLCName () |
|
FString |
GetEditorExe () |
Gets the path to the editor executable. |
TArray< FStr... |
GetExplicitBuildTargetNames () |
Helper function to get all of the build targets available for this profile, based on its current project & cook platforms |
FString |
GetFileName () |
Gets the file name for serialization. |
FString |
GetFilePath () |
Gets the full file path for serialization. |
bool |
GetForceClose () |
Gets the close mode for the cook on the fly server |
FString |
GetHttpChunkDataDirectory () |
Where generated http chunk install data will be stored. |
FString |
GetHttpChunkDataReleaseName () |
What name to tag the generated http chunk install data with. |
FGuid |
GetId () |
Gets the unique identifier of the profile. |
FString |
GetInvalidPlatform () |
Gets the invalid platform, this is only valid when there is a platform centric validation error. |
ELauncherPro... |
GetLaunchMode () |
Gets the launch mode. |
const TArray... |
GetLaunchRoles () |
Gets the profile's collection of launch roles. |
const int32 |
GetLaunchRolesFor ( const FString& DeviceId, TArray< ILauncherProfileLaunchRoleP... ) |
Gets the launch roles assigned to the specified device. |
FString |
GetName () |
Gets the human readable name of the profile. |
FString |
GetOriginalReleaseVersionName () |
|
FString |
GetPackageDirectory () |
Gets the packaging directory. |
ELauncherPro... |
GetPackagingMode () |
Gets the packaging mode. |
FString |
GetProjectBasePath () |
Gets the base project path for the project (e.g. Samples/Showcases/MyShowcase) |
FString |
GetProjectName () |
Gets the name of the Unreal project to use. |
FString |
GetProjectPath () |
Gets the full path to the Unreal project to use. |
FString |
GetReferenceContainerCryptoKeysFileName () |
|
FString |
GetReferenceContainerGlobalFileName () |
Provides a database of compressed iostore chunks to reuse during the staging process. |
const bool |
GetSkipCookingEditorContent () |
|
uint32 |
GetTimeout () |
Gets the timeout time for the cook on the fly server. |
bool |
HasBuildTargetSpecified () |
Checks whether the profile specifies a build target. |
bool |
HasProjectSpecified () |
Checks whether the profile specifies a project. |
bool |
HasValidationError () |
Checks whether the last validation yielded any error. |
bool |
HasValidationError ( ELauncherProfileValidationErrors::T... ) |
Checks whether the last validation yielded the specified error. |
bool |
IsArchiving () |
Whether to archive build |
bool |
IsBuildingUAT () |
Checks whether UAT should be built. |
bool |
IsCompressed () |
Checks if compression is enabled |
bool |
IsCookingIncrementally () |
Checks whether incremental cooking is enabled. |
bool |
IsCookingUnversioned () |
Checks whether unversioned cooking is enabled. |
bool |
IsCreatingDLC () |
|
bool |
IsCreatingReleaseVersion () |
Creating a release version of the cooked content |
bool |
IsDeployablePlatform ( const FString& PlatformName ) |
Checks whether devices of the specified platform can be deployed to. |
bool |
IsDeployingIncrementally () |
Checks whether incremental deployment is enabled. |
bool |
IsDLCIncludingEngineContent () |
|
bool |
IsEncryptingIniFiles () |
Checks if encrypting ini files is enabled |
bool |
IsFileServerHidden () |
Checks whether the file server's console window should be hidden. |
bool |
IsFileServerStreaming () |
Checks whether the file server is a streaming file server. |
bool |
IsForDistribution () |
Checks if encrypting ini files is enabled |
bool |
IsGenerateHttpChunkData () |
Return whether packaging will use chunk data to generate http chunk install data. |
bool |
IsGeneratingChunks () |
Return whether packaging will generate chunk data. |
bool |
IsGeneratingPatch () |
Are we going to generate a patch (Source content patch needs to be specified) GetPatchSourceContentPath * SetPatchSourceContentPath |
bool |
IsIncludingPrerequisites () |
Checks whether to include an installer for prerequisites of packaged games, such as redistributable operating system components, on platforms that support it. |
bool |
IsIterateSharedCookedBuild () |
|
bool |
IsPackingWithUnrealPak () |
Checks whether packaging with UnrealPak is enabled. |
bool |
IsRetainStagedDirectory () |
Whether or not to save the unaltered staged directory for platforms that modify i/o store containers for deployment. |
bool |
IsUsingIoStore () |
Using I/O store or not. |
bool |
IsUsingZenStore () |
Using Zen storage server or not. |
bool |
IsValidForLaunch () |
Checks whether this profile is valid to use when running a game instance. |
bool |
Load ( const FJsonObject& Object ) |
Loads the profile from a JSON file |
bool |
MakeBinaryConfig () |
Make binary config file during staging or not. |
FOnProfileBu... |
OnBuildTargetOptionsChanged () |
Access delegate used when build target options change. |
FCookCancele... |
OnCookCanceled () |
Returns the cook delegate which should be called if the cook is canceled Used by cook by the book in the editor |
FIsCookFinis... |
OnIsCookFinished () |
Returns the cook delegate which can be used to query if the cook is finished. |
FOnProfilePr... |
OnProjectChanged () |
Accesses delegate used when the project changes. |
void |
RemoveCookedCulture ( const FString& CultureName ) |
Removes a cooked culture. |
void |
RemoveCookedMap ( const FString& MapName ) |
Removes a cooked map. |
void |
RemoveCookedPlatform ( const FString& PlatformName ) |
Removes a platform from the cook list. |
void |
RemoveLaunchRole ( const ILauncherProfileLaunchRoleRef... ) |
Removes the given launch role from the profile. |
bool |
RequiresExplicitBuildTargetName () |
Whether the profile will require an explicit -target=XXX parameter |
void |
Save ( TJsonWriter<>& Writer ) |
Saves the profile into a JSON file |
bool |
Serialize ( FArchive& Archive ) |
Serializes the profile from or into the specified archive. |
void |
SetAdditionalCommandLineParameters ( const FString& Params ) |
Sets the additional command line parameters for the application to use at launch. |
void |
SetAddPatchLevel ( bool InAddPatchLevel ) |
|
void |
SetArchive ( bool bArchive ) |
Sets whether to archive build |
void |
SetArchiveDirectory ( const FString& Dir ) |
Sets the archive directory. |
void |
SetBasedOnReleaseVersionName ( const FString& InBasedOnReleaseVer... ) |
|
void |
SetBuildConfiguration ( EBuildConfiguration Configuration ) |
Sets the build configuration. |
void |
SetBuildMode ( ELauncherProfileBuildModes::Type Mo... ) |
Sets the current build mode |
void |
SetBuildTarget ( const FString& TargetName ) |
Sets the build target. |
void |
SetBuildTargetSpecified ( bool Specified ) |
Sets whether this profile specfies a build target. |
void |
SetBuildUAT ( bool Build ) |
Sets whether to build UAT. |
void |
SetCompressed ( bool Enable ) |
Sets Compression. |
void |
SetCookConfiguration ( EBuildConfiguration Configuration ) |
Sets the build configuration of the cooker. |
void |
SetCookMode ( ELauncherProfileCookModes::Type Mod... ) |
Sets the cook mode. |
void |
SetCookOptions ( const FString& Options ) |
Sets the cook options. |
void |
SetCreateDLC ( bool InBuildDLC ) |
|
void |
SetCreateReleaseVersion ( bool InCreateReleaseVersion ) |
|
void |
SetCreateReleaseVersionName ( const FString& InCreateReleaseVers... ) |
|
void |
SetDefaultDeployPlatform ( const FName PlatformName ) |
Adds a platform to deploy (only used if a specific device is not specified). |
void |
SetDefaults () |
Sets all profile settings to their defaults. |
void |
SetDeployedDeviceGroup ( const ILauncherDeviceGroupPtr& Dev... ) |
Sets the device group to deploy to. |
void |
SetDeploymentMode ( ELauncherProfileDeploymentModes::Ty... ) |
Sets the deployment mode. |
void |
SetDeployWithUnrealPak ( bool UseUnrealPak ) |
Sets whether to pack with UnrealPak. |
void |
SetDescription ( const FString& NewDescription ) |
Updates the description of the profile. |
void |
SetDLCIncludeEngineContent ( bool InDLCIncludeEngineContent ) |
|
void |
SetDLCName ( const FString& InDLCName ) |
|
void |
SetEditorExe ( const FString& EditorExe ) |
Sets the path to the editor executable to use in UAT. |
void |
SetEncryptingIniFiles ( bool Enabled ) |
Set encrypt ini files |
void |
SetForceClose ( bool Close ) |
Sets the cook on the fly close mode |
void |
SetForDistribution ( bool Enabled ) |
Set this build is for distribution to the public |
void |
SetGenerateChunks ( bool bGenerateChunks ) |
Set whether packaging will generate chunk data. |
void |
SetGenerateHttpChunkData ( bool bGenerateHttpChunkData ) |
Set whether packaging will use chunk data to generate http chunk install data. |
void |
SetGeneratePatch ( bool InShouldGeneratePatch ) |
Sets if we are going to generate a patch |
void |
SetHideFileServerWindow ( bool Hide ) |
Sets whether to hide the file server's console window. |
void |
SetHttpChunkDataDirectory ( const FString& InHttpChunkDataDire... ) |
Set where generated http chunk install data will be stored. |
void |
SetHttpChunkDataReleaseName ( const FString& InHttpChunkDataRele... ) |
Set what name to tag the generated http chunk install data with. |
void |
SetIncludePrerequisites ( bool InValue ) |
Sets whether to include game prerequisites. |
void |
SetIncrementalCooking ( bool Incremental ) |
Sets incremental cooking. |
void |
SetIncrementalDeploying ( bool Incremental ) |
Sets incremental deploying. |
void |
SetIterateSharedCookedBuild ( bool IterateSharedCookedBuild ) |
|
void |
SetLaunchMode ( ELauncherProfileLaunchModes::Type M... ) |
Sets the launch mode. |
void |
SetMakeBinaryConfig ( bool bMakeBinaryConfig ) |
Sets whether to make a binary config file during packaging |
void |
SetName ( const FString& NewName ) |
Updates the name of the profile. |
void |
SetNotForLicensees () |
Changes the save location to an internal project path. |
void |
SetOriginalReleaseVersionName ( const FString& InOriginalReleaseVe... ) |
|
void |
SetPackageDirectory ( const FString& Dir ) |
Sets the packaging directory. |
void |
SetPackagingMode ( ELauncherProfilePackagingModes::Typ... ) |
Sets the packaging mode. |
void |
SetProjectPath ( const FString& Path ) |
Sets the path to the Unreal project to use. |
void |
SetProjectSpecified ( bool Specified ) |
Sets whether this profile specifies the a project. |
void |
SetReferenceContainerCryptoKeysFileName ( const FString& InReferenceContaine... ) |
|
void |
SetReferenceContainerGlobalFileName ( const FString& InReferenceContaine... ) |
|
void |
SetRetainStagedDirectory ( bool bInRetainStagedDirectory ) |
|
void |
SetShouldUpdateDeviceFlash ( bool bInShouldUpdateFlash ) |
Sets whether or not the flash image/software on the device should attempt to be updated before running |
void |
SetSkipCookingEditorContent ( const bool InSkipCookingEditorConte... ) |
Skip editor content while cooking, This will strip editor content from final builds |
void |
SetStageBaseReleasePaks ( bool InStageBaseReleasePaks ) |
|
void |
SetStreamingFileServer ( bool Streaming ) |
Sets whether to use a streaming file server. |
void |
SetTimeout ( uint32 InTime ) |
Sets the cook on the fly server timeout |
void |
SetUnversionedCooking ( bool Unversioned ) |
Sets unversioned cooking. |
void |
SetUseIoStore ( bool bUseIoStore ) |
Sets whether to use I/O store for optimized loading. |
void |
SetUseZenStore ( bool bUseZenStore ) |
Sets whether to use the Zen storage server |
bool |
ShouldAddPatchLevel () |
Are we going to generate a new patch tier |
bool |
ShouldBuild () |
Determines whether the current profile requires building |
bool |
ShouldStageBaseReleasePaks () |
Should we stage the pak files from the base release version this patch is built on |
bool |
ShouldUpdateDeviceFlash () |
Whether or not the flash image/software on the device should attempt to be updated before running |
bool |
SupportsEngineMaps () |
Checks whether the profile's selected project supports Engine maps. |