Struct AsyncOperationHandle<TObject>
Handle for internal operations. This allows for reference counting and checking for valid references.
Syntax
public struct AsyncOperationHandle<TObject> : IEnumerator, IEquatable<AsyncOperationHandle<TObject>>
Type Parameters
| Name |
Description |
| TObject |
The object type of the underlying operation.
|
Properties
DebugName
Debug name of the operation.
Declaration
public string DebugName { get; }
Property Value
IsDone
True if the operation is complete.
Declaration
public bool IsDone { get; }
Property Value
OperationException
The exception for a failed operation. This will be null unless Status is failed.
Declaration
public Exception OperationException { get; }
Property Value
PercentComplete
The progress of the internal operation.
Declaration
public float PercentComplete { get; }
Property Value
Result
The result object of the operations.
Declaration
public TObject Result { get; }
Property Value
Status
The status of the internal operation.
Declaration
public AsyncOperationStatus Status { get; }
Property Value
Task
Return a Task object to wait on when using async await.
Declaration
public Task<TObject> Task { get; }
Property Value
| Type |
Description |
| Task<TObject> |
|
Methods
Equals(AsyncOperationHandle<TObject>)
Provide equality for this struct.
Declaration
public bool Equals(AsyncOperationHandle<TObject> other)
Parameters
Returns
Implements
GetHashCode()
Get hash code of this struct.
Declaration
public override int GetHashCode()
Returns
Overrides
IsValid()
Check if the handle references an internal operation.
Declaration
Returns
| Type |
Description |
| Boolean |
True if valid.
|
Events
Completed
Completion event for the internal operation. If this is assigned on a completed operation, the callback is deferred until the LateUpdate of the current frame.
Declaration
public event Action<AsyncOperationHandle<TObject>> Completed
Event Type
CompletedTypeless
Completion event for non-typed callback handlers. If this is assigned on a completed operation, the callback is deferred until the LateUpdate of the current frame.
Declaration
public event Action<AsyncOperationHandle> CompletedTypeless
Event Type
Destroyed
Event for handling the destruction of the operation.
Declaration
public event Action<AsyncOperationHandle> Destroyed
Event Type
Operators
Implicit(AsyncOperationHandle<TObject> to AsyncOperationHandle)
Conversion between typed and non typed handles.
Declaration
public static implicit operator AsyncOperationHandle(AsyncOperationHandle<TObject> obj)
Parameters
Returns
Explicit Interface Implementations
IEnumerator.Current
Declaration
object IEnumerator.Current { get; }
Returns
Implements
IEnumerator.MoveNext()
Declaration
bool IEnumerator.MoveNext()
Returns
Implements
IEnumerator.Reset()
Declaration
Implements