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

Inheritance Hierarchy

References

   
Module ContentBrowserAliasDataSource
Header /Engine/Plugins/Editor/ContentBrowser/ContentBrowserAliasDataSoure/Source/ContentBrowserAliasDataSource/Public/ContentBrowserAliasDataSource.h
Include #include "ContentBrowserAliasDataSource.h"

Syntax

UCLASS&40;&41;  
class UContentBrowserAliasDataSource : public UContentBrowserDataSource

Remarks

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.

Functions

  Type Name Description
Public function void

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

 Add an alias for a given asset.
Public function void

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

 Add a list of aliases for a given asset.
Public function void

Initialize ( const bool InAutoRegister
)

  
Public function Const void Logs all the content browser aliases
Public function 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.
Public function void Get all aliases from metadata for the given asset, then calls AddAlias or RemoveAlias for every alias that doesn't match the stored data.
Public function void

RemoveAlias ( const FSoftObjectPath& ObjectPath,
const FName Alias
)

 Remove the given alias from the data source
Public function void

RemoveAliases ( const FSoftObjectPath& ObjectPath
)

 Remove all aliases for the given object
Public function void

RemoveAliases ( const FAssetData& Asset
)

 Remove all aliases for the given asset

Overridden from UContentBrowserDataSource

  Type Name Description
Public function Virtual bool

AppendItemReference ( const FContentBrowserItemData& InItem,
FString& InOutStr
)

 Attempt to append any path references for the given item to the given string.
Protected function Virtual void Rebuilds the tree of virtual paths that ends with internal roots
Public function Virtual bool Attempt to open the given item for editing.
Public function Virtual bool Attempt to preview the given items.
Public function Virtual bool Attempt to mark the given items as private (NotExternallyReferenceable)
Public function Virtual bool

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

 Attempt to save the given items.
Public function Virtual bool Attempt to open the given items for read-only viewing.
Public function Virtual bool

CanEditItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item is can be edited, optionally providing error information if it cannot.
Public function Virtual bool

CanPreviewItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item is can be previewed, optionally providing error information if it cannot.
Public function Virtual bool

CanPrivatizeItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item can be privatized, optionally providing error information if it cannot.
Public function Virtual bool

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

 Query whether the given item is can be saved, optionally providing error information if it cannot.
Public function Virtual bool

CanViewItem ( const FContentBrowserItemData& InItem,
FText* OutErrorMsg
)

 Query whether the given item is can be viewed (a read-only asset editor), optionally providing error information if it cannot.
Public function Virtual void Tell the data source to remove the cached data for the filter compilation for this specific owner.
Public function Virtual void

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

 Given a path and a data filter, produce an optimized filter that can be used to efficiently enumerate items that match it, and also query whether an item would pass it.
Public function Virtual bool Query whether the given item passes the given compiled filter.
Public function Virtual bool

EditItem ( const FContentBrowserItemData& InItem
)

 Attempt to open the given item for editing.
Public function Virtual void

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

 Enumerate items that have the given virtual path, optionally filtering by type, and invoking the callback for each matching item.
Public function Virtual void Enumerate items that match the given compiled filter, invoking the callback for each matching item.
Public function Virtual Const TArray< FContentBrowserItemPath >

GetAliasesForPath ( const FSoftObjectPath& InInternalPath
)

 Get a list of other paths that the data source may be using to represent a specific path
Public function Virtual bool

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

 Query the value of the given attribute on the given item.
Public function Virtual bool

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

 Query the values of all attributes on the given item.
Public function Virtual bool

GetItemPhysicalPath ( const FContentBrowserItemData& InItem,
FString& OutDiskPath
)

 Query the physical (on-disk) path of the given item.
Public function Virtual bool Query whether the given item is considered dirty (ie, has unsaved changes).
Public function Virtual bool

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

 Attempt to convert the given asset data to a virtual path associated with this data source.
Public function Virtual bool

Legacy_TryConvertPackagePathToVirtualPath ( const FName InPackagePath,
FName& OutPath
)

 Attempt to convert the given package path to a virtual path associated with this data source.
Public function Virtual bool

Legacy_TryGetAssetData ( const FContentBrowserItemData& InItem,
FAssetData& OutAssetData
)

 Attempt to retrieve the asset data associated with the given item.
Public function Virtual bool

Legacy_TryGetPackagePath ( const FContentBrowserItemData& InItem,
FName& OutPackagePath
)

 Legacy functions seem necessary for FrontendFilters to work.
Public function Virtual bool Attempt to preview the given item.
Public function Virtual bool Attempt to mark the given item as private (NotExternallyReferenceable).
Public function Virtual void

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

 Tell the data source to remove any cached data for the filter compilation that might not be needed any more.
Public function Virtual bool

SaveItem ( const FContentBrowserItemData& InItem,
const EContentBrowserItemSaveFlags InSaveFlags
)

 Attempt to save the given item.
Public function Virtual void Shutdown this data source instance.
Public function Virtual bool

TryGetCollectionId ( const FContentBrowserItemData& InItem,
FSoftObjectPath& OutCollectionId
)

 Attempt to retrieve the identifier that should be used when storing a reference to the given item within a collection.
Public function Virtual bool

UpdateThumbnail ( const FContentBrowserItemData& InItem,
FAssetThumbnail& InThumbnail
)

 Attempt to update the thumbnail associated with the given item.
Public function Virtual bool

ViewItem ( const FContentBrowserItemData& InItem
)

 Attempt to open the given item for read-only viewing.

Constants

Name Description
AliasTagName The metadata tag to set for the AliasDataSource to automatically create aliases for an asset

Deprecated Functions

  Type Name Description
Public function void

RemoveAlias ( const FName ObjectPath,
const FName Alias
)

 FNames containing full asset paths are deprecated, use FSoftObjectPath instead
Public function void

RemoveAliases ( const FName ObjectPath
)

 FNames containing full asset paths are deprecated, use FSoftObjectPath instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page