1. Epic GamesDeveloper
  3. UGatherTextCommandletBase

UGatherTextCommandletBase

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

Unreal Engine C++ API Reference > Editor > UnrealEd > Commandlets

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Classes/Commandlets/GatherTextCommandletBase.h
Include #include "Commandlets/GatherTextCommandletBase.h"

Syntax

class UGatherTextCommandletBase : public UCommandlet

Remarks

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

Variables

  Type Name Description
Protected variable TSharedPtr< FLocTextHelper > GatherManifestHelper  
Protected variable TSharedPtr< FLocalizationSCC > SourceControlInfo  
Protected variable TMap< FName, FString > SplitPlatforms Mapping from platform name to the path marker for that platform

Constructors

  Type Name Description
Public function  

UGatherTextCommandletBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function bool

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

 Wrappers for extracting config values.
Public function int32

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

  
Public function bool

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

  
Public function Static const FString & Utility to get the correct base path (engine or project) for the current environment.
Public function Const FName  
Public function int32

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

  
Public function bool

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

  
Public function Virtual void

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

  
Public function Const bool

IsSplitPlatformName ( const FName InPlatformName
)

 Utilities for split platform detection.
Public function Virtual Const bool

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

 Returns true if this commandlet should run during a preview run.
Public function Const bool

ShouldSplitPlatformForPath ( const FString& InPath,
FName* OutPlatformName
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Constants

Name Description
ConfigParam Common params and switches among all text gathering commadnlets.
DisableSubmitSwitch  
EnableSourceControlSwitch  
GatherTypeParam  
PreviewSwitch  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page