FTextLocalizationResource

Utility class for working with Localization Resource (LocRes) files.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Internationalization/TextLocalizationResource.h

Include

#include "Internationalization/TextLocalizationResource.h"

Syntax

class FTextLocalizationResource

Remarks

Utility class for working with Localization Resource (LocRes) files.

Variables

Name Description

Public variable

FEntriesTable

 

Entries

Constructors

Functions

Name Description

Public function

void

 

AddEntry

(
    const FTextKey& InNamespace,
    const FTextKey& InKey,
    const FString& InSourceString,
    const FString& InLocalizedString,
    const int32 InPriority,
    const FTextKey& InLocResID
)

Add a single entry to this resource.

Public function

void

 

AddEntry

(
    const FTextKey& InNamespace,
    const FTextKey& InKey,
    const uint32 InSourceStringHash,
    const FString& InLocalizedString,
    const int32 InPriority,
    const FTextKey& InLocResID
)

Optimized representation of a case-sensitive string, as used by localization keys.

Public function Static

uint32

 

HashString

(
    const TCHAR* InStr,
    const uint32 InBaseHash
)

Utility to produce a hash for a string (as used by SourceStringHash)

Public function Static

uint32

 

HashString

(
    const FString& InStr,
    const uint32 InBaseHash
)

Utility to produce a hash for a string (as used by SourceStringHash)

Public function Const

bool

 

IsEmpty()

Is this resource empty?

Public function

bool

 

LoadFromArchive

(
    FArchive& Archive,
    const FTextKey& LocResID,
    const int32 Priority
)

Load the given LocRes archive into this resource.

Public function

void

 

LoadFromDirectory

(
    const FString& DirectoryPath,
    const int32 Priority
)

Load all LocRes files in the specified directory into this resource.

Public function

bool

 

LoadFromFile

(
    const FString& FilePath,
    const int32 Priority
)

Load the given LocRes file into this resource.

Public function Const

bool

 

SaveToArchive

(
    FArchive& Archive,
    const FTextKey& LocResID
)

Save this resource to the given LocRes archive.

Public function Const

bool

 

SaveToFile

(
    const FString& FilePath
)

Save this resource to the given LocRes file.

Operators

Name Description

Public function

FTextLocaliz...

 

operator=

(
    const FTextLocalizationResource&
)

Public function

FTextLocaliz...

 

operator=

(
    FTextLocalizationResource&&
)

Classes

Name

Description

Public struct

FEntry

Data struct for tracking a localization entry from a localization resource.

Typedefs

Name

Description

FEntriesTable
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss