Report
Reports a running progress indicator's current status.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor
Report(int, float)
Reports a running progress indicator's current status.
public static void Report(int id, float progress)
Parameters
Remarks
When you report in steps, you can set the label for the steps with Progress.SetStepLabel. Note: Changes are applied on the next application tick unless you call this function from the main thread using a synchronous progress indicator (see Synchronous).
Additional Resources: Progress.Report, Progress.GetProgress, Progress.GetDescription, Progress.SetDescription.
Report(int, int, int)
Reports a running progress indicator's current status.
public static void Report(int id, int currentStep, int totalSteps)
Parameters
Remarks
When you report in steps, you can set the label for the steps with Progress.SetStepLabel. Note: Changes are applied on the next application tick unless you call this function from the main thread using a synchronous progress indicator (see Synchronous).
Additional Resources: Progress.Report, Progress.GetProgress, Progress.GetDescription, Progress.SetDescription.
Report(int, float, string)
Reports a running progress indicator's current status.
public static void Report(int id, float progress, string description)
Parameters
The progress indicator's unique ID.
A new progress value between 0 and 1.
An updated description of the progress indicator. If the the progress status has not changed, or you do not set a description, this is null. To clear the current progress description, pass an empty string such as "".
Remarks
When you report in steps, you can set the label for the steps with Progress.SetStepLabel. Note: Changes are applied on the next application tick unless you call this function from the main thread using a synchronous progress indicator (see Synchronous).
Additional Resources: Progress.Report, Progress.GetProgress, Progress.GetDescription, Progress.SetDescription.
Report(int, int, int, string)
Reports a running progress indicator's current status.
public static void Report(int id, int currentStep, int totalSteps, string description)
Parameters
The progress indicator's unique ID.
An updated current step.
An updated total number of steps, from start to finish.
An updated description of the progress indicator. If the the progress status has not changed, or you do not set a description, this is null. To clear the current progress description, pass an empty string such as "".
Remarks
When you report in steps, you can set the label for the steps with Progress.SetStepLabel. Note: Changes are applied on the next application tick unless you call this function from the main thread using a synchronous progress indicator (see Synchronous).
Additional Resources: Progress.Report, Progress.GetProgress, Progress.GetDescription, Progress.SetDescription.