Google.Android.AppBundle.Editor.AssetPackConfig

Configuration for all asset packs that will be packaged in an Android App Bundle (AAB).

Summary

Public attributes
`AssetPacks = new Dictionary()`	`readonly Dictionary< string, AssetPack >` Dictionary from asset pack name to AssetPack object containing info such as delivery mode.
`DefaultDeviceGroup = "other"`	`string` When asset packs for multiple device groups are present, this specifies the group used when building standalone APKs for Android pre-Lollipop devices.
`DefaultDeviceTier = 0`	`DeviceTier` When asset packs for multiple device tiers are present, this specifies the tier used when building standalone APKs for Android pre-Lollipop devices.
`DefaultTextureCompressionFormat = TextureCompressionFormat.Default`	`TextureCompressionFormat` When asset packs for multiple texture compression formats are present, this specifies the format used when building standalone APKs for Android pre-Lollipop devices.
`PathToDeviceTargetingConfigFile = ""`	`string` Specifies the path to the device targeting config file.
`SplitBaseModuleAssets`	`bool` Indicates that the assets in an AAB's base module should be split into a separate install-time asset pack.

Properties
`DeliveredAssetPacks`	`Dictionary< string, AssetPack >` A dictionary containing the subset of AssetPacks that are marked for delivery.

Public functions
`AddAssetBundle(string assetBundleFilePath, AssetPackDeliveryMode deliveryMode)`	`void` Package the specified AssetBundle file in its own AssetPack with the specified delivery mode.
`AddAssetBundles(IDictionary< TextureCompressionFormat, string > compressionFormatToAssetBundleFilePath, AssetPackDeliveryMode deliveryMode)`	`void` Package the specified AssetBundle files, which vary only by TextureCompressionFormat, in an AssetPack with the specified delivery mode.
`AddAssetBundles(IDictionary< DeviceTier, string > deviceTierToAssetBundleFilePath, AssetPackDeliveryMode deliveryMode)`	`void` Package the specified AssetBundle files, which vary only by DeviceTier, in an AssetPack with the specified delivery mode.
`AddAssetBundles(IDictionary< string, string > deviceGroupToAssetBundleFilePath, AssetPackDeliveryMode deliveryMode)`	`void` Package the specified AssetBundle files, which vary only by device group, in an AssetPack with the specified delivery mode.
`AddAssetsFolder(string assetPackName, string assetsFolderPath, AssetPackDeliveryMode deliveryMode)`	`void` Package all raw assets in the specified folder in an AssetPack with the specified name and using the specified delivery mode.
`AddAssetsFolders(string assetPackName, IDictionary< TextureCompressionFormat, string > compressionFormatToAssetPackDirectoryPath, AssetPackDeliveryMode deliveryMode)`	`void` Package the specified raw assets in the specified folders, keyed by TextureCompressionFormat, in an AssetPack with the specified delivery mode.
`AddAssetsFolders(string assetPackName, IDictionary< DeviceTier, string > deviceTierToAssetPackDirectoryPath, AssetPackDeliveryMode deliveryMode)`	`void` Package the specified raw assets in the specified folders, keyed by DeviceTier, in an AssetPack with the specified delivery mode.
`AddAssetsFolders(string assetPackName, IDictionary< string, string > deviceGroupToAssetPackDirectoryPath, AssetPackDeliveryMode deliveryMode)`	`void` Package the specified raw assets in the specified folders, keyed by device group, in an AssetPack with the specified delivery mode.
`HasDeliveredAssetPacks()`	`bool` Returns true if this configuration includes at least 1 asset pack that may be packaged in an AAB.

Public attributes

AssetPacks

readonly Dictionary< string, AssetPack > AssetPacks = new Dictionary<string, AssetPack>()

Dictionary from asset pack name to AssetPack object containing info such as delivery mode.

Note: asset pack names must start with a letter and can contain only letters, numbers, and underscores. Note: convenience methods such as AddAssetBundle are recommended to more safely add new Asset packs, but this dictionary is available for direct modification for advanced use cases.

DefaultDeviceGroup

string DefaultDeviceGroup = "other"

When asset packs for multiple device groups are present, this specifies the group used when building standalone APKs for Android pre-Lollipop devices.

DefaultDeviceTier

DeviceTier DefaultDeviceTier = 0

When asset packs for multiple device tiers are present, this specifies the tier used when building standalone APKs for Android pre-Lollipop devices.

DefaultTextureCompressionFormat

TextureCompressionFormat DefaultTextureCompressionFormat = TextureCompressionFormat.Default

When asset packs for multiple texture compression formats are present, this specifies the format used when building standalone APKs for Android pre-Lollipop devices.

PathToDeviceTargetingConfigFile

string PathToDeviceTargetingConfigFile = ""

Specifies the path to the device targeting config file.

Should only be set if you are using device targeting. The file should be a JSON file containing a list of device groups. It can either be absolute or relative.

SplitBaseModuleAssets

bool SplitBaseModuleAssets

Indicates that the assets in an AAB's base module should be split into a separate install-time asset pack.

Usually when building a game, some assets are stored in the base module's "assets" directory. Games that run into APK size limits may have previously used the "Split Application Binary" option to create APK Expansion (*.obb) files, however this is unsupported with AABs. If Play Console indicates that the base module exceeds a download size limit, for example 150 MB, enabling this option may resolve the issue. See https://developer.android.com/guide/app-bundle.

Properties

DeliveredAssetPacks

Dictionary< string, AssetPack > DeliveredAssetPacks

A dictionary containing the subset of AssetPacks that are marked for delivery.

Note: the returned Dictionary doesn't indicate whether SplitBaseModuleAssets is enabled.

Public functions

AddAssetBundle

void AddAssetBundle(
  string assetBundleFilePath,
  AssetPackDeliveryMode deliveryMode
)

Package the specified AssetBundle file in its own AssetPack with the specified delivery mode.

The name of the created asset pack will match that of the specified AssetBundle file.

Details

Parameters

`assetBundleFilePath`	The path to a single AssetBundle file.
`deliveryMode`	The AssetPackDeliveryMode for the asset pack.

Exceptions

`ArgumentException`	If the asset pack name is invalid.
`FileNotFoundException`	If the AssetBundle file doesn't exist.

AddAssetBundles

void AddAssetBundles(
  IDictionary< TextureCompressionFormat, string > compressionFormatToAssetBundleFilePath,
  AssetPackDeliveryMode deliveryMode
)

Package the specified AssetBundle files, which vary only by TextureCompressionFormat, in an AssetPack with the specified delivery mode.

When using Play Asset Delivery APIs, only the AssetBundle for the device's preferred texture compression format will be delivered.

Details

Parameters

`compressionFormatToAssetBundleFilePath`	A dictionary from TextureCompressionFormat to AssetBundle files.
`deliveryMode`	The AssetPackDeliveryMode for the asset pack.

Exceptions

`ArgumentException`	If the dictionary or asset pack name is invalid.
`FileNotFoundException`	If any AssetBundle file doesn't exist.

AddAssetBundles

void AddAssetBundles(
  IDictionary< DeviceTier, string > deviceTierToAssetBundleFilePath,
  AssetPackDeliveryMode deliveryMode
)

Package the specified AssetBundle files, which vary only by DeviceTier, in an AssetPack with the specified delivery mode.

When using Play Asset Delivery APIs, only the AssetBundle for the device's tier will be delivered.

AddAssetBundles

void AddAssetBundles(
  IDictionary< string, string > deviceGroupToAssetBundleFilePath,
  AssetPackDeliveryMode deliveryMode
)

Package the specified AssetBundle files, which vary only by device group, in an AssetPack with the specified delivery mode.

When using Play Asset Delivery APIs, only the AssetBundle for the device's group will be delivered.

AddAssetsFolder

void AddAssetsFolder(
  string assetPackName,
  string assetsFolderPath,
  AssetPackDeliveryMode deliveryMode
)

Package all raw assets in the specified folder in an AssetPack with the specified name and using the specified delivery mode.

Details

Parameters

`assetPackName`	The name of the asset pack.
`assetsFolderPath`	The path to a directory whose files will be directly copied into the asset pack during app bundle creation.
`deliveryMode`	The AssetPackDeliveryMode for the asset pack.

Exceptions

`ArgumentException`	If the assetPackName is invalid.
`FileNotFoundException`	If the assetsFolderPath doesn't exist.

AddAssetsFolders

void AddAssetsFolders(
  string assetPackName,
  IDictionary< TextureCompressionFormat, string > compressionFormatToAssetPackDirectoryPath,
  AssetPackDeliveryMode deliveryMode
)

Package the specified raw assets in the specified folders, keyed by TextureCompressionFormat, in an AssetPack with the specified delivery mode.

When using Play Asset Delivery APIs, only the folder for the device's preferred texture compression format will be delivered.

Details

Parameters

`assetPackName`	The name of the asset pack.
`compressionFormatToAssetPackDirectoryPath`	A dictionary from TextureCompressionFormat to the path of directories of files that will be directly copied into the asset pack during app bundle creation.
`deliveryMode`	The AssetPackDeliveryMode for the asset pack.

Exceptions

ArgumentException

If the dictionary or asset pack name is invalid.

AddAssetsFolders

void AddAssetsFolders(
  string assetPackName,
  IDictionary< DeviceTier, string > deviceTierToAssetPackDirectoryPath,
  AssetPackDeliveryMode deliveryMode
)

Package the specified raw assets in the specified folders, keyed by DeviceTier, in an AssetPack with the specified delivery mode.

When using Play Asset Delivery APIs, only the AssetBundle for the device's tier will be delivered.

AddAssetsFolders

void AddAssetsFolders(
  string assetPackName,
  IDictionary< string, string > deviceGroupToAssetPackDirectoryPath,
  AssetPackDeliveryMode deliveryMode
)

Package the specified raw assets in the specified folders, keyed by device group, in an AssetPack with the specified delivery mode.

When using Play Asset Delivery APIs, only the AssetBundle for the device's group will be delivered.

HasDeliveredAssetPacks

bool HasDeliveredAssetPacks()

Returns true if this configuration includes at least 1 asset pack that may be packaged in an AAB.

Return true if SplitBaseModuleAssets is enabled, even if there are no other asset packs.