Interface IBuildStep
Base interface for BuildStep. Note: When writing a new build step, derive from BuildStep instead of this interface.
Namespace: Unity.Build
Syntax
public interface IBuildStepProperties
Description
Description of this IBuildStep displayed in build progress reporting.
Declaration
string Description { get; }Property Value
| Type | Description |
|---|---|
| String |
OptionalComponents
List of IBuildSettingsComponent derived types that are optional for this IBuildStep.
Declaration
Type[] OptionalComponents { get; }Property Value
| Type | Description |
|---|---|
| Type[] |
RequiredComponents
List of IBuildSettingsComponent derived types that are required for this IBuildStep.
Declaration
Type[] RequiredComponents { get; }Property Value
| Type | Description |
|---|---|
| Type[] |
Methods
CleanupBuildStep(BuildContext)
Cleanup this IBuildStep. Cleanup will only be called if this IBuildStep ran.
Declaration
BuildStepResult CleanupBuildStep(BuildContext context)Parameters
| Type | Name | Description |
|---|---|---|
| BuildContext | context | The BuildContext used by the execution of this IBuildStep. |
Returns
| Type | Description |
|---|---|
| BuildStepResult |
IsEnabled(BuildContext)
Determine if this IBuildStep will be executed or not.
Declaration
bool IsEnabled(BuildContext context)Parameters
| Type | Name | Description |
|---|---|---|
| BuildContext | context | The BuildContext used by the execution of this IBuildStep. |
Returns
| Type | Description |
|---|---|
| Boolean | true if enabled, false otherwise. |
RunBuildStep(BuildContext)
Run this IBuildStep. If a previous IBuildStep fails, this IBuildStep will not run.
Declaration
BuildStepResult RunBuildStep(BuildContext context)Parameters
| Type | Name | Description |
|---|---|---|
| BuildContext | context | The BuildContext used by the execution of this IBuildStep. |
Returns
| Type | Description |
|---|---|
| BuildStepResult | The result of running this IBuildStep. |