Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > AssetTools

Light Theme

Dark Theme

AssetTools

Windows

MacOS

Linux

Filters

Classes

	Name	Description
	FAdvancedAssetCategory
	FAdvancedCopyMap
	FAdvancedCopyParams
	FAssetRenameData
	FAssetToolsModule
	FAssetTypeActions_Base	A base class for all AssetTypeActions.
	FAssetTypeActions_CSVAssetBase
	FClassTypeActions_Base	A base class for all ClassTypeActions.
	FCollectionAssetManagement	Handles the collection management for the given assets
	FRevisionInfo	Revision information for a single revision of a file in source control
	IAssetTools
	IAssetTypeActions	AssetTypeActions provide actions and other information about asset types
	IClassTypeActions	ClassTypeActions provide actions and other information about asset types that host classes
	UAdvancedCopyCustomization
	UAssetTools
	UAssetToolsHelpers
	UAssetToolsSettings

Typedefs

Name	Description
FAssetPostRenameEvent
FMovedContentFolder	Called when a folder is moved or renamed
FOnAlwaysShowPath	Callback used when a folder should be forced to be visible in the Content Browser
FOnFolderPathChanged

Enums

	Name	Description
	EAssetRenameResult
	EAssetTypeActivationMethod::Type
	EAssetTypeCategories::Type	The list of categories for Asset Type Actions and UFactory subclasses.

Functions

	Name	Description
bool	AssetViewUtils::AssetHasCustomThumbnail ( const FAssetData& AssetData )	Returns true if the specified asset that uses shared thumbnails has a thumbnail assigned to it
void	AssetViewUtils::CaptureThumbnailFromViewport ( FViewport* InViewport, const TArray< FAssetData >& InAsse... )	Capture active viewport to thumbnail and assigns that thumbnail to incoming assets
void	AssetViewUtils::ClearCustomThumbnails ( const TArray< FAssetData >& InAsse... )	Clears custom thumbnails for the selected assets
void	AssetViewUtils::CopyAssets ( const TArray< UObject* >& Ass..., const FString& DestPath )	Copies assets to a new path
bool	AssetViewUtils::CopyFolders ( const TArray< FString >& InSourceP..., const FString& DestPath )	Copies all assets in all source paths to the destination path, preserving path structure
int32	AssetViewUtils::DeleteAssets ( const TArray< UObject* >& Ass... )	Attempts to deletes the specified assets. Returns the number of assets deleted
bool	AssetViewUtils::DeleteFolders ( const TArray< FString >& PathsToDe... )	Attempts to delete the specified folders and all assets inside them.
bool	AssetViewUtils::DoesFolderExist ( const FString& FolderPath )	Returns true if the path specified exists as a folder in the asset registry
void	AssetViewUtils::GetAssetsInPaths ( const TArray< FString >& InPaths, TArray< FAssetData >& OutAssetData... )	Gets an array of assets inside the specified folders
FLinearColor	AssetViewUtils::GetDefaultColor()	Gets the default color the folder should appear as
int32	AssetViewUtils::GetMaxCookPathLen()	Gets the maximum path length for a cooked file.
void	AssetViewUtils::GetObjectsInAssetData ( const TArray< FAssetData >& AssetL..., TArray< UObject* >& OutDroppe... )	Get all the objects in a list of asset data
int32	AssetViewUtils::GetPackageLengthForCooking ( const FString& PackageName, bool IsInternalBuild )	Returns the length of the computed cooked package name and path whether it's run on a build machine or locally
void	AssetViewUtils::GetUnloadedAssets ( const TArray< FString >& ObjectPat..., TArray< FString >& OutUnloadedObje... )	Determines the unloaded assets that need loading
bool	AssetViewUtils::HasCustomColors ( TArray< FLinearColor >* OutCol... )	Checks to see if any folder has a custom color, optionally outputs them to a list
bool	AssetViewUtils::IsDevelopersFolder ( const FString& InPath )	Returns true if the passed-in path is a developers folder
bool	AssetViewUtils::IsEngineFolder ( const FString& InPath, const bool bIncludePlugins )	Returns true if the passed-in path is a engine folder
bool	AssetViewUtils::IsPluginFolder ( const FString& InPath, const TArray< TSharedRef< IPlugin >..., EPluginLoadedFrom* OutPluginSo... )	Returns true if the passed-in path is a plugin folder, optionally reporting where the plugin was loaded from.
bool	AssetViewUtils::IsPluginFolder ( const FString& InPath, EPluginLoadedFrom* OutPluginSo... )	Returns true if the passed-in path is a plugin folder, optionally reporting where the plugin was loaded from
bool	AssetViewUtils::IsProjectFolder ( const FString& InPath, const bool bIncludePlugins )	Returns true if the passed-in path is a project folder
bool	AssetViewUtils::IsValidFolderName ( const FString& FolderName, FText& Reason )	Returns true if the supplied folder name can be used as part of a package name
bool	AssetViewUtils::IsValidFolderPathForCreate ( const FString& FolderPath, const FString& NewFolderName, FText& OutErrorMessage )	Returns true if the specified folder name in the specified path is available for folder creation
bool	AssetViewUtils::IsValidObjectPathForCreate ( const FString& ObjectPath, const UClass* ObjectClass, FText& OutErrorMessage, bool bAllowExistingAsset )	Returns true if the specified path is available for object creation
bool	AssetViewUtils::IsValidObjectPathForCreate ( const FString& ObjectPath, FText& OutErrorMessage, bool bAllowExistingAsset )	Returns true if the specified path is available for object creation
bool	AssetViewUtils::IsValidPackageForCooking ( const FString& PackageName, FText& OutErrorMessage )	Checks to see whether the path is within the size restrictions for cooking
bool	AssetViewUtils::LoadAssetsIfNeeded ( const TArray< FString >& ObjectPat..., TArray< UObject* >& LoadedObj..., bool bAllowedToPromptToLoadAssets, bool bLoadRedirects )	Makes sure the specified assets are loaded into memory.
const TShare...	AssetViewUtils::LoadColor ( const FString& FolderPath )	Loads the color of this path from the config
TArray< UPac...	AssetViewUtils::LoadPackages ( const TArray< FString >& PackageNa... )	Loads all the specified packages
void	AssetViewUtils::MoveAssets ( const TArray< UObject* >& Ass..., const FString& DestPath, const FString& SourcePath )	Moves assets to a new path
bool	AssetViewUtils::MoveFolders ( const TArray< FString >& InSourceP..., const FString& DestPath )	Moves all assets in all source paths to the destination path, preserving path structure
FOnAlwaysSho...	AssetViewUtils::OnAlwaysShowPath()
FOnFolderPat...	AssetViewUtils::OnFolderPathChanged()
bool	AssetViewUtils::OpenEditorForAsset ( const FString& ObjectPath )	Loads the specified object if needed and opens the asset editor for it
bool	AssetViewUtils::OpenEditorForAsset ( UObject* Asset )	Opens the asset editor for the specified asset
bool	AssetViewUtils::OpenEditorForAsset ( const TArray< UObject* >& Ass... )	Opens the asset editor for the specified assets
bool	AssetViewUtils::PrepareFoldersForDragDrop ( const TArray< FString >& SourcePat..., TMap< FString, TArray< UObject*... )	A helper function for folder drag/drop which loads all assets in a path (including sub-paths) and returns the assets found
bool	AssetViewUtils::PromptToLoadAssets ( const TArray< FString >& UnloadedO... )	Prompts the user to load the list of unloaded objects
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
void	AssetViewUtils::SaveColor ( const FString& FolderPath, const TSharedPtr< FLinearColor >& ..., bool bForceAdd )	Saves the color of the path to the config
bool	AssetViewUtils::SaveDirtyPackages()	Prompts to save all modified packages
bool	AssetViewUtils::SavePackages ( const TArray< UPackage* >& Pa... )	Saves all the specified packages
void	AssetViewUtils::ShowErrorNotifcation ( const FText& InErrorMsg )	Show an error notification toast if the given error message is not empty
void	AssetViewUtils::SyncPackagesFromSourceControl ( const TArray< FString >& PackageNa... )	Syncs the specified packages from source control, other than any level assets which are currently being edited
void	AssetViewUtils::SyncPathsFromSourceControl ( const TArray< FString >& ContentPa... )	Syncs the content from the specified paths from source control, other than any level assets which are currently being edited

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss