Struct AsyncOperationHandle

Non typed operation handle. This allows for reference counting and checking for valid references.

Inherited Members
Namespace: UnityEngine.ResourceManagement.AsyncOperations
Syntax
public struct AsyncOperationHandle : IEnumerator

Properties

DebugName

Debug name of the operation.

Declaration
public string DebugName { get; }
Property Value
Type Description
String

IsDone

True if the operation is complete.

Declaration
public bool IsDone { get; }
Property Value
Type Description
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
Exception

PercentComplete

The progress of the internal operation.

Declaration
public float PercentComplete { get; }
Property Value
Type Description
Single

Result

The result object of the operations.

Declaration
public object Result { get; }
Property Value
Type Description
Object

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<object> Task { get; }
Property Value
Type Description
Task<Object>

Methods

Convert<T>()

Converts handle to be typed. This does not increment the reference count. To convert back to non-typed, implicit conversion is available.

Declaration
public AsyncOperationHandle<T> Convert<T>()
Returns
Type Description
AsyncOperationHandle<T>

A new handle that is typed.
Type Parameters
Name Description
T

The type of the handle.

Equals(AsyncOperationHandle)

Provide equality for this struct.

Declaration
public bool Equals(AsyncOperationHandle other)
Parameters
Type Name Description
AsyncOperationHandle other

The operation to compare to.
Returns
Type Description
Boolean

True if the the operation handles reference the same AsyncOperation and the version is the same.

GetDependencies(List<AsyncOperationHandle>)

Get dependency operations.

Declaration
public void GetDependencies(List<AsyncOperationHandle> deps)
Parameters
Type Name Description
List<AsyncOperationHandle> deps

GetDownloadStatus()

Return the current download status for this operation and its dependencies. In some instances, the information will not be available. This can happen if the operation is dependent on the initialization operation for addressables. Once the initialization operation completes, the information returned will be accurate.

Declaration
public DownloadStatus GetDownloadStatus()
Returns
Type Description
DownloadStatus

The download status.

GetHashCode()

Get hash code of this struct.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

IsValid()

Check if the internal operation is not null and has the same version of this handle.

Declaration
public bool IsValid()
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> Completed
Event Type
Type Description
Action<AsyncOperationHandle>

Destroyed

Event for handling the destruction of the operation.

Declaration
public event Action<AsyncOperationHandle> Destroyed
Event Type
Type Description
Action<AsyncOperationHandle>

Explicit Interface Implementations

IEnumerator.Current

Declaration
object IEnumerator.Current { get; }
Returns
Type Description
Object
Implements

IEnumerator.MoveNext()

Overload for MoveNext().

Declaration
bool IEnumerator.MoveNext()
Returns
Type Description
Boolean

Returns true if the enumerator can advance to the next element in the collectin. Returns false otherwise.
Implements

IEnumerator.Reset()

Overload for Reset().

Declaration
void IEnumerator.Reset()
Implements