Unity - Scripting API: Progress.Start
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 int Start(string name, string description, Progress.Options options, int parentId);
Parameters
| Parameter | Description |
|---|---|
| name | The progress indicator's name. You can display the name as a title in the progress window. Use / (slash) as a separator to group child progress indicators together. |
| description | The progress indicator's initial description. You can change it using Report or SetDescription. |
| parentId | The unique ID of the parent progress indicator, if any. If the progress indicator has no parent, pass -1. |
| options | The progress indicator's initial progress options. |
Returns
int The newly created progress identifier. This identifier is used for all other APIs to update the progress status.
Description
This method starts a new progress indicator.