Interface: OverlayTask
Defined in: editor/overlayController.tsx:380
Represents a foreground canvas task.
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
|
| Task title to display. |
Methods
end()
end():
void
Defined in: editor/overlayController.tsx:401
Completes the task and removes its representation from the overlay.
If the task is marked with error via setError(), that error will be kept displaying until another task is started later.
Returns
void
setError()
setError(
error):void
Defined in: editor/overlayController.tsx:394
Marks the task as failed with the specified error.
If set, the error will be displayed until another task will be started later.
This method can be called multiple times and will not complete the task (i.e. end() method call is required).
Parameters
| Parameter | Type |
|---|---|
|
|
Returns
void