1. Epic GamesDeveloper
  3. UContentBrowserDataSubsystem

UContentBrowserDataSubsystem

Subsystem that provides access to Content Browser data.

API > API/Editor > API/Editor/ContentBrowserData

Inheritance Hierarchy

References

   
Module ContentBrowserData
Header /Engine/Source/Editor/ContentBrowserData/Public/ContentBrowserDataSubsystem.h
Include #include "ContentBrowserDataSubsystem.h"

Syntax

class UContentBrowserDataSubsystem :  
    public UEditorSubsystem,  
    public IContentBrowserItemDataSink

Remarks

Subsystem that provides access to Content Browser data. This type deals with the composition of multiple data sources, which provide information about the folders and files available in the Content Browser.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Activate all available data sources.
Public function bool

ActivateDataSource ( const FName Name
)

 Attempt to activate the named data source.
Public function Const bool

CanCreateFolder ( const FName InPath,
FText* OutErrorMsg
)

 Query whether a folder can be created at the given virtual path, optionally providing error information if it cannot.
Public function Const void

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

 Take a raw data filter and convert it into a compiled version that could be re-used for multiple queries using the same data (typically this is only useful for post-filtering multiple items).
Public function TArray< FString >  
Public function void

ConvertInternalPathToVirtual ( const FStringView InPath,
FName& OutPath
)

 Converts an internal path to a virtual path based on current rules
Public function void Converts an internal path to a virtual path.
Public function FName Converts an internal path to a virtual path.
Public function Const FContentBrowserItemTemporaryContext

CreateFolder ( const FName InPath
)

 Attempt to begin the process of asynchronously creating a folder at the given virtual path, returning a temporary item that can be finalized or canceled by the user.
Public function void Deactivate all active data sources.
Public function bool

DeactivateDataSource ( const FName Name
)

 Attempt to deactivate the named data source.
Public function Const void

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

 Enumerate the items (folders and/or files) that exist at the given virtual path.
Public function Const void

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

 Enumerate the items (folders and/or files) that exist at the given virtual path.
Public function Const bool

EnumerateItemsAtPaths ( const TArrayView< struct FContentBrowserItemPath > InItemPaths,
const EContentBrowserItemTypeFilter InItemTypeFilter,
TFunctionRef< bool(FContentBrowserItemData&&)> InCallback
)

 Enumerate the items (files) that exist at the given paths.
Public function Const bool

EnumerateItemsForObjects ( const TArrayView< UObject* > InObjects,
TFunctionRef< bool(FContentBrowserItemData&&)> InCallback
)

 Enumerate the items (files) that exist for the given objects.
Public function Const void Enumerate the items (folders and/or files) that match a previously compiled filter.
Public function Const void Enumerate the items (folders and/or files) that match a previously compiled filter.
Public function Const void

EnumerateItemsUnderPath ( const FName InPath,
const FContentBrowserDataFilter& InFilter,
TFunctionRef< bool(FContentBrowserItem&&)> InCallback
)

 Enumerate the items (folders and/or files) that exist under the given virtual path.
Public function Const void

EnumerateItemsUnderPath ( const FName InPath,
const FContentBrowserDataFilter& InFilter,
TFunctionRef< bool(FContentBrowserItemData&&)> InCallback
)

 Enumerate the items (folders and/or files) that exist under the given virtual path.
Public function Const TArray< FName > Get the list of current active data sources.
Public function Const TArray< FContentBrowserItemPath >

GetAliasesForPath ( const FName InInternalPath
)

 Get a list of other paths that the data source may be using to represent a specific path
Public function Const TArray< FContentBrowserItemPath > Get a list of other paths that the data source may be using to represent a specific path
Public function 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 Const const FString & Prefix to use when generating virtual paths and "Show All Folder" option is enabled
Public function Const TArray< FName > Get the list of current available data sources.
Public function Const const TArray< FName > & Returns reference to default list of paths that appear first in content browser based on internal or invariant paths
Public function TSharedRef< FPathPermissionList > & Permission list that controls whether content in a given folder path can be edited.
Public function Const FContentBrowserItem

GetItemAtPath ( const FName InPath,
const EContentBrowserItemTypeFilter InItemTypeFilter
)

 Get the first item (folder and/or file) that exists at the given virtual path.
Public function Const TArray< FContentBrowserItem >

GetItemsAtPath ( const FName InPath,
const EContentBrowserItemTypeFilter InItemTypeFilter
)

 Get the items (folders and/or files) that exist at the given virtual path.
Public function Const TArray< FContentBrowserItem >

GetItemsUnderPath ( const FName InPath,
const FContentBrowserDataFilter& InFilter
)

 Get the items (folders and/or files) that exist under the given virtual path.
Public function Const const TArray< FName > & Returns reference to list of paths that appear first in content browser based on internal or invariant paths
Public function Const bool

IsDiscoveringItems ( TArray< FText >* OutStatus
)

 Query whether any data sources are currently discovering content, and retrieve optional status messages that can be shown in the UI.
Public function Const bool

IsFolderVisible ( const FName InPath,
const EContentBrowserIsFolderVisibleFlags InFlags
)

 Query whether the given virtual folder should be visible in the UI.
Public function void

Legacy_TryConvertAssetDataToVirtualPaths ( const FAssetData& InAssetData,
const bool InUseFolderPaths,
TFunctionRef< bool(FName)> InCallback
)

 Attempt to convert the given asset data to a virtual paths associated with the active data sources (callback will be called for each successful conversion).
Public function void

Legacy_TryConvertPackagePathToVirtualPaths ( const FName InPackagePath,
TFunctionRef< bool(FName)> InCallback
)

 Attempt to convert the given package path to virtual paths associated with the active data sources (callback will be called for each successful conversion).
Public function FContentBrowserGenerateVirtualPathDelegate & Delegate called to generate a virtual path. Can be set to override default behavior.
Public function FOnContentBrowserItemDataDiscoveryComplete & Delegate called when all active data sources have completed their initial content discovery scan.
Public function FOnContentBrowserItemDataRefreshed & Delegate called for wholesale item data updates from data sources that can't provide delta-updates, or when the set of active data sources is modified.
Public function FOnContentBrowserItemDataUpdated & Delegate called for incremental item data updates from data sources that can provide delta-updates.
Public function bool

PrioritizeSearchPath ( const FName InPath
)

 If possible, attempt to prioritize content discovery for the given virtual path.
Public function void Rebuild the virtual path tree if rules have changed.
Public function void

SetGenerateVirtualPathPrefixDelegate ( const FContentBrowserGenerateVirtualPathDelegate& InDelegate
)

 Set delegate used to generate a virtual path.
Public function void

SetPathViewSpecialSortFolders ( const TArray< FName >& InSpecialSortFolders
)

 Customize list of folders that appear first in content browser based on internal or invariant paths
Public function void Call when rules of virtual path generation have changed beyond content browser settings.
Public function Const EContentBrowserPathType

TryConvertVirtualPath ( const FStringView InPath,
FName& OutPath
)

 Converts virtual path back into an internal or invariant path
Public function Const EContentBrowserPathType

TryConvertVirtualPath ( const FStringView InPath,
FStringBuilderBase& OutPath
)

 Converts virtual path back into an internal or invariant path
Public function Const EContentBrowserPathType

TryConvertVirtualPath ( const FStringView InPath,
FString& OutPath
)

 Converts virtual path back into an internal or invariant path
Public function Const EContentBrowserPathType

TryConvertVirtualPath ( const FName InPath,
FName& OutPath
)

 Converts virtual path back into an internal or invariant path
Public function Const TArray< FString >

TryConvertVirtualPathsToInternal ( const TArray< FString >& InVirtualPaths
)

 Returns array of paths converted to internal.

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void Implement this for initialization of instances of the system

Overridden from IContentBrowserItemDataSink

  Type Name Description
Public function Virtual void

ConvertInternalPathToVirtual ( const FStringView InPath,
FStringBuilderBase& OutPath
)

 Converts an internal path to a virtual path.

Classes

  Type Name Description
Public struct FContentBrowserFilterCacheApi Provide an partial access to private api for the filter cache ID owners See FContentBrowserDataFilterCacheIDOwner declaration for how to use the caching for filter compilation  

Typedefs

Name Description
FNameToDataSourceMap  

Deprecated Functions

  Type Name Description
Public function Const bool IsFolderVisibleIfHidingEmpty is deprecated. Use IsFolderVisible instead and add EContentBrowserIsFolderVisibleFlags::HideEmptyFolders to the flags.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page