Class BuildPipeline
Defines a list of IBuildStep to run in order.
Inheritance
Inherited Members
Namespace: Unity.Build
Assembly: solution.dll
Syntax
public sealed class BuildPipeline : ScriptableObjectPropertyContainer<BuildPipeline>, ISerializationCallbackReceiver, IBuildStep
Fields
| Name | Description |
|---|---|
| AssetExtension | File extension for BuildPipeline assets. |
| BuildSteps | |
| RunStep |
Properties
| Name | Description |
|---|---|
| Description | Description of this BuildPipeline displayed in build progress reporting. |
| OptionalComponents | List of IBuildSettingsComponent derived types that are optional for this BuildPipeline. |
| RequiredComponents | List of IBuildSettingsComponent derived types that are required for this BuildPipeline. |
Methods
| Name | Description |
|---|---|
| Build(BuildSettings, BuildProgress, Action<BuildContext>) | Build this BuildPipeline. |
| CanBuild(BuildSettings, out string) | Determine if this BuildPipeline can build. |
| CanRun(BuildSettings, out string) | Determine if this BuildPipeline can run. |
| CleanupBuildStep(BuildContext) | Cleanup the IBuildStep list of this BuildPipeline. Cleanup will only be called for IBuildStep that ran. |
| IsEnabled(BuildContext) | Determine if this BuildPipeline will be executed or not. |
| Reset() | Reset this asset in preparation for deserialization. |
| Run(BuildSettings) | Run this BuildPipeline. This will attempt to run the build target produced from building this BuildPipeline. |
| RunBuildStep(BuildContext) | Run the IBuildStep list of this BuildPipeline. If a IBuildStep fails, subsequent IBuildStep are not run. |
| Sanitize() | Sanitize this asset after deserialization. |