Component:LocaleActiveDriver: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Locale Active Driver
|Name=Locale Active Driver
}}
}}
{{stub}}
The '''LocaleActiveDriver''' does a comparison against the local user's locale code and returns if it matches.


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Target|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv0=true|
|Target|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv0=true| The field to drive with whether or not <code>LocaleCode</code> is the local user's active locale code.
|LocaleCode|String|
|LocaleCode|String| The locale code to check for ignoring cass.
|MatchMainLanguage|Bool|
|MatchMainLanguage|Bool| Whether to match to the locale's main language.
}}
}}
== Behavior ==
== Examples ==


== See Also ==
== See Also ==
Line 20: Line 16:
[[Category:Components:Localization{{#translation:}}|Locale Active Driver]]
[[Category:Components:Localization{{#translation:}}|Locale Active Driver]]
[[Category:Components{{#translation:}}|Locale Active Driver]]
[[Category:Components{{#translation:}}|Locale Active Driver]]
[[Category:ComponentStubs]]

Latest revision as of 17:55, 23 January 2025

Component image 
Locale Active Driver component as seen in the Scene Inspector

The LocaleActiveDriver does a comparison against the local user's locale code and returns if it matches.

Usage

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.
Target field drive of Bool The field to drive with whether or not LocaleCode is the local user's active locale code.
LocaleCode String The locale code to check for ignoring cass.
MatchMainLanguage Bool Whether to match to the locale's main language.

See Also