Item

class in UnityEditor

Switch to Manual

Description

A data structure that provides information about a progress indicator.

Variables

cancellableReturns true if the progress indicator's associated event can be canceled.
descriptionReturns the progress indicator's description.
elapsedTimeReturns the number of seconds that the progress indicator has been running for.
existsChecks whether the progress indicator exists.
finishedReturns true if the progress indicator is finished, but not removed.
idReturns the progress indicator's unique identifier.
indefiniteReturns true if the progress indicator is indefinite.
nameReturns the progress indicator's name.
optionsReturns the option flags used to start the progress indicator.
parentIdReturns the unique ID of the progress indicator's parent, or -1 if the progress indicator is not a child of another progress indicator.
progressReturns the progress value of a progress indicator's associated task.
remainingTimeReturns this progress indicator's remaining time to completion.
respondingReturns true if progress is ongoing, false if the progress indicator has not received any progress report for more than 5 seconds.
runningReturns true if the progress indicator is running and active.
startTimeReturns the time when the progress indicator started.
statusReturns the progress indicator's status.
timeDisplayModeReturns the progress indicator's time display mode.
updateTimeReturns the last time the progress indicator was updated.

Public Functions

CancelCancels a running progress indicator.
ClearRemainingTimeResets the computation of the progress indicator's remaining time.
FinishMarks the progress indicator as finished.
RegisterCancelCallbackRegisters a callback that is called when the user cancels a running progress indicator's associated task.
RemoveFinishes and removes an active progress indicator.
ReportReports the progress indicator's current status.
SetDescriptionSets the progress indicator's description. To clear the description pass null.
SetRemainingTimeSets the progress indicator's remaining time, in seconds.
SetTimeDisplayModeSet a progress indicator's time display mode.
UnregisterCancelCallbackUnregisters a previously registered progress cancellation callback.