FInternationalization

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Internationalization/Internationalization.h

Include

#include "Internationalization/Internationalization.h"

Syntax

class FInternationalization

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

Name Description

Public function

void

 

AddCustomCulture

(
    const TSharedRef< ICustomCulture > ...
)

Add a new custom culture

Public function Const

void

 

BackupCultureState

(
    FCultureStateSnapshot& OutSnapshot
)

Backup the current culture state to the given snapshot struct.

Public function

void

 

ClearCurrentAssetGroupCulture

(
    const FName& InAssetGroupName
)

Clear the given asset group category culture.

Public function Static

FText

 

ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText

(
    const TCHAR* InTextLiteral,
    const TCHAR* InNamespace,
    const TCHAR* InKey
)

Public function Static

FInternation...

 

Get()

Public function

TArray< FCul...

 

GetAvailableCultures

(
    const TArray< FString >& InCulture...,
    const bool bIncludeDerivedCultures
)

Given some culture names, populate a list of cultures that are available to be used.

Public function

FCulturePtr

 

GetCulture

(
    const FString& InCultureName
)

Get the culture corresponding to the given name.

Public function Const

void

 

GetCultureNames

(
    TArray< FString >& CultureNames
)

Public function Const

FCultureRef

 

GetCurrentAssetGroupCulture

(
    const FName& InAssetGroupName
)

Get the given asset group category culture.

Public function Const

FCultureRef

 

GetCurrentCulture()

Get the current culture.

Public function Const

FCultureRef

 

GetCurrentLanguage()

Get the current language (for localization).

Public function Const

FCultureRef

 

GetCurrentLocale()

Get the current locale (for internationalization).

Public function Const

FCulturePtr

 

GetCustomCulture

(
    const FString& InCultureName
)

Get a new custom culture from its name

Public function Const

FCultureRef

 

GetDefaultCulture()

Get the default culture specified by the OS.

Public function Const

FCultureRef

 

GetDefaultLanguage()

Get the default language specified by the OS.

Public function Const

FCultureRef

 

GetDefaultLocale()

Get the default locale specified by the OS.

Public function Const

FCultureRef

 

GetInvariantCulture()

Get the invariant culture that can be used when you don't care about localization/internationalization.

Public function

TArray< FStr...

 

GetPrioritizedCultureNames

(
    const FString& Name
)

Public function Static

bool

 

IsAvailable()

Checks to see that an internationalization instance exists, and has been initialized.

Public function

bool

 

IsCultureAllowed

(
    const FString& Name
)

Is the given culture enabled or disabled in this build?

Public function

bool

 

IsCultureRemapped

(
    const FString& Name,
    FString* OutMappedCulture
)

Has the given culture been remapped in this build?

Public function Const

bool

 

IsInitialized()

Public function

void

 

LoadAllCultureData()

Load and cache the data needed for every culture we know about (this is usually done per-culture as required)

Public function

FInternation...

 

OnCultureChanged()

Public function

void

 

RefreshCultureDisplayNames

(
    const TArray< FString >& InPriorit...
)

Refresh the display names of the cached cultures

Public function

void

 

RestoreCultureState

(
    const FCultureStateSnapshot& InSna...
)

Restore a previous culture state from the given snapshot struct.

Public function

bool

 

SetCurrentAssetGroupCulture

(
    const FName& InAssetGroupName,
    const FString& InCultureName
)

Set the given asset group category culture by name.

Public function

bool

 

SetCurrentCulture

(
    const FString& InCultureName
)

Set the current culture by name.

Public function

bool

 

SetCurrentLanguage

(
    const FString& InCultureName
)

Set only the current language (for localization) by name.

Public function

bool

 

SetCurrentLanguageAndLocale

(
    const FString& InCultureName
)

Set the current language (for localization) and locale (for internationalization) by name.

Public function

bool

 

SetCurrentLocale

(
    const FString& InCultureName
)

Set only the current locale (for internationalization) by name.

Public function Static

void

 

TearDown()

Classes

Name

Description

Public class

FCultureChangedEvent

Broadcasts whenever the current culture changes

Public struct

FCultureStateSnapshot

Struct that can be used to capture a snapshot of the active culture state in a way that can be re-applied losslessly.

Typedefs

Name

Description

FImplementation

Deprecated Functions

Name Description

Public function

void

 

GetCulturesWithAvailableLocalization

(
    const TArray< FString >& InLocaliz...,
    TArray< FCultureRef >& OutAvailabl...,
    const bool bIncludeDerivedCultures
)

FInternationalization::GetCulturesWithAvailableLocalization is deprecated in favor of calling FTextLocalizationManager::GetLocalizedCultureNames, potentially followed by FInternationalization::GetAvailableCultures

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss