UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCulture Class Reference

#include <Culture.h>

Public Member Functions

CORE_API ~FCulture ()
 
CORE_API const FString & GetDisplayName () const
 
CORE_API const FString & GetEnglishName () const
 
CORE_API int GetKeyboardLayoutId () const
 
CORE_API int GetLCID () const
 
CORE_API TArray< FString > GetPrioritizedParentCultureNames () const
 
CORE_API const FString & GetPreferredOnDiskIdentifier () const
 
CORE_API const FString & GetName () const
 
CORE_API const FString & GetVerseIdentifier () const
 
CORE_API const FString & GetNativeName () const
 
CORE_API const FString & GetUnrealLegacyThreeLetterISOLanguageName () const
 
CORE_API const FString & GetThreeLetterISOLanguageName () const
 
CORE_API const FString & GetTwoLetterISOLanguageName () const
 
CORE_API const FString & GetNativeLanguage () const
 
CORE_API const FString & GetRegion () const
 
CORE_API const FString & GetNativeRegion () const
 
CORE_API const FString & GetScript () const
 
CORE_API const FString & GetVariant () const
 
CORE_API bool IsRightToLeft () const
 
CORE_API const FDecimalNumberFormattingRulesGetDecimalNumberFormattingRules () const
 
CORE_API const FDecimalNumberFormattingRulesGetPercentFormattingRules () const
 
CORE_API const FDecimalNumberFormattingRulesGetCurrencyFormattingRules (const FString &InCurrencyCode) const
 
CORE_API ETextPluralForm GetPluralForm (float Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (double Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (int8 Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (int16 Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (int32 Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (int64 Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (uint8 Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (uint16 Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (uint32 Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (uint64 Val, const ETextPluralType PluralType) const
 
CORE_API ETextPluralForm GetPluralForm (long Val, const ETextPluralType PluralType) const
 
CORE_API const TArray< ETextPluralForm > & GetValidPluralForms (const ETextPluralType PluralType) const
 
CORE_API void RefreshCultureDisplayNames (const TArray< FString > &InPrioritizedDisplayCultureNames, const bool bFullRefresh=true)
 

Static Public Member Functions

static CORE_API FCultureRef Create (TUniquePtr< FCultureImplementation > &&InImplementation)
 
static CORE_API TArray< FString > GetPrioritizedParentCultureNames (const FString &LanguageCode, const FString &ScriptCode, const FString &RegionCode)
 
static CORE_API FString CreateCultureName (const FString &LanguageCode, const FString &ScriptCode, const FString &RegionCode)
 
static CORE_API FString GetCanonicalName (const FString &Name)
 
static CORE_API FString CultureNameToVerseIdentifier (const FString &Name)
 
static CORE_API FString CultureNameFromVerseIdentifier (const FString &VerseIdentifer)
 
static CORE_API ECultureIdentifierType GetPreferredOnDiskIdentifierType ()
 

Constructor & Destructor Documentation

◆ ~FCulture()

FCulture::~FCulture ( )

Member Function Documentation

◆ Create()

FCultureRef FCulture::Create ( TUniquePtr< FCultureImplementation > &&  InImplementation)
static

◆ CreateCultureName()

FString FCulture::CreateCultureName ( const FString &  LanguageCode,
const FString &  ScriptCode,
const FString &  RegionCode 
)
static

◆ CultureNameFromVerseIdentifier()

FString FCulture::CultureNameFromVerseIdentifier ( const FString &  VerseIdentifer)
static

Given a well-formed Verse culture identifier (eg, "en_US"), convert it to its equivalent UE culture name (eg, "en-US").

Note
GetCanonicalName will also perform this conversion, with additional validation.

◆ CultureNameToVerseIdentifier()

FString FCulture::CultureNameToVerseIdentifier ( const FString &  Name)
static

Given a well-formed UE culture name (eg, "en-US"), convert it to its equivalent Verse identifier (eg, "en_US").

◆ GetCanonicalName()

FString FCulture::GetCanonicalName ( const FString &  Name)
static

◆ GetCurrencyFormattingRules()

const FDecimalNumberFormattingRules & FCulture::GetCurrencyFormattingRules ( const FString &  InCurrencyCode) const

◆ GetDecimalNumberFormattingRules()

const FDecimalNumberFormattingRules & FCulture::GetDecimalNumberFormattingRules ( ) const

◆ GetDisplayName()

const FString & FCulture::GetDisplayName ( ) const

◆ GetEnglishName()

const FString & FCulture::GetEnglishName ( ) const

◆ GetKeyboardLayoutId()

int FCulture::GetKeyboardLayoutId ( ) const

◆ GetLCID()

int FCulture::GetLCID ( ) const

◆ GetName()

const FString & FCulture::GetName ( ) const

Get the name of this culture, eg, "en-US"

◆ GetNativeLanguage()

const FString & FCulture::GetNativeLanguage ( ) const

◆ GetNativeName()

const FString & FCulture::GetNativeName ( ) const

◆ GetNativeRegion()

const FString & FCulture::GetNativeRegion ( ) const

◆ GetPercentFormattingRules()

const FDecimalNumberFormattingRules & FCulture::GetPercentFormattingRules ( ) const

◆ GetPluralForm() [1/11]

ETextPluralForm FCulture::GetPluralForm ( double  Val,
const ETextPluralType  PluralType 
) const

◆ GetPluralForm() [2/11]

CORE_API ETextPluralForm FCulture::GetPluralForm ( float  Val,
const ETextPluralType  PluralType 
) const

Get the correct plural form to use for the given number

Parameters
PluralTypeThe type of plural form to get (cardinal or ordinal)

◆ GetPluralForm() [3/11]

CORE_API ETextPluralForm FCulture::GetPluralForm ( int16  Val,
const ETextPluralType  PluralType 
) const

◆ GetPluralForm() [4/11]

ETextPluralForm FCulture::GetPluralForm ( int32  Val,
const ETextPluralType  PluralType 
) const

◆ GetPluralForm() [5/11]

CORE_API ETextPluralForm FCulture::GetPluralForm ( int64  Val,
const ETextPluralType  PluralType 
) const

◆ GetPluralForm() [6/11]

CORE_API ETextPluralForm FCulture::GetPluralForm ( int8  Val,
const ETextPluralType  PluralType 
) const

◆ GetPluralForm() [7/11]

CORE_API ETextPluralForm FCulture::GetPluralForm ( long  Val,
const ETextPluralType  PluralType 
) const

◆ GetPluralForm() [8/11]

CORE_API ETextPluralForm FCulture::GetPluralForm ( uint16  Val,
const ETextPluralType  PluralType 
) const

◆ GetPluralForm() [9/11]

CORE_API ETextPluralForm FCulture::GetPluralForm ( uint32  Val,
const ETextPluralType  PluralType 
) const

◆ GetPluralForm() [10/11]

CORE_API ETextPluralForm FCulture::GetPluralForm ( uint64  Val,
const ETextPluralType  PluralType 
) const

◆ GetPluralForm() [11/11]

CORE_API ETextPluralForm FCulture::GetPluralForm ( uint8  Val,
const ETextPluralType  PluralType 
) const

◆ GetPreferredOnDiskIdentifier()

const FString & FCulture::GetPreferredOnDiskIdentifier ( ) const

Get the preferred on-disk identifier of this culture (eg, "en-US" vs "en_US") to use when creating new localized content.

Note
You should still assume both kinds of identifier may be used within a project.

◆ GetPreferredOnDiskIdentifierType()

ECultureIdentifierType FCulture::GetPreferredOnDiskIdentifierType ( )
static

Get the preferred on-disk identifier type (eg, "en-US" vs "en_US") to use when creating new localized content.

Note
You should still assume both kinds of identifier may be used within a project.

◆ GetPrioritizedParentCultureNames() [1/2]

TArray< FString > FCulture::GetPrioritizedParentCultureNames ( ) const

◆ GetPrioritizedParentCultureNames() [2/2]

TArray< FString > FCulture::GetPrioritizedParentCultureNames ( const FString &  LanguageCode,
const FString &  ScriptCode,
const FString &  RegionCode 
)
static

◆ GetRegion()

const FString & FCulture::GetRegion ( ) const

◆ GetScript()

const FString & FCulture::GetScript ( ) const

◆ GetThreeLetterISOLanguageName()

const FString & FCulture::GetThreeLetterISOLanguageName ( ) const

◆ GetTwoLetterISOLanguageName()

const FString & FCulture::GetTwoLetterISOLanguageName ( ) const

◆ GetUnrealLegacyThreeLetterISOLanguageName()

const FString & FCulture::GetUnrealLegacyThreeLetterISOLanguageName ( ) const

◆ GetValidPluralForms()

const TArray< ETextPluralForm > & FCulture::GetValidPluralForms ( const ETextPluralType  PluralType) const

Get the plural forms supported by this culture

Parameters
PluralTypeThe type of plural form to get (cardinal or ordinal)

◆ GetVariant()

const FString & FCulture::GetVariant ( ) const

◆ GetVerseIdentifier()

const FString & FCulture::GetVerseIdentifier ( ) const

Get the name of this culture as a Verse identifier (for a Verse path), eg, "en_US"

◆ IsRightToLeft()

bool FCulture::IsRightToLeft ( ) const

◆ RefreshCultureDisplayNames()

void FCulture::RefreshCultureDisplayNames ( const TArray< FString > &  InPrioritizedDisplayCultureNames,
const bool  bFullRefresh = true 
)

The documentation for this class was generated from the following files: