EditorUtility.DisplayCancelableProgressBar

Description

Displays or updates a progress bar that has a cancel button.

The window title will be set to title and the info will be set to info. Progress should be set to a value between 0.0 and 1.0, where 0 means nothing done and 1.0 means 100% completed.

This is useful when you perform a long blocking operation in an Editor script, and want to notify the user about the 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.

This function's return value indicates whether the user pressed the cancel button. You must stop the task that is in progress. After you display the progress bar, clear it using ClearProgressBar.

See Also: DisplayCancelableProgressBar, ClearProgressBar methods, Progress class.


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();
        }
    }
}