989onan bot (talk | contribs) Automated: update SyncDelegates |
add info |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
|Name=Locale Settings | |Name=Locale Settings | ||
}} | }} | ||
The '''Locale Settings''' component is part of the [[Settings]] system and controls the platform's language. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|PrimaryInterfaceLocaleCode|String| | |PrimaryInterfaceLocaleCode|String| The primary language for the UI. | ||
|CultureLocaleCode|String| | |CultureLocaleCode|String| The locale code for the primary language, Ex: "en_us", "ru", or "pl_PL" | ||
|UseImperialUnits|Bool| | |UseImperialUnits|Bool| Whether to use Imperial or Metric units regardless of language selection. | ||
}} | }} | ||
== Sync Delegates == | == Sync Delegates == | ||
{{Table ComponentTriggers | {{Table ComponentTriggers | ||
|SetCurrentLocale:[[Type:Action`1|Action`1]]<[[Type:String|String]]>|[[Type:Action`1|Action`1]]<[[Type:String|String]]>|false| | |SetCurrentLocale:[[Type:Action`1|Action`1]]<[[Type:String|String]]>|[[Type:Action`1|Action`1]]<[[Type:String|String]]>|false| Called when the set current locale button is touched. | ||
}} | }} | ||
== | == Usage == | ||
Not used directly by the user. | |||
== Examples == | == Examples == | ||
Used in the [[Settings]] menu. | |||
== See Also == | == See Also == | ||
| Line 25: | Line 27: | ||
[[Category:Components:Uncategorized{{#translation:}}|Locale Settings]] | [[Category:Components:Uncategorized{{#translation:}}|Locale Settings]] | ||
[[Category:Components{{#translation:}}|Locale Settings]] | [[Category:Components{{#translation:}}|Locale Settings]] | ||
Latest revision as of 17:57, 1 June 2025
Component image 
Locale Settings component as seen in the Scene Inspector
The Locale Settings component is part of the Settings system and controls the platform's language.
Fields
| Name | Type | Description |
|---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't. |
PrimaryInterfaceLocaleCode
|
String | The primary language for the UI. |
CultureLocaleCode
|
String | The locale code for the primary language, Ex: "en_us", "ru", or "pl_PL" |
UseImperialUnits
|
Bool | Whether to use Imperial or Metric units regardless of language selection. |
Sync Delegates
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|---|---|---|
SetCurrentLocale:Action`1<String>
|
Action`1<String> | X | Called when the set current locale button is touched. |
Usage
Not used directly by the user.
Examples
Used in the Settings menu.