Class BuildStepResult

Holds the result of the execution of a BuildStep.

Inheritance
Object
ResultBase
BuildStepResult
Inherited Members
Namespace: Unity.Build
Syntax
public sealed class BuildStepResult : ResultBase

Constructors

BuildStepResult()

Declaration
public BuildStepResult()

BuildStepResult(BuildStep, UnityEditor.Build.Reporting.BuildReport)

Create a new instance of BuildStepResult from a .

Declaration
public BuildStepResult(BuildStep step, UnityEditor.Build.Reporting.BuildReport report)
Parameters
Type Name Description
BuildStep step

The BuildStep that was executed.
UnityEditor.Build.Reporting.BuildReport report

The report that was generated.

Properties

BuildStep

The BuildStep that was executed.

Declaration
public BuildStep BuildStep { get; }
Property Value
Type Description
BuildStep

Description

Description of the BuildStep.

Declaration
public string Description { get; }
Property Value
Type Description
String

Methods

Failure(BuildStep, Exception)

Create a new instance of BuildStepResult that represent a failed execution.

Declaration
public static BuildStepResult Failure(BuildStep step, Exception exception)
Parameters
Type Name Description
BuildStep step

The BuildStep that was executed.
Exception exception

The exception.
Returns
Type Description
BuildStepResult

A new BuildStepResult instance.

Failure(BuildStep, String)

Create a new instance of BuildStepResult that represent a failed execution.

Declaration
public static BuildStepResult Failure(BuildStep step, string message)
Parameters
Type Name Description
BuildStep step

The BuildStep that was executed.
String message

The failure message.
Returns
Type Description
BuildStepResult

A new BuildStepResult instance.

Success(BuildStep)

Create a new instance of BuildStepResult that represent a successful execution.

Declaration
public static BuildStepResult Success(BuildStep step)
Parameters
Type Name Description
BuildStep step

The BuildStep that was executed.
Returns
Type Description
BuildStepResult

A new BuildStepResult instance.

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

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