Struct AsyncOperationHandle<TObject>
Handle for internal operations. This allows for reference counting and checking for valid references.
Namespace: UnityEngine.ResourceManagement.AsyncOperations
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
| Type | Description |
|---|---|
| System.String |
IsDone
True if the operation is complete.
Declaration
public bool IsDone { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
OperationException
The exception for a failed operation. This will be null unless Status is failed.
Declaration
public Exception OperationException { get; }Property Value
| Type | Description |
|---|---|
| System.Exception |
PercentComplete
The progress of the internal operation.
Declaration
public float PercentComplete { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Result
The result object of the operations.
Declaration
public TObject Result { get; }Property Value
| Type | Description |
|---|---|
| TObject |
Status
The status of the internal operation.
Declaration
public AsyncOperationStatus Status { get; }Property Value
| Type | Description |
|---|---|
| AsyncOperationStatus |
Task
Return a Task object to wait on when using async await.
Declaration
public Task<TObject> Task { get; }Property Value
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TObject> |
Methods
Equals(AsyncOperationHandle<TObject>)
Provide equality for this struct.
Declaration
public bool Equals(AsyncOperationHandle<TObject> other)Parameters
| Type | Name | Description |
|---|---|---|
| AsyncOperationHandle<TObject> | other | The operation to compare to. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
GetHashCode()
Get hash code of this struct.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 |
Overrides
IsValid()
Check if the handle references an internal operation.
Declaration
public bool IsValid()Returns
| Type | Description |
|---|---|
| System.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>> CompletedEvent Type
| Type | Description |
|---|---|
| System.Action<AsyncOperationHandle<TObject>> |
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> CompletedTypelessEvent Type
| Type | Description |
|---|---|
| System.Action<AsyncOperationHandle> |
Destroyed
Event for handling the destruction of the operation.
Declaration
public event Action<AsyncOperationHandle> DestroyedEvent Type
| Type | Description |
|---|---|
| System.Action<AsyncOperationHandle> |
Operators
Implicit(AsyncOperationHandle<TObject> to AsyncOperationHandle)
Conversion between typed and non typed handles.
Declaration
public static implicit operator AsyncOperationHandle(AsyncOperationHandle<TObject> obj)Parameters
| Type | Name | Description |
|---|---|---|
| AsyncOperationHandle<TObject> | obj |
Returns
| Type | Description |
|---|---|
| AsyncOperationHandle |