description: Computes the LODLevel for a StaticMeshComponent taking into account the ScreenSize

code: int32 GetLODLevelForScreenSize ( const [UStaticMeshComponent](API\Runtime\Engine\Components\UStaticMeshComponent) * StaticMeshComponent, const float ScreenSize )


description: Returns theALODActorparent for the given InActor, nullptr if none available

module: HierarchicalLODUtilities

code: [ALODActor](API\Runtime\Engine\Engine\ALODActor) * GetParentLODActor ( const [AActor](API\Runtime\Engine\GameFramework\AActor) * InActor )


description: Retrieves a wildcard that includes all possible HLOD packagenames that could be used by the given package.

code: [FString](API\Runtime\Core\Containers\FString) GetWildcardOfHLODPackagesForPackage ( const [FString](API\Runtime\Core\Containers\FString) & PackageName )


description: Handles changes in actors for the current world, checks if InActor is part of a HLOD cluster and if so set its dirty-flag

code: void HandleActorModified ( [AActor](API\Runtime\Engine\GameFramework\AActor) * InActor )


description: Checks if an actor is clustered

code: const bool IsActorClustered ( const [AActor](API\Runtime\Engine\GameFramework\AActor) * InActor )


description: Checks whether or not the given InWorld is used as a streaming level by any other World in the level

code: bool IsWorldUsedForStreaming ( const [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld )


description: Merges two clusters together

code: const bool MergeClusters ( [ALODActor](API\Runtime\Engine\Engine\ALODActor) * TargetCluster, [ALODActor](API\Runtime\Engine\Engine\ALODActor) * SourceCluster )


description: Removes the given actor from it's parent cluster

code: const bool RemoveActorFromCluster ( [AActor](API\Runtime\Engine\GameFramework\AActor) * InActor )


description: Retrieves the HLOD package that is created for the given level

code: [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * RetrieveLevelHLODPackage ( const [ULevel](API\Runtime\Engine\Engine\ULevel) * InLevel, const uint32 HLODLevelIndex )


description: Retrieves the HLOD proxy that is created for the given level

code: [UHLODProxy](API\Runtime\Engine\Engine\UHLODProxy) * RetrieveLevelHLODProxy ( const [ULevel](API\Runtime\Engine\Engine\ULevel) * InLevel, const uint32 HLODLevelIndex )


description:
Returns whether or not the given actor is eligible for creating a HLOD cluster creation
EClusterGenerationError

code: [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) ShouldGenerateCluster ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, const int32 HLODLevelIndex )


code: virtual ~IHierarchicalLODUtilities()


className: IHierarchicalLODUtilities

description: IHierarchicalLODUtilitiesmodule interface

code: class IHierarchicalLODUtilities


className: IHierarchicalLODUtilitiesModule

code: class IHierarchicalLODUtilitiesModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: operator&

code: constexpr [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) operator& ( [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) Lhs, [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) Rhs )


className: operator&=

code: [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) & operator&= ( [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) & Lhs, [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) Rhs )


className: operator~

code: constexpr [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) operator~ ( [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) E )


className: operator^

code: constexpr [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) operator^ ( [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) Lhs, [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) Rhs )


className: operator^=

code: [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) & operator^= ( [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) & Lhs, [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) Rhs )


className: operator!

code: constexpr bool operator! ( [EClusterGenerationError](API\Developer\HierarchicalLODUtilities\EClusterGenerationError) E )


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

module: HotReload

code: static [IHotReloadModule](API\Developer\HotReload\IHotReloadModule) & Get()


className: IHotReloadModule

description: The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.

code: class IHotReloadModule : public [IHotReloadInterface](API\Runtime\CoreUObject\Misc\IHotReloadInterface)


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: CreateIoStoreContainerFiles

module: IoStoreUtilities

code: int32 CreateIoStoreContainerFiles ( const TCHAR * CmdLine )


className: DumpIoStoreContainerInfo

code: bool DumpIoStoreContainerInfo ( const TCHAR * InContainerFilename, const [FKeyChain](API\Runtime\Core\Misc\FKeyChain) & InKeyChain )


className: ExtractFilesFromIoStoreContainer

code: bool ExtractFilesFromIoStoreContainer ( const TCHAR * InContainerFilename, const TCHAR * InDestPath, const [FKeyChain](API\Runtime\Core\Misc\FKeyChain) & InKeyChain, const [FString](API\Runtime\Core\Containers\FString) * InFilter, [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), uint64 > * OutOrderMap, [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > * OutUsedEncryptionKeys, bool * bOutIsSigned )


description: Identify as a implmenter of this class from theIPackageStoreWriterapi.

code: virtual [FZenStoreWriter](API\Developer\IoStoreUtilities\FZenStoreWriter) * AsZenStoreWriter()


code: virtual EPackageWriterResult BeginCacheForCookedPlatformData ( [FBeginCacheForCookedPlatformDataInfo](API\Runtime\Core\Serialization\ICookedPackageWriter\FBeginCacheForCo-) & Info )


description: Package data may only be produced afterBeginCook()has been called and beforeEndCook()is called

code: virtual void BeginCook ( const [FCookInfo](API\Runtime\Core\Serialization\ICookedPackageWriter\FCookInfo) & Info )


description: This must be called before any data is produced for a given package

code: virtual void BeginPackage ( const [FBeginPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FBeginPackageInfo) & Info )


description: Finalize a package started withBeginPackage()

code: virtual void CommitPackage ( [FCommitPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FCommitPackageInfo) && Info )


description: Append all data to the Exports archive that would normally be done in CommitPackage, used for diffing.

code: virtual void CompleteExportsArchiveForDiff ( [FPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FPackageInfo) & Info, [FLargeMemoryWriter](API\Runtime\Core\Serialization\FLargeMemoryWriter) & ExportsArchive )


description: Signal the end of a cooking pass.

code: virtual void EndCook ( const [FCookInfo](API\Runtime\Core\Serialization\ICookedPackageWriter\FCookInfo) & Info )


code: bool BlockAndDequeue &40; FZenCommitInfo & OutCommit &41;


code: void Enqueue &40; FZenCommitInfo && Commit &41;


code: void CompleteAdding&40;&41;


code: void ResetAdding&40;&41;


className: FCommitQueue

code: class FCommitQueue


className: FZenCommitInfo

code: struct FZenCommitInfo

PackageState

type: TUniquePtr< FPe...


description: Return cook capabilities/settings this PackageWriter has/requires


description: Returns all cooked package store entries.

code: virtual void GetEntries ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FPackageStoreEntryResource](API\Runtime\Core\IO\FPackageStoreEntryResource) >, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FOplogCookInfo](API\Developer\IoStoreUtilities\IPackageStoreWriter\FOplogCookInfo) >)> && )


description: Returns an Attachment that was previously commited for the given PackageName. Returns an empty object if not found.

code: virtual [FCbObject](API\Runtime\Core\Serialization\FCbObject) GetOplogAttachment ( [FName](API\Runtime\Core\UObject\FName) PackageName, FUtf8StringView AttachmentKey )


description: Cooked package writers asynchronously hash the chunks for each package after CommitPackage. Once cooking has completed, use this to acquire the results. This is synced using voidUPackage::WaitForAsyncFileWrites()- do not access the results before that completes. Non-const so that the cooking process can Move the map of hashes.

code: virtual [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FPackageHashes](API\Runtime\Core\Serialization\FPackageHashes) > > & GetPackageHashes()


description: Delete outdated cooked data, etc.

code: virtual void Initialize ( const [FCookInfo](API\Runtime\Core\Serialization\ICookedPackageWriter\FCookInfo) & Info )


description: Load the bytes of the previously-cooked package, used for diffing

code: virtual bool GetPreviousCookedBytes ( const [FPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FPackageInfo) & Info, [FPreviousCookedBytesData](API\Runtime\Core\Serialization\ICookedPackageWriter\FPreviousCookedBytesData) & OutData )


description: Returns an AssetRegistry describing the previous cook results. This doesn't mean a cook saved off to another directory - it means the AssetRegistry that's living in the directory we are about to cook in to.


description: Signal the given cooked package(s) have been checked for changes and have not been modified since the last cook.

code: virtual void MarkPackagesUpToDate ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > UpToDatePackages )


code: virtual FCommitEvent & OnCommit()


code: virtual [FEntryCreatedEvent](API\Developer\IoStoreUtilities\IPackageStoreWriter\FEntryCreatedEvent) & OnEntryCreated()


code: virtual [FMarkUpToDateEvent](API\Developer\IoStoreUtilities\IPackageStoreWriter\FMarkUpToDateEvent) & OnMarkUpToDate()


description: Remove all cooked packages from storage.

code: virtual void RemoveCookedPackages()


description: Remove the given cooked package(s) from storage; they have been modified since the last cook.

code: virtual void RemoveCookedPackages ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > PackageNamesToRemove )


className: ReservedOplogKeys

code: static [TArray](API\Runtime\Core\Containers\TArray)< const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * > ReservedOplogKeys;


description: Delegates to forward PackageWriter events ontoUCookOnTheFlyServerwhen cooking.

code: void SetBeginCacheCallback ( [FBeginCacheCallback](API\Runtime\Core\Serialization\ICookedPackageWriter\FBeginCacheCallback) && InBeginCacheCallback )


description: Read PackageData written by WriteMPCookMessageForPackage on a CookWorker. Called only on CookDirector.

code: virtual bool TryReadMPCookMessageForPackage ( [FName](API\Runtime\Core\UObject\FName) PackageName, [FCbObjectView](API\Runtime\Core\Serialization\FCbObjectView) Message )


description: Write separate files written by UObjects during cooking viaUObject::CookAdditionalFiles.

code: virtual void WriteAdditionalFile ( const [FAdditionalFileInfo](API\Runtime\Core\Serialization\IPackageWriter\FAdditionalFileInfo) & Info, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & FileData )


description: Write bulk data for the current package

code: virtual void WriteBulkData ( const [FBulkDataInfo](API\Runtime\Core\Serialization\IPackageWriter\FBulkDataInfo) & Info, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & BulkData, const [TArray](API\Runtime\Core\Containers\TArray)< [FFileRegion](API\Runtime\Core\Serialization\FFileRegion) > & FileRegions )


code: void WriteIoStorePackageData ( const [FPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FPackageInfo) & Info, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & PackageData, const [FPackageStoreEntryResource](API\Runtime\Core\IO\FPackageStoreEntryResource) & PackageStoreEntry, const [TArray](API\Runtime\Core\Containers\TArray)< [FFileRegion](API\Runtime\Core\Serialization\FFileRegion) > & FileRegions )


description: Write separate data written by UObjects viaFLinkerSave::AdditionalDataToAppend.

code: virtual void WriteLinkerAdditionalData ( const [FLinkerAdditionalDataInfo](API\Runtime\Core\Serialization\IPackageWriter\FLinkerAdditionalDataInfo) & Info, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & Data, const [TArray](API\Runtime\Core\Containers\TArray)< [FFileRegion](API\Runtime\Core\Serialization\FFileRegion) > & FileRegions )


description: Asynchronously create a CompactBinary Object message that replicates all of the package data from package save that is collected in memory and written at end of cook rather than being written to disk during package save. Used during MPCook to transfer this information from CookWorker to CookDirector. Called after CommitPackage, and only on CookWorkers.

code: virtual [TFuture](API\Runtime\Core\Async\TFuture)< [FCbObject](API\Runtime\Core\Serialization\FCbObject) > WriteMPCookMessageForPackage ( [FName](API\Runtime\Core\UObject\FName) PackageName )


description: This may only be called after aBeginPackage()call has been made to signal the start of a package store transaction

code: virtual void WritePackageData ( const [FPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FPackageInfo) & Info, [FLargeMemoryWriter](API\Runtime\Core\Serialization\FLargeMemoryWriter) & ExportsArchive, const [TArray](API\Runtime\Core\Containers\TArray)< [FFileRegion](API\Runtime\Core\Serialization\FFileRegion) > & FileRegions )


description: Write the PackageTrailer, a separate segment for some bulkdata that is written the end of the file.

code: virtual void WritePackageTrailer ( const [FPackageTrailerInfo](API\Runtime\Core\Serialization\IPackageWriter\FPackageTrailerInfo) & Info, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & Data )


className: ZenHostInfo

code: struct ZenHostInfo

HostName

type: FString


code: FZenStoreWriter ( const [FString](API\Runtime\Core\Containers\FString) & OutputPath, const [FString](API\Runtime\Core\Containers\FString) & MetadataDirectoryPath, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Identify as a member of this interface from theICookedPackageWriterapi.

code: virtual [IPackageStoreWriter](API\Developer\IoStoreUtilities\IPackageStoreWriter) * AsPackageStoreWriter()


className: FZenStoreWriter

description: A PackageStoreWriter that saves cooked packages for use by IoStore, and stores them in the Zen storage service.

code: class FZenStoreWriter : public [IPackageStoreWriter](API\Developer\IoStoreUtilities\IPackageStoreWriter)


description: Downcast function forIPackageStoreWriterthat is of classFZenStoreWriter.

code: virtual [FZenStoreWriter](API\Developer\IoStoreUtilities\FZenStoreWriter) * AsZenStoreWriter()


className: FCommitEvent

description: Broadcasted after a package has been committed, i.e cooked.

code: class FCommitEvent : public TBaseMulticastDelegate_OneParam< void, const FCommitEventArgs & >


className: FCommitEventArgs

description: Package commit event arguments

code: struct FCommitEventArgs

AdditionalFiles

type: TArray<FAdditi...

CookInfos

type: TArrayView< con...

PackageName

type: FName


className: FEntryCreatedEvent

code: class FEntryCreatedEvent : public TBaseMulticastDelegate_OneParam< void, const FEntryCreatedEventArgs & >


className: FEntryCreatedEventArgs

code: struct FEntryCreatedEventArgs

Entry

type: constFPackageS...


className: FMarkUpToDateEvent

description: Broadcasted after a set of packages have been found to be up to date.

code: class FMarkUpToDateEvent : public TBaseMulticastDelegate_OneParam< void, const FMarkUpToDateEventArgs & >


className: FMarkUpToDateEventArgs

code: struct FMarkUpToDateEventArgs

PackageIndexes

type: TArray< int32 >


className: FAttachment

code: struct FAttachment


className: FOplogCookInfo

code: struct FOplogCookInfo

Attachments

type: TArray<FAttach...

bUpToDate

type: bool


description: Returns all cooked package store entries.

code: void GetEntries ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FPackageStoreEntryResource](API\Runtime\Core\IO\FPackageStoreEntryResource) >, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FOplogCookInfo](API\Developer\IoStoreUtilities\IPackageStoreWriter\FOplogCookInfo) >)> && )


className: IPackageStoreWriter

code: class IPackageStoreWriter : public [ICookedPackageWriter](API\Runtime\Core\Serialization\ICookedPackageWriter)


className: LegacyDiffIoStoreContainers

code: bool LegacyDiffIoStoreContainers ( const TCHAR * InContainerFilename1, const TCHAR * InContainerFilename2, bool bInLogUniques1, bool bInLogUniques2, const [FKeyChain](API\Runtime\Core\Misc\FKeyChain) & InKeyChain1, const [FKeyChain](API\Runtime\Core\Misc\FKeyChain) * InKeyChain2 )


className: LegacyListIoStoreContainer

code: bool LegacyListIoStoreContainer ( const TCHAR * InContainerFilename, int64 InSizeFilter, const [FString](API\Runtime\Core\Containers\FString) & InCSVFilename, const [FKeyChain](API\Runtime\Core\Misc\FKeyChain) & InKeyChain )


className: ProcessFilesFromIoStoreContainer

code: bool ProcessFilesFromIoStoreContainer ( const TCHAR * InContainerFilename, const TCHAR * InDestPath, const [FKeyChain](API\Runtime\Core\Misc\FKeyChain) & InKeyChain, const [FString](API\Runtime\Core\Containers\FString) * InFilter, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) &, const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) &, const uint8 *, uint64)> FileProcessFunc, [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), uint64 > * OutOrderMap, [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > * OutUsedEncryptionKeys, bool * bOutIsSigned, int32 MaxConcurrentReaders )


className: SignIoStoreContainer

code: bool SignIoStoreContainer ( const TCHAR * InContainerFilename, const FRSAKeyHandle InSigningKey )


className: UploadIoStoreContainerFiles

code: bool UploadIoStoreContainerFiles ( const TCHAR * Params )


description: Enumerates modes in which the launcher cooks builds.

module: LauncherServices

code: namespace ELauncherProfileBuildModes { enum Type { Auto, Build, DoNotBuild, } }


description: Enumerates selections for maps to cook.

code: namespace ELauncherProfileCookedMaps { enum Type { AllMaps, NoMaps, SelectedMaps, } }


code: namespace ELauncherProfileCookModes { enum Type { DoNotCook, ByTheBook, OnTheFly, ByTheBookInEditor, OnTheFlyInEditor, } }


description: Enumerates deployment modes.

code: namespace ELauncherProfileDeploymentModes { enum Type { DoNotDeploy, CopyToDevice, FileServer, CopyRepository, } }


description: Enumerates launch modes.

code: namespace ELauncherProfileLaunchModes { enum Type { DoNotLaunch, CustomRoles, DefaultRole, } }


description: Enumerates packaging modes.

code: namespace ELauncherProfilePackagingModes { enum Type { DoNotPackage, Locally, SharedRepository, } }


description: Enumerates launch role instance types.

code: namespace ELauncherProfileRoleInstanceTypes { enum Type { DedicatedServer, ListenServer, StandaloneClient, UnrealEditor, } }


description:
Returns the string representation of the specified ELauncherProfileRoleInstanceTypes value.
A string value.

code: namespace ELauncherProfileRoleInstanceTypes { [FString](API\Runtime\Core\Containers\FString) ELauncherProfileRoleInstanceTypes::ToString ( [ELauncherProfileRoleInstanceTypes::Type](API\Developer\LauncherServices\ELauncherProfileRoleInstanceType-) InstanceType ) }


description: Enumerates profile validation messages.

code: namespace ELauncherProfileValidationErrors { enum Type { CopyToDeviceRequiresCookByTheBook, CustomRolesNotSupportedYet, DeployedDeviceGroupRequired, InitialCultureNotAvailable, InitialMapNotAvailable, MalformedLaunchCommandLine, NoBuildConfigurationSelected, NoCookedCulturesSelected, NoLaunchRoleDeviceAssigned, NoPlatformSelected, NoProjectSelected, NoPackageDirectorySpecified, NoPlatformSDKInstalled, UnversionedAndIncrimental, GeneratingPatchesCanOnlyRunFromByTheBookCookMode, GeneratingMultiLevelPatchesRequiresGeneratePatch, StagingBaseReleasePaksWithoutABaseReleaseVersion, GeneratingChunksRequiresCookByTheBook, GeneratingChunksRequiresUnrealPak, GeneratingHttpChunkDataRequiresGeneratingChunks, GeneratingHttpChunkDataRequiresValidDirectoryAndName, ShippingDoesntSupportCommandlineOptionsCantUseCookOnTheFly, CookOnTheFlyDoesntSupportServer, NoArchiveDirectorySpecified, LaunchDeviceIsUnauthorized, IoStoreRequiresPakFiles, BuildTargetCookVariantMismatch, BuildTargetIsRequired, FallbackBuildTargetIsRequired, CopyToDeviceRequiresNoPackaging, Count, } }


description: Enumerates launcher task status types.

code: namespace ELauncherTaskStatus { enum Type { Busy, Canceled, Completed, Failed, Pending, } }


code: namespace ELauncherWorkerStatus { enum Type { Busy, Canceling, Canceled, Completed, } }


className: FCookCanceledDelegate

description: Delegate type used to callback if the cook has been canceled only used for cook by the book in editor

code: typedef TBaseDelegate_NoParams< void > FCookCanceledDelegate


description:
Gets a list of available build configurations for the specified game name.
A list of build configuration names.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetAvailableConfigurations ( const [FString](API\Runtime\Core\Containers\FString) & GameName )


description:
Gets a list of available game names.
Game names.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetAvailableGames()


description:
Gets the list of available maps for the specified game.
A list of available map names.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetAvailableMaps ( [FString](API\Runtime\Core\Containers\FString) GameName, bool IncludeEngineMaps, bool Sorted )


description: Returns the list of build targets that must be explicitly specified for the given project.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetExplicitBuildTargetsForProject ( const [FString](API\Runtime\Core\Containers\FString) & InProjectFilePath, const [TSet](API\Runtime\Core\Containers\TSet)< EBuildTargetType > * InFilterTargetTypes )


description:
Checks whether the specified game is available.
true if the game is available, false otherwise.

code: static bool IsGameAvailable ( [FString](API\Runtime\Core\Containers\FString) GameName )


className: FGameProjectHelper

description: Implements a helper class for finding project specific information.

code: class FGameProjectHelper


className: FIsCookFinishedDelegate

description: Delegate type for detecting if cook is finished Used when cooking from the editor. Specific cook task will wait for the cook to be finished by the editor

code: typedef TBaseDelegate_NoParams< bool > FIsCookFinishedDelegate


className: FOnCreateLauncher

code: typedef TMulticastDelegate_OneParam< void, [ILauncherRef](API\Developer\LauncherServices\ILauncherRef) > FOnCreateLauncher


className: FOnLaunchCanceledDelegate

description: Delegate used to notify when the launch was canceled

code: typedef TMulticastDelegate_OneParam< void, double > FOnLaunchCanceledDelegate


className: FOnLauncherDeviceGroupDeviceAdded

description: The first parameter is the device group that invoked the delegate. The second parameter is the identifier of the device that was removed.

code: typedef TMulticastDelegate_TwoParams< void, const [ILauncherDeviceGroupRef](API\Developer\LauncherServices\ILauncherDeviceGroupRef) &, const [FString](API\Runtime\Core\Containers\FString) & > FOnLauncherDeviceGroupDeviceAdded


className: FOnLauncherDeviceGroupDeviceRemoved

code: typedef TMulticastDelegate_TwoParams< void, const [ILauncherDeviceGroupRef](API\Developer\LauncherServices\ILauncherDeviceGroupRef) &, const [FString](API\Runtime\Core\Containers\FString) & > FOnLauncherDeviceGroupDeviceRemoved


description: The first parameter is the selected device group (or NULL if the selection was cleared).

code: typedef TMulticastDelegate_OneParam< void, const [ILauncherDeviceGroupPtr](API\Developer\LauncherServices\ILauncherDeviceGroupPtr) & > FOnLauncherProfileDeployedDeviceGroupChanged


description: The first parameter is the profile that was added.

code: typedef TMulticastDelegate_OneParam< void, const [ILauncherDeviceGroupRef](API\Developer\LauncherServices\ILauncherDeviceGroupRef) & > FOnLauncherProfileManagerDeviceGroupAdded


description: The first parameter is the profile that was removed.

code: typedef TMulticastDelegate_OneParam< void, const [ILauncherDeviceGroupRef](API\Developer\LauncherServices\ILauncherDeviceGroupRef) & > FOnLauncherProfileManagerDeviceGroupRemoved


className: FOnLauncherProfileManagerInitialized

description: The first parameter is the profile manager.

code: typedef TMulticastDelegate_OneParam< void, [ILauncherProfileManager](API\Developer\LauncherServices\ILauncherProfileManager) & > FOnLauncherProfileManagerInitialized


className: FOnLauncherProfileManagerProfileAdded

code: typedef TMulticastDelegate_OneParam< void, const [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) & > FOnLauncherProfileManagerProfileAdded


className: FOnLaunchCompletedDelegate

description: Delegate used to notify when the launch is complete

code: typedef TMulticastDelegate_ThreeParams< void, bool, double, int32 > FOnLaunchCompletedDelegate


className: FOnLauncherProfileManagerProfileRemoved

code: typedef TMulticastDelegate_OneParam< void, const [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) & > FOnLauncherProfileManagerProfileRemoved


className: FOnLauncherProfileManagerProjectChanged

description: Declares a delegate to be invoked when the project is changed.

code: typedef TMulticastDelegate_NoParams< void > FOnLauncherProfileManagerProjectChanged


className: FOnLauncherWorkerStarted

code: typedef TMulticastDelegate_TwoParams< void, [ILauncherWorkerPtr](API\Developer\LauncherServices\ILauncherWorkerPtr), [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) > FOnLauncherWorkerStarted


className: FOnProfileBuildTargetOptionsChanged

description: Delegate type for a change in build target options

code: typedef TMulticastDelegate_NoParams< void > FOnProfileBuildTargetOptionsChanged


className: FOnProfileProjectChanged

description: Delegate type for a change in project

code: typedef TMulticastDelegate_NoParams< void > FOnProfileProjectChanged


className: FOnStageCompletedDelegate

description: Delegate used to notify when a stage ends

code: typedef TMulticastDelegate_TwoParams< void, const [FString](API\Runtime\Core\Containers\FString) &, double > FOnStageCompletedDelegate


className: FOnStageStartedDelegate

description: Delegate used to notify when a stage starts

code: typedef TMulticastDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOnStageStartedDelegate


className: FOnTaskCompletedDelegate

code: typedef TMulticastDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOnTaskCompletedDelegate


className: FOnTaskStartedDelegate

code: typedef TMulticastDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOnTaskStartedDelegate


className: FOutputMessageReceivedDelegate

description: Delegate used to notify of an output message

code: typedef TMulticastDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOutputMessageReceivedDelegate


description:
Launches the specified profile.
The worker thread, or nullptr if not launched.

code: [ILauncherWorkerPtr](API\Developer\LauncherServices\ILauncherWorkerPtr) Launch ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITargetDeviceProxyManager](API\Developer\TargetDeviceServices\ITargetDeviceProxyManager) > & DeviceProxyManager, const [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) & Profile )


description: Virtual destructor.

code: virtual ~ILauncher()


className: ILauncher

description: Interface for game launchers.

code: class ILauncher

FLauncherWorkerStartedDelegate

type: FOnLauncherWork...


description: Adds a device to the group.

code: void AddDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceID )


description:
Get a list of identifiers for devices associated with this device group.
The list of device identifiers.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetDeviceIDs()


description:
Gets the unique identifier of the device group.
The device group identifier.


description:
Gets the human readable name of the device group.
The name of the device group.

code: const [FString](API\Runtime\Core\Containers\FString) & GetName() const


description:
Get a list of devices associated with this device group.
The number of devices the device group maintains.

code: int32 GetNumDevices() const


description:
Returns a delegate that is invoked when device was added to this group.
The delegate.


description:
Returns a delegate that is invoked when device was removed from this group.
The delegate.


description: Removes all devices from the group.

code: void RemoveAllDevices()


description: Removes a device from the group.

code: void RemoveDevice ( const [FString](API\Runtime\Core\Containers\FString) & DeviceID )


description: Sets the name of the device group.

code: void SetName ( const [FString](API\Runtime\Core\Containers\FString) & NewName )


description: Virtual destructor.

code: virtual ~ILauncherDeviceGroup()


className: ILauncherDeviceGroup

description: Interface for Launcher device groups.

code: class ILauncherDeviceGroup


className: ILauncherDeviceGroupPtr

description: Type definition for shared pointers to instances ofILauncherDeviceGroup.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncherDeviceGroup](API\Developer\LauncherServices\ILauncherDeviceGroup) > ILauncherDeviceGroupPtr


className: ILauncherDeviceGroupRef

description: Type definition for shared references to instances ofILauncherDeviceGroup.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncherDeviceGroup](API\Developer\LauncherServices\ILauncherDeviceGroup) > ILauncherDeviceGroupRef


description: RemoveCookedCulture

code: void AddCookedCulture ( const [FString](API\Runtime\Core\Containers\FString) & CultureName )


description: RemoveCookedMap

code: void AddCookedMap ( const [FString](API\Runtime\Core\Containers\FString) & MapName )


description: RemoveCookedPlatform

code: void AddCookedPlatform ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName )


description: RemoveCookedCulture

code: void ClearCookedCultures()


description: RemoveCookedMap

code: void ClearCookedMaps()


description: RemoveLaunchRole


description: RemoveCookedPlatform

code: void ClearCookedPlatforms()


description: Notifies the profile that the fallback build target changed.

code: void FallbackBuildTargetUpdated()


description: Notifies the profile that the fallback project path changed.

code: void FallbackProjectUpdated()


description: SetAdditionalCommandLineParameters


description: SetArchiveDirectory


description: SetBuildConfigurationName


description: SetBuildMode


description: SetBuildTarget


description: SetCookConfigurationName


description: RemoveCookedMap

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetCookedMaps() const


description: RemoveCookedCulture

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetCookedCultures() const


description: RemoveCookedPlatform

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetCookedPlatforms() const


description:
Gets the selected cook mode.
Cook mode.


description:
Gets the cooker command line options.
Cook options string.

code: const [FString](API\Runtime\Core\Containers\FString) & GetCookOptions() const


description: Gets the default platforms to deploy if no specific devices were selected.

code: const [FName](API\Runtime\Core\UObject\FName) GetDefaultDeployPlatform() const


description:
Gets the default launch role.
A reference to the default launch role.

code: const [ILauncherProfileLaunchRoleRef](API\Developer\LauncherServices\ILauncherProfileLaunchRoleRef) & GetDefaultLaunchRole() const


description: SetDeployedDeviceGroup


description: SetDeploymentMode


description:
Gets the human readable description of the profile.
The profile description.


description:
Gets the path to the editor executable.
Path to the editor executable.


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

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetExplicitBuildTargetNames() const


description:
Gets the file name for serialization.
The file name.


description:
Gets the full file path for serialization.
The file path.


description: SetForceClose

code: bool GetForceClose() const


description:
Where generated http chunk install data will be stored.
true if data will be generated, false otherwise.


description:
What name to tag the generated http chunk install data with.
true if data will be generated, false otherwise.


description:
Gets the unique identifier of the profile.
The profile identifier.


description:
Gets the invalid platform, this is only valid when there is a platform centric validation error.
string specifying the invalid platform.


description: SetLaunchMode


description: RemoveLaunchRole

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ILauncherProfileLaunchRolePtr](API\Developer\LauncherServices\ILauncherProfileLaunchRolePtr) > & GetLaunchRoles() const


description:
Gets the human readable name of the profile.
The profile name.


description: Gets the launch roles assigned to the specified device.

code: const int32 GetLaunchRolesFor ( const [FString](API\Runtime\Core\Containers\FString) & DeviceId, [TArray](API\Runtime\Core\Containers\TArray)< [ILauncherProfileLaunchRolePtr](API\Developer\LauncherServices\ILauncherProfileLaunchRolePtr) > & OutRoles )


description: SetPackageDirectory


description: SetPackagingMode


description: Gets the base project path for the project (e.g. Samples/Showcases/MyShowcase)


description: Gets the name of the Unreal project to use.


description: SetProjectPath


description: Provides a database of compressed iostore chunks to reuse during the staging process. See IoStoreUtilities.cpp ReferenceContainerGlobalFileName.


code: const bool GetSkipCookingEditorContent() const


description: SetTimeout

code: uint32 GetTimeout() const


description:
Checks whether the profile specifies a build target.
true if the profile specifies a build target.

code: bool HasBuildTargetSpecified() const


description:
Checks whether the profile specifies a project. Not specifying a project means that it can be used for any project.
true if the profile specifies a project.

code: bool HasProjectSpecified() const


description:
Checks whether the last validation yielded any error.
true if the any error is present, false otherwise.

code: bool HasValidationError() const


description:
Checks whether the last validation yielded the specified error.
true if the error is present, false otherwise.

code: bool HasValidationError ( [ELauncherProfileValidationErrors::Type](API\Developer\LauncherServices\ELauncherProfileValidationErrors-) Error ) const


description: SetArchive

code: bool IsArchiving() const


description: SetBuildGame

code: bool IsBuildingUAT() const


description: SetCompressed

code: bool IsCompressed() const


description: SetIncrementalCooking

code: bool IsCookingIncrementally() const


description: SetUnversionedCooking

code: bool IsCookingUnversioned() const


code: bool IsCreatingDLC() const


description: Creating a release version of the cooked content

code: bool IsCreatingReleaseVersion() const


description:
Whether a platform is deployable depends on the current profile settings. The right combination of build, cook and package settings must be present.
true if the platform is deployable, false otherwise.

code: bool IsDeployablePlatform ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName )


description: SetIncrementalDeploying

code: bool IsDeployingIncrementally() const


description:
Checks if encrypting ini files is enabled
true if encrypting ini files is enabled

code: bool IsEncryptingIniFiles() const


description: SetHideFileServer

code: bool IsFileServerHidden() const


description: SetStreamingFileServer

code: bool IsFileServerStreaming() const


code: bool IsForDistribution() const


description:
Return whether packaging will use chunk data to generate http chunk install data.
true if data will be generated, false otherwise.

code: bool IsGenerateHttpChunkData() const


description:
Return whether packaging will generate chunk data.
true if Chunks will be generated, false otherwise.

code: bool IsGeneratingChunks() const


description: Are we going to generate a patch (Source content patch needs to be specified)  GetPatchSourceContentPath *  SetPatchSourceContentPath

code: bool IsGeneratingPatch() const


description: SetIncludePrerequisites

code: bool IsIncludingPrerequisites() const


code: bool IsIterateSharedCookedBuild() const


description: SetPackageWithUnrealPak

code: bool IsPackingWithUnrealPak() const


description: Whether or not to save the unaltered staged directory for platforms that modify i/o store containers for deployment. This is so that the containers can be saved and used as a reference container later.

code: bool IsRetainStagedDirectory() const


description:
Using I/O store or not.
true if using I/O store

code: bool IsUsingIoStore() const


description:
Using Zen storage server or not.
true if using Zen storage server

code: bool IsUsingZenStore() const


description:
Checks whether this profile is valid to use when running a game instance.
Whether the profile is valid or not.

code: bool IsValidForLaunch()


description: Loads the profile from a JSON file

code: bool Load ( const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & Object )


description:
Make binary config file during staging or not.
true to make binary config file

code: bool MakeBinaryConfig() const


description:
Access delegate used when build target options change.
The delegate.


description: Returns the cook delegate which should be called if the cook is canceled Used by cook by the book in the editor


description: Used by cook by the book in the editor.


description: GetCookedCultures

code: void RemoveCookedCulture ( const [FString](API\Runtime\Core\Containers\FString) & CultureName )


description:
Accesses delegate used when the project changes.
The delegate.


description: GetCookedMaps

code: void RemoveCookedMap ( const [FString](API\Runtime\Core\Containers\FString) & MapName )


description: GetBuildPlatforms

code: void RemoveCookedPlatform ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName )


description: GetLaunchRoles

code: void RemoveLaunchRole ( const [ILauncherProfileLaunchRoleRef](API\Developer\LauncherServices\ILauncherProfileLaunchRoleRef) & Role )


description: Whether the profile will require an explicit -target=XXX parameter


description: Saves the profile into a JSON file

code: void Save ( TJsonWriter<> & Writer )


description:
Serializes the profile from or into the specified archive.
true if the profile was serialized, false otherwise.

code: bool Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


description: GetAdditionalCommandLineParameters

code: void SetAdditionalCommandLineParameters ( const [FString](API\Runtime\Core\Containers\FString) & Params )


code: void SetAddPatchLevel ( bool InAddPatchLevel )


description: GetArchiveMode

code: void SetArchive ( bool bArchive )


description: GetArchiveDirectory

code: void SetArchiveDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Dir )


code: void SetBasedOnReleaseVersionName ( const [FString](API\Runtime\Core\Containers\FString) & InBasedOnReleaseVersion )


description: GetBuildConfigurationName

code: void SetBuildConfiguration ( EBuildConfiguration Configuration )


description: GetBuildMode

code: void SetBuildMode ( [ELauncherProfileBuildModes::Type](API\Developer\LauncherServices\ELauncherProfileBuildModes__Type) Mode )


description: IsBuilding

code: void SetBuildUAT ( bool Build )


description: GetBuildTarget

code: void SetBuildTarget ( const [FString](API\Runtime\Core\Containers\FString) & TargetName )


description: Sets whether this profile specfies a build target.

code: void SetBuildTargetSpecified ( bool Specified )


description: IsCompressed

code: void SetCompressed ( bool Enable )


description: GetCookConfiguration

code: void SetCookConfiguration ( EBuildConfiguration Configuration )


description: GetCookMode

code: void SetCookMode ( [ELauncherProfileCookModes::Type](API\Developer\LauncherServices\ELauncherProfileCookModes__Type) Mode )


description: GetCookOptions

code: void SetCookOptions ( const [FString](API\Runtime\Core\Containers\FString) & Options )


code: void SetCreateDLC ( bool InBuildDLC )


code: void SetCreateReleaseVersion ( bool InCreateReleaseVersion )


code: void SetCreateReleaseVersionName ( const [FString](API\Runtime\Core\Containers\FString) & InCreateReleaseVersionName )


description: Adds a platform to deploy (only used if a specific device is not specified). Will deploy to the default device of the given platform, or the first device if none are marked as 'default'.

code: void SetDefaultDeployPlatform ( const [FName](API\Runtime\Core\UObject\FName) PlatformName )


description: Sets all profile settings to their defaults.

code: void SetDefaults()


description: GetDeployedDeviceGroup

code: void SetDeployedDeviceGroup ( const [ILauncherDeviceGroupPtr](API\Developer\LauncherServices\ILauncherDeviceGroupPtr) & DeviceGroup )


description: GetDeploymentMode

code: void SetDeploymentMode ( [ELauncherProfileDeploymentModes::Type](API\Developer\LauncherServices\ELauncherProfileDeploymentModes_-) Mode )


description: IsPackingWithUnrealPak

code: void SetDeployWithUnrealPak ( bool UseUnrealPak )


description: Updates the description of the profile.

code: void SetDescription ( const [FString](API\Runtime\Core\Containers\FString) & NewDescription )


code: void SetDLCIncludeEngineContent ( bool InDLCIncludeEngineContent )


description: Sets the path to the editor executable to use in UAT.

code: void SetEditorExe ( const [FString](API\Runtime\Core\Containers\FString) & EditorExe )


code: void SetDLCName ( const [FString](API\Runtime\Core\Containers\FString) & InDLCName )


description: IsEncryptIniFiles

code: void SetEncryptingIniFiles ( bool Enabled )


description: GetForceClose

code: void SetForceClose ( bool Close )


description: IsForDistribution

code: void SetForDistribution ( bool Enabled )


description: Set whether packaging will generate chunk data.

code: void SetGenerateChunks ( bool bGenerateChunks )


description: Set whether packaging will use chunk data to generate http chunk install data.

code: void SetGenerateHttpChunkData ( bool bGenerateHttpChunkData )


description: Sets if we are going to generate a patch

code: void SetGeneratePatch ( bool InShouldGeneratePatch )


description:
Set where generated http chunk install data will be stored.
the directory path to use.

code: void SetHttpChunkDataDirectory ( const [FString](API\Runtime\Core\Containers\FString) & InHttpChunkDataDirectory )


description: GetHideFileServerWindow

code: void SetHideFileServerWindow ( bool Hide )


description: Set what name to tag the generated http chunk install data with.

code: void SetHttpChunkDataReleaseName ( const [FString](API\Runtime\Core\Containers\FString) & InHttpChunkDataReleaseName )


description: IsIncludingPrerequisites

code: void SetIncludePrerequisites ( bool InValue )


description: IsCookingIncrementally

code: void SetIncrementalCooking ( bool Incremental )


description: IsDeployingIncrementally

code: void SetIncrementalDeploying ( bool Incremental )


code: void SetIterateSharedCookedBuild ( bool IterateSharedCookedBuild )


description: GetLaunchMode

code: void SetLaunchMode ( [ELauncherProfileLaunchModes::Type](API\Developer\LauncherServices\ELauncherProfileLaunchModes__Typ-) Mode )


description: Sets whether to make a binary config file during packaging

code: void SetMakeBinaryConfig ( bool bMakeBinaryConfig )


description: Updates the name of the profile.

code: void SetName ( const [FString](API\Runtime\Core\Containers\FString) & NewName )


description: Changes the save location to an internal project path.

code: void SetNotForLicensees()


code: void SetOriginalReleaseVersionName ( const [FString](API\Runtime\Core\Containers\FString) & InOriginalReleaseVersion )


description: GetPackageDirectory

code: void SetPackageDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Dir )


description: GetPackagingMode

code: void SetPackagingMode ( [ELauncherProfilePackagingModes::Type](API\Developer\LauncherServices\ELauncherProfilePackagingModes__-) Mode )


description: GetProjectPath

code: void SetProjectPath ( const [FString](API\Runtime\Core\Containers\FString) & Path )


description: Sets whether this profile specifies the a project.

code: void SetProjectSpecified ( bool Specified )


code: void SetReferenceContainerGlobalFileName ( const [FString](API\Runtime\Core\Containers\FString) & InReferenceContainerGlobalFileName )


code: void SetReferenceContainerCryptoKeysFileName ( const [FString](API\Runtime\Core\Containers\FString) & InReferenceContainerCryptoKeysFileName )


code: void SetRetainStagedDirectory ( bool bInRetainStagedDirectory )


description: Sets whether or not the flash image/software on the device should attempt to be updated before running

code: void SetShouldUpdateDeviceFlash ( bool bInShouldUpdateFlash )


description: Skip editor content while cooking, This will strip editor content from final builds

code: void SetSkipCookingEditorContent ( const bool InSkipCookingEditorContent )


code: void SetStageBaseReleasePaks ( bool InStageBaseReleasePaks )


description: GetStreamingFileServer

code: void SetStreamingFileServer ( bool Streaming )


description: GetTimeout

code: void SetTimeout ( uint32 InTime )


description: IsCookingUnversioned

code: void SetUnversionedCooking ( bool Unversioned )


description: Sets whether to use I/O store for optimized loading.

code: void SetUseIoStore ( bool bUseIoStore )


description: Sets whether to use the Zen storage server

code: void SetUseZenStore ( bool bUseZenStore )


description: Are we going to generate a new patch tier

code: bool ShouldAddPatchLevel() const


description: SetBuildMode

code: bool ShouldBuild()


description: Should we stage the pak files from the base release version this patch is built on

code: bool ShouldStageBaseReleasePaks() const


description: Whether or not the flash image/software on the device should attempt to be updated before running

code: bool ShouldUpdateDeviceFlash() const


description:
Checks whether the profile's selected project supports Engine maps.
true if Engine maps are supported, false otherwise.

code: bool SupportsEngineMaps() const


description: Virtual destructor.

code: virtual ~ILauncherProfile()


className: ILauncherProfile

description: Interface for launcher profile.

code: class ILauncherProfile


description:
Gets the identifier of the device that is assigned to this role.
The device identifier, or an empty string if the role is unassigned.

code: const [FString](API\Runtime\Core\Containers\FString) & GetAssignedDevice() const


description: SetInitialCulture

code: const [FString](API\Runtime\Core\Containers\FString) & GetInitialCulture() const


description: SetInitialMap

code: const [FString](API\Runtime\Core\Containers\FString) & GetInitialMap() const


description:
Gets the instance type (i.e. client, server, etc).
Instance type.


description:
Gets the name of this role.
The role name.

code: const [FString](API\Runtime\Core\Containers\FString) & GetName() const


description: SetCommandLine

code: const [FString](API\Runtime\Core\Containers\FString) & GetUATCommandLine() const


description: SetVsyncEnabled

code: bool IsVsyncEnabled() const


code: void Save ( TJsonWriter<> & Writer, const TCHAR * Name )


code: void Load ( const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & Object )


description: Serializes the role from or into the specified archive.

code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


description: GetUATCommandLine

code: void SetCommandLine ( const [FString](API\Runtime\Core\Containers\FString) & NewCommandLine )


description: GetInitialCulture

code: void SetInitialCulture ( const [FString](API\Runtime\Core\Containers\FString) & CultureName )


description: GetInitialMap

code: void SetInitialMap ( const [FString](API\Runtime\Core\Containers\FString) & MapName )


description: Sets the role instance type (i.e. client, server, etc).

code: void SetInstanceType ( [ELauncherProfileRoleInstanceTypes::Type](API\Developer\LauncherServices\ELauncherProfileRoleInstanceType-) InInstanceType )


description: GetName

code: void SetName ( const [FString](API\Runtime\Core\Containers\FString) & NewName )


description: IsVsyncEnabled

code: void SetVsyncEnabled ( bool Enabled )


description: Virtual destructor.

code: virtual ~ILauncherProfileLaunchRole()


className: ILauncherProfileLaunchRole

description: Interface for launch roles.

code: class ILauncherProfileLaunchRole


className: ILauncherProfileLaunchRolePtr

description: Type definition for shared pointers to instances ofILauncherProfileLaunchRole.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncherProfileLaunchRole](API\Developer\LauncherServices\ILauncherProfileLaunchRole) > ILauncherProfileLaunchRolePtr


description: Adds the given device group.

code: void AddDeviceGroup ( const [ILauncherDeviceGroupRef](API\Developer\LauncherServices\ILauncherDeviceGroupRef) & DeviceGroup )


className: ILauncherProfileLaunchRoleRef

description: Type definition for shared references to instances ofILauncherProfileLaunchRole.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncherProfileLaunchRole](API\Developer\LauncherServices\ILauncherProfileLaunchRole) > ILauncherProfileLaunchRoleRef


description:
Create a new device group and maintains a reference for its future usage.
The device group created.


description:
Creates a new profile.
The new profile created.


description: If a profile with the same identifier already exists in the profile collection, it will be deleted before the given profile is added.

code: void AddProfile ( const [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) & Profile )


description: Modifies profile name. Saves file to new location and deletes old one to avoid duplicating profiles.

code: void ChangeProfileName ( const [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) & Profile, [FString](API\Runtime\Core\Containers\FString) Name )


description:
Creates a new device group but does not add it to the internal tracking.
The new device group created.


description:
Creates a new profile but does not add it to the internal tracking.
The new profile created.

code: [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) CreateUnsavedProfile ( [FString](API\Runtime\Core\Containers\FString) ProfileName )


description:
Finds or Adds then returns a simple profile for the specified Device
The simple profile for the specified device.

code: [ILauncherSimpleProfilePtr](API\Developer\LauncherServices\ILauncherSimpleProfilePtr) FindOrAddSimpleProfile ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName )


description: GetProfile

code: [ILauncherProfilePtr](API\Developer\LauncherServices\ILauncherProfilePtr) FindProfile ( const [FString](API\Runtime\Core\Containers\FString) & ProfileName )


description:
Gets the simple profile for the specified device.
The simple profile for the specified device, or nullptr if the simple profile doesn't exist.

code: [ILauncherSimpleProfilePtr](API\Developer\LauncherServices\ILauncherSimpleProfilePtr) FindSimpleProfile ( const [FString](API\Runtime\Core\Containers\FString) & DeviceName )


description:
Gets the collection of device groups.
A read-only collection of device groups.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ILauncherDeviceGroupPtr](API\Developer\LauncherServices\ILauncherDeviceGroupPtr) > & GetAllDeviceGroups() const


description: Return a list of all build build targets for the current project that need to be specified explicitly via -target= If a build target isn't in the list, it does not need to be specified (and BuildTarget can be an empty string)

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetAllExplicitBuildTargetNames() const


description: GetSelectedProfile

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ILauncherProfilePtr](API\Developer\LauncherServices\ILauncherProfilePtr) > & GetAllProfiles() const


description: Gets the default build target to use.


description:
Gets the device group with the specified identifier.
A shared pointer to the group, or nullptr if the group was not found.

code: [ILauncherDeviceGroupPtr](API\Developer\LauncherServices\ILauncherDeviceGroupPtr) GetDeviceGroup ( const [FGuid](API\Runtime\Core\Misc\FGuid) & GroupId ) const


description: FindProfile

code: [ILauncherProfilePtr](API\Developer\LauncherServices\ILauncherProfilePtr) GetProfile ( const [FGuid](API\Runtime\Core\Misc\FGuid) & ProfileId ) const


description: Return list of all registered profile wizards

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ILauncherProfileWizardPtr](API\Developer\LauncherServices\ILauncherProfileWizardPtr) > & GetProfileWizards() const


description: Gets the base project path for the project


description: Gets the name of the Unreal project to use.


description: SetProjectPath


description: SaveProfile

code: [ILauncherProfilePtr](API\Developer\LauncherServices\ILauncherProfilePtr) LoadJSONProfile ( [FString](API\Runtime\Core\Containers\FString) ProfileFile )


description: SaveProfile

code: [ILauncherProfilePtr](API\Developer\LauncherServices\ILauncherProfilePtr) LoadProfile ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


description: SaveSettings

code: void LoadSettings()


description:
Returns a delegate that is invoked when a device group was added.
The delegate.


description:
Returns a delegate that is invoked when a device group was removed.
The delegate.


description:
Returns a delegate that is invoked when a profile was added.
The delegate.


description: Register wizard that can be used to create pre-defined launcher profiles

code: void RegisterProfileWizard ( const [ILauncherProfileWizardPtr](API\Developer\LauncherServices\ILauncherProfileWizardPtr) & ProfileWizard )


description: Deletes the specified device group.

code: void RemoveDeviceGroup ( const [ILauncherDeviceGroupRef](API\Developer\LauncherServices\ILauncherDeviceGroupRef) & DeviceGroup )


description:
Returns a delegate that is invoked when the project is changed.
The delegate.


description: Deletes the given profile.

code: void RemoveProfile ( const [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) & Profile )


description: Deletes the given simple profile.

code: void RemoveSimpleProfile ( const [ILauncherSimpleProfileRef](API\Developer\LauncherServices\ILauncherSimpleProfileRef) & SimpleProfile )


description: Saves all the device groups to a config file

code: void SaveDeviceGroups()


description: LoadJSONProfile

code: bool SaveJSONProfile ( const [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) & Profile )


description: LoadProfile

code: bool SaveProfile ( const [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) & Profile )


description: LoadSettings

code: void SaveSettings()


description: Sets the default buid target to use.

code: void SetBuildTarget ( const [FString](API\Runtime\Core\Containers\FString) & InBuildTarget )


description: GetProjectPath

code: void SetProjectPath ( const [FString](API\Runtime\Core\Containers\FString) & InProjectPath )


description: Unregister launcher profile wizard

code: void UnregisterProfileWizard ( const [ILauncherProfileWizardPtr](API\Developer\LauncherServices\ILauncherProfileWizardPtr) & ProfileWizard )


description: Virtual destructor.

code: virtual ~ILauncherProfileManager()


className: ILauncherProfileManager

description: Interface for launcher profile managers.

code: class ILauncherProfileManager


className: ILauncherProfileManagerPtr

description: Type definition for shared pointers to instances ofILauncherProfileManager.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncherProfileManager](API\Developer\LauncherServices\ILauncherProfileManager) > ILauncherProfileManagerPtr


className: ILauncherProfileManagerRef

description: Type definition for shared references to instances ofILauncherProfileManager.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncherProfileManager](API\Developer\LauncherServices\ILauncherProfileManager) > ILauncherProfileManagerRef


className: ILauncherProfilePtr

description: Type definition for shared pointers to instances ofILauncherProfile.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncherProfile](API\Developer\LauncherServices\ILauncherProfile) > ILauncherProfilePtr


className: ILauncherProfileRef

description: Type definition for shared references to instances ofILauncherProfile.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncherProfile](API\Developer\LauncherServices\ILauncherProfile) > ILauncherProfileRef


description: Wizard description text that will be used for menu tooltip


description: Wizard name that will be used for menu


description: Handle request to create launcher profile using this wizard

code: void HandleCreateLauncherProfile ( const [ILauncherProfileManagerRef](API\Developer\LauncherServices\ILauncherProfileManagerRef) & ProfileManager )


description: Virtual destructor.

code: virtual ~ILauncherProfileWizard()


className: ILauncherProfileWizard

description: Interface for a factory to create pre-defined launcher profiles.

code: class ILauncherProfileWizard


className: ILauncherProfileWizardPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncherProfileWizard](API\Developer\LauncherServices\ILauncherProfileWizard) > ILauncherProfileWizardPtr


className: ILauncherProfileWizardRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncherProfileWizard](API\Developer\LauncherServices\ILauncherProfileWizard) > ILauncherProfileWizardRef


className: ILauncherPtr

description: Type definition for shared pointers to instances ofILauncher.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncher](API\Developer\LauncherServices\ILauncher) > ILauncherPtr


className: ILauncherRef

description: Type definition for shared references to instances ofILauncher.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncher](API\Developer\LauncherServices\ILauncher) > ILauncherRef


code: void BroadcastLauncherServicesSDKNotInstalled ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName, const [FString](API\Runtime\Core\Containers\FString) & DocLink )


description:
Creates a new device group.
A new device group.


code: [ILauncherDeviceGroupRef](API\Developer\LauncherServices\ILauncherDeviceGroupRef) CreateDeviceGroup ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Guid, const [FString](API\Runtime\Core\Containers\FString) & Name )


description:
Creates a game launcher.
A new game launcher.


description: Creates a launcher profile.

code: [ILauncherProfileRef](API\Developer\LauncherServices\ILauncherProfileRef) CreateProfile ( const [FString](API\Runtime\Core\Containers\FString) & ProfileName )


className: FLauncherServicesSDKNotInstalled

description: Delegate for when a platform SDK isn't installed corrected (takes the platform name and the documentation link to show)

code: class FLauncherServicesSDKNotInstalled : public TBaseMulticastDelegate_TwoParams< void, const FString &, const FString & >


description: Determines the executable that should be used for executing commandlets


description:
Gets the launcher profile manager.
The launcher profile manager.


className: ProfileManagerInitializedDelegate

description: Delegate that is invoked when a profile manager is initialized.


description: Virtual destructor.

code: virtual ~ILauncherServicesModule()


className: ILauncherServicesModule

description: Interface for launcher tools modules.

code: class ILauncherServicesModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)

OnCreateLauncherDelegate

type: FOnCreateLaunch...


description: SetBuildConfigurationName


description:
Gets the selected cook mode.
Cook mode.


description:
Gets the device name this profile is for.
Device Name.

code: const [FString](API\Runtime\Core\Containers\FString) & GetDeviceName() const


description: SetDeviceVariant


description:
Loads the simple profile from the specified file.
true if the profile was loaded, false otherwise.

code: bool Load ( const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) & Object )


description:
Saves the simple profile to the specified file.
true if the profile was saved, false otherwise.

code: void Save ( TJsonWriter<> & Writer )


description:
Serializes the simple profile from or into the specified archive.
true if the profile was serialized, false otherwise.

code: bool Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


description: GetBuildConfigurationName

code: void SetBuildConfiguration ( EBuildConfiguration InConfiguration )


description: GetCookMode

code: void SetCookMode ( [ELauncherProfileCookModes::Type](API\Developer\LauncherServices\ELauncherProfileCookModes__Type) InMode )


description: Sets all profile settings to their defaults.

code: void SetDefaults()


description: Updates the device name.

code: void SetDeviceName ( const [FString](API\Runtime\Core\Containers\FString) & InDeviceName )


description: GetDeviceVariant

code: void SetDeviceVariant ( [FName](API\Runtime\Core\UObject\FName) InVariant )


description: Virtual destructor.

code: virtual ~ILauncherSimpleProfile()


className: ILauncherSimpleProfile

description: Interface for simple launcher profile.

code: class ILauncherSimpleProfile


className: ILauncherSimpleProfilePtr

description: Type definition for shared pointers to instances ofILauncherProfile.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncherSimpleProfile](API\Developer\LauncherServices\ILauncherSimpleProfile) > ILauncherSimpleProfilePtr


className: ILauncherSimpleProfileRef

description: Type definition for shared references to instances ofILauncherProfile.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncherSimpleProfile](API\Developer\LauncherServices\ILauncherSimpleProfile) > ILauncherSimpleProfileRef


description: Cancels the task.

code: void Cancel()


description:
Gets the task's name.
Task name.

code: const [FString](API\Runtime\Core\Containers\FString) & GetDesc() const


description:
Gets the duration of time that the task has been running.
Time duration.


description:
Gets the amount of errors that were generated during this task
the amount

code: uint32 GetErrorCount() const


description:
Gets the task's name.
Task name.

code: const [FString](API\Runtime\Core\Containers\FString) & GetName() const


description:
Gets the task's current status.
Task status.


description:
Gets if the task is trying to cancel
if task is trying to cancel

code: bool IsCancelling() const


description:
Gets the amount of warnings that were generated during this task
the amount

code: uint32 GetWarningCount() const


description:
A task is finished when it is neither pending, nor busy.
true if the task finished, false otherwise.

code: bool IsFinished() const


description:
Gets the completed delegate
the delegate


description:
Gets the stage completed delegate
the delegate


description:
Retrieves the return code from the task
return code from the task

code: int32 ReturnCode() const


className: ILauncherTask

description: Interface for launcher worker tasks.

code: class ILauncherTask


className: ILauncherTaskPtr

description: Type definition for shared pointers to instances ofILauncherTask.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncherTask](API\Developer\LauncherServices\ILauncherTask) > ILauncherTaskPtr


className: ILauncherTaskRef

description: Type definition for shared references to instances ofILauncherTask.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncherTask](API\Developer\LauncherServices\ILauncherTask) > ILauncherTaskRef


description: Set the app id running on the device

code: virtual void AddDevicePackagePair ( const [FString](API\Runtime\Core\Containers\FString) & Device, const [FString](API\Runtime\Core\Containers\FString) & Package )


description: Cancels the operation.


description: Cancels the operation and waits for the thread to finish any remaining work.

code: void CancelAndWait()


description:
Get the launcher profile
the variable


description:
Gets the worker's status.
Worker status.


description:
Gets the worker's list of tasks.
The number of tasks returned.

code: int32 GetTasks ( [TArray](API\Runtime\Core\Containers\TArray)< [ILauncherTaskPtr](API\Developer\LauncherServices\ILauncherTaskPtr) > & OutTasks ) const


description:
Gets the canceled delegate
the delegate


description:
Gets the output message delegate
the delegate


description:
Gets the stage started delegate
the delegate


description: Virtual destructor.

code: virtual ~ILauncherWorker()


className: ILauncherWorker

description: Interface for launcher worker threads.

code: class ILauncherWorker


className: ILauncherWorkerPtr

description: Type definition for shared pointers to instances ofILauncherWorker.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ILauncherWorker](API\Developer\LauncherServices\ILauncherWorker) > ILauncherWorkerPtr


className: ILauncherWorkerRef

description: Type definition for shared references to instances ofILauncherWorker.

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ILauncherWorker](API\Developer\LauncherServices\ILauncherWorker) > ILauncherWorkerRef


className: LexToStringLocalized

code: [FString](API\Runtime\Core\Containers\FString) LexToStringLocalized ( [ELauncherProfileValidationErrors::Type](API\Developer\LauncherServices\ELauncherProfileValidationErrors-) Value )


className: EConflictReportFormat

description: An enum representing all the formats the conflict report can be output in.

module: Localization

code: enum EConflictReportFormat { None, Txt, CSV, }


className: EGenerateLocResFlags

code: enum EGenerateLocResFlags { None = 0, AllowStaleTranslations = 1<<0, ValidateFormatPatterns = 1<<1, ValidateSafeWhitespace = 1<<2, }


className: ELocalizationGatherPathRoot

code: enum ELocalizationGatherPathRoot { Auto, Engine, Project, }


className: ELocalizationTargetConflictStatus

code: enum ELocalizationTargetConflictStatus { Unknown, ConflictsPresent, Clear, }


className: ELocalizationTargetLoadingPolicy

code: enum ELocalizationTargetLoadingPolicy { Never, Always, Editor, Game, PropertyNames, ToolTips, }


className: ELocalizedTextCollapseMode

code: enum ELocalizedTextCollapseMode { IdenticalTextIdAndSource, IdenticalPackageIdTextIdAndSource, IdenticalNamespaceAndSource, }


className: ELocTextHelperLoadFlags

description: Flags controlling the behavior used when loading manifests and archives intoFLocTextHelper

code: enum ELocTextHelperLoadFlags { Load = 1<<0, Create = 1<<1, LoadOrCreate = Load | Create, }


className: ELocTextExportSourceMethod

description: What kind of "source" should we use when looking up translations for export?

code: enum ELocTextExportSourceMethod { SourceText, NativeText, }


className: ELocTextPlatformSplitMode

description: How should we split platform specific localization data?

code: enum ELocTextPlatformSplitMode { None, Confidential, All, }


className: EPortableObjectFormat

code: enum EPortableObjectFormat { Unreal, Crowdin, }


code: FCultureStatistics ( const [FString](API\Runtime\Core\Containers\FString) & InCultureName )


className: FCultureStatistics

code: struct FCultureStatistics

CultureName

description: The ISO name for this culture.

WordCount

description: The estimated number of words that have been localized for this culture.


className: FExportLocalizationOptions

code: struct FExportLocalizationOptions

bAutoCleanup

description: True to automatically clean-up any scratch data created during the localization export

bGatherAssets

description: True to gather localization from assets

bGatherSource

description: True to gather localization from source code (if a plugin has a Config or Source folder)

bGatherVerse

description: True to gather localization from Verse

bUpdatePluginDescriptor

description: True to update the plugin descriptors (if needed) so that they contain the exported localization target

CopyrightNotice

description: An optional copyright notice to insert into the exported files

LocalizationCategory

type: ELocalizedTextS...

description: The category to use for the exported localization target (only used when bUpdatePluginDescriptor is true)

PluginNameToCollectionNameFilter

type: TMap<FString, ...

description: Optional mapping of plugin names to collection names (to act as a filter for their asset gather step)

UGCLocDescriptor

type: FUserGeneratedC...

description: Common export options for all plugins


code: bool Validate ( const bool bIsEngineTarget, [FText](API\Runtime\Core\Internationalization\FText) & OutError ) const


className: FGatherTextExcludePath

code: struct FGatherTextExcludePath

PathRoot

type: ELocalizationGa...


className: FGatherTextFileExtension

code: struct FGatherTextFileExtension


code: FGatherTextFromMetaDataConfiguration()


className: FGatherTextFromMetaDataConfiguration

ExcludePathWildcards

type: TArray<FGather...

description: Metadata from source files whose paths match these wildcard patterns will be excluded from gathering.

FieldOwnerTypesToExclude

type: TArray<FString...

description: List of field owner types (eg, MyClass, MyStruct, etc) that should have fields within them excluded from the gather.

FieldOwnerTypesToInclude

description: List of field owner types (eg, MyClass, MyStruct, etc) that should have fields within them included in the gather, or empty to include everything.

FieldTypesToExclude

description: List of field types (eg, Property, Function, ScriptStruct, Enum, etc) the should be excluded from the gather.

FieldTypesToInclude

description: List of field types (eg, Property, Function, ScriptStruct, Enum, etc) that should be included in the gather, or empty to include everything.

IncludePathWildcards

description: Metadata from source files whose paths match these wildcard patterns, specified relative to the project's root, may be processed for gathering.

IsEnabled

description: If enabled, metadata will be gathered according to this configuration.

KeySpecifications

type: TArray<FMetaDa...

description: Specifications for how to gather text from specific metadata keys.

ShouldGatherFromEditorOnlyData

description: If enabled, data that is specified as editor-only may be processed for gathering.


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FGatherTextFileExtension](API\Developer\Localization\FGatherTextFileExtension) > & GetDefaultPackageFileExtensions()


code: FGatherTextFromPackagesConfiguration()


className: FGatherTextFromPackagesConfiguration

Collections

type: TArray<FName>

description: Packages in these collections may be processed for gathering.

ExcludeClasses

type: TArray<FSoftCl...

description: Classes that should be excluded from gathering.

ExcludePathWildcards

description: Packages whose paths match these wildcard patterns will be excluded from gathering.

FileExtensions

description: Packages whose names match these wildcard patterns may be processed for text to gather.

IncludePathWildcards

description: Packages whose paths match these wildcard patterns, specified relative to the project's root, may be processed for gathering.

IsEnabled

description: If enabled, text from packages will be gathered according to this configuration.

ShouldExcludeDerivedClasses

description: Should classes derived from those in the exclude classes list also be excluded from gathering?

SkipGatherCache

description: Should we ignore the cached text in the package header and perform a full package load instead?


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FGatherTextFileExtension](API\Developer\Localization\FGatherTextFileExtension) > & GetDefaultTextFileExtensions()


code: FGatherTextFromTextFilesConfiguration()


className: FGatherTextFromTextFilesConfiguration

ExcludePathWildcards

description: Text files whose paths match these wildcard patterns will be excluded from gathering.

FileExtensions

description: Text files whose names match these wildcard patterns may be parsed for text to gather.

IsEnabled

description: If enabled, text from text files will be gathered according to this configuration.

SearchDirectories

description: The paths of directories to be searched recursively for text files, specified relative to the project's root, which may be parsed for text to gather.


className: FGatherTextIncludePath

code: struct FGatherTextIncludePath

Pattern

type: FString


code: FLocalizationCompilationSettings()


className: FGatherTextSearchDirectory

code: struct FGatherTextSearchDirectory


className: FLocalizationCompilationSettings

code: struct FLocalizationCompilationSettings

SkipSourceCheck

description: Should we skip the source check when compiling translations? This will allow translations whose source no longer matches the active source to still be used by the game at runtime.

ValidateFormatPatterns

description: Should we validate that format patterns are valid for the culture being compiled (eg, detect invalid plural rules or broken syntax).

ValidateSafeWhitespace

description: Should we validate that text doesn't contain any unsafe whitespace (leading or trailing whitespace) that could get lost during the translation process.


code: [FConfigSection](API\Runtime\Core\Misc\FConfigSection) & GatherTextStep ( const uint32 Index )


code: bool WriteWithSCC ( const [FString](API\Runtime\Core\Containers\FString) & InConfigFilename )


className: FLocalizationConfigurationScript

code: struct FLocalizationConfigurationScript : public [FConfigFile](API\Runtime\Core\Misc\FConfigFile)


code: FLocalizationExportingSettings()


className: FLocalizationExportingSettings

code: struct FLocalizationExportingSettings

CollapseMode

type: ELocalizedTextC...

description: How should we collapse down text when exporting to PO?

POFormat

type: EPortableObject...

description: Which format of PO file should we use?

ShouldAddSourceLocationsAsComments

description: Should source locations be added to PO file entries as comments? Useful if a third party service doesn't expose PO file reference comments, which typically store the source location.

ShouldPersistCommentsOnExport

description: Should user comments in existing PO files be persisted after export? Useful if using a third party service that stores editor/translator notes in the PO format's comment fields.


description: Get the resolved placeholder token of the path root ("%LOCENGINEROOT%" for Engine or "%LOCPROJECTROOT%" for Project; empty for Auto)

code: static [FString](API\Runtime\Core\Containers\FString) GetResolvedPathRootToken ( const [ELocalizationGatherPathRoot](API\Developer\Localization\ELocalizationGatherPathRoot) InPathRoot )


description: Get the display name of the resolved path root (either "Engine/" or "{ProjectName/" depending on the setting and target type

code: static [FText](API\Runtime\Core\Internationalization\FText) GetResolvedPathRootDisplayName ( const [ELocalizationGatherPathRoot](API\Developer\Localization\ELocalizationGatherPathRoot) InPathRoot, const bool bIsEngineTarget )


description: Get the path name of the resolved path root (eitherFPaths::EngineDir()orFPaths::ProjectDir()depending on the setting and target type

code: static [FString](API\Runtime\Core\Containers\FString) GetResolvedPathRoot ( const [ELocalizationGatherPathRoot](API\Developer\Localization\ELocalizationGatherPathRoot) InPathRoot, const bool bIsEngineTarget )


className: FLocalizationGatherPathRootUtil

code: struct FLocalizationGatherPathRootUtil


code: FLocalizationImportDialogueSettings()


className: FLocalizationImportDialogueSettings

bImportNativeAsSource

description: Should the dialogue for the native culture be imported as if it were source audio? If false, the native culture dialogue will be imported as localized data for the native culture.

ImportedDialogueFolder

description: Folder in which to create the generated sound waves.

RawAudioPath

type: FDirectoryPath

description: Path to the folder to import the audio from.


code: bool CheckinFiles ( const [FText](API\Runtime\Core\Internationalization\FText) & InChangeDescription, [FText](API\Runtime\Core\Internationalization\FText) & OutError )


code: bool CheckOutFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [FText](API\Runtime\Core\Internationalization\FText) & OutError )


code: bool CleanUp ( [FText](API\Runtime\Core\Internationalization\FText) & OutError )


code: bool IsReady ( [FText](API\Runtime\Core\Internationalization\FText) & OutError )


code: bool RevertFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [FText](API\Runtime\Core\Internationalization\FText) & OutError )


className: FLocalizationSCC

code: class FLocalizationSCC


description: Checks to see whether source control is available based upon the current editor SCC settings.

code: static bool IsSourceControlAvailable()


description: Check to see whether we should automatically submit changed files after running the commandlet. This should be used to optionally pass "-DisableSCCSubmit" to the commandlet.


description: Check to see whether we should use SCC when running the localization commandlets. This should be used to optionally pass "-EnableSCC" to the commandlet.

code: static bool IsSourceControlEnabled()


code: static const [FString](API\Runtime\Core\Containers\FString) LocalizationSourceControlSettingsCategoryName = TEXT("LocalizationSourceControlSettings");


description: Set whether we should use SCC when running the localization commandlets.

code: static void SetSourceControlEnabled ( const bool bIsEnabled )


description: Set whether we should automatically submit changed files after running the commandlet.

code: static void SetSourceControlAutoSubmitEnabled ( const bool bIsEnabled )


code: static const [FString](API\Runtime\Core\Containers\FString) SourceControlAutoSubmitEnabledSettingName = TEXT("SourceControlAutoSubmitEnabled");


className: SourceControlEnabledSettingName

code: static const [FString](API\Runtime\Core\Containers\FString) SourceControlEnabledSettingName = TEXT("SourceControlEnabled");


className: FLocalizationSourceControlSettings

description: Struct containing util functions for getting/setting the SCC settings for the localization dashboard


code: FLocalizationTargetSettings()


className: FLocalizationTargetSettings

code: struct FLocalizationTargetSettings

AdditionalManifestDependencies

type: TArray<FFilePa...

description: Text present in these manifests will not be duplicated in this target.

CompileSettings

type: FLocalizationCo...

description: Settings for compiling translations.

ConflictStatus

type: ELocalizationTa...

description: Whether the target has outstanding conflicts that require resolution.

ExportSettings

type: FLocalizationEx...

description: Settings for exporting translations.

GatherFromMetaData

type: FGatherTextFrom...

description: Parameters for defining what text is gathered from metadata and how.

GatherFromPackages

description: Parameters for defining what text is gathered from packages and how.

GatherFromTextFiles

description: Parameters for defining what text is gathered from text files and how.

Guid

type: FGuid

ImportDialogueSettings

type: FLocalizationIm...

description: Settings for importing dialogue from WAV files.

Name

description: Unique name for the target.

NativeCultureIndex

description: The index of the native culture among the supported cultures.

RequiredModuleNames

description: The names of modules which must be loaded when gathering text.

SupportedCulturesStatistics

type: TArray<FCultur...

description: Cultures for which the source text is being localized for.

TargetDependencies

type: TArray<FGuid>

description: Text present in these targets will not be duplicated in this target.


description: Called after reading the given file from disk

code: virtual void PostFileRead ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Called after writing the given file to disk

code: virtual void PostFileWrite ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Called prior to reading the given file on disk

code: virtual void PreFileRead ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Called prior to writing the given file to disk

code: virtual void PreFileWrite ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


code: FLocFileSCCNotifies ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocalizationSCC](API\Developer\Localization\FLocalizationSCC) > & InSourceControlInfo )


description: Virtual destructor

code: virtual ~FLocFileSCCNotifies()


className: FLocFileSCCNotifies

code: class FLocFileSCCNotifies : public [ILocFileNotifies](API\Developer\Localization\ILocFileNotifies)


description: Convert the conflicts to a string format that can be easily saved as a .txt report summary.


description: Add a new conflict entry.

code: void AddConflict ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & InKeyMetadata, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, const [FString](API\Runtime\Core\Containers\FString) & InSourceLocation )


className: FConflictMap

code: typedef [TMultiMap](API\Runtime\Core\Containers\TMultiMap)< [FLocKey](API\Runtime\Core\Internationalization\FLocKey), [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FConflict > > FConflictMap


code: FLocTextConflicts &40; const FLocTextConflicts & &41;


description: Convert the conflicts to a string format that can be easily saved as a .csv report summary.


className: FLocTextConflicts

description: Class that tracks any conflicts that occur when gathering source text entries.

code: class FLocTextConflicts


description:
Add a new source text entry to the manifest.
Returns true if it was added successfully (or if a matching entry already exists), false if a duplicate entry was found with different text (an identity conflict).

code: bool AddSourceText ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, const [FManifestContext](API\Runtime\Core\Internationalization\FManifestContext) & InContext, const [FString](API\Runtime\Core\Containers\FString) * InDescription )


description:
Attempt to add a manifest dependency.
True if the file was load, false otherwise.

code: bool AddDependency ( const [FString](API\Runtime\Core\Containers\FString) & InDependencyFilePath, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


description:
Add a new translation to the given archive.
Returns true if it was added successfully, false otherwise.

code: bool AddTranslation ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FArchiveEntry](API\Runtime\Core\Internationalization\FArchiveEntry) > & InEntry )


code: bool AddTranslation ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & InKeyMetadataObj, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InTranslation, const bool InOptional )


code: void EnumerateTranslations ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FEnumerateTranslationsFuncPtr](API\Developer\Localization\FLocTextHelper\FEnumerateTranslationsFuncPtr) & InCallback, const bool InCheckDependencies ) const


code: void EnumerateSourceTexts ( const [FEnumerateSourceTextsFuncPtr](API\Developer\Localization\FLocTextHelper\FEnumerateSourceTextsFuncPtr) & InCallback, const bool InCheckDependencies ) const


className: FEnumerateSourceTextsFuncPtr

description: Enumerate all the source texts in the manifest, optionally skipping those entries from a dependent manifest.


description:
Find an existing dependency entry using its namespace and context.
The entry, or null if it couldn't be found.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FManifestEntry](API\Runtime\Core\Internationalization\FManifestEntry) > FindDependencyEntry ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FManifestContext](API\Runtime\Core\Internationalization\FManifestContext) & InContext, [FString](API\Runtime\Core\Containers\FString) * OutDependencyFilePath ) const


className: FEnumerateTranslationsFuncPtr

description: This only enumerates translations that have a source in the manifest.


description:
Find an dependency entry using its namespace and key.
The entry, or null if it couldn't be found.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FManifestEntry](API\Runtime\Core\Internationalization\FManifestEntry) > FindDependencyEntry ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [FString](API\Runtime\Core\Containers\FString) * InSourceText, [FString](API\Runtime\Core\Containers\FString) * OutDependencyFilePath ) const


description:
This should only be used to upgrade old non-keyed archive entries when importing legacy data.
True if keys were found, false otherwise.

code: bool FindKeysForLegacyTranslation ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FString](API\Runtime\Core\Containers\FString) & InSource, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > InKeyMetadataObj, [TArray](API\Runtime\Core\Containers\TArray)< [FLocKey](API\Runtime\Core\Internationalization\FLocKey) > & OutKeys ) const


code: static bool FindKeysForLegacyTranslation ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > & InManifest, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > & InNativeArchive, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FString](API\Runtime\Core\Containers\FString) & InSource, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > InKeyMetadataObj, [TArray](API\Runtime\Core\Containers\TArray)< [FLocKey](API\Runtime\Core\Internationalization\FLocKey) > & OutKeys )


description:
Find an existing source text entry using its namespace and key.
The entry, or null if it couldn't be found.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FManifestEntry](API\Runtime\Core\Internationalization\FManifestEntry) > FindSourceText ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [FString](API\Runtime\Core\Containers\FString) * InSourceText ) const


description:
Find an existing source text entry using its namespace and context.
The entry, or null if it couldn't be found.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FManifestEntry](API\Runtime\Core\Internationalization\FManifestEntry) > FindSourceText ( const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FManifestContext](API\Runtime\Core\Internationalization\FManifestContext) & InContext ) const


description: Get an array of culture codes for all the cultures (native and foreign).

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetAllCultures ( const bool bSingleCultureMode ) const


description:
Find an existing translation entry from its source text.
The entry, or null if it couldn't be found.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FArchiveEntry](API\Runtime\Core\Internationalization\FArchiveEntry) > FindTranslation ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > InKeyMetadataObj ) const


description: Get a conflict report that can be easily saved as a report summary.


description: Get the optional copyright notice to insert into files that support it.

code: const [FString](API\Runtime\Core\Containers\FString) & GetCopyrightNotice() const


description: Given some source text, work out which text should be exported (eg, when exporting to PO).

code: void GetExportText ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > InKeyMetadataObj, const [ELocTextExportSourceMethod](API\Developer\Localization\ELocTextExportSourceMethod) InSourceMethod, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & OutSource, [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & OutTranslation ) const


description: Get an array of culture codes for the foreign cultures (does not include the native culture).

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetForeignCultures() const


description: Get the culture code of the native culture (eg, en), or an empty string if the native culture is unknown.

code: const [FString](API\Runtime\Core\Containers\FString) & GetNativeCulture() const


description: The interface that allows source control integration (may be null).

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ILocFileNotifies](API\Developer\Localization\ILocFileNotifies) > GetLocFileNotifies() const


description: How are we splitting localization data per-platform?


description: Get the platforms names that should be split, based on the active split mode.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetPlatformsToSplit() const


description: Given some source text, work out which text is our current "best" translation (eg, when compiling to LocRes).

code: void GetRuntimeText ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > InKeyMetadataObj, const [ELocTextExportSourceMethod](API\Developer\Localization\ELocTextExportSourceMethod) InSourceMethod, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & OutTranslation, const bool bSkipSourceCheck ) const


description: The name of the target we're working with.

code: const [FString](API\Runtime\Core\Containers\FString) & GetTargetName() const


description: The path to the localization target (the root of this path should contain the manifest, and the archives should be under culture code directories).

code: const [FString](API\Runtime\Core\Containers\FString) & GetTargetPath() const


description:
Get a word count report for the current state of the manifest and archives.
The word count report.

code: [FLocTextWordCounts](API\Developer\Localization\FLocTextWordCounts) GetWordCountReport ( const [FDateTime](API\Runtime\Core\Misc\FDateTime) & InTimestamp, const TCHAR * InBaseReportFilePath ) const


description: Check to see whether we've loaded the given archive (native or foreign).

code: bool HasArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture ) const


description: This requires that the given culture is in the list of foreign cultures set during construction.

code: bool HasForeignArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture ) const


description: Check to see whether we've loaded the manifest.

code: bool HasManifest() const


description: Check to see whether we've loaded the native archive.

code: bool HasNativeArchive() const


description:
Import a previously exported translation (generated using GetExportText) back into the archive. This will either update an existing translation, or add a new one if it can't be found.
Returns true if it was imported successfully, false otherwise.

code: bool ImportTranslation ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InNamespace, const [FLocKey](API\Runtime\Core\Internationalization\FLocKey) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > InKeyMetadataObj, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InSource, const [FLocItem](API\Runtime\Core\Internationalization\FLocItem) & InTranslation, const bool InOptional )


description:
Attempt to load (or create) the manifest and all archive files specified during construction.
True if all files were loaded (or created), false otherwise.

code: bool LoadAll ( const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


description:
The manifest must have been loaded prior to loading archives.
True if the files were loaded (or created), false otherwise.

code: bool LoadAllArchives ( const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


description:
The manifest and native archive (if set) must have been loaded prior to loading foreign archives.
True if the file was loaded (or created), false otherwise.

code: bool LoadArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


code: bool LoadArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FString](API\Runtime\Core\Containers\FString) & InArchiveFilePath, const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


code: bool LoadForeignArchive ( const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) InLoadFlags, [FText](API\Runtime\Core\Internationalization\FText) * OutError )