Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UContentBrowserAliasDataSource

UContentBrowserAliasDataSource

A companion to the ContentBrowserAssetDataSource which can display assets in folders other than their actual folder.

API > API/Plugins > API/Plugins/ContentBrowserAliasDataSource

A companion to the ContentBrowserAssetDataSource which can display assets in folders other than their actual folder. Aliases mimic their source asset as closely as possible, including editing, saving, thumbnails, and more. Some behavior is restricted such as moving or deleting an alias item.

Aliases can either be created automatically by tagging the asset with the value defined by AliasTagName and giving it a comma-separated list of aliases, or manually managed by calling AddAlias and RemoveAlias. ReconcileAliasesForAsset is provided as a helper function to automatically update new/removed aliases for an existing asset.

   
Name UContentBrowserAliasDataSource
Type class
Header File /Engine/Plugins/Editor/ContentBrowser/ContentBrowserAliasDataSource/Source/ContentBrowserAliasDataSource/Public/ContentBrowserAliasDataSource.h
Include Path #include "ContentBrowserAliasDataSource.h"

Syntax

UCLASS (MinimalAPI)  
class UContentBrowserAliasDataSource : public UContentBrowserDataSource

Inheritance Hierarchy

Structs

Name Remarks
FAliasData  

Constants

Name Type Remarks Include Path
AliasTagName FName The metadata tag to set for the AliasDataSource to automatically create aliases for an asset ContentBrowserAliasDataSource.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AliasesForObjectPath TMap< FSoftObjectPath, TArray< FName > > A list of alias paths to display for each asset, eg /Game/Meshes/SourceMesh.SourceMesh ContentBrowserAliasDataSource.h  
AliasesInPackagePath TMap< FName, TArray< FContentBrowserUniqueAlias > > A list of alias paths to display for each folder, eg /Game/MyData/Aliases ContentBrowserAliasDataSource.h  
AliasFolderDisplayNames TMap< FName, FText > Alias folder display names keyed against their alias path, eg /Game/MyData/Aliases/ ContentBrowserAliasDataSource.h  
AliasForInternalPath TMap< FName, FContentBrowserUniqueAlias > The alias path to display for each file ContentBrowserAliasDataSource.h  
AllAliases TMap< FContentBrowserUniqueAlias, FAliasData > Alias data keyed by their full alias path, eg /Game/MyData/Aliases/SourceMesh ContentBrowserAliasDataSource.h  
AlreadyAddedOriginalAssets TSet< FSoftObjectPath > A set used for removing duplicate aliases in the same query, stored here to avoid constant reallocation ContentBrowserAliasDataSource.h  
AssetRegistry IAssetRegistry *   ContentBrowserAliasDataSource.h  
AssetTools IAssetTools *   ContentBrowserAliasDataSource.h  
bFilterShouldMatchCollectionContent bool If true, EnumerateItemsMatchingFilter will include aliases of items contained in collections included in the filter ContentBrowserAliasDataSource.h  
ContentBrowserModule FContentBrowserModule *   ContentBrowserAliasDataSource.h  
FilterCache UContentBrowserAssetDataSource::FAssetDataSourceFilterCache   ContentBrowserAliasDataSource.h  
PathTree FPathTree The full folder hierarchy for all alias paths ContentBrowserAliasDataSource.h  
RebuildAliasesDelegate FSimpleMulticastDelegate Delegate broadcast after all aliases removed to give chance for systems to re-add aliases ContentBrowserAliasDataSource.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddAlias ( const FAssetData& Asset,
const FName Alias,
const bool bInIsFromMetaData,
const bool bSkipPrimaryAssetValidation
)

 Add an alias for a given asset. ContentBrowserAliasDataSource.h  

void AddAlias ( const FAssetData& Asset,
const FContentBrowserLocalizedAlias& Alias,
const bool bInIsFromMetaData,
const bool bSkipPrimaryAssetValidation
)

   ContentBrowserAliasDataSource.h  

void AddAliases ( const FAssetData& Asset,
const TArray< FName >& Aliases,
const bool bInIsFromMetaData,
const bool bSkipPrimaryAssetValidation
)

 Add a list of aliases for a given asset. ContentBrowserAliasDataSource.h  

void AddAliases ( const FAssetData& Asset,
const TArray< FContentBrowserLocalizedAlias >& Aliases,
const bool bInIsFromMetaData,
const bool bSkipPrimaryAssetValidation
)

   ContentBrowserAliasDataSource.h  

void AddAliasFolderDisplayName ( const FName AliasFolder,
const FText& DisplayName
)

 Add a display name override for the given alias folder, eg /MyAliases. ContentBrowserAliasDataSource.h  
  ContentBrowserAliasDataSource.h  

bool HasAliasesForPath ( const FSoftObjectPath& InInternalPath
) const

   ContentBrowserAliasDataSource.h  

void Initialize ( const bool InAutoRegister
)

   ContentBrowserAliasDataSource.h  

void LogAliases()

 Logs all the content browser aliases ContentBrowserAliasDataSource.h  

FSimpleMulticastDelegate & OnRebuildAliases()

 Broadcast after RebuildAliases() called to allow systems to re-add aliases ContentBrowserAliasDataSource.h  

void RebuildAliases()

 When called, removes all aliases and triggers delegate for various systems to re-add aliases ContentBrowserAliasDataSource.h  

void ReconcileAliasesForAsset ( const FAssetData& Asset,
const TArray< FContentBrowserLocalizedAlias >& NewAliases
)

   ContentBrowserAliasDataSource.h  

void ReconcileAliasesForAsset ( const FAssetData& Asset,
const TArray< FName >& NewAliases
)

 Calls AddAlias or RemoveAlias for every alias that doesn't match the stored data for the given asset. ContentBrowserAliasDataSource.h  

void ReconcileAliasesFromMetaData ( const FAssetData& Asset
)

 Get all aliases from metadata for the given asset, then calls AddAlias or RemoveAlias for every alias that doesn't match the stored data. ContentBrowserAliasDataSource.h  

void RemoveAlias ( const FSoftObjectPath& ObjectPath,
const FName Alias
)

 Remove the given alias from the data source ContentBrowserAliasDataSource.h  

void RemoveAlias ( const FName ObjectPath,
const FName Alias
)

   ContentBrowserAliasDataSource.h  

void RemoveAliases ( const FSoftObjectPath& ObjectPath
)

 Remove all aliases for the given object ContentBrowserAliasDataSource.h  

void RemoveAliases ( const FAssetData& Asset
)

 Remove all aliases for the given asset ContentBrowserAliasDataSource.h  

void RemoveAliases ( const FName ObjectPath
)

   ContentBrowserAliasDataSource.h  

void RemoveAliasFolderDisplayName ( const FName AliasFolder
)

 Remove a display name override for the given alias folder, eg /MyAliases. ContentBrowserAliasDataSource.h  

void SetFilterShouldMatchCollectionContent ( bool bInFilterShouldMatchCollectionContent
)

   ContentBrowserAliasDataSource.h  

Overridden from UContentBrowserDataSource

Name Remarks Include Path Unreal Specifiers

virtual bool AppendItemObjectPath ( const FContentBrowserItemData& InItem,
FString& InOutStr
)

   ContentBrowserAliasDataSource.h  

virtual bool AppendItemPackageName ( const FContentBrowserItemData& InItem,
FString& InOutStr
)

   ContentBrowserAliasDataSource.h  

virtual bool AppendItemReference ( const FContentBrowserItemData& InItem,
FString& InOutStr
)

   ContentBrowserAliasDataSource.h  

virtual bool BulkEditItems ( TArrayView< const FContentBrowserItemData > InItems
)

   ContentBrowserAliasDataSource.h  

virtual bool BulkPreviewItems ( TArrayView< const FContentBrowserItemData > InItems
)

   ContentBrowserAliasDataSource.h  

virtual bool BulkPrivatizeItems ( TArrayView< const FContentBrowserItemData > InItems,
const EAssetAccessSpecifier InAssetAccessSpecifier
)

   ContentBrowserAliasDataSource.h  

virtual bool BulkSaveItems ( TArrayView< const FContentBrowserItemData > InItems,
const EContentBrowserItemSaveFlags InSaveFlags
)

   ContentBrowserAliasDataSource.h  

virtual bool BulkViewItems ( TArrayView< const FContentBrowserItemData > InItems
)

   ContentBrowserAliasDataSource.h  

virtual bool CanEditItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

   ContentBrowserAliasDataSource.h  

virtual bool CanModifyItemAssetAccessSpecifier ( const FContentBrowserItemData& InItem
)

   ContentBrowserAliasDataSource.h  

virtual bool CanPreviewItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

   ContentBrowserAliasDataSource.h  

virtual bool CanPrivatizeItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

   ContentBrowserAliasDataSource.h  

virtual bool CanSaveItem ( const FContentBrowserItemData& InItem,
const EContentBrowserItemSaveFlags InSaveFlags,
FText* OutErrorMsg
)

   ContentBrowserAliasDataSource.h  

virtual bool CanViewItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

   ContentBrowserAliasDataSource.h  

virtual void ClearCachedFilterData ( const FContentBrowserDataFilterCacheIDOwner& IDOwner
)

   ContentBrowserAliasDataSource.h  

virtual void CompileFilter ( const FName InPath,
const FContentBrowserDataFilter& InFilter,
FContentBrowserDataCompiledFilter& OutCompiledFilter
)

   ContentBrowserAliasDataSource.h  

virtual bool DoesItemPassFilter ( const FContentBrowserItemData& InItem,
const FContentBrowserDataCompiledFilter& InFilter
)

   ContentBrowserAliasDataSource.h  

virtual bool EditItem ( const FContentBrowserItemData& InItem
)

   ContentBrowserAliasDataSource.h  

virtual void EnumerateItemsAtPath ( const FName InPath,
const EContentBrowserItemTypeFilter InItemTypeFilter,
TFunctionRef< bool(FContentBrowserItemData&&)> InCallback
)

   ContentBrowserAliasDataSource.h  

virtual void EnumerateItemsAtUserProvidedPath ( const FStringView InPath,
const EContentBrowserItemTypeFilter InItemTypeFilter,
TFunctionRef< bool(FContentBrowserItemData&&)> InCallback
)

   ContentBrowserAliasDataSource.h  

virtual void EnumerateItemsMatchingFilter ( const FContentBrowserDataCompiledFilter& InFilter,
TFunctionRef< bool(FContentBrowserItemData&&)> InCallback
)

   ContentBrowserAliasDataSource.h  

virtual TArray< FContentBrowserItemPath > GetAliasesForPath ( const FSoftObjectPath& InInternalPath
) const

   ContentBrowserAliasDataSource.h  

virtual bool GetItemAssetAccessSpecifier ( const FContentBrowserItemData& InItem,
EAssetAccessSpecifier& OutAssetAccessSpecifier
)

   ContentBrowserAliasDataSource.h  

virtual bool GetItemAttribute ( const FContentBrowserItemData& InItem,
const bool InIncludeMetaData,
const FName InAttributeKey,
FContentBrowserItemDataAttributeValue& OutAttributeValue
)

   ContentBrowserAliasDataSource.h  

virtual bool GetItemAttributes ( const FContentBrowserItemData& InItem,
const bool InIncludeMetaData,
FContentBrowserItemDataAttributeValues& OutAttributeValues
)

   ContentBrowserAliasDataSource.h  

virtual bool GetItemPhysicalPath ( const FContentBrowserItemData& InItem,
FString& OutDiskPath
)

   ContentBrowserAliasDataSource.h  

virtual bool IsFolderVisible ( const FName Path,
const EContentBrowserIsFolderVisibleFlags Flags,
const FContentBrowserFolderContentsFilter& ContentsFilter
)

   ContentBrowserAliasDataSource.h  

virtual bool IsItemDirty ( const FContentBrowserItemData& InItem
)

   ContentBrowserAliasDataSource.h  

virtual bool Legacy_TryConvertAssetDataToVirtualPath ( const FAssetData& InAssetData,
const bool InUseFolderPaths,
FName& OutPath
)

   ContentBrowserAliasDataSource.h  

virtual bool Legacy_TryConvertPackagePathToVirtualPath ( const FName InPackagePath,
FName& OutPath
)

   ContentBrowserAliasDataSource.h  

virtual bool Legacy_TryGetAssetData ( const FContentBrowserItemData& InItem,
FAssetData& OutAssetData
)

   ContentBrowserAliasDataSource.h  

virtual bool Legacy_TryGetPackagePath ( const FContentBrowserItemData& InItem,
FName& OutPackagePath
)

 Legacy functions seem necessary for FrontendFilters to work. ContentBrowserAliasDataSource.h  

virtual bool PreviewItem ( const FContentBrowserItemData& InItem
)

   ContentBrowserAliasDataSource.h  

virtual bool PrivatizeItem ( const FContentBrowserItemData& InItem,
const EAssetAccessSpecifier InAssetAccessSpecifier
)

   ContentBrowserAliasDataSource.h  

virtual void RemoveUnusedCachedFilterData ( const FContentBrowserDataFilterCacheIDOwner& IDOwner,
TArrayView< const FName > InVirtualPathsInUse,
const FContentBrowserDataFilter& DataFilter
)

   ContentBrowserAliasDataSource.h  

virtual bool SaveItem ( const FContentBrowserItemData& InItem,
const EContentBrowserItemSaveFlags InSaveFlags
)

   ContentBrowserAliasDataSource.h  

virtual void Shutdown()

   ContentBrowserAliasDataSource.h  

virtual bool TryGetCollectionId ( const FContentBrowserItemData& InItem,
FSoftObjectPath& OutCollectionId
)

   ContentBrowserAliasDataSource.h  

virtual bool UpdateThumbnail ( const FContentBrowserItemData& InItem,
FAssetThumbnail& InThumbnail
)

   ContentBrowserAliasDataSource.h  

virtual bool ViewItem ( const FContentBrowserItemData& InItem
)

   ContentBrowserAliasDataSource.h  

Protected

Overridden from UContentBrowserDataSource

Name Remarks Include Path Unreal Specifiers

virtual void BuildRootPathVirtualTree()

   ContentBrowserAliasDataSource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page