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>.UseFallback

LocalizedDatabase<AssetTable, AssetTableEntry>.GetDefaultTableAsync()

LocalizedDatabase<AssetTable, AssetTableEntry>.GetTableAsync(TableReference, Locale)

LocalizedDatabase<AssetTable, AssetTableEntry>.PreloadTables(TableReference, Locale)

LocalizedDatabase<AssetTable, AssetTableEntry>.PreloadTables(IList<TableReference>, Locale)

LocalizedDatabase<AssetTable, AssetTableEntry>.ReleaseTable(TableReference, Locale)

LocalizedDatabase<AssetTable, AssetTableEntry>.GetTableEntryAsync(TableReference, TableEntryReference, Locale, FallbackBehavior)

LocalizedDatabase<AssetTable, AssetTableEntry>.OnLocaleChanged(Locale)

LocalizedDatabase<AssetTable, AssetTableEntry>.ResetState()

Namespace: UnityEngine.Localization.Settings

Syntax

public class LocalizedAssetDatabase : LocalizedDatabase<AssetTable, AssetTableEntry>, IPreloadRequired, IReset

Remarks

A localized asset must derive from .

Methods

GetLocalizedAssetAsync<TObject>(TableEntryReference, Locale)

Returns a handle to a localized asset loading operation from the . This function is asynchronous and may not have an immediate result available. Check IsDone to see if the data is available, if it is false then use the Completed event or yield on the operation. 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 to prevent the operation being reused and to finally return the operation back to the pool.

Declaration

public AsyncOperationHandle<TObject> GetLocalizedAssetAsync<TObject>(TableEntryReference tableEntryReference, Locale locale = null)
    where TObject : Object

Parameters

Type	Name	Description
TableEntryReference	tableEntryReference	A reference to the entry in the
Locale	locale	The Locale to load the table from. Null will use SelectedLocale.

Returns

Type	Description
AsyncOperationHandle<TObject>

Type Parameters

Name	Description
TObject	The type of asset that should be loaded.

GetLocalizedAssetAsync<TObject>(TableReference, TableEntryReference, Locale)

Returns a handle to a localized asset loading operation from the requested table. This function is asynchronous and may not have an immediate result available. Check IsDone to see if the data is available, if it is false then use the Completed event or yield on the operation. 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 to prevent the operation being reused and to finally return the operation back to the pool.

Declaration

public virtual AsyncOperationHandle<TObject> GetLocalizedAssetAsync<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
AsyncOperationHandle<TObject>

Type Parameters

Name	Description
TObject	The type of asset that should be loaded.

GetLocalizedAssetAsyncInternal<TObject>(TableReference, TableEntryReference, Locale)

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

Declaration

protected virtual AsyncOperationHandle<TObject> GetLocalizedAssetAsyncInternal<TObject>(TableReference tableReference, TableEntryReference tableEntryReference, Locale locale)
    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

Returns

Type	Description
AsyncOperationHandle<TObject>

Type Parameters

Name	Description
TObject	The type of asset that should be loaded.

Extension Methods

TupleExtensions.IsValueTuple(Object)

TupleExtensions.GetValueTupleItemObjects(Object)

TupleExtensions.GetValueTupleItemObjectsFlattened(Object)