LocalizationDescriptor.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "Serialization/JsonWriter.h"
 
class FJsonObject;
class FText;
 
namespace ELocalizationTargetDescriptorLoadingPolicy
{
    enum Type
    {
        Never,
        Always,
        Editor,
        Game,
        PropertyNames,
        ToolTips,
        Max,
    };
 
    PROJECTS_API ELocalizationTargetDescriptorLoadingPolicy::Type FromString(const TCHAR *Text);
 
    PROJECTS_API const TCHAR* ToString(const ELocalizationTargetDescriptorLoadingPolicy::Type Value);
};
 
namespace ELocalizationConfigGenerationPolicy
{
    enum Type
    {
        Never,
        User,
        Auto,
        Max,
    };
 
    PROJECTS_API ELocalizationConfigGenerationPolicy::Type FromString(const TCHAR* Text);
 
    PROJECTS_API const TCHAR* ToString(const ELocalizationConfigGenerationPolicy::Type Value);
};
 
 
struct FLocalizationTargetDescriptor
{
    FString Name;
 
    ELocalizationTargetDescriptorLoadingPolicy::Type LoadingPolicy;
 
    ELocalizationConfigGenerationPolicy::Type ConfigGenerationPolicy;
 
    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);
 
    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);
 
    PROJECTS_API void Write(TJsonWriter<>& Writer) const;
 
    PROJECTS_API void UpdateJson(FJsonObject& JsonObject) const;
 
    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);
 
    PROJECTS_API bool ShouldLoadLocalizationTarget() const;
};