Class AsyncOperationBase<TObject> | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class AsyncOperationBase<TObject>

    base class for implemented AsyncOperations, implements the needed interfaces and consolidates redundant code

    Inheritance
    System.Object
    AsyncOperationBase<TObject>
    ChainOperation<TObject, TObjectDependency>
    EmptyOperation<TObject>
    GroupOperation<TObject>
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: UnityEngine.ResourceManagement
    Syntax
    public abstract class AsyncOperationBase<TObject> : IAsyncOperation<TObject>, IAsyncOperation, IEnumerator
    Type Parameters
    Name Description
    TObject

    Constructors

    AsyncOperationBase()

    Declaration
    protected AsyncOperationBase()

    Fields

    m_context

    Declaration
    protected object m_context
    Field Value
    Type Description
    System.Object

    m_error

    Declaration
    protected Exception m_error
    Field Value
    Type Description
    Exception

    m_releaseToCacheOnCompletion

    Declaration
    protected bool m_releaseToCacheOnCompletion
    Field Value
    Type Description
    System.Boolean

    m_result

    Declaration
    protected TObject m_result
    Field Value
    Type Description
    TObject

    m_status

    Declaration
    protected AsyncOperationStatus m_status
    Field Value
    Type Description
    AsyncOperationStatus

    Properties

    Context

    Declaration
    public object Context { get; protected set; }
    Property Value
    Type Description
    System.Object
    Implements
    IAsyncOperation.Context

    Current

    Declaration
    public object Current { get; }
    Property Value
    Type Description
    System.Object

    IsDone

    Declaration
    public virtual bool IsDone { get; }
    Property Value
    Type Description
    System.Boolean
    Implements
    IAsyncOperation.IsDone

    IsValid

    Declaration
    public bool IsValid { get; set; }
    Property Value
    Type Description
    System.Boolean
    Implements
    IAsyncOperation.IsValid

    OperationException

    Declaration
    public Exception OperationException { get; }
    Property Value
    Type Description
    Exception
    Implements
    IAsyncOperation.OperationException

    PercentComplete

    Declaration
    public virtual float PercentComplete { get; }
    Property Value
    Type Description
    System.Single
    Implements
    IAsyncOperation.PercentComplete

    Result

    Declaration
    public TObject Result { get; }
    Property Value
    Type Description
    TObject
    Implements
    IAsyncOperation<T>.Result

    Status

    Declaration
    public AsyncOperationStatus Status { get; protected set; }
    Property Value
    Type Description
    AsyncOperationStatus
    Implements
    IAsyncOperation.Status

    Methods

    InvokeCompletionEvent()

    Declaration
    public void InvokeCompletionEvent()

    MoveNext()

    Declaration
    public bool MoveNext()
    Returns
    Type Description
    System.Boolean

    Release()

    Declaration
    public virtual void Release()
    Implements
    IAsyncOperation.Release()

    Reset()

    Declaration
    public void Reset()

    ResetStatus()

    Declaration
    public virtual void ResetStatus()
    Implements
    IAsyncOperation.ResetStatus()

    Retain()

    Declaration
    public IAsyncOperation<TObject> Retain()
    Returns
    Type Description
    IAsyncOperation<TObject>
    Implements
    IAsyncOperation<T>.Retain()

    SetResult(TObject)

    Declaration
    public virtual void SetResult(TObject result)
    Parameters
    Type Name Description
    TObject result

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.Object.ToString()

    Validate()

    Declaration
    public bool Validate()
    Returns
    Type Description
    System.Boolean
    Implements
    IAsyncOperation.Validate()

    Events

    Completed

    Declaration
    public event Action<IAsyncOperation<TObject>> Completed
    Event Type
    Type Description
    Action<IAsyncOperation<TObject>>
    Implements
    IAsyncOperation<T>.Completed

    Explicit Interface Implementations

    IAsyncOperation.Completed

    Declaration
    event Action<IAsyncOperation> IAsyncOperation.Completed
    Returns
    Type Description
    Action<IAsyncOperation>
    Implements
    IAsyncOperation.Completed

    IAsyncOperation.Result

    Declaration
    object IAsyncOperation.Result { get; }
    Returns
    Type Description
    System.Object
    Implements
    IAsyncOperation.Result
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023