The Progress utility class reports the progress of asynchronous tasks to Unity.
The Progress utility class can be used to report progress of asynchronous tasks in multiple ways. Here is an example of a task that runs on the EditorApplication.update loop and reports progress:
using System.Collections; using UnityEditor;
class ProgressReport_EditorUpdate { static IEnumerator s_CurrentEnumerator;
[MenuItem("Examples/ProgressReport/EditorUpdate")] static void RunEditorUpdate() { if (s_CurrentEnumerator == null) { s_CurrentEnumerator = RunTaskWithReport(); } EditorApplication.update -= RunTaskOnUpdate; EditorApplication.update += RunTaskOnUpdate; }
static void RunTaskOnUpdate() { if (s_CurrentEnumerator == null) { return; }
// Execute one step of the task var atEnd = !s_CurrentEnumerator.MoveNext();
// If there is nothing more to do, remove the update callback if (atEnd) { s_CurrentEnumerator = null; EditorApplication.update -= RunTaskOnUpdate; } }
static IEnumerator RunTaskWithReport() { // Create a new progress indicator int progressId = Progress.Start("Running one task");
// Report the progress status at anytime for (int frame = 0; frame <= 1000; ++frame) { string description; if (frame < 250) description = "First part of the task"; else if (frame < 750) description = "Second part of the task"; else description = "Last part of the task"; Progress.Report(progressId, frame / 1000.0f, description);
// Do your computation that you want to report progress on // ... yield return null; }
// The task is finished. Remove the associated progress indicator. Progress.Remove(progressId); } }
Here is another example of a task that runs on a separate thread and reports progress:
using System.Threading; using System.Threading.Tasks; using UnityEditor;
class ProgressReport_Threaded { [MenuItem("Examples/ProgressReport/Threaded")] static void RunThreaded() { Task.Run(RunTaskWithReport); }
static void RunTaskWithReport() { // Create a new progress indicator int progressId = Progress.Start("Running one task");
// Report the progress status at anytime for (int frame = 0; frame <= 1000; ++frame) { string description; if (frame < 250) description = "First part of the task"; else if (frame < 750) description = "Second part of the task"; else description = "Last part of the task"; Progress.Report(progressId, frame / 1000.0f, description);
// Do your computation that you want to report progress on ComputeSlowStep(); }
// The task is finished. Remove the associated progress indicator. Progress.Remove(progressId); }
static void ComputeSlowStep() { // Simulate a slow computation with a 1 millisecond sleep Thread.Sleep(1); } }
globalProgress | Returns the global average progression of all running tasks. |
globalRemainingTime | Returns the maximum time remaining for all running progress indicators. |
running | Returns true if there is at least one running progress indicator, false otherwise. |
Cancel | Cancels a runnning progress indicator, and invokes the cancel callback for the associated task. |
ClearRemainingTime | Resets the computation of a progress indicator's remaining time. |
EnumerateItems | Returns an enumerator to loop over all progress indicators. |
Exists | Checks whether a progress indicator with the specified ID exists. |
Finish | Marks the progress indicator as finished. |
GetCount | Gets the number of available progress indicators. |
GetCountPerStatus | For each available status, gets the number of progress indicators with that status. |
GetCurrentStep | Gets the current step for a progress indicator. |
GetDescription | Gets a progress indicator's description. |
GetEndDateTime | Gets the timestamp of when the progress indicator ended. |
GetId | Finds a progress indicator's unique ID using its index in the set of all available progress indicators. |
GetName | Gets a progress indicator's name. |
GetOptions | Gets the options that you specified when you started the progress indicator. |
GetParentId | Gets the unique ID of the progress indicator's parent, if any. |
GetPriority | Gets a progress indicator's priority. |
GetProgress | Gets a progress indicator's progress. |
GetProgressById | Gets information about a progress indicator. |
GetRemainingTime | Gets a progress indicator's remaining time, in seconds. |
GetRunningProgressCount | Gets the number of active or running progress indicators. |
GetStartDateTime | Gets the timestamp of when the progress indicator started. |
GetStatus | Gets the progress indicator's status. |
GetStepLabel | Gets the label that displays a progress indicator's steps. |
GetTimeDisplayMode | Get a progress indicator's time display mode. |
GetTotalSteps | Gets the total number of steps, from start to finish, for a progress indicator. |
GetUpdateDateTime | Gets the time that the progress indicator last changed, or finished. |
IsCancellable | Indicates whether you can cancel the progress indicator's associated task. |
IsPausable | Indicates whether you can pause the progress indicator's task. |
Pause | Pauses a runnning progress indicator, and invokes the pause callback for its task. |
RegisterCancelCallback | Registers a callback that is called when the user requests to cancel a running progress indicator's associated task. |
RegisterPauseCallback | Registers a callback that is called when the user requests to pause or resume a running progress indicator's task. |
Remove | Finishes and removes an active progress indicator. |
Report | Reports a running progress indicator's current status. |
Resume | Resumes a paused progress indicator, and invokes the pause callback for the associated task. |
SetDescription | Sets the progress indicator's description. To clear the description pass null. |
SetPriority | Sets a progress indicator's priority. |
SetRemainingTime | Sets the progress indicator's remaining time, in seconds. |
SetStepLabel | Sets the label that displays a progress indicator's steps. |
SetTimeDisplayMode | Set a progress indicator's time display mode. |
ShowDetails | Opens the progress window for background tasks. |
Start | This method starts a new progress indicator. |
UnregisterCancelCallback | Unregisters a previously registered progress cancellation callback. |
UnregisterPauseCallback | Unregisters a previously registered progress pause callback. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.