Interface IProgressTracker

Base interface for the build progress tracker

Namespace: UnityEditor.Build.Pipeline.Interfaces

Assembly: Unity.ScriptableBuildPipeline.Editor.dll

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
float

TaskCount

Number of build tasks to run

Declaration

int TaskCount { get; set; }

Property Value

Type	Description
int

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
bool	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
bool	false if the build should not continue due to user interaction with the progress bar; otherwise, true.