Class LocalizedAssetDatabase

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

Inheritance
Object
LocalizedDatabase<AssetTable, AssetTableEntry>
LocalizedAssetDatabase
Inherited Members
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.