docs.unity3d.com
    Show / Hide Table of Contents

    Class LocalizedAssetDatabase

    The Localized Asset Database provides a single point of access for all localized assets.

    Inheritance
    Object
    LocalizedDatabase<AssetTable, AssetTableEntry>
    LocalizedAssetDatabase
    Inherited Members
    LocalizedDatabase<AssetTable, AssetTableEntry>.PreloadOperation
    LocalizedDatabase<AssetTable, AssetTableEntry>.DefaultTable
    LocalizedDatabase<AssetTable, AssetTableEntry>.TableProvider
    LocalizedDatabase<AssetTable, AssetTableEntry>.TablePostprocessor
    LocalizedDatabase<AssetTable, AssetTableEntry>.UseFallback
    LocalizedDatabase<AssetTable, AssetTableEntry>.GetDefaultTableAsync()
    LocalizedDatabase<AssetTable, AssetTableEntry>.GetTableAsync(TableReference, Locale)
    LocalizedDatabase<AssetTable, AssetTableEntry>.GetTable(TableReference, Locale)
    LocalizedDatabase<AssetTable, AssetTableEntry>.PreloadTables(TableReference, Locale)
    LocalizedDatabase<AssetTable, AssetTableEntry>.PreloadTables(IList<TableReference>, Locale)
    LocalizedDatabase<AssetTable, AssetTableEntry>.ReleaseAllTables(Locale)
    LocalizedDatabase<AssetTable, AssetTableEntry>.ReleaseTable(TableReference, Locale)
    LocalizedDatabase<AssetTable, AssetTableEntry>.GetAllTables(Locale)
    LocalizedDatabase<AssetTable, AssetTableEntry>.IsTableLoaded(TableReference, Locale)
    LocalizedDatabase<AssetTable, AssetTableEntry>.GetTableEntryAsync(TableReference, TableEntryReference, Locale, FallbackBehavior)
    LocalizedDatabase<AssetTable, AssetTableEntry>.GetTableEntry(TableReference, TableEntryReference, Locale, FallbackBehavior)
    LocalizedDatabase<AssetTable, AssetTableEntry>.OnLocaleChanged(Locale)
    LocalizedDatabase<AssetTable, AssetTableEntry>.ResetState()
    Namespace: UnityEngine.Localization.Settings
    Syntax
    [Serializable]
    public class LocalizedAssetDatabase : LocalizedDatabase<AssetTable, AssetTableEntry>, IPreloadRequired, IReset, IDisposable
    Remarks

    A localized asset must derive from Object.

    Methods

    GetLocalizedAsset<TObject>(TableEntryReference, Locale)

    Returns a localized asset from the DefaultTable.

    Declaration
    public TObject GetLocalizedAsset<TObject>(TableEntryReference tableEntryReference, Locale locale = null)
        where TObject : Object
    Parameters
    Type Name Description
    TableEntryReference tableEntryReference

    A reference to the entry in the DefaultTable

    Locale locale

    The Locale to load the table from. Null will use SelectedLocale.

    Returns
    Type Description
    TObject
    Type Parameters
    Name Description
    TObject

    The type of asset that should be loaded.

    GetLocalizedAsset<TObject>(TableReference, TableEntryReference, Locale)

    Returns a localized asset from the requested table.

    Declaration
    public virtual TObject GetLocalizedAsset<TObject>(TableReference tableReference, TableEntryReference tableEntryReference, Locale locale = null)
        where TObject : Object
    Parameters
    Type Name Description
    TableReference tableReference

    A reference to the table that the asset should be loaded from.

    TableEntryReference tableEntryReference

    A reference to the entry in the table.

    Locale locale

    The Locale to load the table from. Null will use SelectedLocale.

    Returns
    Type Description
    TObject
    Type Parameters
    Name Description
    TObject

    The type of asset that should be loaded.

    GetLocalizedAssetAsync<TObject>(TableEntryReference, Locale, FallbackBehavior)

    Returns a handle to a localized asset loading operation from the DefaultTable. This method is asynchronous and may not have an immediate result. Check IsDone to see if the data is available, if it is false then you can use the Completed event to get a callback when it is finished, yield on the operation or call WaitForCompletion to force the operation to complete. Once the Completed event has been called, during the next update, the internal operation will be returned to a pool so that it can be reused. If you do plan to keep hold of the handle after completion then you should call Acquire to prevent the operation being reused and Release(AsyncOperationHandle) to finally return the operation back to the pool.

    Declaration
    public AsyncOperationHandle<TObject> GetLocalizedAssetAsync<TObject>(TableEntryReference tableEntryReference, Locale locale = null, FallbackBehavior fallbackBehavior = FallbackBehavior.UseProjectSettings)
        where TObject : Object
    Parameters
    Type Name Description
    TableEntryReference tableEntryReference

    A reference to the entry in the DefaultTable

    Locale locale

    The Locale to load the table from. Null will use SelectedLocale.

    FallbackBehavior fallbackBehavior

    Determines if a fallback should be used when no value could be found for the Locale.

    Returns
    Type Description
    AsyncOperationHandle<TObject>
    Type Parameters
    Name Description
    TObject

    The type of asset that should be loaded.

    GetLocalizedAssetAsync<TObject>(TableReference, TableEntryReference, Locale, FallbackBehavior)

    Returns a handle to a localized asset loading operation from the requested table. This method is asynchronous and may not have an immediate result. Check IsDone to see if the data is available, if it is false then you can use the Completed event to get a callback when it is finished, yield on the operation or call WaitForCompletion to force the operation to complete. Once the Completed event has been called, during the next update, the internal operation will be returned to a pool so that it can be reused. If you do plan to keep hold of the handle after completion then you should call Acquire to prevent the operation being reused and Release(AsyncOperationHandle) to finally return the operation back to the pool.

    Declaration
    public virtual AsyncOperationHandle<TObject> GetLocalizedAssetAsync<TObject>(TableReference tableReference, TableEntryReference tableEntryReference, Locale locale = null, FallbackBehavior fallbackBehavior = FallbackBehavior.UseProjectSettings)
        where TObject : Object
    Parameters
    Type Name Description
    TableReference tableReference

    A reference to the table that the asset should be loaded from.

    TableEntryReference tableEntryReference

    A reference to the entry in the table.

    Locale locale

    The Locale to load the table from. Null will use SelectedLocale.

    FallbackBehavior fallbackBehavior

    Determines if a fallback should be used when no value could be found for the Locale.

    Returns
    Type Description
    AsyncOperationHandle<TObject>
    Type Parameters
    Name Description
    TObject

    The type of asset that should be loaded.

    GetLocalizedAssetAsyncInternal<TObject>(TableReference, TableEntryReference, Locale, FallbackBehavior)

    Implementation for all versions of GetLocalizedAssetAsync<TObject>(TableEntryReference, Locale, FallbackBehavior).

    Declaration
    protected virtual AsyncOperationHandle<TObject> GetLocalizedAssetAsyncInternal<TObject>(TableReference tableReference, TableEntryReference tableEntryReference, Locale locale, FallbackBehavior fallbackBehavior = FallbackBehavior.UseProjectSettings)
        where TObject : Object
    Parameters
    Type Name Description
    TableReference tableReference

    A reference to the table that the asset should be loaded from.

    TableEntryReference tableEntryReference

    A reference to the entry in the table.

    Locale locale

    The Locale to use instead of the default SelectedLocale

    FallbackBehavior fallbackBehavior

    Determines if a fallback should be used when no value could be found for the Locale.

    Returns
    Type Description
    AsyncOperationHandle<TObject>
    Type Parameters
    Name Description
    TObject

    The type of asset that should be loaded.


    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Methods
      • GetLocalizedAsset<TObject>(TableEntryReference, Locale)
      • GetLocalizedAsset<TObject>(TableReference, TableEntryReference, Locale)
      • GetLocalizedAssetAsync<TObject>(TableEntryReference, Locale, FallbackBehavior)
      • GetLocalizedAssetAsync<TObject>(TableReference, TableEntryReference, Locale, FallbackBehavior)
      • GetLocalizedAssetAsyncInternal<TObject>(TableReference, TableEntryReference, Locale, FallbackBehavior)
    Back to top
    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