Method UpdateCatalogs
UpdateCatalogs(IEnumerable<string>, bool)
Update the specified catalogs.
Declaration
public static AsyncOperationHandle<List<IResourceLocator>> UpdateCatalogs(IEnumerable<string> catalogs = null, bool autoReleaseHandle = true)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<string> | catalogs | The set of catalogs to update. If null, all catalogs that have an available update will be updated. |
| bool | autoReleaseHandle | If true, the handle will automatically be released when the operation completes. |
Returns
| Type | Description |
|---|---|
| Async |
The operation with the list of updated content catalog data. |
Remarks
When you call the UpdateCatalog function, all other Addressable requests are blocked until the operation is finished. You can release the operation handle returned by UpdateCatalogs immediately after the operation finishes (or set the autoRelease parameter to true).
If you call UpdateCatalog without providing a list of catalogs, the Addressables system checks all of the currently loaded catalogs for updates.
If you update a catalog when you have already loaded content from the related AssetBundles, you can encounter conflicts between the loaded AssetBundles and the updated versions. To avoid conflicts, update the catalog before loading assets or unload the AssetBundles before the updating the catalog. You can enable the Unique Bundle Ids option in your Addressable settings to avoid conflicts, but that can increase memory consumption since you will still have the original AssetBundles in memory after loading the updated ones. Enabling this option can also make the download size of content updates larger because typically more AssetBundles must be rebuilt.
See Updating catalogs for more details.
UpdateCatalogs(bool, IEnumerable<string>, bool)
Update the specified catalogs.
Declaration
public static AsyncOperationHandle<List<IResourceLocator>> UpdateCatalogs(bool autoCleanBundleCache, IEnumerable<string> catalogs = null, bool autoReleaseHandle = true)Parameters
| Type | Name | Description |
|---|---|---|
| bool | autoCleanBundleCache | If true, removes any nonreferenced bundles in the cache. |
| IEnumerable<string> | catalogs | The set of catalogs to update. If null, all catalogs that have an available update will be updated. |
| bool | autoReleaseHandle | If true, the handle will automatically be released when the operation completes. |
Returns
| Type | Description |
|---|---|
| Async |
The operation with the list of updated content catalog data. |
Remarks
When you call the UpdateCatalog function, all other Addressable requests are blocked until the operation is finished. You can release the operation handle returned by UpdateCatalogs immediately after the operation finishes (or set the autoRelease parameter to true).
If you call UpdateCatalog without providing a list of catalogs, the Addressables system checks all of the currently loaded catalogs for updates.
If you update a catalog when you have already loaded content from the related AssetBundles, you can encounter conflicts between the loaded AssetBundles and the updated versions. To avoid conflicts, update the catalog before loading assets or unload the AssetBundles before the updating the catalog. You can enable the Unique Bundle Ids option in your Addressable settings to avoid conflicts, but that can increase memory consumption since you will still have the original AssetBundles in memory after loading the updated ones. Enabling this option can also make the download size of content updates larger because typically more AssetBundles must be rebuilt.
See Updating catalogs for more details.