Class BuildScriptSchemaDriven

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

Inheritance

object

Object

ScriptableObject

BuildScriptBase

BuildScriptSchemaDriven

BuildScriptPackedMode.PackedModeSchemaDriven

Implements

IDataBuilder

Inherited Members

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.CopyAndRegisterContentState(string, string, FileRegistry, AddressablesPlayerBuildResult)

BuildScriptBase.NotifyUserAboutBuildReport()

BuildScriptBase.DisplayBuildReport()

BuildScriptBase.ClearContentUpdateNotifications(List<AddressableAssetGroup>)

BuildScriptBase.CreateCatalogBuilder(AddressableAssetSettings)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

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

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

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

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

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.Build.DataBuilders

Assembly: Unity.Addressables.Editor.dll

Syntax

[CreateAssetMenu(fileName = "BuildScriptSchemaDriver.asset", menuName = "Addressables/Content Builders/Default Build Schema Driven")]
[AddressablesHelpURL("Builds.html")]
public class BuildScriptSchemaDriven : BuildScriptBase, IDataBuilder

Remarks

This is the preferred base class for custom Addressables build scripts. Subclass it and override CreateSchemaBuilders() to add, replace, or wrap the schema builders that drive the build. Most build customisations — bundle packing, catalog generation, content update logic — should be implemented by subclassing the relevant ISchemaBuilder (e.g. BundledAssetSchemaBuilder) and returning it from CreateSchemaBuilders(), rather than overriding methods on the build script itself.

BuildScriptPackedMode extends this class with additional virtual hooks (ProcessBundledAssetSchema, ConstructAssetBundleName) for compatibility with earlier extension patterns. New code should prefer schema-builder overrides instead.

Properties

Name	Description
Name	The descriptive name used in the UI.
SchemaBuilders	Gets the schema builders used by this build script to process different group schemas. Schema builders are created lazily via CreateSchemaBuilders().

Methods

Name	Description
BuildDataImplementation<TResult>(AddressablesDataBuilderInput)	The implementation of BuildData<TResult>(AddressablesDataBuilderInput). That is the public entry point, this is the home for child class overrides.
CanBuildData<T>()	Used to determine if this builder is capable of building a specific type of data.
ClearCachedData()	Used to clean up any cached data created by this builder.
ConstructAssetBundleName(AddressableAssetGroup, BundledAssetGroupSchema, BundleDetails, string)	Creates a name for an asset bundle using the provided information.
CreateSchemaBuilders()	Creates and returns the schema builders used to process group schemas during the build. Override this method to provide custom schema builders.
DoBuild<TResult>(AddressablesDataBuilderInput, AddressableAssetsBuildContext)	The method that does the actual building after all the groups have been processed.
IsDataBuilt()	Checks to see if the data is built for the given builder.
PrepGroupBundlePacking(AddressableAssetGroup, List<AssetBundleBuild>, BundledAssetGroupSchema, Func<AddressableAssetEntry, bool>)	Processes an AddressableAssetGroup and generates AssetBundle input definitions based on the BundlePackingMode.
ProcessBundledAssetSchema(BundledAssetGroupSchema, AddressableAssetGroup, AddressableAssetsBuildContext)	The processing of the bundled asset schema. This is where the bundle(s) for a given group are actually setup.
ProcessGroup(AddressableAssetGroup, AddressableAssetsBuildContext)	Build processing of an individual group.
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.