Class ProgressTracker
Keeps track of the SBP build progress.
Namespace: UnityEditor.Build.Pipeline.Utilities
Syntax
public class ProgressTracker : IProgressTracker, IContextObject, IDisposableConstructors
ProgressTracker()
Stores information about the current task.
Declaration
public ProgressTracker()Properties
CurrentTask
Stores the id of currently running task.
Declaration
protected int CurrentTask { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
CurrentTaskTitle
Stores the name of the currently running task.
Declaration
protected string CurrentTaskTitle { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Progress
Stores the amount of progress done as a decimal.
Declaration
public float Progress { get; }Property Value
| Type | Description |
|---|---|
| Single |
Implements
TaskCount
Stores the number of tasks
Declaration
public int TaskCount { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
Implements
TimeStamp
Stores current the time stamp.
Declaration
protected long TimeStamp { get; set; }Property Value
| Type | Description |
|---|---|
| Int64 |
UpdateFrequency
Stores the task update frequency.
Declaration
protected long UpdateFrequency { get; set; }Property Value
| Type | Description |
|---|---|
| Int64 |
UpdatesPerSecond
Stores the amount of updates per second.
Declaration
public uint UpdatesPerSecond { get; set; }Property Value
| Type | Description |
|---|---|
| UInt32 |
Methods
Dispose()
Disposes of the progress tracker instance.
Declaration
public void Dispose()Dispose(Boolean)
Disposes of the progress tracker instance and clears the popup progress bar.
Declaration
protected virtual void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | disposing | Set to true to clear the popup progress bar. Set to false to leave the progress bar as is. |
UpdateInfo(String)
Updates the information displayed for currently running task.
Declaration
public virtual bool UpdateInfo(string taskInfo)Parameters
| Type | Name | Description |
|---|---|---|
| String | taskInfo | The task information. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if the progress bar is running. Returns false if the user cancels the progress bar. |
Implements
UpdateTask(String)
Updates the progress bar to reflect the new running task.
Declaration
public virtual bool UpdateTask(string taskTitle)Parameters
| Type | Name | Description |
|---|---|---|
| String | taskTitle | The name of the new task. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if the progress bar is running. Returns false if the user cancels the progress bar. |