UGatherTextFromSourceCommandlet | Unreal Engine 5.7 Documentation

UGatherTextFromSourceCommandlet: Localization commandlet that collects all text to be localized from the source code.


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

Syntax

UCLASS ()  
class UGatherTextFromSourceCommandlet : public UGatherTextCommandletBase

Name	Remarks	Include Path	Unreal Specifiers
UGatherTextFromSourceCommandlet ( const FObjectInitializer& ObjectInitializer )		Commandlets/GatherTextFromSourceCommandlet.h

Name	Remarks
FDefineDescriptor
FElIfDescriptor
FElseDescriptor
FEndIfDescriptor
FIfDefDescriptor
FIfDescriptor
FIniNamespaceDescriptor
FMacroArgumentGatherer
FMacroDescriptor
FNestedMacroDescriptor	This descriptor finds macros that match those found in the prepass (FNestedMacroPrepassDescriptor)
FNestedMacroPrepassDescriptor	This descripter runs in a prepass to collect macros with nested localizable macros Example: #define METASOUND_PARAM(NAME, NAME_TEXT) \ static const FText NAME#DisplayName = LOCTEXT(#NAME "DisplayName", NAME_TEXT);
FParsableDescriptor
FPreProcessorDescriptor
FStringMacroDescriptor
FStringTableEntryMacroDescriptor
FStringTableEntryMetaDataMacroDescriptor
FStringTableFromFileMacroDescriptor
FStringTableMacroDescriptor
FStructuredLogMacroDescriptor
FUICommandExtMacroDescriptor
FUICommandMacroDescriptor
FUndefDescriptor

Name	Remarks
FManifestEntryResult	Results of mainpass to submit to FLocTextHelper once parallel processing completes.
FParsedNestedMacro	Macro with nested standard macros, collected in a prepass.
FParsedStringTable
FParsedStringTableEntry
FParsedStringTableEntryMetaData
FSourceFileParseContext
FSourceLocation

Name	Type	Remarks	Include Path
FParsedStringTableEntryMetaDataMap	TMap< FName, FParsedStringTableEntryMetaData >		Commandlets/GatherTextFromSourceCommandlet.h

Name	Type	Include Path
DefineString	const FString	Commandlets/GatherTextFromSourceCommandlet.h
MacroString_LOCTEXT	const FString	Commandlets/GatherTextFromSourceCommandlet.h
MacroString_NSLOCTEXT	const FString	Commandlets/GatherTextFromSourceCommandlet.h
MacroString_UI_COMMAND	const FString	Commandlets/GatherTextFromSourceCommandlet.h
MacroString_UI_COMMAND_EXT	const FString	Commandlets/GatherTextFromSourceCommandlet.h

Name	Remarks	Include Path	Unreal Specifiers
virtual EGatherTextCommandletPhase GetPhase()	Which phase does this task need to run in?	Commandlets/GatherTextFromSourceCommandlet.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/GatherTextFromSourceCommandlet.h

Name	Remarks	Include Path	Unreal Specifiers
virtual int32 Main ( const FString& Params )		Commandlets/GatherTextFromSourceCommandlet.h

Name	Remarks	Include Path	Unreal Specifiers
static void CountFileTypes ( const TArray< FString >& FilesToProcess, EGatherSourcePasses Pass )		Commandlets/GatherTextFromSourceCommandlet.h
static bool HandledInPrepass ( const TArray< FParsedNestedMacro >& Results, const FString& Filename, int32 LineNumber, int32& AdvanceByLines )		Commandlets/GatherTextFromSourceCommandlet.h
static void LogStats()		Commandlets/GatherTextFromSourceCommandlet.h
static bool ParseSourceText ( const FString& Text, const TArray< FParsableDescriptor* >& Parsables, FSourceFileParseContext& ParseCtxt, TArray< FParsedNestedMacro >& PrepassResults )		Commandlets/GatherTextFromSourceCommandlet.h
static void PrunePrepassResults ( TArray< FParsedNestedMacro >& Results )		Commandlets/GatherTextFromSourceCommandlet.h
static FString RemoveStringFromTextMacro ( const FString& TextMacro, const FString& IdentForLogging, bool& Error )		Commandlets/GatherTextFromSourceCommandlet.h
static FString StripCommentsFromToken ( const FString& InToken, FSourceFileParseContext& Context )		Commandlets/GatherTextFromSourceCommandlet.h
static FString UnescapeLiteralCharacterEscapeSequences ( const FString& InString )		Commandlets/GatherTextFromSourceCommandlet.h