1. Epic GamesDeveloper
  3. FTextLocalizationResource

FTextLocalizationResource

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

API > API/Runtime > API/Runtime/Core

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

   
Name FTextLocalizationResource
Type class
Header File /Engine/Source/Runtime/Core/Public/Internationalization/TextLocalizationResource.h
Include Path #include "Internationalization/TextLocalizationResource.h"

Syntax

class FTextLocalizationResource

Constructors

Name Remarks Include Path Unreal Specifiers
  Internationalization/TextLocalizationResource.h  
  Internationalization/TextLocalizationResource.h  
  Internationalization/TextLocalizationResource.h  

Structs

Name Remarks
FEntry Data struct for tracking a localization entry from a localization resource.

Typedefs

Name Type Remarks Include Path
FEntriesTable TMap< FTextId, FEntry >   Internationalization/TextLocalizationResource.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Entries FEntriesTable   Internationalization/TextLocalizationResource.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   Internationalization/TextLocalizationResource.h  

void AddEntry ( const FTextKey& InNamespace,
const FTextKey& InKey,
const uint32 InSourceStringHash,
const FTextConstDisplayStringRef& InLocalizedString,
const int32 InPriority,
const FTextKey& InLocResID
)

   Internationalization/TextLocalizationResource.h  

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. Internationalization/TextLocalizationResource.h  

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

   Internationalization/TextLocalizationResource.h  

bool IsEmpty()

 Is this resource empty? Internationalization/TextLocalizationResource.h  

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

 Load the given LocRes archive into this resource. Internationalization/TextLocalizationResource.h  

void LoadFromDirectory ( const FString& DirectoryPath,
const int32 Priority
)

 Load all LocRes files in the specified directory into this resource. Internationalization/TextLocalizationResource.h  

bool LoadFromFile ( const FString& FilePath,
const int32 Priority
)

 Load the given LocRes file into this resource. Internationalization/TextLocalizationResource.h  

bool SaveToArchive ( FArchive& Archive,
const FTextKey& LocResID
) const

 Save this resource to the given LocRes archive. Internationalization/TextLocalizationResource.h  

bool SaveToFile ( const FString& FilePath
) const

 Save this resource to the given LocRes file. Internationalization/TextLocalizationResource.h  

Static

Name Remarks Include Path Unreal Specifiers

static uint32 HashString ( const FString& InStr,
const uint32 InBaseHash
)

 Utility to produce a hash for a string (as used by SourceStringHash) Internationalization/TextLocalizationResource.h  

static uint32 HashString ( const TCHAR* InStr,
const uint32 InBaseHash
)

 Utility to produce a hash for a string (as used by SourceStringHash) Internationalization/TextLocalizationResource.h  

static bool ShouldReplaceEntry ( const FTextKey& Namespace,
const FTextKey& Key,
const FEntry& CurrentEntry,
const FEntry& NewEntry
)

 Test whether the new entry should replace the current entry, optionally logging a conflict Internationalization/TextLocalizationResource.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Internationalization/TextLocalizationResource.h  
  Internationalization/TextLocalizationResource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page