KismetInternationalizationLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/TextProperty.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "KismetInternationalizationLibrary.generated.h"
 
enum class ELocalizationLoadFlags : uint8;
enum class ELocalizedTextSourceCategory : uint8;
 
UCLASS(meta=(BlueprintThreadSafe, ScriptName="InternationalizationLibrary"), MinimalAPI)
class UKismetInternationalizationLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
    UFUNCTION(BlueprintCallable, Category="Utilities|Internationalization", meta=(AdvancedDisplay="1"))
    static ENGINE_API bool SetCurrentCulture(const FString& Culture, const bool SaveToConfig = false);
 
    UFUNCTION(BlueprintPure, Category="Utilities|Internationalization")
    static ENGINE_API FString GetCurrentCulture();
 
    UFUNCTION(BlueprintCallable, Category="Utilities|Internationalization", meta=(AdvancedDisplay="1"))
    static ENGINE_API bool SetCurrentLanguage(const FString& Culture, const bool SaveToConfig = false);
 
    UFUNCTION(BlueprintPure, Category="Utilities|Internationalization")
    static ENGINE_API FString GetCurrentLanguage();
 
    UFUNCTION(BlueprintCallable, Category="Utilities|Internationalization", meta=(AdvancedDisplay="1"))
    static ENGINE_API bool SetCurrentLocale(const FString& Culture, const bool SaveToConfig = false);
 
    UFUNCTION(BlueprintPure, Category="Utilities|Internationalization")
    static ENGINE_API FString GetCurrentLocale();
 
    UFUNCTION(BlueprintCallable, Category="Utilities|Internationalization", meta=(AdvancedDisplay="1"))
    static ENGINE_API bool SetCurrentLanguageAndLocale(const FString& Culture, const bool SaveToConfig = false);
 
    UFUNCTION(BlueprintCallable, Category="Utilities|Internationalization", meta=(AdvancedDisplay="2"))
    static ENGINE_API bool SetCurrentAssetGroupCulture(const FName AssetGroup, const FString& Culture, const bool SaveToConfig = false);
 
    UFUNCTION(BlueprintPure, Category="Utilities|Internationalization")
    static ENGINE_API FString GetCurrentAssetGroupCulture(const FName AssetGroup);
 
    UFUNCTION(BlueprintCallable, Category="Utilities|Internationalization", meta=(AdvancedDisplay="1"))
    static ENGINE_API void ClearCurrentAssetGroupCulture(const FName AssetGroup, const bool SaveToConfig = false);
 
    UFUNCTION(BlueprintPure, Category="Utilities|Internationalization")
    static ENGINE_API FString GetNativeCulture(const ELocalizedTextSourceCategory TextCategory);
 
    UFUNCTION(BlueprintPure, Category="Utilities|Internationalization")
    static ENGINE_API TArray<FString> GetLocalizedCultures(const bool IncludeGame = true, const bool IncludeEngine = false, const bool IncludeEditor = false, const bool IncludeAdditional = false);
 
    static ENGINE_API TArray<FString> GetLocalizedCultures(const ELocalizationLoadFlags LoadFlags);
 
    UFUNCTION(BlueprintPure, Category="Utilities|Internationalization")
    static ENGINE_API FString GetSuitableCulture(const TArray<FString>& AvailableCultures, const FString& CultureToMatch, const FString& FallbackCulture = TEXT("en"));
 
    UFUNCTION(BlueprintPure, Category="Utilities|Internationalization", meta=(AdvancedDisplay="1"))
    static ENGINE_API FString GetCultureDisplayName(const FString& Culture, const bool Localized = true);
 
    UFUNCTION(BlueprintPure, Category="Utilities|Internationalization")
    static ENGINE_API bool IsCultureRightToLeft(const FString& Culture);
};