Class CompatibilityBuildPipeline

Static class exposing convenient methods that match the BuildPipeline method, suitable for porting existing projects to the Scriptable Build Pipeline quickly. New projects could consider calling BuildAssetBundles(IBundleBuildParameters, IBundleBuildContent, out IBundleBuildResults) directly.

Inheritance

Object

CompatibilityBuildPipeline

Namespace: UnityEditor.Build.Pipeline

Syntax

public static class CompatibilityBuildPipeline : object

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	CompatibilityAssetBundleManifest object exposing information about the generated asset bundles.

Remarks

Not all BuildAssetBundleOptions are supported in the Scriptable Build Pipeline. Supported options are: ForceRebuildAssetBundle, AppendHashToAssetBundleName, ChunkBasedCompression, UncompressedAssetBundle, and DisableWriteTypeTree. In addition, existing BuildPipeline callbacks are not yet supported.

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	CompatibilityAssetBundleManifest object exposing information about the generated asset bundles.

Remarks

Not all BuildAssetBundleOptions are supported in the Scriptable Build Pipeline. Supported options are: ForceRebuildAssetBundle, AppendHashToAssetBundleName, ChunkBasedCompression, UncompressedAssetBundle, and DisableWriteTypeTree. In addition, existing BuildPipeline callbacks are not yet supported.