docs.unity3d.com
    Show / Hide Table of Contents

    Class ProgressReporter

    Inheritance
    Object
    TaskTimerReporter
    ProgressReporter
    Inherited Members
    TaskTimerReporter.CurrentProgress
    TaskTimerReporter.Started
    TaskTimerReporter.ReportProgress(String, Single)
    TaskTimerReporter.Completed(String)
    TaskTimerReporter.Fail(String)
    Namespace: UnityEditor.Localization.Reporting
    Syntax
    public class ProgressReporter : TaskTimerReporter, ITaskReporter

    Properties

    Options

    Options for the Progress.

    Declaration
    public Progress.Options Options { get; set; }
    Property Value
    Type Description
    Progress.Options

    ProgressId

    UnityEditor.Progress Id.

    Declaration
    public int ProgressId { get; set; }
    Property Value
    Type Description
    Int32

    ReportTaskSummaryInConsole

    Should the summary be sent to the console using Debug.Log/Debug.LogError?

    Declaration
    public bool ReportTaskSummaryInConsole { get; set; }
    Property Value
    Type Description
    Boolean

    Methods

    PrintStatus(String, String, Single)

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

    Declaration
    protected override void PrintStatus(string title, string description, float progress)
    Parameters
    Type Name Description
    String title
    String description
    Single progress
    Overrides
    TaskTimerReporter.PrintStatus(String, String, Single)

    PrintSummary(String, Boolean)

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

    Declaration
    protected override void PrintSummary(string summary, bool fail)
    Parameters
    Type Name Description
    String summary
    Boolean fail
    Overrides
    TaskTimerReporter.PrintSummary(String, Boolean)

    Start(String, String)

    Start the process.

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

    An optional description of the process.

    Overrides
    TaskTimerReporter.Start(String, String)
    In This Article
    • Properties
      • Options
      • ProgressId
      • ReportTaskSummaryInConsole
    • Methods
      • PrintStatus(String, String, Single)
      • PrintSummary(String, Boolean)
      • 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