AssetRegistryHelpers.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AssetRegistry/ARFilter.h"
#include "AssetRegistry/AssetData.h"
#include "AssetRegistry/IAssetRegistry.h"
#include "Containers/Array.h"
#include "Containers/Set.h"
#include "Containers/UnrealString.h"
#include "Delegates/Delegate.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptInterface.h"
#include "UObject/SoftObjectPath.h"
#include "UObject/UObjectGlobals.h"
#include "Containers/ArrayView.h"
#include "AssetRegistryHelpers.generated.h"
 
class IAssetRegistry;
class UClass;
struct FFrame;
struct FAssetIdentifier;
 
USTRUCT(BlueprintType)
struct FTagAndValue
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadWrite, Transient, Category = AssetData)
    FName Tag;
 
    UPROPERTY(BlueprintReadWrite, Transient, Category = AssetData)
    FString Value;
};
 
UENUM(BlueprintType, DisplayName = "Sort Order")
enum class EAssetRegistrySortOrder : uint8
{
    Ascending,
    Descending
};
 
enum class EAssetsWithOuterForPathsFlags
{
    None                    = 0,
    // If we should scan recursively or not
    RecursivePaths          = (1 << 0),
    // If we should only include on disk assets
    IncludeOnlyOnDiskAsset  = (1 << 1),
    // If we should only return assets directly outered to the provided outer
    ExactOuter              = (1 << 2),
    // Scan the AssetRegistry for each path passed in
    ScanPaths               = (1 << 3)
};
ENUM_CLASS_FLAGS(EAssetsWithOuterForPathsFlags);
 
UCLASS(transient)
class UAssetRegistryHelpers : public UObject
{
    GENERATED_BODY()
 
public:
    UFUNCTION(BlueprintPure, Category = "Asset Registry")
    static TScriptInterface<IAssetRegistry> GetAssetRegistry();
 
    UFUNCTION(BlueprintPure, Category = "Asset Data")
    static FAssetData CreateAssetData(const UObject* InAsset, bool bAllowBlueprintClass = false);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(DisplayName = "Is Valid Asset Data", ScriptMethod))
    static bool IsValid(const FAssetData& InAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod))
    static bool IsUAsset(const FAssetData& InAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod))
    static bool IsRedirector(const FAssetData& InAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod))
    static FString GetFullName(const FAssetData& InAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod))
    static FSoftObjectPath ToSoftObjectPath(const FAssetData& InAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod))
    static UClass* GetClass(const FAssetData& InAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod))
    static UObject* GetAsset(const FAssetData& InAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod))
    static bool IsAssetLoaded(const FAssetData& InAssetData);
 
#if WITH_EDITOR
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod="IsCooked"))
    static bool IsAssetCooked(const FAssetData& InAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod="HasEditorOnlyData"))
    static bool AssetHasEditorOnlyData(const FAssetData& InAssetData);
#endif  // WITH_EDITOR
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod))
    static FString GetExportTextName(const FAssetData& InAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Data", meta=(ScriptMethod))
    static bool GetTagValue(const FAssetData& InAssetData, const FName& InTagName, FString& OutTagValue);
 
    UFUNCTION(BlueprintPure, Category = "Asset Registry")
    static FARFilter SetFilterTagsAndValues(const FARFilter& InFilter, const TArray<FTagAndValue>& InTagsAndValues);
 
    UFUNCTION(BlueprintPure, Category = "Asset Registry", meta=(ScriptMethod))
    static ASSETREGISTRY_API void GetBlueprintAssets(const FARFilter& InFilter, TArray<FAssetData>& OutAssetData);
 
    UFUNCTION(BlueprintCallable, Category = "Asset Registry")
    static ASSETREGISTRY_API void GetDerivedClassAssetData(const TArray<FTopLevelAssetPath>& InBaseClasses, TArray<FAssetData>& OutDerivedClassAssetData);
 
    UFUNCTION(BlueprintPure, Category = "Asset Registry", meta=(ScriptMethod))
    static ASSETREGISTRY_API UClass* FindAssetNativeClass(const FAssetData& AssetData);
 
    DECLARE_DYNAMIC_DELEGATE_RetVal_TwoParams(bool, FSortingPredicate, const FAssetData&, Left, const FAssetData&, Right);
    UFUNCTION(BlueprintCallable, Category = "Asset Registry")
    static ASSETREGISTRY_API void SortByPredicate(UPARAM(Ref) TArray<FAssetData>& Assets, FSortingPredicate SortingPredicate, EAssetRegistrySortOrder SortOrder);
 
    UFUNCTION(BlueprintCallable, Category = "Asset Registry")
    static ASSETREGISTRY_API void SortByAssetName(UPARAM(Ref) TArray<FAssetData>& Assets, EAssetRegistrySortOrder SortOrder);
    
    static ASSETREGISTRY_API void FindReferencersOfAssetOfClass(UObject* AssetInstance, TConstArrayView<UClass*> InMatchClasses, TArray<FAssetData>& OutAssetDatas);
 
    static ASSETREGISTRY_API void FindReferencersOfAssetOfClass(const FAssetIdentifier& InAssetIdentifier, TConstArrayView<UClass*> InMatchClasses, TArray<FAssetData>& OutAssetDatas);
    
    struct FTemporaryCachingModeScope
    {
        ASSETREGISTRY_API FTemporaryCachingModeScope(bool InTempCachingMode);
        ASSETREGISTRY_API ~FTemporaryCachingModeScope();
 
    private:
        bool PreviousCachingMode;
    };
 
    static bool ASSETREGISTRY_API IsAssetDataBlueprintOfClassSet(const FAssetData& AssetData, const TSet<FTopLevelAssetPath>& ClassNameSet);
 
    static ASSETREGISTRY_API void FixupRedirectedAssetPath(FName& InOutAssetPath);
    
    static ASSETREGISTRY_API void FixupRedirectedAssetPath(FSoftObjectPath& InOutSoftObjectPath);
 
#if WITH_EDITOR
    UE_DEPRECATED(5.7, "Please use GetAssetsWithOuterForPaths with enum flags")
    static ASSETREGISTRY_API TArray<FAssetData> GetAssetsWithOuterForPaths(const TArray<FName>& InPackagePaths, FName InOuterPath, bool bInRecursivePaths = false, bool bInIncludeOnlyOnDiskAsset = false, bool bInExactOuter = true);
 
    static ASSETREGISTRY_API TArray<FAssetData> GetAssetsWithOuterForPaths(const TArray<FName>& InPackagePaths, FName InOuterPath, EAssetsWithOuterForPathsFlags InFlags = (EAssetsWithOuterForPathsFlags::ExactOuter | EAssetsWithOuterForPathsFlags::ScanPaths));
#endif
};