Unity - Scripting API: Progress.Report
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.
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.
Declaration
public static void Report(int id, float progress);
Declaration
public static void Report(int id, float progress, string description);
Declaration
public static void Report(int id, int currentStep, int totalSteps);
Declaration
public static void Report(int id, int currentStep, int totalSteps, string description);
Parameters
| Parameter | Description |
|---|---|
| id | The progress indicator's unique ID. |
| progress | A new progress value between 0 and 1. |
| description | 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 "". |
| currentStep | An updated current step. |
| totalSteps | An updated total number of steps, from start to finish. |
Description
Reports a running progress indicator's current status.