Class BuildScriptPackedMode

Build scripts used for player builds and running with bundles in the editor.

Inheritance
Object
Object
ScriptableObject
BuildScriptBase
BuildScriptPackedMode
Inherited Members
Namespace: UnityEditor.AddressableAssets.Build.DataBuilders
Syntax
[CreateAssetMenu(fileName = "BuildScriptPacked.asset", menuName = "Addressables/Content Builders/Default Build Script")]
public class BuildScriptPackedMode : BuildScriptBase, IDataBuilder

Properties

Name

The descriptive name used in the UI.

Declaration
public override string Name { get; }
Property Value
Type Description
String
Overrides

Methods

BuildDataImplementation<TResult>(AddressablesDataBuilderInput)

The implementation of BuildData<TResult>(AddressablesDataBuilderInput). That is the public entry point, this is the home for child class overrides.

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

CanBuildData<T>()

Used to determine if this builder is capable of building a specific type of data.

Declaration
public override bool CanBuildData<T>()
    where T : IDataBuilderResult
Returns
Type Description
Boolean

True if this builder can build this data.
Type Parameters
Name Description
T

The type of data needed to be built.
Overrides

ClearCachedData()

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

Declaration
public override void ClearCachedData()
Overrides

ConstructAssetBundleName(AddressableAssetGroup, BundledAssetGroupSchema, BundleDetails, String)

Creates a name for an asset bundle using the provided information.

Declaration
protected virtual string ConstructAssetBundleName(AddressableAssetGroup assetGroup, BundledAssetGroupSchema schema, BundleDetails info, string assetBundleName)
Parameters
Type Name Description
AddressableAssetGroup assetGroup

The asset group.
BundledAssetGroupSchema schema

The schema of the group.
BundleDetails info

The bundle information.
String assetBundleName

The base name of the asset bundle.
Returns
Type Description
String

Returns the asset bundle name with the provided information.

DoBuild<TResult>(AddressablesDataBuilderInput, AddressableAssetsBuildContext)

The method that does the actual building after all the groups have been processed.

Declaration
protected virtual TResult DoBuild<TResult>(AddressablesDataBuilderInput builderInput, AddressableAssetsBuildContext aaContext)
    where TResult : IDataBuilderResult
Parameters
Type Name Description
AddressablesDataBuilderInput builderInput

The generic builderInput of the
AddressableAssetsBuildContext aaContext
Returns
Type Description
TResult
Type Parameters
Name Description
TResult

IsDataBuilt()

Checks to see if the data is built for the given builder.

Declaration
public override bool IsDataBuilt()
Returns
Type Description
Boolean

Returns true if the data is built. Returns false otherwise.
Overrides

ProcessBundledAssetSchema(BundledAssetGroupSchema, AddressableAssetGroup, AddressableAssetsBuildContext)

The processing of the bundled asset schema. This is where the bundle(s) for a given group are actually setup.

Declaration
protected virtual string ProcessBundledAssetSchema(BundledAssetGroupSchema schema, AddressableAssetGroup assetGroup, AddressableAssetsBuildContext aaContext)
Parameters
Type Name Description
BundledAssetGroupSchema schema

The BundledAssetGroupSchema to process
AddressableAssetGroup assetGroup

The group this schema was pulled from
AddressableAssetsBuildContext aaContext

The general Addressables build builderInput
Returns
Type Description
String

The error string, if any.

ProcessGroup(AddressableAssetGroup, AddressableAssetsBuildContext)

Build processing of an individual group.

Declaration
protected override string ProcessGroup(AddressableAssetGroup assetGroup, AddressableAssetsBuildContext aaContext)
Parameters
Type Name Description
AddressableAssetGroup assetGroup

The group to process
AddressableAssetsBuildContext aaContext

The Addressables builderInput object to base the group processing on
Returns
Type Description
String

An error string if there were any problems processing the groups
Overrides

ProcessGroupSchema(AddressableAssetGroupSchema, AddressableAssetGroup, AddressableAssetsBuildContext)

Called per group per schema to evaluate that schema. This can be an easy entry point for implementing the build aspects surrounding a custom schema. Note, you should not rely on schemas getting called in a specific order.

Declaration
protected virtual string ProcessGroupSchema(AddressableAssetGroupSchema schema, AddressableAssetGroup assetGroup, AddressableAssetsBuildContext aaContext)
Parameters
Type Name Description
AddressableAssetGroupSchema schema

The schema to process
AddressableAssetGroup assetGroup

The group this schema was pulled from
AddressableAssetsBuildContext aaContext

The general Addressables build builderInput
Returns
Type Description
String