Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

EditorUtility.ClearProgressBar

static function ClearProgressBar(): void;
static void ClearProgressBar();
static def ClearProgressBar() as void

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