1. Epic GamesDeveloper
  3. AssetTools

AssetTools

API > API/Developer

Filters

Classes

  Type Name Description
Public struct FAdvancedAssetCategory    
Public class FAdvancedCopyCompletedEvent    
Public struct FAdvancedCopyMap    
Public struct FAdvancedCopyParams    
Public struct FAssetRenameData    
Public class FAssetToolsModule    
Public class FAssetTypeActions_Base A base class for all AssetTypeActions.  
Public class FAssetTypeActions_CSVAssetBase    
Public class FClassTypeActions_Base A base class for all ClassTypeActions.  
Public class FCollectionAssetManagement Handles the collection management for the given assets  
Public struct FMigrationOptions    
Public struct FPackageMigrationContext    
Public class IAssetTools    
Public class IAssetTypeActions AssetTypeActions provide actions and other information about asset types  
Public class IClassTypeActions ClassTypeActions provide actions and other information about asset types that host classes  
Public class UAdvancedCopyCustomization    
Public class UAssetTools    
Public class UAssetToolsHelpers    
Public class UAssetToolsSettings    

Typedefs

Name Description
FAssetPostRenameEvent  
FCanMigrateAsset  
FDuplicatedObjects An array of maps each storing pairs of original object -> duplicated object.
FIsNameAllowed  
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  
FOnPackageMigration  
FOnSyncFinish Called when a sync from AssetViewUtils finishes If Files is non-nullptr, those are the files affected by the sync.
FOnSyncStart Called when a sync from AssetViewUtils starts

Enums

  Type Name Description
Public enum EAssetClassAction    
Public enum EAssetMigrationConflict    
Public enum EAssetRenameResult    
Public enum EAssetTypeActivationMethod::Type    
Public enum EAssetTypeActivationOpenedMethod Types of permissions allowed when attempting to open an asset in editor via activation (EAssetTypeActivationMethod)  
Public enum EAssetTypeCategories::Type The list of categories for Asset Type Actions and UFactory subclasses.  
Public enum ERedirectFixupMode    

Functions

  Type Name Description
Public function InSection

AddMenuEntry ( "MyAsset_DoTheThing",
Label,
ToolTip,
Icon,
UIAction
)

  
Public function bool Returns true if the specified asset that uses shared thumbnails has a thumbnail assigned to it
Public function void

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

 Capture active viewport to thumbnail and assigns that thumbnail to incoming assets
Public function void Clears custom thumbnails for the selected assets
Public function void

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

 Copies assets to a new path
Public function bool

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

 Copies all assets in all source paths to the destination path, preserving path structure
Public function int32

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

 Attempts to deletes the specified assets. Returns the number of assets deleted
Public function bool

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

 Attempts to delete the specified folders and all assets inside them.
Public function bool Returns true if the path specified exists as a folder in the asset registry
Public function void

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

 Gets an array of assets inside the specified folders
Public function FLinearColor Gets the default color the folder should appear as
Public function int32 Gets the maximum path length for an asset package file.
Public function int32 Gets the maximum path length for a cooked file.
Public function void

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

 Get all the objects in a list of asset data
Public function int32

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

 Returns the length of the computed cooked package name and path whether it's run on a build machine or locally
Public function FString Returns the relative path, from the workspace root, of the package
Public function TOptional< FLinearColor >

AssetViewUtils::GetPathColor ( const FString& FolderPath
)

 Returns the color of this path from the config
Public function TSharedPtr< IPlugin >

AssetViewUtils::GetPluginForFolder ( const FStringView InPath
)

 If the passed-in path is a plugin folder, then return its associated plugin
Public function void

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

 Determines the unloaded assets that need loading
Public function bool Checks to see if any folder has a custom color, optionally outputs them to a list
Public function bool

AssetViewUtils::IsDevelopersFolder ( const FStringView InPath
)

 Returns true if the passed-in path is a developers folder
Public function bool

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

 Returns true if the passed-in path is a engine folder
Public function 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
Public function bool

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

 Returns true if the passed-in path is a project folder
Public function bool

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

 Returns true if the supplied folder name can be used as part of a package name
Public function 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
Public function bool

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

 Returns true if the specified path is available for object creation
Public function bool

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

 Returns true if the specified path is available for object creation
Public function bool

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

 Checks to see whether the path is within the size restrictions for cooking
Public function bool

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

 Makes sure the specified assets are loaded into memory.
Public function const TSharedPtr< FLinearColor >

AssetViewUtils::LoadColor ( const FString& FolderPath
)

 LoadColor deprecated, please use GetPathColor
Public function TArray< UPackage * >

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

 Loads all the specified packages
Public function void

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

 Moves assets to a new path
Public function bool

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

 Moves all assets in all source paths to the destination path, preserving path structure
Public function FOnAlwaysShowPath &  
Public function FOnFolderPathChanged &  
Public function FOnSyncFinish &  
Public function FOnSyncStart &  
Public function bool Opens the asset editor for the specified assets
Public function bool Opens the asset editor for the specified asset
Public function bool Loads the specified object if needed and opens the asset editor for it
Public function 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
Public function bool

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

 Prompts the user to load the list of unloaded objects
Public function 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
Public function void

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

 SaveColor deprecated, please use SetPathColor
Public function bool Prompts to save all modified packages
Public function bool

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

 Saves all the specified packages
Public function void

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

 Saves the color of the path to the config
Public function void Show an error notification toast if the given error message is not empty
Public function bool Syncs latest from source control.
Public function bool Syncs the specified packages from source control.
Public function void

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

 The bIsSyncLatestOperation parameter is deprecated. Use SyncLatestFromSourceControl instead.
Public function bool Syncs the specified paths from source control.

Variables

  Type Name Description
Public variable const FSlateIcon Icon  
Public variable const TAttribute< FText > ToolTip HOW TO ADD ASSET EXTENSION MENUS
Public variable const FToolMenuExecuteAction UIAction  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page