1. Epic GamesDeveloper
  3. UGatherTextCommandletBase

UGatherTextCommandletBase

[UGatherTextCommandletBase](API\Editor\UnrealEd\UGatherTextCommandletBase): Base class for localization commandlets.

API > API/Editor > API/Editor/UnrealEd

UGatherTextCommandletBase: Base class for localization commandlets. Just to force certain behaviors and provide helper functionality.

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

Syntax

UCLASS (MinimalAPI)  
class UGatherTextCommandletBase : public UCommandlet

Inheritance Hierarchy

Derived Classes

UGatherTextCommandletBase derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UGatherTextCommandletBase ( const FObjectInitializer& ObjectInitializer
)

   Commandlets/GatherTextCommandletBase.h  

Constants

Name Type Remarks Include Path
ConfigParam const TCHAR * Common params and switches among all text gathering commandlets. Commandlets/GatherTextCommandletBase.h
DisableSubmitSwitch const TCHAR *   Commandlets/GatherTextCommandletBase.h
EnableSourceControlSwitch const TCHAR *   Commandlets/GatherTextCommandletBase.h
GatherTypeParam const TCHAR *   Commandlets/GatherTextCommandletBase.h
PreviewSwitch const TCHAR *   Commandlets/GatherTextCommandletBase.h
SkipNestedMacroPrepassSwitch const TCHAR *   Commandlets/GatherTextCommandletBase.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanParallelize()

 Can this task run in parallel with other tasks in its phase? If true, a random thread may invoke Main so any external/shared resources used must be thread-safe. Commandlets/GatherTextCommandletBase.h  

virtual bool ConfigurePhase ( const FString& Params
)

 Called once before GetPhase to allow the commandlet to compute which phase it needs to run it. Commandlets/GatherTextCommandletBase.h  

bool GetBoolFromConfig ( const TCHAR* Section,
const TCHAR* Key,
bool& OutValue,
const FString& Filename
)

 Wrappers for extracting config values. Commandlets/GatherTextCommandletBase.h  

int32 GetPathArrayFromConfig ( const TCHAR* Section,
const TCHAR* Key,
TArray< FString >& OutArr,
const FString& Filename
)

   Commandlets/GatherTextCommandletBase.h  

bool GetPathFromConfig ( const TCHAR* Section,
const TCHAR* Key,
FString& OutValue,
const FString& Filename
)

   Commandlets/GatherTextCommandletBase.h  

virtual EGatherTextCommandletPhase GetPhase()

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

FName GetSplitPlatformNameFromPath ( const FString& InPath
) const

   Commandlets/GatherTextCommandletBase.h  

int32 GetStringArrayFromConfig ( const TCHAR* Section,
const TCHAR* Key,
TArray< FString >& OutArr,
const FString& Filename
)

   Commandlets/GatherTextCommandletBase.h  

bool GetStringFromConfig ( const TCHAR* Section,
const TCHAR* Key,
FString& OutValue,
const FString& Filename
)

   Commandlets/GatherTextCommandletBase.h  

virtual void Initialize ( const TSharedRef< FLocTextHelper >& InGatherManifestHelper,
const TSharedPtr< FLocalizationSCC >& InSourceControlInfo
)

   Commandlets/GatherTextCommandletBase.h  

bool IsSplitPlatformName ( const FName InPlatformName
) const

 Utilities for split platform detection. Commandlets/GatherTextCommandletBase.h  

void SetEmbeddedContext ( const TSharedPtr< const FGatherTextCommandletEmbeddedContext >& InEmbeddedContext
)

   Commandlets/GatherTextCommandletBase.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/GatherTextCommandletBase.h  

bool ShouldSplitPlatformForPath ( const FString& InPath,
FName* OutPlatformName
) const

   Commandlets/GatherTextCommandletBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Commandlets/GatherTextCommandletBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ResolveLocalizationPath ( FString& InOutPath
)

   Commandlets/GatherTextCommandletBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FString & GetProjectBasePath()

 Utility to get the correct base path (engine or project) for the current environment. Commandlets/GatherTextCommandletBase.h  

static FName GetSplitPlatformNameFromPath_Static ( const FString& InPath,
const TMap< FName, FString >& InSplitPlatforms
)

   Commandlets/GatherTextCommandletBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page