Class CompatibilityBuildPipeline | Scriptable Build Pipeline | 1.5.10
docs.unity3d.com
    Show / Hide Table of Contents

    Class CompatibilityBuildPipeline

    Static class implementing API wrappers to match BuildPipeline APIs but use the Scriptable Build Pipeline.

    Inheritance
    Object
    CompatibilityBuildPipeline
    Namespace: UnityEditor.Build.Pipeline
    Syntax
    public static class CompatibilityBuildPipeline

    Methods

    BuildAssetBundles(String, AssetBundleBuild[], BuildAssetBundleOptions, BuildTarget)

    Wrapper API to match BuildPipeline API but use the Scriptable Build Pipeline to build Asset Bundles.

    Declaration
    public static CompatibilityAssetBundleManifest BuildAssetBundles(string outputPath, AssetBundleBuild[] builds, BuildAssetBundleOptions assetBundleOptions, BuildTarget targetPlatform)
    Parameters
    Type Name Description
    String outputPath

    Output path for the AssetBundles.

    AssetBundleBuild[] builds

    AssetBundle building map.

    BuildAssetBundleOptions assetBundleOptions

    AssetBundle building options.

    BuildTarget targetPlatform

    Chosen target build platform.

    Returns
    Type Description
    CompatibilityAssetBundleManifest

    null - Generating and returning an AssetBundleManifest is not yet supported by the Scriptable Build Pipeline. Est: 2018.3 release for support.

    Remarks

    Not all BuildAssetBundleOptions are supported in the Scriptable Build Pipeline initial release. Supported options are: ChunkBasedCompression, UncompressedAssetBundle, DisableWriteTypeTree, and DisableWriteTypeTree. In addition, existing BuildPipeline callbacks are not yet supported. Est: 2018.3 release for support.

    BuildAssetBundles(String, BuildAssetBundleOptions, BuildTarget)

    Wrapper API to match BuildPipeline API but use the Scriptable Build Pipeline to build Asset Bundles.

    Declaration
    public static CompatibilityAssetBundleManifest BuildAssetBundles(string outputPath, BuildAssetBundleOptions assetBundleOptions, BuildTarget targetPlatform)
    Parameters
    Type Name Description
    String outputPath

    Output path for the AssetBundles.

    BuildAssetBundleOptions assetBundleOptions

    AssetBundle building options.

    BuildTarget targetPlatform

    Chosen target build platform.

    Returns
    Type Description
    CompatibilityAssetBundleManifest

    null - Generating and returning an AssetBundleManifest is not yet supported by the Scriptable Build Pipeline. Est: 2018.3 support.

    Remarks

    Not all BuildAssetBundleOptions are supported in the Scriptable Build Pipeline initial release. Supported options are: ChunkBasedCompression, UncompressedAssetBundle, DisableWriteTypeTree, and DisableWriteTypeTree. In addition, existing BuildPipeline callbacks are not yet supported. Est: 2018.3 release for support.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023