ScriptReference/EditorUtility.DisplayCancelableProgressBar

[docscomments[bot]]

ScriptReference/EditorUtility.DisplayCancelableProgressBar

https://docs.unity3d.com/ScriptReference/EditorUtility.DisplayCancelableProgressBar.html

[docscomments[bot]]

Comment by Dave Smeathers:

Return argument of this function tells if user had pressed the cancel button

It returns true when cancel is pressed.

[docscomments[bot]]

Comment by @ByronMayne:

A good way to use this is using Exceptions to your advantage.

public class Abort() : System.Exception {}  
  
public void Process()  
{  
    EditorUtility.ShowProgressBar("Title", "Doing Stuff", 0f);  
    try  
    {  
        ProcessAssets();   
    }  
    catch(Abort)  
    {  
        // The user hit cancel. Nothing to do here.   
    }  
    catch(Exception e)  
    {  
        // We got an an exception so lets handle it.   
    }  
    finally  
    {  
        // If we get an exception or the user cancels we always clear our progress bar   
        EditorUtility.ClearProgressBar();  
    }  
}  
  
private void ProcessAssets()  
{  
    // Complex code  
    if (EditorUtility.DisplayCancelableProgressBar("Title", "Doing Stuff", 0f))  
    {  
        throw new Abort();   
    }  
    // Other complex code  
}

Having the finally block makes sure that we always clear the progress bar when we are done. If we were to get an exception while doing our process the loading bar would stick around forever and the user would have to restart Unity. Throwing our own Abort exception allows us to break at any point and not log errors to the console.
You can also handle call Clear with IDisposable, for example:

using (var progressBar = new ScopedProgressBar("MyOp")) { }

Like this EditorScopedProgressBar by SoylentGraham