AsyncPackage.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    AsyncPackage.h: Unreal async loading definitions.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/UObjectGlobals.h"
#include "Misc/PackagePath.h"
#include "Misc/PackageAccessTracking.h"
#include "Templates/UniquePtr.h"
#include "UObject/ICookInfo.h"
#include "UObject/LinkerInstancingContext.h"
 
struct FAsyncPackageDesc
{
    int32 RequestID;
    FName Name;
    FPackagePath PackagePath;
    TUniquePtr<FLoadPackageAsyncDelegate> PackageLoadedDelegate;
    EPackageFlags PackageFlags;
    TAsyncLoadPriority Priority;
    int32 PIEInstanceID;
    FLinkerInstancingContext InstancingContext;
#if UE_WITH_PACKAGE_ACCESS_TRACKING
    FName ReferencerPackageName;
    FName ReferencerPackageOp;
#endif
#if WITH_EDITOR
    ECookLoadType CookLoadType;
#endif
 
    const FLinkerInstancingContext* GetInstancingContext() const { return &InstancingContext; }
    void SetInstancingContext(FLinkerInstancingContext InInstancingContext) { InstancingContext = MoveTemp(InInstancingContext); }
 
    FAsyncPackageDesc(int32 InRequestID, const FName& InName, const FPackagePath& InPackagePath, TUniquePtr<FLoadPackageAsyncDelegate>&& InCompletionDelegate = TUniquePtr<FLoadPackageAsyncDelegate>(), EPackageFlags InPackageFlags = PKG_None, int32 InPIEInstanceID = INDEX_NONE, TAsyncLoadPriority InPriority = 0)
        : RequestID(InRequestID)
        , Name(InName)
        , PackagePath(InPackagePath)
        , PackageLoadedDelegate(MoveTemp(InCompletionDelegate))
        , PackageFlags(InPackageFlags)
        , Priority(InPriority)
        , PIEInstanceID(InPIEInstanceID)
#if WITH_EDITOR
        , CookLoadType(ECookLoadType::Unspecified)
#endif
    {
        check(!PackagePath.IsEmpty());
    }
 
    FAsyncPackageDesc(const FAsyncPackageDesc& OldPackage)
        : RequestID(OldPackage.RequestID)
        , Name(OldPackage.Name)
        , PackagePath(OldPackage.PackagePath)
        , PackageFlags(OldPackage.PackageFlags)
        , Priority(OldPackage.Priority)
        , PIEInstanceID(OldPackage.PIEInstanceID)
        , InstancingContext(OldPackage.InstancingContext)
#if UE_WITH_PACKAGE_ACCESS_TRACKING
        , ReferencerPackageName(OldPackage.ReferencerPackageName)
        , ReferencerPackageOp(OldPackage.ReferencerPackageOp)
#endif
#if WITH_EDITOR
        , CookLoadType(OldPackage.CookLoadType)
#endif
    {
    }
 
    FAsyncPackageDesc(const FAsyncPackageDesc& OldPackage, TUniquePtr<FLoadPackageAsyncDelegate>&& InPackageLoadedDelegate)
        : FAsyncPackageDesc(OldPackage)
    {
        PackageLoadedDelegate = MoveTemp(InPackageLoadedDelegate);
    }
 
#if DO_GUARD_SLOW
    ~FAsyncPackageDesc()
    {
        checkSlow(!PackageLoadedDelegate.IsValid() || IsInGameThread());
    }
#endif
};