Class UpgradedStringDatabase
A string database that answers old package references from the built-in localization module.
Inheritance
Inherited Members
Namespace: UnityEngine.Localization.Upgrade
Assembly: Unity.Localization.dll
Syntax
[Serializable]
public class UpgradedStringDatabase : LocalizedStringDatabase, IReset, IPreloadRequiredRemarks
The upgrade wizard installs this in place of LocalizedStringDatabase so scripts written against the package API keep working after the project's tables move to the module. References are translated through the LocalizationUpgradeMap; a reference to a collection the upgrade did not convert resolves to nothing with a warning, because the package pipeline would start Addressables operations against content the upgrade may have deleted. Tables returned by GetTable(TableReference, Locale) are copies built from the module table for the requested locale: reads reflect the module data at the time of the call, and writes to the copy do not flow back to the module.
Properties
| Name | Description |
|---|---|
| UpgradeMap | The map the wizard produced, used to translate old references to module collections. |
Methods
| Name | Description |
|---|---|
| GetTable(TableReference, Locale) | Returns the named table. Uses WaitForCompletion to force the loading to complete synchronously. Please note that WaitForCompletion is not supported on WebGL. |
| GetTableAsync(TableReference, Locale) | Returns the named 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. |
| GetTableEntry(TableReference, TableEntryReference, Locale, FallbackBehavior) | Returns the entry from the requested table. A table entry will contain the localized item and metadata. Uses WaitForCompletion to force the loading to complete synchronously. Please note that WaitForCompletion is not supported on WebGL. |
| GetTableEntryAsync(TableReference, TableEntryReference, Locale, FallbackBehavior) | Returns the entry from the requested table. A table entry will contain the localized item and metadata. 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 UnityEngine.AddressableAssets.Addressables.Release(UnityEngine.ResourceManagement.AsyncOperations.AsyncOperationHandle) to finally return the operation back to the pool. |
| IsTableLoaded(TableReference, Locale) | Checks if the table is currently loaded or not. |
| OnLocaleChanged(Locale) | Called before the LocaleChanged event is sent out in order to give the database a chance to prepare. |