Class BuildStep

Base class for build steps that are executed througout a BuildPipeline.

Inheritance

object

BuildStep

Implements

IBuildStep

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Build

Assembly: solution.dll

Syntax

public abstract class BuildStep : IBuildStep

Properties

Name	Description
Description	Description of this BuildStep displayed in build progress reporting.
OptionalComponents	List of IBuildSettingsComponent derived types that are optional for this BuildStep.
RequiredComponents	List of IBuildSettingsComponent derived types that are required for this BuildStep.

Methods

Name	Description
CleanupBuildStep(BuildContext)	Cleanup this BuildStep. Cleanup will only be called if this BuildStep ran.
Failure(string)	Construct BuildStepResult from this IBuildStep that represent a failed execution.
GetAvailableTypes(Func<Type, bool>)	Retrieves a list of valid types for build steps.
GetOptionalComponent(BuildContext, Type)	Get the value of an optional Type component from BuildSettings. The component Type must exist in the OptionalComponents list. If the component is not found in BuildSettings, a new instance of type Type is returned.
GetOptionalComponent<T>(BuildContext)	Get the value of an optional T component from BuildSettings. The component Type must exist in the OptionalComponents list. If the component is not found in BuildSettings, a new instance of type T is returned.
GetOptionalComponents(BuildContext)	Get all optional components from BuildSettings. Optional component types not found in BuildSettings will be set to a new instance of that type.
GetOptionalComponents(BuildContext, Type)	Get all optional components from BuildSettings, that matches Type. Optional component types not found in BuildSettings will be set to a new instance of that type.
GetOptionalComponents<T>(BuildContext)	Get all optional components from BuildSettings, that matches T. Optional component types not found in BuildSettings will be set to a new instance of that type.
GetRequiredComponent(BuildContext, Type)	Get the value of a required Type component from BuildSettings. The component Type must exist in the RequiredComponents list.
GetRequiredComponent<T>(BuildContext)	Get the value of a required T component from BuildSettings. The component Type must exist in the RequiredComponents list.
GetRequiredComponents(BuildContext)	Get all required components from BuildSettings.
GetRequiredComponents(BuildContext, Type)	Get all required components from BuildSettings, that matches Type.
GetRequiredComponents<T>(BuildContext)	Get all required components from BuildSettings, that matches T.
HasOptionalComponent(BuildContext, Type)	Determine if an optional Type component is stored in BuildSettings. The component Type must exist in the OptionalComponents list.
HasOptionalComponent<T>(BuildContext)	Determine if an optional T component is stored in BuildSettings. The component Type must exist in the OptionalComponents list.
HasRequiredComponent(BuildContext, Type)	Determine if a required Type component is stored in BuildSettings. The component Type must exist in the RequiredComponents list.
HasRequiredComponent<T>(BuildContext)	Determine if a required T component is stored in BuildSettings. The component Type must exist in the RequiredComponents list.
IsEnabled(BuildContext)	Determine if this BuildStep will be executed or not.
RunBuildStep(BuildContext)	Run this BuildStep. If a previous BuildStep fails, this BuildStep will not run.
Success()	Construct BuildStepResult from this IBuildStep that represent a successful execution.