Class LocalizationSettings
Provides access to the localization system and its settings.
Implements
Inherited Members
Namespace: UnityEngine .Localization.Settings
Assembly: Unity.Localization.dll
Syntax
public class LocalizationSettings : ScriptableObject, IReset
Remarks
The Localization Settings serves as the central element of the localization system, offering the primary access point for all player-based localization features.
Properties
Name | Description |
---|---|
Asset |
The asset database is responsible for providing localized assets. |
Available |
|
Has |
Indicates if there is a LocalizationSettings present. If one is not found then it will attempt to find one however unlike Instance it will not create a default, if one can not be found. |
Initialization |
The localization system may not be immediately ready. Loading Locales, preloading assets etc.
This operation can be used to check when the system is ready. You can yield on this in a coroutine to wait.
If Initialize |
Initialize |
Forces the Initialization |
Instance | Singleton instance for the Localization Settings. |
Metadata | Returns the Localization Settings Metadata. Metadata can be used to contain additional information such as App Name localization settings. |
Preload |
Determines which tables, that have been marked as preload, will be loaded during the preloading step. |
Project |
When tracking property variants in a scene, any changes you make whilst in this Locale are saved into the source object instead of as a variant. |
Selected |
The current selected Locale. This is the Locale that will be used by default when localizing assets and strings.
Calling this when the Localization system has not initialized will force the Localization system to load all Locales before returning,
see Selected |
Selected |
The current selected Locale. This is the Locale that will be used by default when localizing assets and strings.
If Initialization |
Startup |
Determines what locale should be used for the Selected |
String |
The string database is responsible for providing localized string assets. |
Methods
Name | Description |
---|---|
Get |
The asset database is responsible for providing localized assets. |
Get |
|
Get |
The localization system may not be immediately ready. Loading Locales, preloading assets etc.
This operation can be used to check when the system is ready. You can yield on this in a coroutine to wait.
If Initialize |
Get |
Returns the singleton of the LocalizationSettings but does not create a default one if no active settings are found. |
Get |
Returns the Localization Settings Metadata. Metadata can be used to contain additional information such as App Name localization settings. |
Get |
The current selected Locale. This is the Locale that will be used by default when localizing assets and strings.
Calling this when the Localization system has not initialized will force the Localization system to load all Locales before returning,
see Selected |
Get |
The current selected Locale. This is the Locale that will be used by default when localizing assets and strings.
If Initialization |
Get |
Determines what locale should be used for the Selected |
Get |
Returns the string database being used to localize all strings. |
On |
Indicates that the Locale is no longer available.
If the locale is the current Selected |
Reset |
Resets the internal state of the object so it is ready to be used again and does not contain any data left over from a previous run. |
Select |
Uses Startup |
Set |
The asset database is responsible for providing localized assets. |
Set |
|
Set |
The current selected Locale. This is the Locale that will be used by default when localizing assets and strings.
Calling this when the Localization system has not initialized will force the Localization system to load all Locales before returning,
see Selected |
Set |
Sets the string database to be used for localizing all strings. |
Events
Name | Description |
---|---|
On |
Called when the Selected |
Selected |
Event that is sent when the Selected |