Class BuildStepResult
Holds the result of the execution of a IBuildStep.
Namespace: Unity.Build
Syntax
public class BuildStepResultConstructors
BuildStepResult(IBuildStep, UnityEditor.Build.Reporting.BuildReport)
Create a new instance of BuildStepResult from a
Declaration
public BuildStepResult(IBuildStep step, UnityEditor.Build.Reporting.BuildReport report)Parameters
| Type | Name | Description |
|---|---|---|
| IBuildStep | step | The IBuildStep that was executed. |
| UnityEditor.Build.Reporting.BuildReport | report | The report that was generated. |
Properties
BuildStep
The IBuildStep that was executed.
Declaration
public IBuildStep BuildStep { get; }Property Value
| Type | Description |
|---|---|
| IBuildStep |
Description
Description of the IBuildStep.
Declaration
public string Description { get; }Property Value
| Type | Description |
|---|---|
| String |
Duration
Duration of the execution of this IBuildStep.
Declaration
public TimeSpan Duration { get; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
Failed
Determine if the execution of the IBuildStep failed.
Declaration
public bool Failed { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Message
The message resulting from the execution of this IBuildStep.
Declaration
public string Message { get; }Property Value
| Type | Description |
|---|---|
| String |
Succeeded
Determine if the execution of the IBuildStep succeeded.
Declaration
public bool Succeeded { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
Failure(IBuildStep, String)
Create a new instance of BuildStepResult that represent a failed execution.
Declaration
public static BuildStepResult Failure(IBuildStep step, string message)Parameters
| Type | Name | Description |
|---|---|---|
| IBuildStep | step | The IBuildStep that was executed. |
| String | message | The failure message. |
Returns
| Type | Description |
|---|---|
| BuildStepResult | A new BuildStepResult instance. |
Success(IBuildStep)
Create a new instance of BuildStepResult that represent a successful execution.
Declaration
public static BuildStepResult Success(IBuildStep step)Parameters
| Type | Name | Description |
|---|---|---|
| IBuildStep | step | The IBuildStep that was executed. |
Returns
| Type | Description |
|---|---|
| BuildStepResult | A new BuildStepResult instance. |
Operators
Implicit(BuildStepResult to Boolean)
Implicit conversion to Boolean.
Declaration
public static implicit operator bool (BuildStepResult result)Parameters
| Type | Name | Description |
|---|---|---|
| BuildStepResult | result | Instance of BuildStepResult. |
Returns
| Type | Description |
|---|---|
| Boolean |