docs.unity3d.com
    Show / Hide Table of Contents

    Class TaskTimerReporter

    Base class responsible for recording the time between each ReportProgress(String, Single).

    Inheritance
    Object
    TaskTimerReporter
    ProgressBarReporter
    ProgressReporter
    Namespace: UnityEditor.Localization.Reporting
    Syntax
    public abstract class TaskTimerReporter : ITaskReporter

    Properties

    CurrentProgress

    The current progress in the range 0-1.

    Declaration
    public float CurrentProgress { get; }
    Property Value
    Type Description
    Single
    Implements
    ITaskReporter.CurrentProgress

    Started

    Has the process started?

    Declaration
    public bool Started { get; }
    Property Value
    Type Description
    Boolean
    Implements
    ITaskReporter.Started

    Methods

    Completed(String)

    Report the process is completed successfully.

    Declaration
    public void Completed(string message)
    Parameters
    Type Name Description
    String message

    Completion message.

    Implements
    ITaskReporter.Completed(String)

    Fail(String)

    Report the process failed.

    Declaration
    public void Fail(string message)
    Parameters
    Type Name Description
    String message

    Error message.

    Implements
    ITaskReporter.Fail(String)

    PrintStatus(String, String, Single)

    Called after ReportProgress(String, Single) to print a summary of the progress.

    Declaration
    protected abstract void PrintStatus(string title, string description, float progress)
    Parameters
    Type Name Description
    String title
    String description
    Single progress

    PrintSummary(String, Boolean)

    Called after Completed(String) or Fail(String) to optionally print a summary of the whole task.

    Declaration
    protected abstract void PrintSummary(string summary, bool fail)
    Parameters
    Type Name Description
    String summary
    Boolean fail

    ReportProgress(String, Single)

    Report the current progress.

    Declaration
    public void ReportProgress(string description, float progress)
    Parameters
    Type Name Description
    String description

    Description of the current state.

    Single progress

    The progress value in the range 0-1.

    Implements
    ITaskReporter.ReportProgress(String, Single)

    Start(String, String)

    Start the process.

    Declaration
    public virtual void Start(string title, string description)
    Parameters
    Type Name Description
    String title
    String description

    An optional description of the process.

    Implements
    ITaskReporter.Start(String, String)
    In This Article
    • Properties
      • CurrentProgress
      • Started
    • Methods
      • Completed(String)
      • Fail(String)
      • PrintStatus(String, String, Single)
      • PrintSummary(String, Boolean)
      • ReportProgress(String, Single)
      • Start(String, String)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023