Interface IProgressTracker

Base interface for the build progress tracker

Namespace: UnityEditor.Build.Pipeline.Interfaces
Syntax
public interface IProgressTracker : IContextObject

Properties

Progress

Current 0.0f to 1.0f progress though the TaskCount

Declaration
float Progress { get; }
Property Value
Type Description
Single

TaskCount

Number of build tasks to run

Declaration
int TaskCount { get; set; }
Property Value
Type Description
Int32

Methods

UpdateInfo(String)

Updates the secondary information display of the progress bar.

Declaration
bool UpdateInfo(string taskInfo)
Parameters
Type Name Description
String taskInfo

The secondary information to display on the progress bar.
Returns
Type Description
Boolean

false if the build should not continue due to user interaction with the progress bar; otherwise, true.

UpdateTask(String)

Increments and updated the title of the progress bar.

Declaration
bool UpdateTask(string taskTitle)
Parameters
Type Name Description
String taskTitle

The title to display on the progress bar.
Returns
Type Description
Boolean

false if the build should not continue due to user interaction with the progress bar; otherwise, true.

Extension Methods