1. Epic GamesDeveloper
  3. AssetTools

AssetTools

API > API/Developer

   
Name AssetTools
Type Developer
Location /Engine/Source/Developer/AssetTools/
Module Build Rules AssetTools.Build.cs

Classes

Name Remarks
FAdvancedCopyCompletedEvent  
FAssetCreateCancelledDynamic  
FAssetCreateCompleteDynamic  
FAssetToolsModule  
FAssetTypeActions_AnimationAsset  
FAssetTypeActions_Base A base class for all AssetTypeActions.
FAssetTypeActions_Blueprint  
FAssetTypeActions_BlueprintGeneratedClass  
FAssetTypeActions_ClassTypeBase Base class for "class type" assets (C++ classes and Blueprints
FAssetTypeActions_CSVAssetBase  
FAssetTypeActions_DataAsset  
FClassTypeActions_Base A base class for all ClassTypeActions.
FCollectionAssetManagement Handles the collection management for the given assets
UAdvancedCopyCustomization  
UAssetTools  
UAssetToolsHelpers  
UAssetToolsSettings  

Structs

Name Remarks
FAdvancedAssetCategory  
FAdvancedCopyMap  
FAdvancedCopyParams  
FAssetRenameData  
FLoadAssetsSettings  
FMigrationOptions  
FPackageMigrationContext  

Interfaces

Name Remarks
IAssetTools  
IAssetTypeActions AssetTypeActions provide actions and other information about asset types
IClassTypeActions ClassTypeActions provide actions and other information about asset types that host classes
ILocalizedAssetTools  

Typedefs

Name Type Remarks Include Path
FAssetCreateCancelled TBaseDelegate_OneParam< void, UFactory * >   IAssetTools.h
FAssetCreateComplete TBaseDelegate_TwoParams< void, UFactory *, UObject * >   IAssetTools.h
FAssetPostRenameEvent TMulticastDelegate_OneParam< void, const TArray< FAssetRenameData > & >   IAssetTools.h
FCanAssetBePublic TBaseDelegate_OneParam< bool, FStringView >   IAssetTools.h
FCanMigrateAsset TBaseDelegate_OneParam< bool, FName >   IAssetTools.h
FDuplicatedObjects TArray< TMap< TSoftObjectPtr< UObject >, TSoftObjectPtr< UObject > > > An array of maps each storing pairs of original object -> duplicated object. IAssetTools.h
FIsNameAllowed TBaseDelegate_TwoParams< bool, const FString &, FText * >   IAssetTools.h
FIsObjectPathAllowed TBaseDelegate_TwoParams< bool, const FString &, FText * >   IAssetTools.h
FMovedContentFolder TTuple< FString, FString > Called when a folder is moved or renamed AssetViewUtils.h
FOnAlwaysShowPath TMulticastDelegate_OneParam< void, const FString & > Callback used when a folder should be forced to be visible in the Content Browser AssetViewUtils.h
FOnFolderPathChanged TMulticastDelegate_OneParam< void, TArrayView< const FMovedContentFolder > >   AssetViewUtils.h
FOnPackageMigration TMulticastDelegate_OneParam< void, FPackageMigrationContext & >   IAssetTools.h
FOnSyncFinish TMulticastDelegate_TwoParams< void, bool, const TArray< FString > * > Called when a sync from AssetViewUtils finishes If Files is non-nullptr, those are the files affected by the sync. AssetViewUtils.h
FOnSyncStart TMulticastDelegate_NoParams< void > Called when a sync from AssetViewUtils starts AssetViewUtils.h
FSanitizeName TBaseDelegate_OneParam< void, FString & >   IAssetTools.h
FShouldCreateAssetsAsExternallyReferenceableForPath TMulticastDelegate_TwoParams< void, FStringView, TOptional< bool > & >   IAssetTools.h
FShowingContentVersePath TBaseDelegate_NoParams< bool >   IAssetTools.h

Enums

Public

Name Remarks
AssetViewUtils::ELoadAssetsResult  
EAssetClassAction  
EAssetMigrationConflict  
EAssetRenameResult  
EAssetTypeActivationMethod::Type  
EAssetTypeActivationOpenedMethod Types of permissions allowed when attempting to open an asset in editor via activation (EAssetTypeActivationMethod)
EAssetTypeCategories::Type The list of categories for Asset Type Actions and UFactory subclasses.
ELocalizedAssetsInSCCResult  
ELocalizedAssetsOnDiskResult  
ELocalizedAssetsResult  
ELocalizedVariantsInclusion  
ERedirectFixupMode  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AssetViewUtils::AssetHasCustomThumbnail ( const FAssetData& AssetData
)

 Returns true if the specified asset that uses shared thumbnails has a thumbnail assigned to it AssetViewUtils.h  

void AssetViewUtils::CaptureThumbnailFromViewport ( FViewport* InViewport,
const TArray< FAssetData >& InAssetsToAssign
)

 Capture active viewport to thumbnail and assigns that thumbnail to incoming assets AssetViewUtils.h  

void AssetViewUtils::ClearCustomThumbnails ( const TArray< FAssetData >& InAssetsToAssign
)

 Clears custom thumbnails for the selected assets AssetViewUtils.h  

void AssetViewUtils::CopyAssets ( const TArray< UObject* >& Assets,
const FString& DestPath
)

 Copies assets to a new path AssetViewUtils.h  

bool AssetViewUtils::CopyFolders ( const TArray< FString >& InSourcePathNames,
const FString& DestPath
)

 Copies all assets in all source paths to the destination path, preserving path structure AssetViewUtils.h  

int32 AssetViewUtils::DeleteAssets ( const TArray< UObject* >& AssetsToDelete
)

 Attempts to deletes the specified assets. Returns the number of assets deleted AssetViewUtils.h  

bool AssetViewUtils::DeleteFolders ( const TArray< FString >& PathsToDelete
)

 Attempts to delete the specified folders and all assets inside them. AssetViewUtils.h  

bool AssetViewUtils::DoesFolderExist ( const FString& FolderPath
)

 Returns true if the path specified exists as a folder in the asset registry AssetViewUtils.h  

void AssetViewUtils::GetAssetsInPaths ( const TArray< FString >& InPaths,
TArray< FAssetData >& OutAssetDataList
)

 Gets an array of assets inside the specified folders AssetViewUtils.h  

FLinearColor AssetViewUtils::GetDefaultColor()

 Gets the default color the folder should appear as AssetViewUtils.h  
Gets the maximum path length for an asset package file. AssetViewUtils.h  
Gets the maximum path length for a cooked file. AssetViewUtils.h  

void AssetViewUtils::GetObjectsInAssetData ( const TArray< FAssetData >& AssetList,
TArray< UObject* >& OutDroppedObjects
)

 Get all the objects in a list of asset data AssetViewUtils.h  

int32 AssetViewUtils::GetPackageLengthForCooking ( const FString& PackageName,
bool bIsInternalBuild,
FString CookSubPath
)

 Returns the length of the computed cooked package name and path whether it's run on a build machine or locally. AssetViewUtils.h  

FString AssetViewUtils::GetPackagePathWithinRoot ( const FString& PackageName
)

 Returns the relative path, from the workspace root, of the package AssetViewUtils.h  

TOptional< FLinearColor > AssetViewUtils::GetPathColor ( const FString& FolderPath
)

 Returns the color of this path from the config AssetViewUtils.h  

TSharedPtr< IPlugin > AssetViewUtils::GetPluginForFolder ( const FStringView InPath
)

 If the passed-in path is a plugin folder, then return its associated plugin AssetViewUtils.h  

void AssetViewUtils::GetUnloadedAssets ( const TArray< FString >& ObjectPaths,
TArray< FString >& OutUnloadedObjects
)

 Determines the unloaded assets that need loading AssetViewUtils.h  

bool AssetViewUtils::HasCustomColors ( TArray< FLinearColor >* OutColors
)

 Checks to see if any folder has a custom color, optionally outputs them to a list AssetViewUtils.h  

bool AssetViewUtils::IsDevelopersFolder ( const FStringView InPath
)

 Returns true if the passed-in path is a developers folder AssetViewUtils.h  

bool AssetViewUtils::IsEngineFolder ( const FStringView InPath,
const bool bIncludePlugins
)

 Returns true if the passed-in path is a engine folder AssetViewUtils.h  

bool AssetViewUtils::IsPluginFolder ( const FStringView InPath,
EPluginLoadedFrom* OutPluginSource
)

 Returns true if the passed-in path is a plugin folder, optionally reporting where the plugin was loaded from AssetViewUtils.h  

bool AssetViewUtils::IsProjectFolder ( const FStringView InPath,
const bool bIncludePlugins
)

 Returns true if the passed-in path is a project folder AssetViewUtils.h  

bool AssetViewUtils::IsValidFolderName ( const FString& FolderName,
FText& Reason
)

 Returns true if the supplied folder name can be used as part of a package name AssetViewUtils.h  

bool AssetViewUtils::IsValidFolderPathForCreate ( const FString& FolderPath,
const FString& NewFolderName,
FText& OutErrorMessage,
bool bAllowExistingFolder
)

 Returns true if the specified folder name in the specified path is available for folder creation AssetViewUtils.h  

bool AssetViewUtils::IsValidObjectPathForCreate ( const FString& ObjectPath,
FText& OutErrorMessage,
bool bAllowExistingAsset
)

 Returns true if the specified path is available for object creation AssetViewUtils.h  

bool AssetViewUtils::IsValidObjectPathForCreate ( const FString& ObjectPath,
const UClass* ObjectClass,
FText& OutErrorMessage,
bool bAllowExistingAsset
)

 Returns true if the specified path is available for object creation AssetViewUtils.h  

bool AssetViewUtils::IsValidPackageForCooking ( const FString& PackageName,
FText& OutErrorMessage
)

 Checks to see whether the path is within the size restrictions for cooking AssetViewUtils.h  

ELoadAssetsResult AssetViewUtils::LoadAssetsIfNeeded ( TConstArrayView< FAssetData > Assets,
TArray< UObject* >& LoadedObjects,
const FLoadAssetsSettings& InSettings
)

 Makes sure the specified assets are loaded into memory, with displayed progress and optional cancellation for the user. AssetViewUtils.h  

ELoadAssetsResult AssetViewUtils::LoadAssetsIfNeeded ( TConstArrayView< FString > ObjectPaths,
TArray< UObject* >& LoadedObjects,
const FLoadAssetsSettings& InSettings
)

   AssetViewUtils.h  

ELoadAssetsResult AssetViewUtils::LoadAssetsIfNeeded ( TConstArrayView< FSoftObjectPath > ObjectPaths,
TArray< UObject* >& LoadedObjects,
const FLoadAssetsSettings& InSettings
)

   AssetViewUtils.h  

bool AssetViewUtils::LoadAssetsIfNeeded ( const TArray< FString >& ObjectPaths,
TArray< UObject* >& LoadedObjects,
bool bAllowedToPromptToLoadAssets,
bool bLoadRedirects
)

 Makes sure the specified assets are loaded into memory. AssetViewUtils.h  

const TSharedPtr< FLinearColor > AssetViewUtils::LoadColor ( const FString& FolderPath
)

 Loads the color of this path from the config AssetViewUtils.h  

TArray< UPackage * > AssetViewUtils::LoadPackages ( const TArray< FString >& PackageNames
)

 Loads all the specified packages AssetViewUtils.h  

void AssetViewUtils::MoveAssets ( const TArray< UObject* >& Assets,
const FString& DestPath,
const FString& SourcePath
)

 Moves assets to a new path AssetViewUtils.h  

bool AssetViewUtils::MoveFolders ( const TArray< FString >& InSourcePathNames,
const FString& DestPath
)

 Moves all assets in all source paths to the destination path, preserving path structure AssetViewUtils.h  

FOnAlwaysShowPath & AssetViewUtils::OnAlwaysShowPath()

   AssetViewUtils.h  

FOnFolderPathChanged & AssetViewUtils::OnFolderPathChanged()

   AssetViewUtils.h  

FOnSyncFinish & AssetViewUtils::OnSyncFinish()

   AssetViewUtils.h  

FOnSyncStart & AssetViewUtils::OnSyncStart()

   AssetViewUtils.h  

bool AssetViewUtils::OpenEditorForAsset ( const FString& ObjectPath
)

 Loads the specified object if needed and opens the asset editor for it AssetViewUtils.h  
Opens the asset editor for the specified asset AssetViewUtils.h  
Opens the asset editor for the specified assets AssetViewUtils.h  

bool AssetViewUtils::PrepareFoldersForDragDrop ( const TArray< FString >& SourcePathNames,
TMap< FString, TArray< UObject* > >& OutSourcePathToLoadedAssets
)

 A helper function for folder drag/drop which loads all assets in a path (including sub-paths) and returns the assets found AssetViewUtils.h  

bool AssetViewUtils::PromptToLoadAssets ( const TArray< FString >& UnloadedObjects
)

 Prompts the user to load the list of unloaded objects AssetViewUtils.h  

bool AssetViewUtils::RenameFolder ( const FString& DestPath,
const FString& SourcePath
)

 Moves all assets from the source path to the destination path, preserving path structure, deletes source path afterwards if possible AssetViewUtils.h  

void AssetViewUtils::SaveColor ( const FString& FolderPath,
const TSharedPtr< FLinearColor >& FolderColor,
bool bForceAdd
)

 Saves the color of the path to the config AssetViewUtils.h  

bool AssetViewUtils::SaveDirtyPackages()

 Prompts to save all modified packages AssetViewUtils.h  

bool AssetViewUtils::SavePackages ( const TArray< UPackage* >& Packages
)

 Saves all the specified packages AssetViewUtils.h  

void AssetViewUtils::SetPathColor ( const FString& FolderPath,
TOptional< FLinearColor > FolderColor
)

 Saves the color of the path to the config AssetViewUtils.h  

void AssetViewUtils::ShowErrorNotifcation ( const FText& InErrorMsg
)

 Show an error notification toast if the given error message is not empty AssetViewUtils.h  

bool AssetViewUtils::SyncLatestFromSourceControl()

 Syncs latest from source control. AssetViewUtils.h  
Syncs the specified packages from source control. AssetViewUtils.h  

void AssetViewUtils::SyncPackagesFromSourceControl ( const TArray< FString >& PackageNames,
bool bIsSyncLatestOperation
)

 Syncs the specified packages from source control. AssetViewUtils.h  

bool AssetViewUtils::SyncPathsFromSourceControl ( const TArray< FString >& Paths
)

 Syncs the specified paths from source control. AssetViewUtils.h  

bool AssetViewUtils::SyncRevisionFromSourceControl ( const FString& Revision
)

 Syncs a specific revision from source control. AssetViewUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page