1. Epic GamesDeveloper
  3. UGatherTextFromAssetsCommandlet

UGatherTextFromAssetsCommandlet

[UGatherTextFromAssetsCommandlet](API\Editor\UnrealEd\UGatherTextFromAssetsCommandlet): Localization commandlet that collects all text to be localized from the game assets.

API > API/Editor > API/Editor/UnrealEd

UGatherTextFromAssetsCommandlet: Localization commandlet that collects all text to be localized from the game assets.

   
Name UGatherTextFromAssetsCommandlet
Type class
Header File /Engine/Source/Editor/UnrealEd/Classes/Commandlets/GatherTextFromAssetsCommandlet.h
Include Path #include "Commandlets/GatherTextFromAssetsCommandlet.h"

Syntax

UCLASS ()  
class UGatherTextFromAssetsCommandlet : public UGatherTextCommandletBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UGatherTextFromAssetsCommandlet ( const FObjectInitializer& ObjectInitializer
)

   Commandlets/GatherTextFromAssetsCommandlet.h  

Structs

Name Remarks
FPackagePendingGather Struct containing the data needed by a pending package that we will gather text from

Enums

Public

Name Remarks
EPackageLocCacheState Localization cache states of a package

Constants

Name Type Remarks Include Path
UsageText const FString   Commandlets/GatherTextFromAssetsCommandlet.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bApplyRedirectorsToCollections bool   Commandlets/GatherTextFromAssetsCommandlet.h  
bFixMissingGatherCache bool   Commandlets/GatherTextFromAssetsCommandlet.h  
bFixPackageLocalizationIdConflict bool   Commandlets/GatherTextFromAssetsCommandlet.h  
bFixStaleGatherCache bool   Commandlets/GatherTextFromAssetsCommandlet.h  
bReportStaleGatherCache bool   Commandlets/GatherTextFromAssetsCommandlet.h  
bSearchAllAssets bool   Commandlets/GatherTextFromAssetsCommandlet.h  
bShouldExcludeDerivedClasses bool   Commandlets/GatherTextFromAssetsCommandlet.h  
bShouldGatherFromEditorOnlyData bool   Commandlets/GatherTextFromAssetsCommandlet.h  
bSkipGatherCache bool   Commandlets/GatherTextFromAssetsCommandlet.h  
bStartWorkersAlways bool True if we should start the worker processes always, even if we don't meet the MinPackagesToUseWorkers threshold Commandlets/GatherTextFromAssetsCommandlet.h  
bStartWorkersImmediately bool True if we should start the worker processes immediately, rather than wait until we know we have packages to load Commandlets/GatherTextFromAssetsCommandlet.h  
CollectionFilters TArray< FString >   Commandlets/GatherTextFromAssetsCommandlet.h  
DestinationPath FString Path to the directory where output reports etc will be saved. Commandlets/GatherTextFromAssetsCommandlet.h  
ExcludeClassNames TArray< FString >   Commandlets/GatherTextFromAssetsCommandlet.h  
ExcludePathFilters TArray< FString >   Commandlets/GatherTextFromAssetsCommandlet.h  
GatherManifestHelperMutex UE::FMutex   Commandlets/GatherTextFromAssetsCommandlet.h  
IncludePathFilters TArray< FString >   Commandlets/GatherTextFromAssetsCommandlet.h  
ManifestDependenciesList TArray< FString >   Commandlets/GatherTextFromAssetsCommandlet.h  
MaxUsedMemoryBytes uint64 Run a GC if the used process memory is greater than this value (or zero to disable) Commandlets/GatherTextFromAssetsCommandlet.h  
MinFreeMemoryBytes uint64 Run a GC if the free system memory is less than this value (or zero to disable) Commandlets/GatherTextFromAssetsCommandlet.h  
ModulesToPreload TArray< FString >   Commandlets/GatherTextFromAssetsCommandlet.h  
NumPackagesDupLocId uint64   Commandlets/GatherTextFromAssetsCommandlet.h  
NumUncachedPackagesProcessedLocally std::atomic< int32 >   Commandlets/GatherTextFromAssetsCommandlet.h  
NumUncachedPackagesProcessedRemotely std::atomic< int32 >   Commandlets/GatherTextFromAssetsCommandlet.h  
NumWorkers int32 Number of worker processes to use Commandlets/GatherTextFromAssetsCommandlet.h  
PackageFileNameFilters TArray< FString >   Commandlets/GatherTextFromAssetsCommandlet.h  
PackagesDistributedToWorkers TMap< FName, FPackagePendingGather > Record of which packages were sent to workers, so that we can re-add them to the main PackagesPendingGather queue if the worker crashes Commandlets/GatherTextFromAssetsCommandlet.h  
PackagesDistributedToWorkersMutex UE::FMutex   Commandlets/GatherTextFromAssetsCommandlet.h  
PackagesPendingGather TArray< FPackagePendingGather >   Commandlets/GatherTextFromAssetsCommandlet.h  
PackagesPendingGatherMutex UE::FMutex   Commandlets/GatherTextFromAssetsCommandlet.h  
PackagesWithDuplicateLocalizationIds TSet< FName >   Commandlets/GatherTextFromAssetsCommandlet.h  
TotalNumUncachedPackages int32 Stats for the uncached package loading Commandlets/GatherTextFromAssetsCommandlet.h  
WorldCollectionFilters TArray< FString >   Commandlets/GatherTextFromAssetsCommandlet.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AssignPackagesToWorkers ( TConstArrayView< FGuid > IdleWorkerIds
)

   Commandlets/GatherTextFromAssetsCommandlet.h  

void CalculateDependenciesForPackagesPendingGather()

   Commandlets/GatherTextFromAssetsCommandlet.h  

bool ConfigureFromScript ( const FString& GatherTextConfigPath,
const FString& SectionName
)

   Commandlets/GatherTextFromAssetsCommandlet.h  

bool GetConfigurationScript ( const TMap< FString, FString >& InCommandLineParameters,
FString& OutFilePath,
FString& OutStepSectionName
)

   Commandlets/GatherTextFromAssetsCommandlet.h  

void IngestPackageResultFromWorker ( const FGatherTextFromAssetsWorkerMessage_PackageResult& PackageResult,
const bool bSendWorkIfIdle
)

   Commandlets/GatherTextFromAssetsCommandlet.h  

void ProcessGatherableTextDataArray ( const TArray< FGatherableTextData >& GatherableTextDataArray
)

   Commandlets/GatherTextFromAssetsCommandlet.h  

void StartWorkers ( const int32 MinPackagesToUseWorkers
)

   Commandlets/GatherTextFromAssetsCommandlet.h  

Overridden from UGatherTextCommandletBase

Name Remarks Include Path Unreal Specifiers

virtual EGatherTextCommandletPhase GetPhase()

 Which phase does this task need to run in? Commandlets/GatherTextFromAssetsCommandlet.h  

virtual bool ShouldRunInPreview ( const TArray< FString >& Switches,
const TMap< FString, FString >& ParamVals
) const

 Returns true if this commandlet should run during a preview run. Commandlets/GatherTextFromAssetsCommandlet.h  

Overridden from UCommandlet

Name Remarks Include Path Unreal Specifiers

virtual int32 Main ( const FString& Params
)

   Commandlets/GatherTextFromAssetsCommandlet.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page