Google.Android.AppBundle.Editor.AssetBundleBuilder

Provides helper methods for building AssetBundles with various texture compression formats.

Summary

Public static functions
BuildAssetBundles(string outputPath, AssetBundleBuild[] builds, AssetPackDeliveryMode deliveryMode, IEnumerable< MobileTextureSubtarget > additionalTextureFormats, BuildAssetBundleOptions assetBundleOptions, bool allowClearDirectory)
Run one or more AssetBundle builds with the specified texture compression formats.
BuildAssetBundles(string outputPath, AssetBundleBuild[] builds, BuildAssetBundleOptions assetBundleOptions, MobileTextureSubtarget baseTextureFormat, IEnumerable< MobileTextureSubtarget > additionalTextureFormats, bool allowClearDirectory)
Dictionary< string, Dictionary< TextureCompressionFormat, string > >
Run one or more AssetBundle builds with the specified texture compression formats.
BuildAssetBundlesDeviceGroup(string outputPath, AssetPackDeliveryMode deliveryMode, Dictionary< string, AssetBundleBuild[]> deviceGroupToBuilds, string defaultDeviceGroup, BuildAssetBundleOptions assetBundleOptions, bool allowClearDirectory)
Run one or more AssetBundle builds for the specified device groups.
BuildAssetBundlesDeviceGroup(string outputPath, Dictionary< string, AssetBundleBuild[]> deviceGroupToBuilds, BuildAssetBundleOptions assetBundleOptions, bool allowClearDirectory)
Dictionary< string, Dictionary< string, string > >
Run one or more AssetBundle builds for each device group.
BuildAssetBundlesDeviceTier(string outputPath, AssetPackDeliveryMode deliveryMode, Dictionary< DeviceTier, AssetBundleBuild[]> deviceTierToBuilds, DeviceTier defaultDeviceTier, BuildAssetBundleOptions assetBundleOptions, bool allowClearDirectory)
Run one or more AssetBundle builds for the specified device tiers.
BuildAssetBundlesDeviceTier(string outputPath, Dictionary< DeviceTier, AssetBundleBuild[]> deviceTierToBuilds, BuildAssetBundleOptions assetBundleOptions, bool allowClearDirectory)
Dictionary< string, Dictionary< DeviceTier, string > >
Run one or more AssetBundle builds for each device tier.

Public static functions

BuildAssetBundles

AssetPackConfig BuildAssetBundles(
  string outputPath,
  AssetBundleBuild[] builds,
  AssetPackDeliveryMode deliveryMode,
  IEnumerable< MobileTextureSubtarget > additionalTextureFormats,
  BuildAssetBundleOptions assetBundleOptions,
  bool allowClearDirectory
)

Run one or more AssetBundle builds with the specified texture compression formats.

Notes about the outputPath parameter:

  • If a relative path is provided, the file paths in the returned AssetPackConfig will be relative paths.
  • If an absolute path is provided, the file paths in the returned object will be absolute paths.
  • AssetBundle builds for additional texture formats will be created in siblings of this directory. For example, for outputDirectory "a/b/c" and texture format ASTC, there will be a directory "a/b/c#tcf_astc".
  • If allowClearDirectory is false, this directory and any sibling directories must be empty or not exist, otherwise an exception is thrown.

Details
Parameters
outputPath
The output directory for the ETC1 AssetBundles. See other notes above.
builds
The main argument to BuildPipeline.
deliveryMode
A delivery mode to apply to every asset pack in the generated config.
additionalTextureFormats
Texture formats to build for in addition to ETC1.
assetBundleOptions
Options to pass to BuildPipeline.
allowClearDirectory
Allows this method to clear the contents of the output directory.
Returns
An AssetPackConfig containing file paths to all generated AssetBundles.

BuildAssetBundles

Dictionary< string, Dictionary< TextureCompressionFormat, string > > BuildAssetBundles(
  string outputPath,
  AssetBundleBuild[] builds,
  BuildAssetBundleOptions assetBundleOptions,
  MobileTextureSubtarget baseTextureFormat,
  IEnumerable< MobileTextureSubtarget > additionalTextureFormats,
  bool allowClearDirectory
)

Run one or more AssetBundle builds with the specified texture compression formats.

This variant allows for overriding the base format and provides a different return type.

Details
Parameters
outputPath
The output directory for base AssetBundles. See the other method for notes.
builds
The main argument to BuildPipeline.
assetBundleOptions
Options to pass to BuildPipeline.
baseTextureFormat
The default format. Note: ETC1 is supported by all devices.
additionalTextureFormats
Texture formats to generate for in addition to the base.
allowClearDirectory
Allows this method to clear the contents of the output directory.
Returns
A dictionary from AssetBundle name to TextureCompressionFormat to file outputPath.

BuildAssetBundlesDeviceGroup

AssetPackConfig BuildAssetBundlesDeviceGroup(
  string outputPath,
  AssetPackDeliveryMode deliveryMode,
  Dictionary< string, AssetBundleBuild[]> deviceGroupToBuilds,
  string defaultDeviceGroup,
  BuildAssetBundleOptions assetBundleOptions,
  bool allowClearDirectory
)

Run one or more AssetBundle builds for the specified device groups.

Notes about the outputPath parameter:

  • If a relative path is provided, the file paths in the returned AssetPackConfig will be relative paths.
  • If an absolute path is provided, the file paths in the returned object will be absolute paths.
  • AssetBundle builds for device groups will be created in siblings of this directory. For example, for outputDirectory "a/b/c" and device group X, there will be a directory "a/b/c#group_X".
  • If allowClearDirectory is false, this directory and any sibling directories must be empty or not exist, otherwise an exception is thrown.

Details
Parameters
outputPath
The output directory for AssetBundles. See other notes above.
deliveryMode
A delivery mode to apply to every asset pack in the generated config.
deviceGroupToBuilds
A dictionary from Device Group to asset bundle builds. All device groups should contain the same asset bundle names.
defaultDeviceGroup
Default device group to be used for standalone APKs. Set to null if not specified.
assetBundleOptions
Options to pass to BuildPipeline.
allowClearDirectory
Allows this method to clear the contents of the output directory.
Returns
An AssetPackConfig containing file paths to all generated AssetBundles.

BuildAssetBundlesDeviceGroup

Dictionary< string, Dictionary< string, string > > BuildAssetBundlesDeviceGroup(
  string outputPath,
  Dictionary< string, AssetBundleBuild[]> deviceGroupToBuilds,
  BuildAssetBundleOptions assetBundleOptions,
  bool allowClearDirectory
)

Run one or more AssetBundle builds for each device group.

Details
Parameters
outputPath
The output directory for base AssetBundles. See the other method for notes.
deviceGroupToBuilds
A dictionary from Device Group to asset bundle builds. All device groups should contains the same asset bundle names.
assetBundleOptions
Options to pass to BuildPipeline.
allowClearDirectory
Allows this method to clear the contents of the output directory.
Returns
A dictionary from AssetBundle name to device group to file outputPath.

BuildAssetBundlesDeviceTier

AssetPackConfig BuildAssetBundlesDeviceTier(
  string outputPath,
  AssetPackDeliveryMode deliveryMode,
  Dictionary< DeviceTier, AssetBundleBuild[]> deviceTierToBuilds,
  DeviceTier defaultDeviceTier,
  BuildAssetBundleOptions assetBundleOptions,
  bool allowClearDirectory
)

Run one or more AssetBundle builds for the specified device tiers.

Notes about the outputPath parameter:

  • If a relative path is provided, the file paths in the returned AssetPackConfig will be relative paths.
  • If an absolute path is provided, the file paths in the returned object will be absolute paths.
  • AssetBundle builds for device tiers will be created in siblings of this directory. For example, for outputDirectory "a/b/c" and device tier HIGH, there will be a directory "a/b/c#tier_high".
  • If allowClearDirectory is false, this directory and any sibling directories must be empty or not exist, otherwise an exception is thrown.

Details
Parameters
outputPath
The output directory for AssetBundles. See other notes above.
deliveryMode
A delivery mode to apply to every asset pack in the generated config.
deviceTierToBuilds
A dictionary from Device Tier to asset bundle builds. All device tiers should contains the same asset bundle names.
defaultDeviceTier
Default device tier to be used for standalone APKs. Set to zero if not specified.
assetBundleOptions
Options to pass to BuildPipeline.
allowClearDirectory
Allows this method to clear the contents of the output directory.
Returns
An AssetPackConfig containing file paths to all generated AssetBundles.

BuildAssetBundlesDeviceTier

Dictionary< string, Dictionary< DeviceTier, string > > BuildAssetBundlesDeviceTier(
  string outputPath,
  Dictionary< DeviceTier, AssetBundleBuild[]> deviceTierToBuilds,
  BuildAssetBundleOptions assetBundleOptions,
  bool allowClearDirectory
)

Run one or more AssetBundle builds for each device tier.

Details
Parameters
outputPath
The output directory for base AssetBundles. See the other method for notes.
deviceTierToBuilds
A dictionary from Device Tier to asset bundle builds. All device tiers should contains the same asset bundle names.
assetBundleOptions
Options to pass to BuildPipeline.
allowClearDirectory
Allows this method to clear the contents of the output directory.
Returns
A dictionary from AssetBundle name to DeviceTier to file outputPath.