docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    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
    AsyncOperationHandle<List<IResourceLocator>>

    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
    AsyncOperationHandle<List<IResourceLocator>>

    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.


    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
    • UpdateCatalogs(IEnumerable<string>, bool)
    • UpdateCatalogs(bool, IEnumerable<string>, bool)
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)