ModAsyncOperation Class |
An awaitable object that is returned by async operations so you can wait for completion in a coroutine as well as access progress and status information.
Inheritance HierarchyNamespace: UMod
Assembly: UMod-Shared (in UMod-Shared.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class ModAsyncOperation : IEnumerator
The ModAsyncOperation type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ModAsyncOperation | Initializes a new instance of the ModAsyncOperation class |
Properties| Name | Description | |
|---|---|---|
 | Current |
IEnumerator.Current imlementation.
|
| IsDone |
Returns true if the async operation has finished or false if it is still running.
|
| IsSuccessful |
Returns true if the async operation completed successfully or false if an error occurred.
|
| Progress |
Get the current progress of the async operation.
This is a normalized value between 0-1.
|
| ProgressPercentage |
Get the current progress percentage of the async operation.
|
| Result |
Get the Object result of the async operation.
|
| Status |
Get the current status of the async operation.
|
Methods| Name | Description | |
|---|---|---|
| MarkAsCompleted | |
 | MoveNext |
IEnumerator.MoveNext() implementation.
|
| Reset |
IEnumerator.Reset() implementation.
|
Fields| Name | Description | |
|---|---|---|
 | isSuccessful |
Was the operation successful or did something gowrong.
|
| status |
Get the current status of the async operation.
|
| userData |
User data suppiled by the object that marked the operation as complete.
|
See Also