FLocalizationTargetDescriptor Struct Reference

#include <LocalizationDescriptor.h>

Public Member Functions
PROJECTS_API	FLocalizationTargetDescriptor (FString InName=FString(), ELocalizationTargetDescriptorLoadingPolicy::Type InLoadingPolicy=ELocalizationTargetDescriptorLoadingPolicy::Never, ELocalizationConfigGenerationPolicy::Type InGenerationPolicy=ELocalizationConfigGenerationPolicy::Never)
PROJECTS_API bool	Read (const FJsonObject &InObject, FText *OutFailReason=nullptr)
PROJECTS_API bool	Read (const FJsonObject &InObject, FText &OutFailReason)
PROJECTS_API void	Write (TJsonWriter<> &Writer) const
PROJECTS_API void	UpdateJson (FJsonObject &JsonObject) const
PROJECTS_API bool	ShouldLoadLocalizationTarget () const

Static Public Member Functions
static PROJECTS_API bool	ReadArray (const FJsonObject &InObject, const TCHAR *InName, TArray< FLocalizationTargetDescriptor > &OutTargets, FText *OutFailReason=nullptr)
static PROJECTS_API bool	ReadArray (const FJsonObject &InObject, const TCHAR *InName, TArray< FLocalizationTargetDescriptor > &OutTargets, FText &OutFailReason)
static PROJECTS_API void	WriteArray (TJsonWriter<> &Writer, const TCHAR *ArrayName, const TArray< FLocalizationTargetDescriptor > &Descriptors)
static PROJECTS_API void	UpdateArray (FJsonObject &JsonObject, const TCHAR *ArrayName, const TArray< FLocalizationTargetDescriptor > &Descriptors)

Public Attributes
FString	Name
ELocalizationTargetDescriptorLoadingPolicy::Type	LoadingPolicy
ELocalizationConfigGenerationPolicy::Type	ConfigGenerationPolicy

Detailed Description

Description of a localization target.

Constructor & Destructor Documentation

FLocalizationTargetDescriptor()

FLocalizationTargetDescriptor::FLocalizationTargetDescriptor	(	FString	InName = FString(),
		ELocalizationTargetDescriptorLoadingPolicy::Type	InLoadingPolicy = ELocalizationTargetDescriptorLoadingPolicy::Never,
		ELocalizationConfigGenerationPolicy::Type	InGenerationPolicy = ELocalizationConfigGenerationPolicy::Never
	)

Normal constructor

Member Function Documentation

Read() [1/2]

bool FLocalizationTargetDescriptor::Read	(	const FJsonObject &	InObject,
		FText &	OutFailReason
	)

Reads a descriptor from the given JSON object

Read() [2/2]

bool FLocalizationTargetDescriptor::Read	(	const FJsonObject &	InObject,
		FText *	OutFailReason = nullptr
	)

Reads a descriptor from the given JSON object

ReadArray() [1/2]

bool FLocalizationTargetDescriptor::ReadArray ( const FJsonObject &  InObject, const TCHAR *  InName, TArray< FLocalizationTargetDescriptor > &  OutTargets, FText &  OutFailReason  )

static

Reads an array of targets from the given JSON object

ReadArray() [2/2]

bool FLocalizationTargetDescriptor::ReadArray ( const FJsonObject &  InObject, const TCHAR *  InName, TArray< FLocalizationTargetDescriptor > &  OutTargets, FText *  OutFailReason = nullptr  )

static

Reads an array of targets from the given JSON object

ShouldLoadLocalizationTarget()

bool FLocalizationTargetDescriptor::ShouldLoadLocalizationTarget

(

)

const

Returns true if we should load this localization target based upon the current runtime environment

UpdateArray()

void FLocalizationTargetDescriptor::UpdateArray ( FJsonObject &  JsonObject, const TCHAR *  ArrayName, const TArray< FLocalizationTargetDescriptor > &  Descriptors  )

static

Updates an array of descriptors in the specified JSON field (indexed by name)

UpdateJson()

void FLocalizationTargetDescriptor::UpdateJson

(

FJsonObject &

JsonObject

)

const

Updates the given json object with values in this descriptor

Write()

void FLocalizationTargetDescriptor::Write

(

TJsonWriter<> &

Writer

)

const

Writes a descriptor to JSON

WriteArray()

void FLocalizationTargetDescriptor::WriteArray ( TJsonWriter<> &  Writer, const TCHAR *  ArrayName, const TArray< FLocalizationTargetDescriptor > &  Descriptors  )

static

Writes an array of targets to JSON

Member Data Documentation

ConfigGenerationPolicy

ELocalizationConfigGenerationPolicy::Type FLocalizationTargetDescriptor::ConfigGenerationPolicy

How the localizationc config files associated with the localization target are generated

LoadingPolicy

ELocalizationTargetDescriptorLoadingPolicy::Type FLocalizationTargetDescriptor::LoadingPolicy

When should the localization data associated with a target should be loaded?

Name

FString FLocalizationTargetDescriptor::Name

Name of this target

---

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

• Engine/Source/Runtime/Projects/Public/LocalizationDescriptor.h
• Engine/Source/Runtime/Projects/Private/LocalizationDescriptor.cpp