Class BuildProgress

Scoped progress indicator that will clear itself on dispose.

Inheritance

Object

BuildProgress

Namespace: Unity.Build

Syntax

public sealed class BuildProgress : IDisposable

Constructors

BuildProgress(String, String, Single)

Initialize a new instance of the BuildProgress class, which acts as a scoped progress indicator.

Declaration

public BuildProgress(string title, string info, float percent = 0F)

Parameters

Type	Name	Description
String	title	Title of the progress indicator.
String	info	Information of the progress indicator.
Single	percent	Completion percent of the progress indicator.

Properties

Info

Update or get the information of the progress indicator.

Declaration

public string Info { get; set; }

Property Value

Type	Description
String

Percent

Update or get the completion percent of the progress indicator.

Declaration

public float Percent { get; set; }

Property Value

Type	Description
Single

Title

Update or get the title of the progress indicator.

Declaration

public string Title { get; set; }

Property Value

Type	Description
String

Methods

Dispose()

Declaration

public void Dispose()

Update()

Update the progress indicator. Returns true if user cancelled.

Declaration

public bool Update()

Returns

Type	Description
Boolean	true if the user cancelled, false otherwise.

Update(Single)

Update the progress indicator. Returns true if user cancelled.

Declaration

public bool Update(float percent)

Parameters

Type	Name	Description
Single	percent	Completion percent of the progress indicator.

Returns

Type	Description
Boolean	true if the user cancelled, false otherwise.

Update(String, Single)

Update the progress indicator. Returns true if user cancelled.

Declaration

public bool Update(string info, float percent)

Parameters

Type	Name	Description
String	info	Information of the progress indicator.
Single	percent	Completion percent of the progress indicator.

Returns

Type	Description
Boolean	true if the user cancelled, false otherwise.

Update(String, String, Single)

Update the progress indicator. Returns true if user cancelled.

Declaration

public bool Update(string title, string info, float percent)

Parameters

Type	Name	Description
String	title	Title of the progress indicator.
String	info	Information of the progress indicator.
Single	percent	Completion percent of the progress indicator.

Returns

Type	Description
Boolean	true if the user cancelled, false otherwise.