Class ClassicBuildPipelineCustomizer

The classic build pipeline allows itself to be customized through this base class. In order to use this functionality, create a class in your own code, and make it implement this class. You then have an opportunity to overide one of the several customization methods.

Inheritance

object

ClassicBuildPipelineCustomizer

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Build.Classic

Assembly: solution.dll

Syntax

public abstract class ClassicBuildPipelineCustomizer

Properties

Name	Description
BuildTarget	The BuildTarget enum that is used for this build
Context
EmbeddedScenes	The list of scenes that is going to be embedded in this build.
OutputBuildDirectory	The output directory this build is being built into
StreamingAssetsDirectory	If you use this property to construct a target path in your RegisterAdditionalFilesToDeploy implementation, your file will be placed in the builds' streamingassets folder (which is in slightly different locations on different platforms)
UsedComponents	If in any of the methods if this class that you implemented, you query the BuildContext for certain compmonents You have to register those component types ahead of time. This allows us to show the user visually which components will be actually used by a build, and which ones will not.
WorkingDirectory	This is a working directory you can use to store files for this build. Common usecase is to generate the files you want to add to a build in this directory, and then use RegisterAdditionalFilesToDeploy to copy them to a directory in the build outputs. (Usually StreamingAssetsDirectory). We provide this working directory, because in many cases generating these files can be done much faster if you have previously generated files around. (Like when you use Unity.ScriptableBuildPipeline package to create assetbundles.

Methods

Name	Description
ModifyEmbeddedScenes(string[])	Override this method if you want to change which scenes will be embedded in this build.
OnBeforeBuild()	Override this method to have an opportunity to run some code before the build is built.
ProvideBuildOptions()	Override this method if you want to change the BuildOptions enum that the build gets used for the build. You can only add flags, not remove them.
ProvidePlayerScriptingDefines()	Override this method if you want to add extra scripting defines to the player build. Note: Only available with Unity version 2020.1 or higher.
RegisterAdditionalFilesToDeploy(Action<string, string>)	Override this method to register additional files you want to copy into the build. You will not do the copy yourself, instead call the provided registerAdditionalFileToDeploy callback, with a sourcefile and a targetfile. You can use the WorkingDirectory property to find a good place to generate your source file. You can use the StreamingAssetsDirectory property to find a good place to copy your file into.