Localization

Filters

Classes

Name

Description

Public struct

FCultureStatistics

Public struct

FGatherTextExcludePath

Public struct

FGatherTextFileExtension

Public struct

FGatherTextFromMetaDataConfiguration

Public struct

FGatherTextFromPackagesConfiguration

Public struct

FGatherTextFromTextFilesConfiguration

Public struct

FGatherTextIncludePath

Public struct

FGatherTextSearchDirectory

Public struct

FLocalizationCompilationSettings

Public struct

FLocalizationConfigurationScript

Public struct

FLocalizationExportingSettings

Public struct

FLocalizationGatherPathRootUtil

Public struct

FLocalizationImportDialogueSettings

Public class

FLocalizationSCC

Public struct

FLocalizationSourceControlSettings

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

Public struct

FLocalizationTargetSettings

Public class

FLocFileSCCNotifies

Public class

FLocTextConflicts

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

Public class

FLocTextHelper

High-level access to the non-compiled localization resources (manifests and archives) in a way that abstracts some of their quirks.

Public struct

FLocTextPlatformSplitUtils

Utilities to get manage platforms to split.

Public class

FLocTextWordCounts

Class that manages the word count reporting of the various cultures.

Public struct

FMetaDataKeyGatherSpecification

Public struct

FMetaDataKeyName

Public struct

FMetaDataTextKeyPattern

Public class

FPortableObjectCulture

Class for handling language codes used in the Portable Object format.

Public class

FPortableObjectEntry

Class for representing entries in a Portable Object file(.po) or a Portable Object Template file(.pot).

Public class

FPortableObjectEntryKey

Class for representing the key of an entry in a Portable Object file(.po) or a Portable Object Template file(.pot).

Public class

FPortableObjectFormatDOM

Contains all the info we need to represent files in the Portable Object format.

Public class

FPortableObjectHeader

Class that stores and manipulates PO and POT file header info.

Public class

FTextLocalizationResourceGenerator

Utility functions for generating compiled LocMeta (Localization MetaData Resource) and LocRes (Localization Resource) files from source localization data

Public class

ILocalizationModule

Public class

ILocFileNotifies

Interface for the loc file notify API.

Public class

ULocalizationSettings

Class for loading/saving configuration settings and the details view objects needed for localization dashboard functionality.

Public class

ULocalizationTarget

Public class

ULocalizationTargetSet

Typedefs

Name

Description

FPortableObjectEntries

Enums

Name

Description

Public enum

ELocalizationGatherPathRoot

Public enum

ELocalizationTargetConflictStatus

Public enum

ELocalizationTargetLoadingPolicy

Public enum

ELocalizedTextCollapseMode

Public enum

ELocTextExportSourceMethod

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

Public enum

ELocTextHelperLoadFlags

Flags controlling the behavior used when loading manifests and archives into FLocTextHelper

Public enum

ELocTextPlatformSplitMode

How should we split platform specific localization data?

Functions

Name Description

Public function

constexpr bo...

 

operator!

Public function

constexpr EL ...

 

operator&

Public function

ELocTextHelp ...

 

operator&=

(
    ELocTextHelperLoadFlags & Lhs,
    ELocTextHelperLoadFlags Rhs
)

Public function

constexpr EL ...

 

operator^

Public function

ELocTextHelp ...

 

operator^=

(
    ELocTextHelperLoadFlags & Lhs,
    ELocTextHelperLoadFlags Rhs
)

Public function

constexpr EL ...

 

operator|

Public function

ELocTextHelp ...

 

operator|=

(
    ELocTextHelperLoadFlags & Lhs,
    ELocTextHelperLoadFlags Rhs
)

Public function

constexpr EL ...

 

operator~

Public function

FString

 

PortableObjectPipeline::ConditionArchiveStrForPo

(
    const FString & InStr
)

Given a string, condition it so it can be written as a field of a PO file

Public function

FString

 

PortableObjectPipeline::ConditionIdentityForPOMsgCtxt

(
    const FString & Namespace,
    const FString & Key,
    const TSharedPtr < FLocMetadataObjec ...,
    const ELocalizedTextCollapseMode In...
)

Given a namespace and key, condition this information so it can be written to the "msgctxt" field of a PO file

Public function

FString

 

PortableObjectPipeline::ConditionPoStringForArchive

(
    const FString & InStr
)

Given the field of a PO file, condition it back to a clean string

Public function

FString

 

PortableObjectPipeline::ConvertSrcLocationToPORef

(
    const FString & InSrcLocation
)

Given a source location string, clean it up for use in PO file fields

Public function

bool

 

PortableObjectPipeline::Export

(
    FLocTextHelper & InLocTextHelper,
    const FString & InCulture,
    const FString & InPOFilePath,
    const ELocalizedTextCollapseMode In...,
    const bool bShouldPersistComments
)

Use the given LocTextHelper to generate a new PO file using the translation data for the given culture

Public function

bool

 

PortableObjectPipeline::ExportAll

(
    FLocTextHelper & InLocTextHelper,
    const FString & InPOCultureRootPath,
    const FString & InPOFilename,
    const ELocalizedTextCollapseMode In...,
    const bool bShouldPersistComments,
    const bool bUseCultureDirectory
)

Use the given LocTextHelper to generate a new PO file using the translation data for all cultures

Public function

FString

 

PortableObjectPipeline::GetConditionedInfoMetaDataForExtractedComment

(
    const FString & KeyName,
    const FString & ValueString
)

Given a meta-data value string, condition it so it can be written as the extracted comment field of a PO file

Public function

FString

 

PortableObjectPipeline::GetConditionedKeyForExtractedComment

(
    const FString & Key
)

Given a key string, condition it so it can be written as the extracted comment field of a PO file

Public function

FString

 

PortableObjectPipeline::GetConditionedReferenceForExtractedComment

(
    const FString & PORefString
)

Given a source location string, condition it so it can be written as the extracted comment field of a PO file

Public function

bool

 

PortableObjectPipeline::Import

(
    FLocTextHelper & InLocTextHelper,
    const FString & InCulture,
    const FString & InPOFilePath,
    const ELocalizedTextCollapseMode In...
)

Update the given LocTextHelper with the translation data imported from the PO file for the given culture

Public function

bool

 

PortableObjectPipeline::ImportAll

(
    FLocTextHelper & InLocTextHelper,
    const FString & InPOCultureRootPath,
    const FString & InPOFilename,
    const ELocalizedTextCollapseMode In...,
    const bool bUseCultureDirectory
)

Update the given LocTextHelper with the translation data imported from the PO file for all cultures

Public function

void

 

PortableObjectPipeline::ParsePOMsgCtxtForIdentity

(
    const FString & MsgCtxt,
    FString & OutNamespace,
    FString & OutKey
)

Given the "msgctxt" field of a PO file, split it into the namespace and key