Version: 2023.2
LanguageEnglish
  • C#
Method group is Obsolete

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

Description

This class is used to report an error when using Progress.RunTask(...).

[MenuItem("Progress/Run Task With Error", priority = 25)]
static void RunTaskWithError()
{
    Progress.RunTask("Task With Error", null, (id, data) => TaskWithError());
}

static IEnumerator TaskWithError() { for (var i = 0; i < 100; ++i) { yield return WaitForSeconds(0.1f); if (i < 75) yield return new Progress.TaskReport(i / 100.0f); else yield return new Progress.TaskError("Forcing an error when reaching 75%."); } }

Additional resources: Progress.Progress.