1. Epic GamesDeveloper
  3. IAssetTools

IAssetTools

API > API/Developer > API/Developer/AssetTools

References

   
Module AssetTools
Header /Engine/Source/Developer/AssetTools/Public/IAssetTools.h
Include #include "IAssetTools.h"

Syntax

class IAssetTools

Functions

  Type Name Description
Public function Const bool

AdvancedCopyPackages ( const FAdvancedCopyParams& CopyParams,
const TArray< TMap< FString, FString >>& PackagesAndDestinations
)

 Copies files after the final set of maps of sources and destinations was confirmed
Public function Const bool

AdvancedCopyPackages ( const TMap< FString, FString >& SourceAndDestPackages,
const bool bForceAutosave,
const bool bCopyOverAllDestinationOverlaps,
FDuplicatedObjects* OutDuplicatedObjects,
EMessageSeverity::Type NotificationSeverityFilter
)

 Copies files after the flattened map of sources and destinations was confirmed
Public function Const bool Returns true if all in list pass writable folder filter
Public function Const bool

AssetUsesGenericThumbnail ( const FAssetData& AssetData
)

 Returns true if the specified asset uses a stock thumbnail resource
Public function Const void

BeginAdvancedCopyPackages ( const TArray< FName >& InputNamesToCopy,
const FString& TargetPath
)

 Copy packages and dependencies to another folder
Public function Const void

BeginAdvancedCopyPackages ( const TArray< FName >& InputNamesToCopy,
const FString& TargetPath,
const FAdvancedCopyCompletedEvent& OnCopyComplete
)

  
Public function Const bool

CanExportAssets ( const TArray< FAssetData >& AssetsToExport
)

 Check if specified assets can be exported.
Public function Const bool

CanLocalize ( const UClass* Class
)

  
Public function Const void

ConvertVirtualTextures ( const TArray< UTexture2D* >& Textures,
bool bConvertBackToNonVirtual,
const TArray< UMaterial* >* RelatedMaterials
)

 Converts the given UTexture2D to virtual textures or converts virtual textures back to standard textures and updates the related UMaterials
Public function UObject *

CreateAsset ( const FString& AssetName,
const FString& PackagePath,
UClass* AssetClass,
UFactory* Factory,
FName CallingContext
)

 Creates an asset with the specified name, path, and factory
Public function void

CreateAssetsFrom ( TConstArrayView< SourceObjectType* > SourceObjects,
UClass* CreateAssetType,
const FString& DefaultSuffix,
TFunctionRef< UFactory*(SourceObjectType*)> FactoryConstructor,
FName CallingContext
)

 Creates one or more assets using the source objects as the basis for the next type.
Public function void

CreateAssetsFrom ( TConstArrayView< UObject* > SourceObjects,
UClass* CreateAssetType,
const FString& DefaultSuffix,
TFunctionRef< UFactory*(UObject*)> FactoryConstructor,
FName CallingContext
)

 Creates one or more assets using the source objects as the basis for the next type.
Public function UObject *

CreateAssetWithDialog ( const FString& AssetName,
const FString& PackagePath,
UClass* AssetClass,
UFactory* Factory,
FName CallingContext,
const bool bCallConfigureProperties
)

 Opens an asset picker dialog and creates an asset with the specified name and path
Public function UObject *

CreateAssetWithDialog ( UClass* AssetClass,
UFactory* Factory,
FName CallingContext
)

 Opens an asset picker dialog and creates an asset with the path chosen in the dialog
Public function Const bool

CreateDiffProcess ( const FString& DiffCommand,
const FString& OldTextFilename,
const FString& NewTextFilename,
const FString& DiffArgs
)

 Attempt to spawn Diff tool as external process
Public function void

CreateUniqueAssetName ( const FString& InBasePackageName,
const FString& InSuffix,
FString& OutPackageName,
FString& OutAssetName
)

 Creates a unique package and asset name taking the form InBasePackageName+InSuffix
Public function Const void

DiffAgainstDepot ( UObject* InObject,
const FString& InPackagePath,
const FString& InPackageName
)

 Try to diff the local version of an asset against the latest one from the depot
Public function Const void

DiffAssets ( UObject* OldAsset,
UObject* NewAsset,
const FRevisionInfo& OldRevision,
const FRevisionInfo& NewRevision
)

 Try and diff two assets using class-specific tool.
Public function Const FString Util for dumping an asset to a temporary text file. Returns absolute filename to temp file
Public function UObject *

DuplicateAsset ( const FString& AssetName,
const FString& PackagePath,
UObject* OriginalObject
)

 Creates an asset with the specified name and path. Uses OriginalObject as the duplication source.
Public function UObject *

DuplicateAssetWithDialog ( const FString& AssetName,
const FString& PackagePath,
UObject* OriginalObject
)

 Opens an asset picker dialog and creates an asset with the specified name and path.
Public function UObject *

DuplicateAssetWithDialogAndTitle ( const FString& AssetName,
const FString& PackagePath,
UObject* OriginalObject,
FText DialogTitle
)

 Opens an asset picker dialog and creates an asset with the specified name and path.
Public function Const void

ExpandDirectories ( const TArray< FString >& Files,
const FString& DestinationPath,
TArray< TPair< FString, FString >>& FilesAndDestinations
)

 Expands any folders found in the files list, and returns a flattened list of destination paths and files.
Public function Const void

ExportAssets ( const TArray< UObject* >& AssetsToExport,
const FString& ExportPath
)

 Exports the specified objects to file.
Public function void

ExportAssets ( const TArray< FString >& AssetsToExport,
const FString& ExportPath
)

 Exports the specified objects to file.
Public function void

ExportAssetsWithDialog ( const TArray< UObject* >& AssetsToExport,
bool bPromptForIndividualFilenames
)

 Exports the specified objects to file.
Public function void

ExportAssetsWithDialog ( const TArray< FString >& AssetsToExport,
bool bPromptForIndividualFilenames
)

 Exports the specified objects to file.
Public function Const EAssetTypeCategories::Type Returns the allocated Category bit for a user-specified Category, or EAssetTypeCategories::Misc if it doesn't exist
Public function void

FindSoftReferencesToObject ( FSoftObjectPath TargetObject,
TArray< UObject* >& ReferencingObjects
)

 Returns list of objects that soft reference the given soft object path.
Public function void

FindSoftReferencesToObjects ( const TArray< FSoftObjectPath >& TargetObjects,
TMap< FSoftObjectPath, TArray< UObject* >>& ReferencingObjects
)

 Returns list of objects that soft reference the given soft object paths.
Public function Const void

FixupReferencers ( const TArray< UObjectRedirector* >& Objects,
bool bCheckoutDialogPrompt,
ERedirectFixupMode FixupMode
)

 Fix up references to the specified redirectors.
Public function Const bool

FlattenAdvancedCopyDestinations ( const TArray< TMap< FString, FString >>& PackagesAndDestinations,
TMap< FString, FString >& FlattenedPackagesAndDestinations
)

 Flattens the maps for each selected package into one complete map to pass to the final copy function while checking for collisions
Public function Const void

GenerateAdvancedCopyDestinations ( FAdvancedCopyParams& InParams,
const TArray< FName >& InPackageNamesToCopy,
const UAdvancedCopyCustomization* CopyCustomization,
TMap< FString, FString >& OutPackagesAndDestinations
)

 Given a set of packages to copy, generate the map of those packages to destination filenames
Public function Static IAssetTools &

Get ()

  
Public function Const void Returns the list of all advanced asset categories
Public function Const void

GetAllAdvancedCopySources ( FName SelectedPackage,
FAdvancedCopyParams& CopyParams,
TArray< FName >& OutPackageNamesToCopy,
TMap< FName, FName >& DependencyMap,
const UAdvancedCopyCustomization* CopyCustomization
)

 Find all the dependencies that also need to be copied in the advanced copy, mapping them to the file that depends on them and excluding any that don't pass the ARFilter stored on CopyParams
Public function TSet< EBlueprintType > & Which BlueprintTypes are allowed to be created. An empty list should allow everything.
Public function Const const TSharedRef< FPathPermissionList > & Get asset class permission list for content browser and other systems
Public function Const TWeakPtr< IAssetTypeActions > Gets the appropriate AssetTypeActions for the supplied class
Public function Const void

GetAssetTypeActionsList ( TArray< TWeakPtr< IAssetTypeActions >>& OutAssetTypeActionsList
)

 Generates a list of currently registered AssetTypeActions
Public function Const TArray< TWeakPtr< IAssetTypeActions > > Gets the list of appropriate AssetTypeActions for the supplied class
Public function Const TWeakPtr< IClassTypeActions > Gets the appropriate ClassTypeActions for the supplied class
Public function Const void

GetClassTypeActionsList ( TArray< TWeakPtr< IClassTypeActions >>& OutClassTypeActionsList
)

 Generates a list of currently registered ClassTypeActions
Public function bool Gets whether assets are being made externally referenceable or not
Public function TSharedRef< FPathPermissionList > & Get folder permission list for content browser and other systems
Public function Const const TSharedRef< FNamePermissionList > & Get extension permission list allowed for importer
Public function Const TArray< UFactory * > Find all supported asset factories.
Public function UE::AssetTools::FOnPackageMigration & Event called when some packages are migrated Note this is only true when AssetTools.UseNewPackageMigration is true
Public function Const TOptional< FLinearColor >

GetTypeColor ( const UClass* Class
)

  
Public function TSharedRef< FPathPermissionList > & Get writable folder permission list for content browser and other systems
Public function Const TArray< UObject * >

ImportAssets ( const TArray< FString >& Files,
const FString& DestinationPath,
UFactory* ChosenFactory,
bool bSyncToBrowser,
TArray< TPair< FString, FString >>* FilesAndDestinations,
bool bAllowAsyncImport,
bool bSceneImport
)

 Imports the specified files to the destination path.
Public function TArray< UObject * > Imports assets using data specified completely up front.
Public function TArray< UObject * >

ImportAssetsWithDialog ( const FString& DestinationPath
)

 Opens a file open dialog to choose files to import to the destination path.
Public function void

ImportAssetsWithDialogAsync ( const FString& DestinationPath
)

 Opens a file open dialog to choose files to import to the destination path.
Public function void

ImportAssetTasks ( const TArray< UAssetImportTask* >& ImportTasks
)

 Imports assets using tasks specified.
Public function Const void Given a complete set of copy parameters, which includes the selected package set, start the advanced copy process
Public function Const bool

IsAssetClassSupported ( const UClass* AssetClass
)

 Is the given asset class supported?
Public function Const bool Gets whether assets registry is still loading assets or not
Public function Const bool Returns whether redirectors are being fixed up.
Public function Const bool

IsImportExtensionAllowed ( const FString& Extension
)

  
Public function Const bool

IsNameAllowed ( const FString& Name,
FText* OutErrorMessage
)

 Returns true if IsNameAllowedDelegate is not set, or if the name passes the filter function
Public function Const void

MigratePackages ( const TArray< FName >& PackageNamesToMigrate,
const FString& DestinationPath,
const FMigrationOptions& Options
)

 Migrate packages and dependencies to another folder
Public function Const void

MigratePackages ( const TArray< FName >& PackageNamesToMigrate
)

 Migrate packages to another game content folder
Public function Const void Show notification that writable folder filter blocked an action
Public function FAssetPostRenameEvent & Event issued at the end of the rename process
Public function void

OpenDiscoveringAssetsDialog ( const FOnAssetsDiscovered& InOnAssetsDiscovered
)

 Opens a dialog asking the user to wait while assets are being discovered
Public function void

OpenEditorForAssets ( const TArray< UObject* >& Assets
)

 Opens editor for assets
Public function EAssetTypeCategories::Type

RegisterAdvancedAssetCategory ( FName CategoryKey,
FText CategoryDisplayName
)

 Allocates a Category bit for a user-defined Category, or EAssetTypeCategories::Misc if all available bits are allocated.
Public function void Registers an asset type actions object so it can provide information about and actions for asset types.
Public function void Allow to add some restrictions to the assets that can be migrated
Public function void Registers a class type actions object so it can provide information about and actions for class asset types.
Public function void

RegisterIsNameAllowedDelegate ( const FName OwnerName,
FIsNameAllowed Delegate
)

 Allows setting of a global name filter that is applied to folders, assets, plugins, etc.
Public function bool

RenameAssets ( const TArray< FAssetRenameData >& AssetsAndNames
)

 Renames assets using the specified names.
Public function EAssetRenameResult

RenameAssetsWithDialog ( const TArray< FAssetRenameData >& AssetsAndNames,
bool bAutoCheckout
)

 Renames assets using the specified names.
Public function void

RenameReferencingSoftObjectPaths ( const TArray< UPackage* > PackagesToCheck,
const TMap< FSoftObjectPath, FSoftObjectPath >& AssetRedirectorMap
)

 Function that renames all FSoftObjectPath object with the old asset path to the new one.
Public function void Controls whether or not newly created assets are made externally referneceable or not
Public function void

SyncBrowserToAssets ( const TArray< UObject* >& AssetsToSync
)

 Syncs the primary content browser to the specified assets, whether or not it is locked.
Public function void

SyncBrowserToAssets ( const TArray< FAssetData >& AssetsToSync
)

  
Public function void Unregisters an asset type actions object.
Public function void

UnregisterCanMigrateAsset ( const FName OwnerName
)

  
Public function void Unregisters a class type actions object.
Public function void Remove a previously-set global name filter
Public function Const bool

ValidateFlattenedAdvancedCopyDestinations ( const TMap< FString, FString >& FlattenedPackagesAndDestinations
)

 Validate the destinations for advanced copy once the map has been flattened

Typedefs

Name Description
FOnAssetsDiscovered  

Deprecated Functions

  Type Name Description
Public function TSharedRef< FNamePermissionList > & Pass in an EAssetClassAction instead of nothing

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page