Class BuildPipeline

Stores BuildStep (or BuildPipeline) and RunStep instructions to be executed when building or running this pipeline.

Inheritance

Object

ScriptableObjectPropertyContainer<BuildPipeline>

BuildPipeline

Inherited Members

ScriptableObjectPropertyContainer<BuildPipeline>.CreateInstance(Action<BuildPipeline>)

ScriptableObjectPropertyContainer<BuildPipeline>.CreateAsset(String, Action<BuildPipeline>)

ScriptableObjectPropertyContainer<BuildPipeline>.CreateAssetInActiveDirectory(String, Action<BuildPipeline>)

ScriptableObjectPropertyContainer<BuildPipeline>.LoadAsset(String)

ScriptableObjectPropertyContainer<BuildPipeline>.LoadAsset(GUID)

ScriptableObjectPropertyContainer<BuildPipeline>.SaveAsset(String)

ScriptableObjectPropertyContainer<BuildPipeline>.RestoreAsset()

ScriptableObjectPropertyContainer<BuildPipeline>.IsModified()

ScriptableObjectPropertyContainer<BuildPipeline>.SerializeToJson()

ScriptableObjectPropertyContainer<BuildPipeline>.DeserializeFromJson(BuildPipeline, String)

ScriptableObjectPropertyContainer<BuildPipeline>.SerializeToPath(String)

ScriptableObjectPropertyContainer<BuildPipeline>.DeserializeFromPath(BuildPipeline, String)

ScriptableObjectPropertyContainer<BuildPipeline>.OnBeforeSerialize()

ScriptableObjectPropertyContainer<BuildPipeline>.OnAfterDeserialize()

Namespace: Unity.Build

Syntax

public sealed class BuildPipeline : ScriptableObjectPropertyContainer<BuildPipeline>, ISerializationCallbackReceiver, IBuildStep

Fields

AssetExtension

File extension for BuildPipeline assets.

Declaration

public const string AssetExtension = ".buildpipeline"

Field Value

Type	Description
String

BuildSteps

The list of BuildStep (or BuildPipeline) to be executed when calling Build(BuildConfiguration, BuildProgress, Action<BuildContext>).

Declaration

public List<IBuildStep> BuildSteps

Field Value

Type	Description
List<IBuildStep>

RunStep

The RunStep to be executed when calling Run(BuildConfiguration).

Declaration

public RunStep RunStep

Field Value

Type	Description
RunStep

Methods

Build(BuildConfiguration, BuildProgress, Action<BuildContext>)

Build this BuildPipeline.

Declaration

public BuildPipelineResult Build(BuildConfiguration config, BuildProgress progress = null, Action<BuildContext> mutator = null)

Parameters

Type	Name	Description
BuildConfiguration	config	The BuildConfiguration used for the build.
BuildProgress	progress	Optional build progress that will be displayed when executing the build.
Action<BuildContext>	mutator	Optional mutator that can be used to modify the BuildContext before building.

Returns

Type	Description
BuildPipelineResult	The result of building this BuildPipeline.

CanBuild(BuildConfiguration, out String)

Determine if this BuildPipeline can build.

Declaration

public bool CanBuild(BuildConfiguration config, out string reason)

Parameters

Type	Name	Description
BuildConfiguration	config	The BuildConfiguration used for the build.
String	reason	If CanBuild(BuildConfiguration, out String) returns false, the reason why it fails.

Returns

Type	Description
Boolean	true if this BuildPipeline can build, otherwise false.

CanRun(BuildConfiguration, out String)

Determine if this BuildPipeline can run.

Declaration

public bool CanRun(BuildConfiguration config, out string reason)

Parameters

Type	Name	Description
BuildConfiguration	config	The BuildConfiguration used for the build.
String	reason	If CanRun(BuildConfiguration, out String) returns false, the reason why it fails.

Returns

Type	Description
Boolean	The result of running this BuildPipeline.

Reset()

Declaration

protected override void Reset()

Overrides

Unity.Build.ScriptableObjectPropertyContainer<Unity.Build.BuildPipeline>.Reset()

Run(BuildConfiguration)

Run this BuildPipeline. This will attempt to run the build target produced from building this BuildPipeline.

Declaration

public RunStepResult Run(BuildConfiguration config)

Parameters

Type	Name	Description
BuildConfiguration	config

Returns

Type	Description
RunStepResult	The result of running this BuildPipeline.

Sanitize()

Declaration

protected override void Sanitize()

Overrides

Unity.Build.ScriptableObjectPropertyContainer<Unity.Build.BuildPipeline>.Sanitize()