Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

EditorUtility.ClearProgressBar

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

public static function ClearProgressBar(): void;
public static void ClearProgressBar();

Description

Removes progress bar.

Will remove any progress bar previously shown using EditorUtility.DisplayProgressBar.

See Also: DisplayProgressBar, DisplayCancelableProgressBar functions.

	// Simple Editor Script that fills a cancelable bar in the given seconds.

class DisplayCancelableProgressBar extends EditorWindow { var secs = 10.0; var startVal = 0; var progress = 0;

@MenuItem("Examples/Cancelable Progress Bar Usage") static function Init() { var window = GetWindow(DisplayCancelableProgressBar); window.Show(); }

function OnGUI() { secs = EditorGUILayout.IntField("Time to wait:", secs); if(GUILayout.Button("Display bar")) { if(secs < 1) { Debug.LogError("Seconds should be bigger than 1"); return; } startVal = EditorApplication.timeSinceStartup; } if(progress < secs) { if(EditorUtility.DisplayCancelableProgressBar( "Simple Progress Bar", "Shows a progress bar for the given seconds", progress/secs)) { Debug.Log("Progress bar canceled by the user"); startVal = 0; } } else { EditorUtility.ClearProgressBar(); } progress = EditorApplication.timeSinceStartup - startVal; }

function OnInspectorUpdate() { Repaint(); } }