docs.unity3d.com
    Show / Hide Table of Contents

    Interface ILocalesProvider

    Holds the Locale's that the project supports.

    Namespace: UnityEngine.Localization.Settings
    Syntax
    public interface ILocalesProvider

    Properties

    Locales

    The list of Locales available.

    Declaration
    List<Locale> Locales { get; }
    Property Value
    Type Description
    List<Locale>

    Methods

    AddLocale(Locale)

    Add a Locale to allow support for a specific language.

    Declaration
    void AddLocale(Locale locale)
    Parameters
    Type Name Description
    Locale locale

    The locale to add.

    GetLocale(LocaleIdentifier)

    Attempt to retrieve a Locale using the identifier.

    Declaration
    Locale GetLocale(LocaleIdentifier id)
    Parameters
    Type Name Description
    LocaleIdentifier id

    LocaleIdentifier to find.

    Returns
    Type Description
    Locale

    If no Locale can be found then null is returned.

    RemoveLocale(Locale)

    Removes support for a specific Locale.

    Declaration
    bool RemoveLocale(Locale locale)
    Parameters
    Type Name Description
    Locale locale

    The locale that should be removed if possible.

    Returns
    Type Description
    Boolean

    true if the locale was removed or false if the locale did not exist.

    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023