# LocalizationSettings

> The runtime settings for localization: the available locales, the selected locale, and the resource database.

## Definition

* **Type:** Class
* **Namespace:** [Unity.Localization](/engine/6000.7/script-reference/unity/localization.md)
* **Assembly:** UnityEngine.LocalizationRuntimeModule
* **Inherits from:** [ScriptableObject](/engine/6000.7/script-reference/unityengine/scriptableobject.md)

```csharp
[HelpURL("localization/localization-settings-reference")]
public class LocalizationSettings : ScriptableObject
```

## Remarks

This is the central entry point for the standalone localization runtime, and it works with no package installed. One active instance is exposed through [LocalizationSettings.Instance](/engine/6000.7/script-reference/unity/localization/localizationsettings/instance.md); its [LocalizationSettings.Database](/engine/6000.7/script-reference/unity/localization/localizationsettings/database.md) (a [ResourceDatabase](/engine/6000.7/script-reference/unity/localization/resourcedatabase.md)) resolves localized strings and assets. Locales are held here as plain [Locale](/engine/6000.7/script-reference/unity/localization/locale.md) objects, and everything else refers to a locale by its [LocaleIdentifier](/engine/6000.7/script-reference/unity/localization/localeidentifier.md) code, resolved through [LocalizationSettings.GetLocale](/engine/6000.7/script-reference/unity/localization/localizationsettings/getlocale.md). The locale list is polymorphic (`[SerializeReference]`), so locale subclasses such as a pseudo-locale can be added. Register locales with [LocalizationSettings.AddLocale](/engine/6000.7/script-reference/unity/localization/localizationsettings/addlocale.md); asset providers can contribute more during [LocalizationSettings.InitializeAsync](/engine/6000.7/script-reference/unity/localization/localizationsettings/initializeasync.md). The startup locale is decided by the [LocalizationSettings.StartupSelectors](/engine/6000.7/script-reference/unity/localization/localizationsettings/startupselectors.md). Call [LocalizationSettings.InitializeAsync](/engine/6000.7/script-reference/unity/localization/localizationsettings/initializeasync.md) to load locales and select the startup locale.

Additional Resources: [ResourceDatabase](/engine/6000.7/script-reference/unity/localization/resourcedatabase.md), [Locale](/engine/6000.7/script-reference/unity/localization/locale.md), [LocaleIdentifier](/engine/6000.7/script-reference/unity/localization/localeidentifier.md), [IStartupLocaleSelector](/engine/6000.7/script-reference/unity/localization/istartuplocaleselector.md)

Initializes localization and switches to a specific locale.

## Examples

```csharp
using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples
{
    public class InitializeAndSwitchLocaleExample : MonoBehaviour
    {
        async void Start()
        {
            await LocalizationSettings.InitializeAsync();
            Locale french = LocalizationSettings.Instance.GetLocale(new LocaleIdentifier("fr"));
            if (french != null)
                LocalizationSettings.SelectedLocale = french;
        }
    }
}
```

## Static Fields

| Value                                                                                               | Description                                                                          |
| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| [ConfigName](/engine/6000.7/script-reference/unity/localization/localizationsettings/configname.md) | The key under which the active settings are stored as an editor build config object. |

## Properties

| Property                                                                                                                | Description                                                                                                                                                                                                |
| ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [AvailableLocales](/engine/6000.7/script-reference/unity/localization/localizationsettings/availablelocales.md)         | The locales registered on this settings instance.                                                                                                                                                          |
| [Database](/engine/6000.7/script-reference/unity/localization/localizationsettings/database.md)                         | The resource database that resolves localized content for this instance.                                                                                                                                   |
| [DeferInitialization](/engine/6000.7/script-reference/unity/localization/localizationsettings/deferinitialization.md)   | Whether the system waits for an explicit call to [LocalizationSettings.InitializeAsync](/engine/6000.7/script-reference/unity/localization/localizationsettings/initializeasync.md) before it initializes. |
| [IsInitialized](/engine/6000.7/script-reference/unity/localization/localizationsettings/isinitialized.md)               | Whether initialization has completed.                                                                                                                                                                      |
| [ProjectLocale](/engine/6000.7/script-reference/unity/localization/localizationsettings/projectlocale.md)               | The default project locale used when no other locale is selected.                                                                                                                                          |
| [SelectedProvider](/engine/6000.7/script-reference/unity/localization/localizationsettings/selectedprovider.md)         | The asset provider used as the default when creating new localized content.                                                                                                                                |
| [SmartStringsSettings](/engine/6000.7/script-reference/unity/localization/localizationsettings/smartstringssettings.md) | The Smart Strings settings whose formatter resolves this project's Smart String entries.                                                                                                                   |
| [StartupSelector](/engine/6000.7/script-reference/unity/localization/localizationsettings/startupselector.md)           | The selector that chose the startup locale, or null when the chain fell through to the project locale.                                                                                                     |
| [StartupSelectors](/engine/6000.7/script-reference/unity/localization/localizationsettings/startupselectors.md)         | The startup locale selectors, evaluated in order to pick the selected locale on initialization.                                                                                                            |

## Static Properties

| Property                                                                                                        | Description                                                                            |
| --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| [HasSettings](/engine/6000.7/script-reference/unity/localization/localizationsettings/hassettings.md)           | Whether an active settings instance is registered.                                     |
| [Instance](/engine/6000.7/script-reference/unity/localization/localizationsettings/instance.md)                 | The active settings instance, or null when none is registered.                         |
| [PreferredLoading](/engine/6000.7/script-reference/unity/localization/localizationsettings/preferredloading.md) | The default loading behaviour used by the reference accessors and their change events. |
| [PreloadBehavior](/engine/6000.7/script-reference/unity/localization/localizationsettings/preloadbehavior.md)   | The preload behavior the flagged table collections follow.                             |
| [ResourceDatabase](/engine/6000.7/script-reference/unity/localization/localizationsettings/resourcedatabase.md) | The active resource database, or null when no settings instance is registered.         |
| [SelectedLocale](/engine/6000.7/script-reference/unity/localization/localizationsettings/selectedlocale.md)     | The currently selected locale, or null when none is selected.                          |

## Methods

| Method                                                                                                                    | Description                                                                               |
| ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| [AddLocale](/engine/6000.7/script-reference/unity/localization/localizationsettings/addlocale.md)                         | Registers a locale as available, deduplicated by locale code.                             |
| [EvaluateStartupLocale](/engine/6000.7/script-reference/unity/localization/localizationsettings/evaluatestartuplocale.md) | Runs the startup selector chain and returns the locale it produces, without selecting it. |
| [GetLocale](/engine/6000.7/script-reference/unity/localization/localizationsettings/getlocale.md)                         | Returns the available locale with the given identifier, or null.                          |
| [GetSmartFormatter](/engine/6000.7/script-reference/unity/localization/localizationsettings/getsmartformatter.md)         | Returns the Smart formatter used to format Smart String entries.                          |
| [RemoveLocale](/engine/6000.7/script-reference/unity/localization/localizationsettings/removelocale.md)                   | Removes a locale from the available set.                                                  |

## Static Methods

| Method                                                                                                        | Description                                                               |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [InitializeAsync](/engine/6000.7/script-reference/unity/localization/localizationsettings/initializeasync.md) | Loads the available locales and selects the startup locale, running once. |

## Static Events

| Member                                                                                                                        | Description                                 |
| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [InitializationCompleted](/engine/6000.7/script-reference/unity/localization/localizationsettings/initializationcompleted.md) | Raised once after initialization completes. |
| [SelectedLocaleChanged](/engine/6000.7/script-reference/unity/localization/localizationsettings/selectedlocalechanged.md)     | Raised after the selected locale changes.   |

## Inheritance

**Inherited Members:**

* [ScriptableObject.CreateInstance(string)](/engine/6000.7/script-reference/unityengine/scriptableobject/createinstance.md#createinstance\(string\))
* [ScriptableObject.CreateInstance(Type)](/engine/6000.7/script-reference/unityengine/scriptableobject/createinstance.md#createinstance\(type\))
* [ScriptableObject.CreateInstance\<T>()](/engine/6000.7/script-reference/unityengine/scriptableobject/createinstance.md)
* [Object.GetEntityId()](/engine/6000.7/script-reference/unityengine/object/getentityid.md)
* [Object.GetHashCode()](/engine/6000.7/script-reference/unityengine/object/gethashcode.md)
* [Object.InstantiateAsync\<T>(T)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, Transform)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, Vector3, Quaternion)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, Transform, Vector3, Quaternion)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Vector3, Quaternion)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, ReadOnlySpan\<Vector3>, ReadOnlySpan\<Quaternion>)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform, Vector3, Quaternion)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform, ReadOnlySpan\<Vector3>, ReadOnlySpan\<Quaternion>)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Transform, ReadOnlySpan\<Vector3>, ReadOnlySpan\<Quaternion>, CancellationToken)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, InstantiateParameters, CancellationToken)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, InstantiateParameters, CancellationToken)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.InstantiateAsync\<T>(T, int, ReadOnlySpan\<Vector3>, ReadOnlySpan\<Quaternion>, InstantiateParameters, CancellationToken)](/engine/6000.7/script-reference/unityengine/object/instantiateasync.md)
* [Object.Instantiate(Object, Vector3, Quaternion)](/engine/6000.7/script-reference/unityengine/object/instantiate.md#instantiate\(object-vector3-quaternion\))
* [Object.Instantiate(Object, Vector3, Quaternion, Transform)](/engine/6000.7/script-reference/unityengine/object/instantiate.md#instantiate\(object-vector3-quaternion-transform\))
* [Object.Instantiate(Object)](/engine/6000.7/script-reference/unityengine/object/instantiate.md#instantiate\(object\))
* [Object.Instantiate(Object, Scene)](/engine/6000.7/script-reference/unityengine/object/instantiate.md#instantiate\(object-scene\))
* [Object.Instantiate\<T>(T, InstantiateParameters)](/engine/6000.7/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Vector3, Quaternion, InstantiateParameters)](/engine/6000.7/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate(Object, Transform)](/engine/6000.7/script-reference/unityengine/object/instantiate.md#instantiate\(object-transform\))
* [Object.Instantiate(Object, Transform, bool)](/engine/6000.7/script-reference/unityengine/object/instantiate.md#instantiate\(object-transform-bool\))
* [Object.Instantiate\<T>(T)](/engine/6000.7/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Vector3, Quaternion)](/engine/6000.7/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Vector3, Quaternion, Transform)](/engine/6000.7/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Transform)](/engine/6000.7/script-reference/unityengine/object/instantiate.md)
* [Object.Instantiate\<T>(T, Transform, bool)](/engine/6000.7/script-reference/unityengine/object/instantiate.md)
* [Object.Destroy(Object, float)](/engine/6000.7/script-reference/unityengine/object/destroy.md)
* [Object.DestroyImmediate(Object, bool)](/engine/6000.7/script-reference/unityengine/object/destroyimmediate.md)
* [Object.FindObjectsByType(Type)](/engine/6000.7/script-reference/unityengine/object/findobjectsbytype.md#findobjectsbytype\(type\))
* [Object.FindObjectsByType(Type, FindObjectsInactive)](/engine/6000.7/script-reference/unityengine/object/findobjectsbytype.md#findobjectsbytype\(type-findobjectsinactive\))
* [Object.DontDestroyOnLoad(Object)](/engine/6000.7/script-reference/unityengine/object/dontdestroyonload.md)
* [Object.FindAnyObjectByType\<T>()](/engine/6000.7/script-reference/unityengine/object/findanyobjectbytype.md#findanyobjectbytypet\(\))
* [Object.FindAnyObjectByType\<T>(FindObjectsInactive)](/engine/6000.7/script-reference/unityengine/object/findanyobjectbytype.md#findanyobjectbytypet\(findobjectsinactive\))
* [Object.FindObjectsByType\<T>()](/engine/6000.7/script-reference/unityengine/object/findobjectsbytype.md#findobjectsbytypet\(\))
* [Object.FindObjectsByType\<T>(FindObjectsInactive)](/engine/6000.7/script-reference/unityengine/object/findobjectsbytype.md#findobjectsbytypet\(findobjectsinactive\))
* [Object.FindAnyObjectByType(Type)](/engine/6000.7/script-reference/unityengine/object/findanyobjectbytype.md#findanyobjectbytype\(type\))
* [Object.FindAnyObjectByType(Type, FindObjectsInactive)](/engine/6000.7/script-reference/unityengine/object/findanyobjectbytype.md#findanyobjectbytype\(type-findobjectsinactive\))
* [Object.ToString()](/engine/6000.7/script-reference/unityengine/object/tostring.md)
* [Object.name](/engine/6000.7/script-reference/unityengine/object/name.md)
* [Object.hideFlags](/engine/6000.7/script-reference/unityengine/object/hideflags.md)

### Operators

| Operator                                                                           | Description                                                             |
| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [operator ==](/engine/6000.7/script-reference/unityengine/object/op-equality.md)   | Compares two object references to see if they refer to the same object. |
| [bool](/engine/6000.7/script-reference/unityengine/object/op-implicit.md)          | Determines whether the object exists.                                   |
| [operator !=](/engine/6000.7/script-reference/unityengine/object/op-inequality.md) | Compares if two objects refer to a different object.                    |