AssetBundleData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Misc/AssertionMacros.h"
#include "UObject/Class.h"
#include "UObject/NameTypes.h"
#include "UObject/PrimaryAssetId.h"
#include "UObject/SoftObjectPath.h"
#include "UObject/SoftObjectPtr.h"
#include "UObject/TopLevelAssetPath.h"
 
#include "AssetBundleData.generated.h"
 
class FOutputDevice;
class UObject;
 
USTRUCT()
struct FAssetBundleEntry
{
    GENERATED_BODY()
public:
    UE_FORCEINLINE_HINT FAssetBundleEntry() {}
PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UE_FORCEINLINE_HINT ~FAssetBundleEntry() {}
    // Explicitly declared constructors/operators because we explicitly declared the destructor to hide deprecation warnings.
    // These can be removed along with the destructor after deprecation.
    FAssetBundleEntry(const FAssetBundleEntry&) = default;
    FAssetBundleEntry(FAssetBundleEntry&&) = default;
    FAssetBundleEntry& operator=(const FAssetBundleEntry&) = default;
    FAssetBundleEntry& operator=(FAssetBundleEntry&&) = default;
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    UPROPERTY()
    FName BundleName;
 
#if WITH_EDITORONLY_DATA
    UE_DEPRECATED(5.1, "BundleAssets has been replaced with AssetPaths.")
    UPROPERTY(meta=(DeprecatedProperty, DeprecationMessage="Asset bundles may only contain top level asset paths which are referenced through the AssetPaths property."))
    TArray<FSoftObjectPath> BundleAssets;
#endif
 
    UPROPERTY()
    TArray<FTopLevelAssetPath> AssetPaths;
    
    explicit FAssetBundleEntry(FName InBundleName)
        : BundleName(InBundleName)
    {
 
    }
 
    bool IsValid() const { return !BundleName.IsNone(); }
 
    bool operator==(const FAssetBundleEntry& Other) const
    {
        // Ignore deprecated fields for equality checks
        return BundleName == Other.BundleName
            && AssetPaths == Other.AssetPaths;
    }
    bool operator!=(const FAssetBundleEntry& Other) const
    {
        return !(*this == Other);
    }
 
    COREUOBJECT_API bool ExportTextItem(FString& ValueStr, const FAssetBundleEntry& DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope) const;
    COREUOBJECT_API bool ImportTextItem(const TCHAR*& Buffer, int32 PortFlags, UObject* Parent, FOutputDevice* ErrorText);
};
 
USTRUCT()
struct FAssetBundleData
{
    GENERATED_BODY()
public:
 
    UE_FORCEINLINE_HINT FAssetBundleData() {}
    UE_FORCEINLINE_HINT ~FAssetBundleData() {}
    FAssetBundleData(const FAssetBundleData&) = default;
    FAssetBundleData(FAssetBundleData&&) = default;
    FAssetBundleData& operator=(const FAssetBundleData&) = default;
    FAssetBundleData& operator=(FAssetBundleData&&) = default;
 
    UPROPERTY()
    TArray<FAssetBundleEntry> Bundles;
 
    bool operator==(const FAssetBundleData& Other) const
    {
        return Bundles == Other.Bundles;
    }
    bool operator!=(const FAssetBundleData& Other) const
    {
        return !(*this == Other);
    }
 
    COREUOBJECT_API FAssetBundleEntry* FindEntry(FName SearchName);
 
    UE_DEPRECATED(5.1, "The contents of an asset bundle now use FTopLevelAssetPath instead of FSoftObjectPath.")
    COREUOBJECT_API void AddBundleAsset(FName BundleName, const FSoftObjectPath& AssetPath);
 
    template< typename T >
    UE_DEPRECATED(5.1, "The contents of an asset bundle now use FTopLevelAssetPath instead of FSoftObjectPath.")
    void AddBundleAsset(FName BundleName, const TSoftObjectPtr<T>& SoftObjectPtr)
    {
        AddBundleAsset(BundleName, SoftObjectPtr.ToSoftObjectPath().GetAssetPath());
    }
 
    UE_DEPRECATED(5.1, "The contents of an asset bundle now use FTopLevelAssetPath instead of FSoftObjectPath.")
    COREUOBJECT_API void AddBundleAssets(FName BundleName, const TArray<FSoftObjectPath>& AssetPaths);
 
    UE_DEPRECATED(5.1, "The contents of an asset bundle now use FTopLevelAssetPath instead of FSoftObjectPath.")
    COREUOBJECT_API void SetBundleAssets(FName BundleName, TArray<FSoftObjectPath>&& AssetPaths);
 
    COREUOBJECT_API void AddBundleAsset(FName BundleName, const FTopLevelAssetPath& AssetPath);
 
    COREUOBJECT_API void AddBundleAssets(FName BundleName, const TArray<FTopLevelAssetPath>& AssetPaths);
 
    COREUOBJECT_API void SetBundleAssets(FName BundleName, TArray<FTopLevelAssetPath>&& AssetPaths);
 
    COREUOBJECT_API void AddBundleAssetTruncated(FName BundleName, const FSoftObjectPath& AssetPath);
 
    COREUOBJECT_API void AddBundleAssetsTruncated(FName BundleName, const TArray<FSoftObjectPath>& AssetPaths);
 
    COREUOBJECT_API void SetBundleAssetsTruncated(FName BundleName, const TArray<FSoftObjectPath>& AssetPaths);
 
    COREUOBJECT_API void Reset();
 
    COREUOBJECT_API bool ExportTextItem(FString& ValueStr, FAssetBundleData const& DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope) const;
    COREUOBJECT_API bool ImportTextItem(const TCHAR*& Buffer, int32 PortFlags, UObject* Parent, FOutputDevice* ErrorText);
 
    COREUOBJECT_API FString ToDebugString() const;
};
 
template<>
struct TStructOpsTypeTraits<FAssetBundleData> : public TStructOpsTypeTraitsBase2<FAssetBundleData>
{
    enum
    {
        WithExportTextItem = true,
        WithImportTextItem = true,
    };
};