Version: 2023.2
LanguageEnglish
  • C#

Progress.GetCurrentStep

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

Declaration

public static int GetCurrentStep(int id);

Parameters

id The progress indicator's unique ID.

Returns

int The current step.

Description

Gets the current step for a progress indicator.

Returns -1 if the indicator is not set to report progress in steps. To set the type of steps that the progress window displays, use Progress.SetStepLabel.

Additional resources: Progress.Report, Progress.GetTotalSteps, Progress.GetStepLabel, Progress.SetStepLabel.