docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BaseCatalogBuilder

    Base class for catalog builders that generate content catalog data for Addressables builds. Provides common functionality for creating catalog files in different formats.

    Inheritance
    object
    BaseCatalogBuilder
    BinaryCatalogBuilder
    JsonCatalogBuilder
    Implements
    ICatalogBuilder
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.AddressableAssets.Build.CatalogBuilders
    Assembly: Unity.Addressables.Editor.dll
    Syntax
    public abstract class BaseCatalogBuilder : ICatalogBuilder

    Properties

    Name Description
    CatalogExtension

    The file extension (without leading dot) used for catalog files produced by this builder.

    CatalogProviderType

    The runtime ContentCatalogProvider type that loads catalogs produced by this builder. Used by CreateForProvider(Type) to map provider selection to a builder.

    SupportsLocalCatalogBundling

    Whether this catalog format supports bundling the local catalog into an AssetBundle (the "Compress Local Catalog" feature). Binary catalogs do not support this.

    Methods

    Name Description
    AddExtensionToCatalogFilename(string)

    Appends the catalog file extension to the given filename if not already present.

    CreateForProvider(Type)

    Returns the first ICatalogBuilder whose CatalogProviderType matches catalogProviderType, discovered via reflection.

    GenerateCatalog(IBuildLogger, CatalogPathConfig, string, IList<ContentCatalogDataEntry>, List<ResourceLocationData>, HashSet<Type>, FileRegistry, string, bool, int, CatalogBundleConfig)

    Generates a content catalog from the provided build data.

    GetBaseCatalogFilename(string)

    Gets the base filename for the catalog based on the locator ID. Returns "catalog" for the default catalog address, otherwise returns the locator ID.

    In This Article
    Back to top
    Copyright © 2026 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)