AssetTools

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public struct

FAdvancedAssetCategory

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

FRevisionInfo

Revision information for a single revision of a file in source control

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

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

Public enum

EAssetRenameResult

Public enum

EAssetTypeActivationMethod::Type

Public enum

EAssetTypeCategories::Type

The list of categories for Asset Type Actions and UFactory subclasses.

Functions

Name Description

Public function

bool

 

AssetViewUtils::AssetHasCustomThumbnail

(
    const FAssetData & AssetData
)

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 >& InAsse...
)

Capture active viewport to thumbnail and assigns that thumbnail to incoming assets

Public function

void

 

AssetViewUtils::ClearCustomThumbnails

(
    const TArray < FAssetData >& InAsse...
)

Clears custom thumbnails for the selected assets

Public function

void

 

AssetViewUtils::CopyAssets

(
    const TArray < UObject * >& Ass...,
    const FString & DestPath
)

Copies assets to a new path

Public function

bool

 

AssetViewUtils::CopyFolders

(
    const TArray < FString >& InSourceP...,
    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 * >& Ass...
)

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

Public function

bool

 

AssetViewUtils::DeleteFolders

(
    const TArray < FString >& PathsToDe...
)

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

Public function

bool

 

AssetViewUtils::DoesFolderExist

(
    const FString & FolderPath
)

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 >& OutAssetData...
)

Gets an array of assets inside the specified folders

Public function

FLinearColor

 

AssetViewUtils::GetDefaultColor()

Gets the default color the folder should appear as

Public function

int32

 

AssetViewUtils::GetMaxCookPathLen()

Gets the maximum path length for a cooked file.

Public function

void

 

AssetViewUtils::GetObjectsInAssetData

(
    const TArray < FAssetData >& AssetL...,
    TArray < UObject * >& OutDroppe...
)

Get all the objects in a list of asset data

Public function

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

Public function

void

 

AssetViewUtils::GetUnloadedAssets

(
    const TArray < FString >& ObjectPat...,
    TArray < FString >& OutUnloadedObje...
)

Determines the unloaded assets that need loading

Public function

bool

 

AssetViewUtils::HasCustomColors

(
    TArray < FLinearColor >* OutCol...
)

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

Public function

bool

 

AssetViewUtils::IsDevelopersFolder

(
    const FString & InPath
)

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

Public function

bool

 

AssetViewUtils::IsEngineFolder

(
    const FString & InPath,
    const bool bIncludePlugins
)

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

Public function

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.

Public function

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

Public function

bool

 

AssetViewUtils::IsProjectFolder

(
    const FString & 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 >& ObjectPat...,
    TArray < UObject * >& LoadedObj...,
    bool bAllowedToPromptToLoadAssets,
    bool bLoadRedirects
)

Makes sure the specified assets are loaded into memory.

Public function

const TShare ...

 

AssetViewUtils::LoadColor

(
    const FString & FolderPath
)

Loads the color of this path from the config

Public function

TArray < UPac ...

 

AssetViewUtils::LoadPackages

(
    const TArray < FString >& PackageNa...
)

Loads all the specified packages

Public function

void

 

AssetViewUtils::MoveAssets

(
    const TArray < UObject * >& Ass...,
    const FString & DestPath,
    const FString & SourcePath
)

Moves assets to a new path

Public function

bool

 

AssetViewUtils::MoveFolders

(
    const TArray < FString >& InSourceP...,
    const FString & DestPath
)

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

Public function

FOnAlwaysSho ...

 

AssetViewUtils::OnAlwaysShowPath()

Public function

FOnFolderPat ...

 

AssetViewUtils::OnFolderPathChanged()

Public function

bool

 

AssetViewUtils::OpenEditorForAsset

(
    const FString & ObjectPath
)

Loads the specified object if needed and opens the asset editor for it

Public function

bool

 

AssetViewUtils::OpenEditorForAsset

(
    UObject * Asset
)

Opens the asset editor for the specified asset

Public function

bool

 

AssetViewUtils::OpenEditorForAsset

(
    const TArray < UObject * >& Ass...
)

Opens the asset editor for the specified assets

Public function

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

Public function

bool

 

AssetViewUtils::PromptToLoadAssets

(
    const TArray < FString >& UnloadedO...
)

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 >& ...,
    bool bForceAdd
)

Saves the color of the path to the config

Public function

bool

 

AssetViewUtils::SaveDirtyPackages()

Prompts to save all modified packages

Public function

bool

 

AssetViewUtils::SavePackages

(
    const TArray < UPackage * >& Pa...
)

Saves all the specified packages

Public function

void

 

AssetViewUtils::ShowErrorNotifcation

(
    const FText & InErrorMsg
)

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

Public function

void

 

AssetViewUtils::SyncPackagesFromSourceControl

(
    const TArray < FString >& PackageNa...
)

Syncs the specified packages from source control, other than any level assets which are currently being edited

Public function

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback