Interface ITaskReporter
Interface for reporting the status of a process.
Namespace: UnityEditor.Localization.Reporting
Syntax
public interface ITaskReporterProperties
CurrentProgress
The current progress in the range 0-1.
Declaration
float CurrentProgress { get; }Property Value
| Type | Description |
|---|---|
| Single |
Started
Has the process started?
Declaration
bool Started { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
Completed(String)
Report the process is completed successfully.
Declaration
void Completed(string message)Parameters
| Type | Name | Description |
|---|---|---|
| String | message | Completion message. |
Fail(String)
Report the process failed.
Declaration
void Fail(string message)Parameters
| Type | Name | Description |
|---|---|---|
| String | message | Error message. |
ReportProgress(String, Single)
Report the current progress.
Declaration
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. |
Start(String, String)
Start the process.
Declaration
void Start(string name, string description)Parameters
| Type | Name | Description |
|---|---|---|
| String | name | The name of the process. |
| String | description | An optional description of the process. |