Report
Reports the progress indicator's current status.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
Report(float)
Reports the progress indicator's current status.
public void Report(float newProgress)
Parameters
A new progress value between 0 and 1.
Remarks
When you report in steps, you can set the label for the steps with Progress.Item.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.Item.progress, Progress.Item.description, Progress.Item.SetDescription.
Report(int, int)
Reports the progress indicator's current status.
public void Report(int newCurrentStep, int newTotalSteps)
Parameters
Remarks
When you report in steps, you can set the label for the steps with Progress.Item.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.Item.progress, Progress.Item.description, Progress.Item.SetDescription.
Report(float, string)
Reports the progress indicator's current status.
public void Report(float newProgress, string newDescription)
Parameters
Remarks
When you report in steps, you can set the label for the steps with Progress.Item.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.Item.progress, Progress.Item.description, Progress.Item.SetDescription.
Report(int, int, string)
Reports the progress indicator's current status.
public void Report(int newCurrentStep, int newTotalSteps, string newDescription)
Parameters
An updated current step.
An updated total number of steps.
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.Item.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.Item.progress, Progress.Item.description, Progress.Item.SetDescription.