Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Remove

Finishes and removes an active progress indicator.
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor.CoreModule

Remove(int)

Finishes and removes an active progress indicator.
public static int Remove(int id)

Parameters

id

int
The progress indicator's unique ID.

Returns

Type

Description

int-1 if the progress indicator is removed. Otherwise, returns the progress indicator's ID.

Remarks

The progress indicator is removed on the next application tick unless it is synchronous (see Synchronous). To force this method to remove the progress indicator synchronously, set the "forceSynchronous" parameter to true.

Remove(int, bool)

Finishes and removes an active progress indicator.
public static int Remove(int id, bool forceSynchronous)

Parameters

id

int
The progress indicator's unique ID.

forceSynchronous

bool
When you set this parameter to true it forces this method to remove the progress indicator synchronously.

Returns

Type

Description

int-1 if the progress indicator is removed. Otherwise, returns the progress indicator's ID.

Remarks

The progress indicator is removed on the next application tick unless it is synchronous (see Synchronous). To force this method to remove the progress indicator synchronously, set the "forceSynchronous" parameter to true.