Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseDisplays or updates a progress bar that has a cancel button.
The window title sets to title
and the info sets to info
.
Set progress should to a value between 0.0 and 1.0, where 0 indicates nothing is loaded and 1.0 indicates loading is complete.
This is useful when you perform a long blocking operation in an Editor script, and want to notify the user of progress.
Use this method for long operations that make the Editor non-responsive. For long operations that happen in the background, use the Progress class instead.
A return value of true indicates that the user pressed the Cancel button. When the return value is true, you must stop the task that is in progress. After you display the progress bar, use EditorUtility.ClearProgressBar to clear it.
Additional resources: EditorUtility.DisplayProgressBar, EditorUtility.ClearProgressBar, and Progress.
Cancelable progress bar in the Editor.
using System.Threading; using UnityEditor; using UnityEngine;
// Shows a cancellable progress bar for the specified number of seconds. public class EditorUtilityDisplayCancelableProgressBar : EditorWindow { public float secs = 5f; [MenuItem("Examples/Progress Bar Usage")] static void Init() { var window = GetWindow(typeof(EditorUtilityDisplayCancelableProgressBar)); window.Show(); }
void OnGUI() { secs = EditorGUILayout.Slider("Time to wait:", secs, 1.0f, 20.0f); if (GUILayout.Button("Display bar")) { var step = 0.1f; for (float t = 0; t < secs; t += step) { if (EditorUtility.DisplayCancelableProgressBar("Cancelable", "Doing some work...", t / secs)) break; // Normally, some computation happens here. // This example uses Sleep. Thread.Sleep((int)(step * 1000.0f)); } EditorUtility.ClearProgressBar(); } } }
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.