ILocalizedTextSource.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/ContainersFwd.h"
#include "Containers/ArrayView.h"
#include "Internationalization/TextKey.h"
#include "Internationalization/LocalizedTextSourceTypes.h"
#include "CoreGlobals.h"
 
class FTextLocalizationResource;
 
class ILocalizedTextSource
{
public:
    virtual ~ILocalizedTextSource() = default;
 
    virtual int32 GetPriority() const
    {
        return ELocalizedTextSourcePriority::Normal;
    }
 
    virtual bool GetNativeCultureName(const ELocalizedTextSourceCategory InCategory, FString& OutNativeCultureName) = 0;
 
    virtual void GetLocalizedCultureNames(const ELocalizationLoadFlags InLoadFlags, TSet<FString>& OutLocalizedCultureNames) = 0;
 
    virtual void LoadLocalizedResources(const ELocalizationLoadFlags InLoadFlags, TArrayView<const FString> InPrioritizedCultures, FTextLocalizationResource& InOutNativeResource, FTextLocalizationResource& InOutLocalizedResource) = 0;
 
    virtual EQueryLocalizedResourceResult QueryLocalizedResource(const ELocalizationLoadFlags InLoadFlags, TArrayView<const FString> InPrioritizedCultures, const FTextId InTextId, FTextLocalizationResource& InOutNativeResource, FTextLocalizationResource& InOutLocalizedResource)
    {
        return EQueryLocalizedResourceResult::NotImplemented;
    }
 
    static UE_FORCEINLINE_HINT bool ShouldLoadNative(const ELocalizationLoadFlags InLoadFlags)
    {
        return EnumHasAnyFlags(InLoadFlags, ELocalizationLoadFlags::Native);
    }
 
    static UE_FORCEINLINE_HINT bool ShouldLoadEditor(const ELocalizationLoadFlags InLoadFlags)
    {
        return EnumHasAnyFlags(InLoadFlags, ELocalizationLoadFlags::Editor);
    }
 
    static UE_FORCEINLINE_HINT bool ShouldLoadGame(const ELocalizationLoadFlags InLoadFlags)
    {
        return EnumHasAnyFlags(InLoadFlags, ELocalizationLoadFlags::Game | ELocalizationLoadFlags::ForceLocalizedGame);
    }
 
    static UE_FORCEINLINE_HINT bool ShouldLoadEngine(const ELocalizationLoadFlags InLoadFlags)
    {
        return EnumHasAnyFlags(InLoadFlags, ELocalizationLoadFlags::Engine);
    }
 
    static UE_FORCEINLINE_HINT bool ShouldLoadAdditional(const ELocalizationLoadFlags InLoadFlags)
    {
        return EnumHasAnyFlags(InLoadFlags, ELocalizationLoadFlags::Additional);
    }
 
    static UE_FORCEINLINE_HINT bool ShouldLoadNativeGameData(const ELocalizationLoadFlags InLoadFlags)
    {
        // The editor loads native game data by default to prevent authoring issues
        // It will load localized data only if the request is forced (eg, when entering game localization preview mode)
        return GIsEditor && !EnumHasAnyFlags(InLoadFlags, ELocalizationLoadFlags::ForceLocalizedGame);
    }
};