1. Epic GamesDeveloper
  3. UEditorAssetLibrary

UEditorAssetLibrary

Utility class to do most of the common functionalities with the ContentBrowser.

API > API/Plugins > API/Plugins/EditorScriptingUtilities

Utility class to do most of the common functionalities with the ContentBrowser. The AssetRegistryHelpers class has more complex utilities. Use FindAssetData to get a FAssetData from an Asset Path. The Asset Path can be represented by ie. (Reference/Text Path) StaticMesh'/Game/MyFolder/MyAsset.MyAsset' ie. (Full Name) StaticMesh /Game/MyFolder/MyAsset.MyAsset ie. (Path Name) /Game/MyFolder/MyAsset.MyAsset ie. (Package Name) /Game/MyFolder/MyAsset The Directory Path can be represented by ie. /Game/MyNewFolder/ ie. /Game/MyNewFolder All operations can be slow. The editor should not be in play in editor mode. It will not work on assets of the type level.

   
Name UEditorAssetLibrary
Type class
Header File /Engine/Plugins/Editor/EditorScriptingUtilities/Source/EditorScriptingUtilities/Public/EditorAssetLibrary.h
Include Path #include "EditorAssetLibrary.h"

Syntax

UCLASS ()  
class UEditorAssetLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool CheckoutAsset ( const FString& AssetToCheckout
)

 Checkout the asset from the Content Browser. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool CheckoutDirectory ( const FString& DirectoryPath,
bool bRecursive
)

 Checkout assets from the Content Browser. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool CheckoutLoadedAsset ( UObject* AssetToCheckout
)

 Checkout the asset from the Content Browser. Checkout operations EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool CheckoutLoadedAssets ( const TArray< UObject* >& AssetsToCheckout
)

 Checkout the assets from the Content Browser. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool ConsolidateAssets ( UObject* AssetToConsolidateTo,
const TArray< UObject* >& AssetsToConsolidate
)

 Consolidates an asset by replacing all references/uses of the provided AssetsToConsolidate with references to AssetToConsolidateTo. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool DeleteAsset ( const FString& AssetPathToDelete
)

 Delete the package the assets live in. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool DeleteDirectory ( const FString& DirectoryPath
)

 Delete the packages inside a directory. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool DeleteLoadedAsset ( UObject* AssetToDelete
)

 Delete an asset from the Content Browser that is already loaded. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool DeleteLoadedAssets ( const TArray< UObject* >& AssetsToDelete
)

 Delete assets from the Content Browser that are already loaded. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool DoAssetsExist ( const TArray< FString >& AssetPaths
)

 Check if the assets exist in the Content Browser. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool DoesAssetExist ( const FString& AssetPath
)

 Check if the asset exists in the Content Browser. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool DoesDirectoryExist ( const FString& DirectoryPath
)

 Check is the directory exist in the Content Browser. Directory operations EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool DoesDirectoryHaveAssets ( const FString& DirectoryPath,
bool bRecursive
)

 Check if there any asset that exist in the directory. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static UObject * DuplicateAsset ( const FString& SourceAssetPath,
const FString& DestinationAssetPath
)

 Duplicate an asset from the Content Browser. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool DuplicateDirectory ( const FString& SourceDirectoryPath,
const FString& DestinationDirectoryPath
)

 Duplicate asset from the Content Browser that are in the folder. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static UObject * DuplicateLoadedAsset ( UObject* SourceAsset,
const FString& DestinationAssetPath
)

 Duplicate an asset from the Content Browser that is already loaded. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static FAssetData FindAssetData ( const FString& AssetPath
)

 Return the AssetData for the Asset that can then be used with the more complex lib AssetRegistryHelpers. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static TArray< FString > FindPackageReferencersForAsset ( const FString& AssetPath,
bool bLoadAssetsToConfirm
)

 Find Package Referencers for an asset. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static FString GetMetadataTag ( UObject* Object,
FName Tag
)

 Get the value associated with the given tag of a loaded asset's metadata. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Metadata"

static TMap< FName, FString > GetMetadataTagValues ( UObject* Object
)

 Get all tags/values of a loaded asset's metadata. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Metadata"

static UPackage * GetPackageForObject ( UObject* Object
)

 Returns the object's containing package EditorAssetLibrary.h
  • BlueprintPure
  • Category="Editor Scripting | Asset"
  • Meta=(Keywords="outer owner package container asset", BlueprintAutocast)

static FString GetPathNameForLoadedAsset ( UObject* LoadedAsset
)

 Return a valid AssetPath for a loaded asset. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static FString GetProjectRootAssetDirectory ()

 Historically, all project assets were stored in the logical "/Game/" directory when using plugins or UEFN projects, we want to ease asset reuse, and so the ambiguous "/Game/" directory is untenable. EditorAssetLibrary.h
  • BlueprintPure
  • Category="Editor Scripting | Asset"

static TMap< FName, FString > GetTagValues ( const FString& AssetPath
)

 Gets all TagValues (from Asset Registry) associated with an (unloaded) asset as strings value. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static TArray< FString > ListAssetByTagValue ( FName TagName,
const FString& TagValue
)

 Return the list of all the assets that have the pair of Tag/Value. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static TArray< FString > ListAssets ( const FString& DirectoryPath,
bool bRecursive,
bool bIncludeFolder
)

 Return the list of all the assets found in the DirectoryPath. List operations EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static UObject * LoadAsset ( const FString& AssetPath
)

 Load an asset from the Content Browser. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static UClass * LoadBlueprintClass ( const FString& AssetPath
)

 Load a Blueprint asset from the Content Browser and return its generated class. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool MakeDirectory ( const FString& DirectoryPath
)

 Create the directory on disk and in the Content Browser. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static void OverrideProjectRootAssetDirectory ( FStringView InProjectRootAssetDirectory
)

 These are intentionally not exposed to scripts, used by editor state machines: EditorAssetLibrary.h  

static void RemoveMetadataTag ( UObject* Object,
FName Tag
)

 Remove the given tag from a loaded asset's metadata. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Metadata"

static bool RenameAsset ( const FString& SourceAssetPath,
const FString& DestinationAssetPath
)

 Rename an asset from the Content Browser. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool RenameDirectory ( const FString& SourceDirectoryPath,
const FString& DestinationDirectoryPath
)

 Rename assets from the Content Browser that are in the folder. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool RenameLoadedAsset ( UObject* SourceAsset,
const FString& DestinationAssetPath
)

 Rename an asset from the Content Browser that is already loaded. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static void ResetProjectRootAssetDirectory()

   EditorAssetLibrary.h  

static bool SaveAsset ( const FString& AssetToSave,
bool bOnlyIfIsDirty
)

 Save the packages the assets live in. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool SaveDirectory ( const FString& DirectoryPath,
bool bOnlyIfIsDirty,
bool bRecursive
)

 Save the packages the assets live in inside the directory. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool SaveLoadedAsset ( UObject* AssetToSave,
bool bOnlyIfIsDirty
)

 Save the packages the assets live in. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static bool SaveLoadedAssets ( const TArray< UObject* >& AssetsToSave,
bool bOnlyIfIsDirty
)

 Save the packages the assets live in. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

static void SetMetadataTag ( UObject* Object,
FName Tag,
const FString& Value
)

 Set the value associated with a given tag of a loaded asset's metadata. EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Metadata"

static void SyncBrowserToObjects ( const TArray< FString >& AssetPaths
)

 Browses to the associated asset and selects it in the most recently used Content Browser (summoning one if necessary) This is an asynchronous operation that can take a couple of frames to resolve the request EditorAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Content Browser"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page