docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BinaryCatalogBuilder

    Catalog builder that generates content catalogs in a compact binary format. Binary catalogs are smaller and faster to load than JSON catalogs.

    Inheritance
    object
    BaseCatalogBuilder
    BinaryCatalogBuilder
    Implements
    ICatalogBuilder
    Inherited Members
    BaseCatalogBuilder.CreateForProvider(Type)
    BaseCatalogBuilder.AddExtensionToCatalogFilename(string)
    BaseCatalogBuilder.GetBaseCatalogFilename(string)
    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 class BinaryCatalogBuilder : 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
    GenerateCatalog(IBuildLogger, CatalogPathConfig, string, IList<ContentCatalogDataEntry>, List<ResourceLocationData>, HashSet<Type>, FileRegistry, string, bool, int, CatalogBundleConfig)

    Generates a content catalog from the provided build data.

    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)