1. Epic GamesDeveloper
  3. UEditorAssetSubsystem

UEditorAssetSubsystem

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

Unreal Engine C++ API Reference > Editor > UnrealEd > Subsystems

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/Subsystems/EditorAssetSubsystem.h
Include #include "Subsystems/EditorAssetSubsystem.h"

Syntax

class UEditorAssetSubsystem : public UEditorSubsystem

Remarks

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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Call this to add a callback to extract an asset from a file, for example from a drag and drop operation.
Public function bool

CheckoutAsset ( const FString& AssetToCheckout
)

 Checkout an asset.
Public function bool

CheckoutDirectory ( const FString& DirectoryPath,
bool bRecursive
)

 Checkout all assets in a directory.
Public function bool

CheckoutLoadedAsset ( UObject* AssetToCheckout
)

 Checkout the asset corresponding to an object.
Public function bool

CheckoutLoadedAssets ( const TArray< UObject* >& AssetsToCheckout
)

 Checkout the assets.
Public function bool

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

 Consolidates assets by replacing all references/uses of the provided AssetsToConsolidate with references to AssetToConsolidateTo.
Public function bool

DeleteAsset ( const FString& AssetPathToDelete
)

 Delete the package an asset is in.
Public function bool

DeleteDirectory ( const FString& DirectoryPath
)

 Delete the packages inside a directory.
Public function bool

DeleteLoadedAsset ( UObject* AssetToDelete
)

 Delete an asset that is already loaded.
Public function bool

DeleteLoadedAssets ( const TArray< UObject* >& AssetsToDelete
)

 Delete assets that are already loaded.
Public function bool

DoAssetsExist ( const TArray< FString >& AssetPaths
)

 Check if assets exist in the Asset Registry.
Public function bool

DoesAssetExist ( const FString& AssetPath
)

 Check if an asset exists in the Asset Registry.
Public function bool

DoesDirectoryContainAssets ( const FString& DirectoryPath,
bool bRecursive
)

 Check if a directory contains any assets.
Public function bool

DoesDirectoryExist ( const FString& DirectoryPath
)

 Check if a directory exists.
Public function UObject *

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

 Duplicate an asset.
Public function bool

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

 Duplicate a directory and the assets in it.
Public function UObject *

DuplicateLoadedAsset ( UObject* SourceAsset,
const FString& DestinationAssetPath
)

 Duplicate an asset that is already loaded. Will try to checkout the file.
Public function FAssetData

FindAssetData ( const FString& AssetPath
)

 Return the AssetData for the Asset that can then be used with AssetRegistryHelpers.
Public function TArray< FString >

FindPackageReferencersForAsset ( const FString& AssetPath,
bool bLoadAssetsToConfirm
)

 Find Package Referencers for an asset.
Public function FString

GetMetadataTag ( UObject* Object,
FName Tag
)

 Get the value associated with the given tag of a loaded asset's metadata.
Public function TMap< FName, FString > Get all tags/values of a loaded asset's metadata.
Public function FOnExtractAssetFromFile & Get the delegate for extracting an asset from a file, for example from a drag and drop operation.
Public function FString Return a valid AssetPath for a loaded asset.
Public function TMap< FName, FString >

GetTagValues ( const FString& AssetPath
)

 Gets all TagValues (from Asset Registry) associated with an (unloaded) asset as strings value.
Public function TArray< FString >

ListAssets ( const FString& DirectoryPath,
bool bRecursive,
bool bIncludeFolder
)

 Return the list of all the assets found in the DirectoryPath.
Public function TArray< FString >

ListAssetsByTagValue ( FName TagName,
const FString& TagValue
)

 Return the list of all the assets that have the pair of Tag/Value.
Public function 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.
Public function UClass *

LoadBlueprintClass ( const FString& AssetPath
)

 Load a Blueprint asset and return its generated class.
Public function bool

MakeDirectory ( const FString& DirectoryPath
)

 Create a directory on disk.
Public function void

RemoveMetadataTag ( UObject* Object,
FName Tag
)

 Remove the given tag from a loaded asset's metadata.
Public function void Call this to remove a callback added with AddOnExtractAssetFromFile.
Public function bool

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

 Rename an asset.
Public function bool

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

 Rename a directory.
Public function bool

RenameLoadedAsset ( UObject* SourceAsset,
const FString& DestinationAssetPath
)

 Rename an asset that is already loaded.
Public function bool

SaveAsset ( const FString& AssetToSave,
bool bOnlyIfIsDirty
)

 Save the packages the assets live in.
Public function bool

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

 Save the packages the assets live in inside the directory.
Public function bool

SaveLoadedAsset ( UObject* AssetToSave,
bool bOnlyIfIsDirty
)

 Save the package the asset lives in.
Public function bool

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

 Save the packages the assets live in.
Public function void

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

 Set the value associated with a given tag of a loaded asset's metadata.

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void Implement this for initialization of instances of the system

Classes

  Type Name Description
Public class FOnExtractAssetFromFileDynamic Dynamic version of FOnExtractAssetFromFile.  

Typedefs

Name Description
FOnExtractAssetFromFile Delegate for extracting an asset from a file, for example from a drag and drop operation.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page