Progress

класс в UnityEditor

Описание

Служебный класс Progress сообщает Unity о ходе выполнения асинхронных задач.

public IEnumerator Run_OneTask()
{
    // Create a new progress indicator
    int progressId = Progress.Start("Running one task", 0);

    // Report the progress status at anytime
    for (int frame = 0; frame <= 1000; ++frame)
    {
        Progress.Report(progressId, "any progress update or null if it hasn't changed", frame / 1000.0f);

        // Do something else
        yield return null;
    }

    // The task is finished. Remove the associated progress indicator.
    Progress.Remove(progressId);
}

Статические Свойства

globalProgress	Возвращает глобальный средний прогресс всех запущенных задач.
globalRemainingTime	Возвращает максимальное время, оставшееся для всех запущенных индикаторов выполнения.
running	Возвращает значение true, если есть хотя бы один работающий индикатор выполнения, и значение false в противном случае.

Статические Методы

Cancel	Отменяет текущий индикатор выполнения и вызывает обратный вызов отмены для связанной задачи.
ClearRemainingTime	Сбрасывает расчет оставшегося времени индикатора выполнения.
EnumerateItems	Возвращает перечислитель для перебора всех индикаторов выполнения.
Exists	Проверяет, существует ли индикатор выполнения с указанным идентификатором.
Finish	Отмечает индикатор выполнения как завершенный.
GetCount	Получает количество доступных индикаторов выполнения.
GetCountPerStatus	Для каждого доступного статуса получает количество индикаторов прогресса с этим статусом.
GetCurrentStep	Получает текущий шаг индикатора выполнения.
GetDescription	Получает описание индикатора выполнения.
GetId	Находит уникальный идентификатор индикатора выполнения, используя его индекс в наборе всех доступных индикаторов выполнения.
GetName	Получает имя индикатора выполнения.
GetOptions	Получает параметры, указанные вами при запуске индикатора выполнения.
GetParentId	Получает уникальный идентификатор родителя индикатора выполнения, если таковой имеется.
GetPriority	Получает приоритет индикатора выполнения.
GetProgress	Получает прогресс индикатора выполнения.
GetProgressById	Получает информацию об индикаторе выполнения.
GetRemainingTime	Получает оставшееся время индикатора выполнения в секундах.
GetRunningProgressCount	Получает количество активных или запущенных индикаторов выполнения.
GetStartDateTime	Получает отметку времени запуска индикатора хода выполнения.
GetStatus	Получает состояние индикатора выполнения.
GetStepLabel	Получает метку, отображающую шаги индикатора выполнения.
GetTimeDisplayMode	Получить режим отображения времени индикатора прогресса.
GetTotalSteps	Получает общее количество шагов от начала до конца для индикатора выполнения.
GetUpdateDateTime	Получает время последнего изменения или окончания индикатора хода выполнения.
IsCancellable	Указывает, можете ли вы отменить задачу, связанную с индикатором выполнения.
IsPausable	Указывает, можете ли вы приостановить задачу индикатора выполнения.
Pause	Приостанавливает работающий индикатор выполнения и вызывает обратный вызов pause для своей задачи.
RegisterCancelCallback	Регистрирует обратный вызов, который вызывается, когда пользователь отменяет задачу, связанную с запущенным индикатором выполнения.
RegisterPauseCallback	Регистрирует обратный вызов, который вызывается, когда пользователь приостанавливает выполнение задачи индикатора выполнения.
Remove	Завершает и удаляет активный индикатор выполнения.
Report	Сообщает о текущем состоянии текущего индикатора выполнения.
Resume	Возобновляет приостановленный индикатор выполнения и вызывает обратный вызов приостановки для связанной задачи.
SetDescription	Задает описание индикатора выполнения. Чтобы очистить описание, передайте null.
SetPriority	Устанавливает приоритет индикатора выполнения.
SetRemainingTime	Устанавливает оставшееся время индикатора выполнения в секундах.
SetStepLabel	Задает метку, отображающую шаги индикатора выполнения.
SetTimeDisplayMode	Установите режим отображения времени индикатора прогресса.
ShowDetails	Открывает окно выполнения фоновых задач.
Start	Этот метод запускает новый индикатор выполнения.
UnregisterCancelCallback	Отменяет регистрацию ранее зарегистрированного обратного вызова отмены выполнения.
UnregisterPauseCallback	Отменяет регистрацию ранее зарегистрированного обратного вызова приостановки выполнения.

События

added	Событие, возникающее при запуске нового индикатора выполнения.
removed	Событие, возникающее при удалении индикатора выполнения.
updated	Событие, возникающее при обновлении состояния индикатора выполнения.

Вы можете отблагодарить автора, за перевод документации на русский язык. ₽ Спасибо