Class KismetInternationalizationLibrary
Kismet Internationalization Library
Inherited Members
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class KismetInternationalizationLibrary : BlueprintFunctionLibrary
Properties
| Improve this Doc View SourceDefaultObject
Get UE4 Default Object for this Class
Declaration
public static KismetInternationalizationLibrary DefaultObject { get; }
Property Value
Type | Description |
---|---|
KismetInternationalizationLibrary |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }
Property Value
Type | Description |
---|---|
Class |
Methods
| Improve this Doc View SourceClearCurrentAssetGroupCulture(Name, Boolean)
Clear the given asset group category culture.
Declaration
public static void ClearCurrentAssetGroupCulture(Name AssetGroup, bool SaveToConfig)
Parameters
Type | Name | Description |
---|---|---|
Name | AssetGroup | |
System.Boolean | SaveToConfig |
Remarks
@param AssetGroup The asset group to clear the culture for. @param SaveToConfig If true, save the new setting to the users' "GameUserSettings" config so that it persists after a reload.
GetCurrentAssetGroupCulture(Name)
Get the given asset group category culture.
Declaration
public static string GetCurrentAssetGroupCulture(Name AssetGroup)
Parameters
Type | Name | Description |
---|---|---|
Name | AssetGroup |
Returns
Type | Description |
---|---|
System.String |
Remarks
@note Returns the current language if the group category doesn't have a culture override. @param AssetGroup The asset group to get the culture for. @return The culture as an IETF language tag (eg, "zh-Hans-CN").
GetCurrentCulture()
Get the current culture as an IETF language tag:
- A two-letter ISO 639-1 language code (eg, "zh").
Declaration
public static string GetCurrentCulture()
Returns
Type | Description |
---|---|
System.String |
Remarks
- An optional four-letter ISO 15924 script code (eg, "Hans").
- An optional two-letter ISO 3166-1 country code (eg, "CN"). @note This function exists for legacy API parity with SetCurrentCulture and is equivalent to GetCurrentLanguage. @return The culture as an IETF language tag (eg, "zh-Hans-CN").
GetCurrentLanguage()
Get the current language (for localization) as an IETF language tag:
- A two-letter ISO 639-1 language code (eg, "zh").
Declaration
public static string GetCurrentLanguage()
Returns
Type | Description |
---|---|
System.String |
Remarks
- An optional four-letter ISO 15924 script code (eg, "Hans").
- An optional two-letter ISO 3166-1 country code (eg, "CN"). @return The language as an IETF language tag (eg, "zh-Hans-CN").
GetCurrentLocale()
Get the current locale (for internationalization) as an IETF language tag:
- A two-letter ISO 639-1 language code (eg, "zh").
Declaration
public static string GetCurrentLocale()
Returns
Type | Description |
---|---|
System.String |
Remarks
- An optional four-letter ISO 15924 script code (eg, "Hans").
- An optional two-letter ISO 3166-1 country code (eg, "CN"). @return The locale as an IETF language tag (eg, "zh-Hans-CN").
New(UObject, Name)
Spawn an object of this class
Declaration
public static KismetInternationalizationLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type | Name | Description |
---|---|---|
UObject | obj | |
Name | name |
Returns
Type | Description |
---|---|
KismetInternationalizationLibrary |
SetCurrentAssetGroupCulture(Name, String, Boolean)
Set the given asset group category culture from an IETF language tag (eg, "zh-Hans-CN").
Declaration
public static bool SetCurrentAssetGroupCulture(Name AssetGroup, string Culture, bool SaveToConfig)
Parameters
Type | Name | Description |
---|---|---|
Name | AssetGroup | |
System.String | Culture | |
System.Boolean | SaveToConfig |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@param AssetGroup The asset group to set the culture for. @param Culture The culture to set, as an IETF language tag (eg, "zh-Hans-CN"). @param SaveToConfig If true, save the new setting to the users' "GameUserSettings" config so that it persists after a reload. @return True if the culture was set, false otherwise.
SetCurrentCulture(String, Boolean)
Set the current culture.
Declaration
public static bool SetCurrentCulture(string Culture, bool SaveToConfig)
Parameters
Type | Name | Description |
---|---|---|
System.String | Culture | |
System.Boolean | SaveToConfig |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@note This function is a sledgehammer, and will set both the language and locale, as well as clear out any asset group cultures that may be set. @param Culture The culture to set, as an IETF language tag (eg, "zh-Hans-CN"). @param SaveToConfig If true, save the new setting to the users' "GameUserSettings" config so that it persists after a reload. @return True if the culture was set, false otherwise.
SetCurrentLanguage(String, Boolean)
Set only the current language (for localization).
Declaration
public static bool SetCurrentLanguage(string Culture, bool SaveToConfig)
Parameters
Type | Name | Description |
---|---|---|
System.String | Culture | |
System.Boolean | SaveToConfig |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@note Unless you're doing something advanced, you likely want SetCurrentLanguageAndLocale or SetCurrentCulture instead. @param Culture The language to set, as an IETF language tag (eg, "zh-Hans-CN"). @param SaveToConfig If true, save the new setting to the users' "GameUserSettings" config so that it persists after a reload. @return True if the language was set, false otherwise.
SetCurrentLanguageAndLocale(String, Boolean)
Set the current language (for localization) and locale (for internationalization).
Declaration
public static bool SetCurrentLanguageAndLocale(string Culture, bool SaveToConfig)
Parameters
Type | Name | Description |
---|---|---|
System.String | Culture | |
System.Boolean | SaveToConfig |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@param Culture The language and locale to set, as an IETF language tag (eg, "zh-Hans-CN"). @param SaveToConfig If true, save the new setting to the users' "GameUserSettings" config so that it persists after a reload. @return True if the language and locale were set, false otherwise.
SetCurrentLocale(String, Boolean)
Set only the current locale (for internationalization).
Declaration
public static bool SetCurrentLocale(string Culture, bool SaveToConfig)
Parameters
Type | Name | Description |
---|---|---|
System.String | Culture | |
System.Boolean | SaveToConfig |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@note Unless you're doing something advanced, you likely want SetCurrentLanguageAndLocale or SetCurrentCulture instead. @param Culture The locale to set, as an IETF language tag (eg, "zh-Hans-CN"). @param SaveToConfig If true, save the new setting to the users' "GameUserSettings" config so that it persists after a reload. @return True if the locale was set, false otherwise.
Operators
| Improve this Doc View SourceImplicit(IntPtr to KismetInternationalizationLibrary)
Convert from IntPtr to UObject
Declaration
public static implicit operator KismetInternationalizationLibrary(IntPtr p)
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | p |
Returns
Type | Description |
---|---|
KismetInternationalizationLibrary |