1. Epic GamesDeveloper
  3. UEditorAssetSubsystem

UEditorAssetSubsystem

[UEditorAssetSubsystem](API\Editor\UnrealEd\UEditorAssetSubsystem) Subsystem for exposing asset related utilities to scripts.

API > API/Editor > API/Editor/UnrealEd

UEditorAssetSubsystem Subsystem for exposing asset related utilities to scripts. Asset Paths can be represented in the following ways: (Reference/Text Path) StaticMesh'/Game/MyFolder/MyAsset.MyAsset' (Full Name) StaticMesh /Game/MyFolder/MyAsset.MyAsset (Path Name) /Game/MyFolder/MyAsset.MyAsset (Package Name) /Game/MyFolder/MyAsset Directory Paths can be represented in the following ways: /Game/MyNewFolder/ /Game/MyNewFolder

   
Name UEditorAssetSubsystem
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/Subsystems/EditorAssetSubsystem.h
Include Path #include "Subsystems/EditorAssetSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class UEditorAssetSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UEditorAssetSubsystem()

   Subsystems/EditorAssetSubsystem.h  

Classes

Name Remarks
FOnExtractAssetFromFileDynamic Dynamic version of FOnExtractAssetFromFile.

Typedefs

Name Type Remarks Include Path
FOnExtractAssetFromFile TMulticastDelegate_TwoParams< void, const TArray< FString > &Files, TArray< FAssetData > &AssetDataArray > Delegate for extracting an asset from a file, for example from a drag and drop operation. Subsystems/EditorAssetSubsystem.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
OnExtractAssetFromFile FOnExtractAssetFromFile Delegate for extracting an asset from a file, for example from a drag and drop operation. Subsystems/EditorAssetSubsystem.h  
OnExtractAssetFromFileDynamicArray TArray< FOnExtractAssetFromFileDynamic > Array of dynamic delegates for extracting an asset from a file. Subsystems/EditorAssetSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddOnExtractAssetFromFile ( FOnExtractAssetFromFileDynamic Delegate
)

 Call this to add a callback to extract an asset from a file, for example from a drag and drop operation. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

bool CheckoutAsset ( const FString& AssetToCheckout
)

 Checkout an asset. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset | Revision Control"
  • Meta=(Keywords="Source Control")

bool CheckoutDirectory ( const FString& DirectoryPath,
bool bRecursive
)

 Checkout all assets in a directory. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset | Revision Control"
  • Meta=(Keywords="Source Control")

bool CheckoutLoadedAsset ( UObject* AssetToCheckout
)

 Checkout the asset corresponding to an object. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset | Revision Control"
  • Meta=(Keywords="Source Control")

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

 Checkout the assets. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset | Revision Control"
  • Meta=(Keywords="Source Control")

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

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

virtual void Deinitialize()

   Subsystems/EditorAssetSubsystem.h  

bool DeleteAsset ( const FString& AssetPathToDelete
)

 Delete the package an asset is in. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

bool DeleteDirectory ( const FString& DirectoryPath
)

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

bool DeleteLoadedAsset ( UObject* AssetToDelete
)

 Delete an asset that is already loaded. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

 Delete assets that are already loaded. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

bool DoAssetsExist ( const TArray< FString >& AssetPaths
)

 Check if assets exist in the Asset Registry. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

bool DoesAssetExist ( const FString& AssetPath
)

 Check if an asset exists in the Asset Registry. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

bool DoesDirectoryContainAssets ( const FString& DirectoryPath,
bool bRecursive
)

 Check if a directory contains any assets. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

bool DoesDirectoryExist ( const FString& DirectoryPath
)

 Check if a directory exists. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

 Duplicate an asset. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

 Duplicate a directory and the assets in it. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

 Duplicate an asset that is already loaded. Will try to checkout the file. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

FAssetData FindAssetData ( const FString& AssetPath
)

 Return the AssetData for the Asset that can then be used with AssetRegistryHelpers. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

 Find Package Referencers for an asset. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"
  • Meta=(AdvancedDisplay=1)

TArray< FAssetData > GetAllAssetsByMetaDataTags ( const TSet< FName >& RequiredTags,
const TSet< UClass* >& AllowedClasses
)

 Gets all assets which have the given tags. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

int32 GetAssetFilenameLengthForCooking ( const FString& AssetPath
)

 Returns the length of the computed cooked package name and path Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

int32 GetLoadedAssetFilenameLengthForCooking ( const UObject* Asset
)

 Returns the length of the computed cooked package name and path Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

FString GetMetadataTag ( UObject* Object,
FName Tag
)

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

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

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

FOnExtractAssetFromFile & GetOnExtractAssetFromFile ()

 Get the delegate for extracting an asset from a file, for example from a drag and drop operation. Subsystems/EditorAssetSubsystem.h  
Return a valid AssetPath for a loaded asset. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

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

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   Subsystems/EditorAssetSubsystem.h  

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

 Return the list of all the assets found in the DirectoryPath. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

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

UObject * LoadAsset ( const FString& AssetPath
)

 Load an asset. It will verify if the object is already loaded and only load it if it's necessary. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

UClass * LoadBlueprintClass ( const FString& AssetPath
)

 Load a Blueprint asset and return its generated class. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

bool MakeDirectory ( const FString& DirectoryPath
)

 Create a directory on disk. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

void RemoveMetadataTag ( UObject* Object,
FName Tag
)

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

void RemoveOnExtractAssetFromFile ( FOnExtractAssetFromFileDynamic Delegate
)

 Call this to remove a callback added with AddOnExtractAssetFromFile. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

 Rename an asset. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

 Rename a directory. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

 Rename an asset that is already loaded. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

bool SaveAsset ( const FString& AssetToSave,
bool bOnlyIfIsDirty
)

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

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

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

bool SaveLoadedAsset ( UObject* AssetToSave,
bool bOnlyIfIsDirty
)

 Save the package the asset lives in. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

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

bool SetDirtyFlag ( UObject* Object,
const bool bDirtyState
)

 Set the package dirty flag for an asset Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

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

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

bool SortByMetaData ( TArray< FAssetData >& Assets,
FName MetaDataTag,
EEditorAssetMetaDataSortType MetaDataType,
EEditorAssetSortOrder SortOrder
)

 Sorts the assets based on their meta data's type. Subsystems/EditorAssetSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Asset"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page