1. Epic GamesDeveloper
  3. UAssetRegistryHelpers

UAssetRegistryHelpers

API > API/Runtime > API/Runtime/AssetRegistry

   
Name UAssetRegistryHelpers
Type class
Header File /Engine/Source/Runtime/AssetRegistry/Public/AssetRegistry/AssetRegistryHelpers.h
Include Path #include "AssetRegistry/AssetRegistryHelpers.h"

Syntax

UCLASS (Transient)  
class UAssetRegistryHelpers : public UObject

Inheritance Hierarchy

Classes

Name Remarks
FSortingPredicate  

Structs

Name Remarks
FTemporaryCachingModeScope Enable/disable asset registry caching mode for the duration of the scope

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AssetHasEditorOnlyData ( const FAssetData& InAssetData
)

 Returns true if the asset has its editor-only data AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod="HasEditorOnlyData")

static FAssetData CreateAssetData ( const UObject* InAsset,
bool bAllowBlueprintClass
)

 Creates asset data from a UObject. AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"

static UClass * FindAssetNativeClass ( const FAssetData& AssetData
)

 Returns the first native class of the asset type that can be found. AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Registry"
  • Meta=(ScriptMethod)

static void FindReferencersOfAssetOfClass ( const FAssetIdentifier& InAssetIdentifier,
TConstArrayView< UClass* > InMatchClasses,
TArray< FAssetData >& OutAssetDatas
)

 Finds references of the provided asset that are of the a class contained in the InMatchClasses set. AssetRegistry/AssetRegistryHelpers.h  

static void FindReferencersOfAssetOfClass ( UObject* AssetInstance,
TConstArrayView< UClass* > InMatchClasses,
TArray< FAssetData >& OutAssetDatas
)

 Finds references of the provided asset that are of the a class contained in the InMatchClasses set. AssetRegistry/AssetRegistryHelpers.h  

static void FixupRedirectedAssetPath ( FName& InOutAssetPath
)

 Resolves the provided asset path using asset redirectors. AssetRegistry/AssetRegistryHelpers.h  

static void FixupRedirectedAssetPath ( FSoftObjectPath& InOutSoftObjectPath
)

 Resolves the provided soft object asset path using asset redirectors. AssetRegistry/AssetRegistryHelpers.h  

static UObject * GetAsset ( const FAssetData& InAssetData
)

 Returns the asset UObject if it is loaded or loads the asset if it is unloaded then returns the result AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod)

static TScriptInterface< IAssetRegistry > GetAssetRegistry()

   AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Registry"

static TArray< FAssetData > GetAssetsWithOuterForPaths ( const TArray< FName >& InPackagePaths,
FName InOuterPath,
bool bInRecursivePaths,
bool bInIncludeOnlyOnDiskAsset,
bool bInExactOuter
)

 Returns all the corresponding assets from the provided paths that are outered to the provided outer name. AssetRegistry/AssetRegistryHelpers.h  

static void GetBlueprintAssets ( const FARFilter& InFilter,
TArray< FAssetData >& OutAssetData
)

 Gets asset data for all blueprint assets that match the filter. AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Registry"
  • Meta=(ScriptMethod)

static UClass * GetClass ( const FAssetData& InAssetData
)

   AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod)

static FString GetExportTextName ( const FAssetData& InAssetData
)

 Returns the name for the asset in the form: Class'ObjectPath' AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod)

static FString GetFullName ( const FAssetData& InAssetData
)

 Returns the full name for the asset in the form: Class ObjectPath AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod)

static bool GetTagValue ( const FAssetData& InAssetData,
const FName& InTagName,
FString& OutTagValue
)

 Gets the value associated with the given tag as a string AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod)

static bool IsAssetCooked ( const FAssetData& InAssetData
)

 Returns true if the asset is cooked AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod="IsCooked")

static bool IsAssetDataBlueprintOfClassSet ( const FAssetData& AssetData,
const TSet< FTopLevelAssetPath >& ClassNameSet
)

 Checks to see if the given asset data is a blueprint with a base class in the ClassNameSet. AssetRegistry/AssetRegistryHelpers.h  

static bool IsAssetLoaded ( const FAssetData& InAssetData
)

 Returns true if the asset is loaded AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod)

static bool IsRedirector ( const FAssetData& InAssetData
)

 Returns true if the this asset is a redirector. AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod)

static bool IsUAsset ( const FAssetData& InAssetData
)

 Returns true if this is the primary asset in a package, true for maps and assets but false for secondary objects like class redirectors AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod)

static bool IsValid ( const FAssetData& InAssetData
)

 Checks to see if this AssetData refers to an asset or is NULL AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(DisplayName="Is Valid Asset Data", ScriptMethod)

static FARFilter SetFilterTagsAndValues ( const FARFilter& InFilter,
const TArray< FTagAndValue >& InTagsAndValues
)

 Populates the FARFilters tags and values map with the passed in tags and values AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Registry"

static void SortByAssetName ( UPARAM(Ref) TArray< FAssetData >& Assets,
EAssetRegistrySortOrder SortOrder
)

 Sorts the assets by their asset name. AssetRegistry/AssetRegistryHelpers.h
  • BlueprintCallable
  • Category="Asset Registry"

static void SortByPredicate ( UPARAM(Ref) TArray< FAssetData >& Assets,
FSortingPredicate SortingPredicate,
EAssetRegistrySortOrder SortOrder
)

 Sorts the assets based on a custom Blueprint delegate. AssetRegistry/AssetRegistryHelpers.h
  • BlueprintCallable
  • Category="Asset Registry"

static FSoftObjectPath ToSoftObjectPath ( const FAssetData& InAssetData
)

 Convert to a SoftObjectPath for loading AssetRegistry/AssetRegistryHelpers.h
  • BlueprintPure
  • Category="Asset Data"
  • Meta=(ScriptMethod)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page