FTextLocalizationResource Class Reference

#include <TextLocalizationResource.h>

Classes
struct	FEntry

Public Types
typedef TMap< FTextId, FEntry >	FEntriesTable

Public Member Functions
	FTextLocalizationResource ()=default
	FTextLocalizationResource (const FTextLocalizationResource &)=default
FTextLocalizationResource &	operator= (const FTextLocalizationResource &)=default
	FTextLocalizationResource (FTextLocalizationResource &&)=default
FTextLocalizationResource &	operator= (FTextLocalizationResource &&)=default
CORE_API void	AddEntry (const FTextKey &InNamespace, const FTextKey &InKey, const FString &InSourceString, const FString &InLocalizedString, const int32 InPriority, const FTextKey &InLocResID=FTextKey())
CORE_API void	AddEntry (const FTextKey &InNamespace, const FTextKey &InKey, const FString &InSourceString, const FTextConstDisplayStringRef &InLocalizedString, const int32 InPriority, const FTextKey &InLocResID=FTextKey())
CORE_API void	AddEntry (const FTextKey &InNamespace, const FTextKey &InKey, const uint32 InSourceStringHash, const FString &InLocalizedString, const int32 InPriority, const FTextKey &InLocResID=FTextKey())
CORE_API void	AddEntry (const FTextKey &InNamespace, const FTextKey &InKey, const uint32 InSourceStringHash, const FTextConstDisplayStringRef &InLocalizedString, const int32 InPriority, const FTextKey &InLocResID=FTextKey())
CORE_API bool	IsEmpty () const
CORE_API void	LoadFromDirectory (const FString &DirectoryPath, const int32 Priority)
CORE_API bool	LoadFromFile (const FString &FilePath, const int32 Priority)
CORE_API bool	LoadFromArchive (FArchive &Archive, const FTextKey &LocResID, const int32 Priority)
CORE_API bool	SaveToFile (const FString &FilePath) const
CORE_API bool	SaveToArchive (FArchive &Archive, const FTextKey &LocResID) const

Static Public Member Functions
static UE_FORCEINLINE_HINT uint32	HashString (const TCHAR *InStr, const uint32 InBaseHash=0)
static UE_FORCEINLINE_HINT uint32	HashString (const FString &InStr, const uint32 InBaseHash=0)

Public Attributes
FEntriesTable	Entries

Detailed Description

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

Member Typedef Documentation

FEntriesTable

typedef TMap<FTextId, FEntry> FTextLocalizationResource::FEntriesTable

Constructor & Destructor Documentation

FTextLocalizationResource() [1/3]

FTextLocalizationResource::FTextLocalizationResource ( )

default

FTextLocalizationResource() [2/3]

FTextLocalizationResource::FTextLocalizationResource ( const FTextLocalizationResource &  )

default

FTextLocalizationResource() [3/3]

FTextLocalizationResource::FTextLocalizationResource ( FTextLocalizationResource &&  )

default

Member Function Documentation

AddEntry() [1/4]

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

Add a single entry to this resource.

AddEntry() [2/4]

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

AddEntry() [3/4]

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

AddEntry() [4/4]

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

HashString() [1/2]

static UE_FORCEINLINE_HINT uint32 FTextLocalizationResource::HashString ( const FString &  InStr, const uint32  InBaseHash = 0  )

inlinestatic

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

HashString() [2/2]

static UE_FORCEINLINE_HINT uint32 FTextLocalizationResource::HashString ( const TCHAR *  InStr, const uint32  InBaseHash = 0  )

inlinestatic

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

IsEmpty()

bool FTextLocalizationResource::IsEmpty

(

)

const

Is this resource empty?

LoadFromArchive()

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

Load the given LocRes archive into this resource.

LoadFromDirectory()

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

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

LoadFromFile()

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

Load the given LocRes file into this resource.

operator=() [1/2]

FTextLocalizationResource & FTextLocalizationResource::operator= ( const FTextLocalizationResource &  )

default

operator=() [2/2]

FTextLocalizationResource & FTextLocalizationResource::operator= ( FTextLocalizationResource &&  )

default

SaveToArchive()

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

Save this resource to the given LocRes archive.

SaveToFile()

bool FTextLocalizationResource::SaveToFile

(

const FString &

FilePath

)

const

Save this resource to the given LocRes file.

Member Data Documentation

Entries

FEntriesTable FTextLocalizationResource::Entries

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Core/Public/Internationalization/TextLocalizationResource.h
• Engine/Source/Runtime/Core/Private/Internationalization/TextLocalizationResource.cpp