Class BuildStep

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

Inheritance

object

BuildStep

BuildStepApplyPlayerSettings

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
Category	Category name of this BuildStep displayed in the searcher menu.
Description	Description of this BuildStep displayed in build progress reporting.
IsShown	Determine if this BuildStep should be displayed in the inspector and searcher menu.
Name	The name of this BuildStep.
OptionalComponents	List of IBuildComponent derived types that are optional for this BuildStep.
RequiredComponents	List of IBuildComponent 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 BuildStep that represent a failed execution.
GetCategory(Type)	Get the category name displayed in the searcher menu of a BuildStep type.
GetCategory<T>()	Get the category name displayed in the searcher menu of a BuildStep type.
GetDescription(Type)	Get the description displayed in build progress reporting of a BuildStep type.
GetDescription<T>()	Get the description displayed in build progress reporting of a BuildStep type.
GetIsShown(Type)	Determine if a BuildStep type should be displayed in the inspector and searcher menu.
GetIsShown<T>()	Determine if a BuildStep type should be displayed in the inspector and searcher menu.
GetName(Type)	Get the name of a BuildStep type.
GetName<T>()	Get the name of a BuildStep type.
GetOptionalComponent(BuildContext, Type)	Get the value of an optional Type component from BuildConfiguration. The component Type must exist in the OptionalComponents list. If the component is not found in BuildConfiguration, a new instance of type Type is returned.
GetOptionalComponent<T>(BuildContext)	Get the value of an optional T component from BuildConfiguration. The component Type must exist in the OptionalComponents list. If the component is not found in BuildConfiguration, a new instance of type T is returned.
GetOptionalComponents(BuildContext)	Get all optional components from BuildConfiguration. Optional component types not found in BuildConfiguration will be set to a new instance of that type.
GetOptionalComponents(BuildContext, Type)	Get all optional components from BuildConfiguration, that matches Type. Optional component types not found in BuildConfiguration will be set to a new instance of that type.
GetOptionalComponents<T>(BuildContext)	Get all optional components from BuildConfiguration, that matches T. Optional component types not found in BuildConfiguration will be set to a new instance of that type.
GetRequiredComponent(BuildContext, Type)	Get the value of a required Type component from BuildConfiguration. The component Type must exist in the RequiredComponents list.
GetRequiredComponent<T>(BuildContext)	Get the value of a required T component from BuildConfiguration. The component Type must exist in the RequiredComponents list.
GetRequiredComponents(BuildContext)	Get all required components from BuildConfiguration.
GetRequiredComponents(BuildContext, Type)	Get all required components from BuildConfiguration, that matches Type.
GetRequiredComponents<T>(BuildContext)	Get all required components from BuildConfiguration, that matches T.
HasOptionalComponent(BuildContext, Type)	Determine if an optional Type component is stored in BuildConfiguration. The component Type must exist in the OptionalComponents list.
HasOptionalComponent<T>(BuildContext)	Determine if an optional T component is stored in BuildConfiguration. The component Type must exist in the OptionalComponents list.
HasRequiredComponent(BuildContext, Type)	Determine if a required Type component is stored in BuildConfiguration. The component Type must exist in the RequiredComponents list.
HasRequiredComponent<T>(BuildContext)	Determine if a required T component is stored in BuildConfiguration. 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 BuildStep that represent a successful execution.

Extension Methods

BuildStepExtensions.GetOutputBuildDirectory(BuildStep, BuildContext)