Navigation
Unreal Engine C++ API Reference > Runtime > Core > Internationalization
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
Type | Name | Description | |
---|---|---|---|
![]() |
void | AddCustomCulture
(
const TSharedRef< ICustomCulture >& InCustomCulture |
Add a new custom culture |
![]() ![]() |
void | BackupCultureState
(
FCultureStateSnapshot& OutSnapshot |
Backup the current culture state to the given snapshot struct. |
![]() |
void | ClearCurrentAssetGroupCulture
(
const FName& InAssetGroupName |
Clear the given asset group category culture. |
![]() ![]() |
FText | ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText
(
const TCHAR* InTextLiteral, |
|
![]() ![]() |
FInternationalization & | Get () |
|
![]() |
TArray< FCultureRef > | GetAvailableCultures
(
const TArray< FString >& InCultureNames, |
Given some culture names, populate a list of cultures that are available to be used. |
![]() |
FCulturePtr | GetCulture
(
const FString& InCultureName |
Get the culture corresponding to the given name. |
![]() ![]() |
void | GetCultureNames
(
TArray< FString >& CultureNames |
|
![]() ![]() |
FCultureRef | GetCurrentAssetGroupCulture
(
const FName& InAssetGroupName |
Get the given asset group category culture. |
![]() ![]() |
FCultureRef | Get the current culture. | |
![]() ![]() |
TArray< FCultureRef > | GetCurrentCultures
(
const bool bIncludeLanguage, |
Get the current cultures in use, optionally including the current language, locale, and any asset groups. |
![]() ![]() |
FCultureRef | Get the current language (for localization). | |
![]() ![]() |
FCultureRef | Get the current locale (for internationalization). | |
![]() ![]() |
FCulturePtr | GetCustomCulture
(
const FString& InCultureName |
Get a new custom culture from its name |
![]() ![]() |
FCultureRef | Get the default culture specified by the OS. | |
![]() ![]() |
FCultureRef | Get the default language specified by the OS. | |
![]() ![]() |
FCultureRef | Get the default locale specified by the OS. | |
![]() ![]() |
FCultureRef | Get the invariant culture that can be used when you don't care about localization/internationalization. | |
![]() |
TArray< FString > | GetPrioritizedCultureNames
(
const FString& Name |
|
![]() ![]() |
bool | IsAvailable () |
Checks to see that an internationalization instance exists, and has been initialized. |
![]() |
bool | IsCultureAllowed
(
const FString& Name |
Is the given culture enabled or disabled in this build? |
![]() |
bool | IsCultureRemapped
(
const FString& Name, |
Has the given culture been remapped in this build? |
![]() ![]() |
bool | ||
![]() |
void | Load and cache the data needed for every culture we know about (this is usually done per-culture as required) | |
![]() |
FInternationalization::FCultureChangedEvent TBaseMulticastDelegate_NoParams | ||
![]() |
void | Refresh any config data that has been cached | |
![]() |
void | RefreshCultureDisplayNames
(
const TArray< FString >& InPrioritizedDisplayCultureNames |
Refresh the display names of the cached cultures |
![]() |
void | RestoreCultureState
(
const FCultureStateSnapshot& InSnapshot |
Restore a previous culture state from the given snapshot struct. |
![]() |
bool | SetCurrentAssetGroupCulture
(
const FName& InAssetGroupName, |
Set the given asset group category culture by name. |
![]() |
bool | SetCurrentCulture
(
const FString& InCultureName |
Set the current culture by name. |
![]() |
bool | SetCurrentLanguage
(
const FString& InCultureName |
Set only the current language (for localization) by name. |
![]() |
bool | SetCurrentLanguageAndLocale
(
const FString& InCultureName |
Set the current language (for localization) and locale (for internationalization) by name. |
![]() |
bool | SetCurrentLocale
(
const FString& InCultureName |
Set only the current locale (for internationalization) by name. |
![]() ![]() |
void | TearDown () |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
FCultureChangedEvent | Broadcasts whenever the current culture changes | |
![]() |
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
Type | Name | Description | |
---|---|---|---|
![]() |
void | GetCulturesWithAvailableLocalization
(
const TArray< FString >& InLocalizationPaths, |
FInternationalization::GetCulturesWithAvailableLocalization is deprecated in favor of calling FTextLocalizationManager::GetLocalizedCultureNames, potentially followed by FInternationalization::GetAvailableCultures |