Class BuildScriptPlayAssetDelivery

In addition to the Default Build Script behavior (building AssetBundles), this script assigns Android bundled content to "install-time", fast-follow" or "on-demand" asset packs using data from PlayAssetDeliverySchema. All "install-time" content is being assigned to the 'AddressablesAssetPack' which is guaranteed to be "install-time".

We will generate some files to create asset packs in Gradle project using PlayAssetDeliveryModifyProjectScript and to store build and runtime data. These files are located in 'Assets/PlayAssetDelivery/Build/aa*' folders:

• Create a 'BuildProcessorData.json' file to store the build paths and Gradle project paths for bundles that should be copied to asset packs. When building Player this will be used by the PlayAssetDeliveryModifyProjectScript to copy bundles to their corresponding Gradle project paths.
• Create a 'CustomAssetPacksData.json' file to store custom asset pack information to be used at runtime. See PlayAssetDeliveryInitialization. Also when building Player Addressables 'catalog.json' and 'settings.json' files are being relocated to the 'AddressablesAssetPack'.

Any content of Addressables.BuildPath directory which is not assigned to asset packs will be included in the streaming assets pack. This happens with the groups which don't have PlayAssetDeliverySchema and Build path in their Content Packing & Loading schema is set to Local, and also with the groups with delivery type set to "None" in PlayAssetDeliverySchema.

Inheritance

object

Object

ScriptableObject

BuildScriptBase

BuildScriptPackedMode

BuildScriptPlayAssetDelivery

Implements

IDataBuilder

Inherited Members

BuildScriptPackedMode.CanBuildData<T>()

BuildScriptPackedMode.ProcessGroup(AddressableAssetGroup, AddressableAssetsBuildContext)

BuildScriptPackedMode.ProcessGroupSchema(AddressableAssetGroupSchema, AddressableAssetGroup, AddressableAssetsBuildContext)

BuildScriptPackedMode.ProcessBundledAssetSchema(BundledAssetGroupSchema, AddressableAssetGroup, AddressableAssetsBuildContext)

BuildScriptPackedMode.PrepGroupBundlePacking(AddressableAssetGroup, List<AssetBundleBuild>, BundledAssetGroupSchema, Func<AddressableAssetEntry, bool>)

BuildScriptPackedMode.ConstructAssetBundleName(AddressableAssetGroup, BundledAssetGroupSchema, BundleDetails, string)

BuildScriptPackedMode.IsDataBuilt()

BuildScriptBase.BuiltInBundleBaseName

BuildScriptBase.instanceProviderType

BuildScriptBase.sceneProviderType

BuildScriptBase.Log

BuildScriptBase.BuildData<TResult>(AddressablesDataBuilderInput)

BuildScriptBase.ProcessAllGroups(AddressableAssetsBuildContext)

BuildScriptBase.DeleteFile(string)

BuildScriptBase.WriteFile(string, byte[], FileRegistry)

BuildScriptBase.WriteFile(string, string, FileRegistry)

BuildScriptBase.CopyAndRegisterContentState(string, string, AddressablesDataBuilderInput, AddressablesPlayerBuildResult)

BuildScriptBase.NotifyUserAboutBuildReport()

BuildScriptBase.DisplayBuildReport()

BuildScriptBase.ClearContentUpdateNotifications(List<AddressableAssetGroup>)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEditor.AddressableAssets.Android

Assembly: Unity.Addressables.Android.Editor.dll

Syntax

[CreateAssetMenu(fileName = "BuildScriptPlayAssetDelivery.asset", menuName = "Addressables/Custom Build/Play Asset Delivery")]
public class BuildScriptPlayAssetDelivery : BuildScriptPackedMode, IDataBuilder

Properties

Name

The descriptive name used in the UI.

Declaration

public override string Name { get; }

Property Value

Type	Description
string

Overrides

UnityEditor.AddressableAssets.Build.DataBuilders.BuildScriptPackedMode.Name

Methods

BuildDataImplementation<TResult>(AddressablesDataBuilderInput)

Android specific implementation of BuildData<TResult>. When building for Android, actual builds happen for all target texture compressions.

Declaration

protected override TResult BuildDataImplementation<TResult>(AddressablesDataBuilderInput builderInput) where TResult : IDataBuilderResult

Parameters

Type	Name	Description
AddressablesDataBuilderInput	builderInput	The builderInput object used in the build

Returns

Type	Description
TResult	The build data result

Type Parameters

Name	Description
TResult	The type of data to build

Overrides

UnityEditor.AddressableAssets.Build.DataBuilders.BuildScriptPackedMode.BuildDataImplementation<TResult>(UnityEditor.AddressableAssets.Build.AddressablesDataBuilderInput)

ClearCachedData()

Used to clean up any cached data created by this builder.

Declaration

public override void ClearCachedData()

Overrides

UnityEditor.AddressableAssets.Build.DataBuilders.BuildScriptPackedMode.ClearCachedData()

DoBuild<TResult>(AddressablesDataBuilderInput, AddressableAssetsBuildContext)

The method that actually builds Addressables for the specific texture compression and creates json files required to prepare Android Gradle project.

Declaration

protected override TResult DoBuild<TResult>(AddressablesDataBuilderInput builderInput, AddressableAssetsBuildContext aaContext) where TResult : IDataBuilderResult

Parameters

Type	Name	Description
AddressablesDataBuilderInput	builderInput	The builderInput object used in the build
AddressableAssetsBuildContext	aaContext	Context object for passing data through SBP, between different sections of Addressables code

Returns

Type	Description
TResult	The build data result for the specific texture compression

Type Parameters

Name	Description
TResult	The type of data to build

Overrides

UnityEditor.AddressableAssets.Build.DataBuilders.BuildScriptPackedMode.DoBuild<TResult>(UnityEditor.AddressableAssets.Build.AddressablesDataBuilderInput, UnityEditor.AddressableAssets.Build.DataBuilders.AddressableAssetsBuildContext)

Implements

UnityEditor.AddressableAssets.Build.IDataBuilder