Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UContentBrowserDataSubsystem

UContentBrowserDataSubsystem

Subsystem that provides access to Content Browser data.

API > API/Editor > API/Editor/ContentBrowserData

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.

   
Name UContentBrowserDataSubsystem
Type class
Header File /Engine/Source/Editor/ContentBrowserData/Public/ContentBrowserDataSubsystem.h
Include Path #include "ContentBrowserDataSubsystem.h"

Syntax

UCLASS (MinimalAPI, Config=Editor)  
class UContentBrowserDataSubsystem :  
    public UEditorSubsystem ,  
    public IContentBrowserItemDataSink

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UContentBrowserDataSubsystem()

   ContentBrowserDataSubsystem.h  

Structs

Name Remarks
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 Type Remarks Include Path
FNameToDataSourceMap TSortedMap< FName, UContentBrowserDataSource *, FDefaultAllocator, FNameFastLess >   ContentBrowserDataSubsystem.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveDataSources FNameToDataSourceMap Map of data sources that are currently active. ContentBrowserDataSubsystem.h  
ActiveDataSourcesDiscoveringContent TSet< FName > Set of data sources that are currently running content discovery. ContentBrowserDataSubsystem.h  
AllFolderPrefix FString Prefix to use when generating virtual paths and "Show All Folder" option is enabled ContentBrowserDataSubsystem.h  
AvailableDataSources FNameToDataSourceMap Map of data sources that are currently available. ContentBrowserDataSubsystem.h  
bContentMountedThisFrame bool True if content was just mounted this frame ContentBrowserDataSubsystem.h  
bIsPIEActive bool True if Play in Editor is active. ContentBrowserDataSubsystem.h  
bPendingItemDataRefreshedNotification bool True if an item data refresh notification is pending. ContentBrowserDataSubsystem.h  
CreateHideFolderIfEmptyFilterDelegates TArray< FContentBrowserCreateHideFolderIfEmptyFilter > Delegates to create filters that check whether an empty folder should always be filtered out in the Content Browser ContentBrowserDataSubsystem.h  
DefaultHideFolderIfEmptyFilter TSharedPtr< IContentBrowserHideFolderIfEmptyFilter > Default filter used to check whether an empty folder should always be filtered out in the Content Browser ContentBrowserDataSubsystem.h  
DefaultPathViewSpecialSortFolders TArray< FName > Default array of invariant paths to use when sorting ContentBrowserDataSubsystem.h  
DelayedPendingUpdates TMap< FContentBrowserItemKey, FContentBrowserItemDataUpdate > Set of item data updates that are delayed to preserve the editor performance. ContentBrowserDataSubsystem.h  
EditableFolderPermissionList TSharedRef< FPathPermissionList > Permission list of folder paths we can edit ContentBrowserDataSubsystem.h  
EnabledDataSources TArray< FName > Array of data source names that should be activated when available. ContentBrowserDataSubsystem.h
  • Config
GenerateVirtualPathPrefixDelegate FContentBrowserGenerateVirtualPathDelegate Generates an optional virtual path prefix for a given internal path ContentBrowserDataSubsystem.h  
ItemDataDiscoveryCompleteDelegate FOnContentBrowserItemDataDiscoveryComplete Delegate called when all active data sources have completed their initial content discovery scan. ContentBrowserDataSubsystem.h  
ItemDataRefreshedDelegate 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. ContentBrowserDataSubsystem.h  
ItemDataUpdatedDelegate FOnContentBrowserItemDataUpdated Delegate called for incremental item data updates from data sources that can provide delta-updates. ContentBrowserDataSubsystem.h  
LastCacheIDForFilter int64   ContentBrowserDataSubsystem.h  
PathViewSpecialSortFolders TArray< FName > Optional array of invariant paths to use when sorting ContentBrowserDataSubsystem.h  
PendingUpdates TArray< FContentBrowserItemDataUpdate > Queue of incremental item data updates. ContentBrowserDataSubsystem.h  
TickHandle FTSTicker::FDelegateHandle Handle for the Tick callback. ContentBrowserDataSubsystem.h  
TickSuppressionCount int32 >0 if Tick events have currently been suppressed. ContentBrowserDataSubsystem.h  
UsePluginVersePathDelegate FContentBrowserUsePluginVersePathDelegate Delegate to check whether the plugin VersePath should be its path in the content browser, if it has one ContentBrowserDataSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ActivateAllDataSources()

 Activate all available data sources. ContentBrowserDataSubsystem.h
  • BlueprintCallable
  • Category="ContentBrowser"

bool ActivateDataSource ( const FName Name
)

 Attempt to activate the named data source. ContentBrowserDataSubsystem.h
  • BlueprintCallable
  • Category="ContentBrowser"

bool CanCreateFolder ( const FName InPath,
FText* OutErrorMsg
) const

 Query whether a folder can be created at the given virtual path, optionally providing error information if it cannot. ContentBrowserDataSubsystem.h  

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

 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). ContentBrowserDataSubsystem.h  

TArray< FString > ConvertInternalPathsToVirtual ( const TArray< FString >& InPaths
)

   ContentBrowserDataSubsystem.h  
  ContentBrowserDataSubsystem.h  

void ConvertInternalPathToVirtual ( const FStringView InPath,
FName& OutPath
)

 Converts an internal path to a virtual path based on current rules ContentBrowserDataSubsystem.h  

void ConvertInternalPathToVirtual ( FName InPath,
FName& OutPath
)

   ContentBrowserDataSubsystem.h  
  ContentBrowserDataSubsystem.h  

FText ConvertVirtualPathToDisplay ( FName InVirtualPath,
const EContentBrowserItemTypeFilter InLeafType
) const

   ContentBrowserDataSubsystem.h  

FText ConvertVirtualPathToDisplay ( const FStringView InVirtualPath,
const EContentBrowserItemTypeFilter InLeafType
) const

 Converts a virtual path to a display path, where each path segment is replaced with the display name of its corresponding FContentBrowserItem. ContentBrowserDataSubsystem.h  
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. ContentBrowserDataSubsystem.h  
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. ContentBrowserDataSubsystem.h  
Creates the default IContentBrowserHideFolderIfEmptyFilter, and combines it with the results of any additional registered FContentBrowserCreateHideFolderIfEmptyFilter delegates. ContentBrowserDataSubsystem.h  

void DeactivateAllDataSources()

 Deactivate all active data sources. ContentBrowserDataSubsystem.h
  • BlueprintCallable
  • Category="ContentBrowser"

bool DeactivateDataSource ( const FName Name
)

 Attempt to deactivate the named data source. ContentBrowserDataSubsystem.h
  • BlueprintCallable
  • Category="ContentBrowser"

virtual void Deinitialize()

   ContentBrowserDataSubsystem.h  

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

   ContentBrowserDataSubsystem.h  

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

 Enumerate the items (folders and/or files) that exist at the given virtual path. ContentBrowserDataSubsystem.h  

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

 Enumerate the items (files) that exist at the given paths. ContentBrowserDataSubsystem.h  

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

 Enumerate the items (folders and/or files) that exist at the given user provided path. ContentBrowserDataSubsystem.h  

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

   ContentBrowserDataSubsystem.h  

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

 Enumerate the items (files) that exist for the given objects. ContentBrowserDataSubsystem.h  
  ContentBrowserDataSubsystem.h  
  ContentBrowserDataSubsystem.h  
Enumerate the items (folders and/or files) that match a previously compiled filter. ContentBrowserDataSubsystem.h  

void EnumerateItemsUnderPath ( const FName InPath,
const FContentBrowserDataFilter& InFilter,
const TGetOrEnumerateSink< FContentBrowserItemData >& InSink
) const

 Version which allows passing an array or a callback, allows sources to presize the array for large queries. ContentBrowserDataSubsystem.h  

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

   ContentBrowserDataSubsystem.h  

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

 Enumerate the items (folders and/or files) that exist under the given virtual path. ContentBrowserDataSubsystem.h  

TArray< FName > GetActiveDataSources()

 Get the list of current active data sources. ContentBrowserDataSubsystem.h
  • BlueprintCallable
  • Category="ContentBrowser"

TArray< FContentBrowserItemPath > GetAliasesForPath ( const FName InInternalPath
) const

   ContentBrowserDataSubsystem.h  
Get a list of other paths that the data source may be using to represent a specific path ContentBrowserDataSubsystem.h  
  ContentBrowserDataSubsystem.h  

const FString & GetAllFolderPrefix()

 Prefix to use when generating virtual paths and "Show All Folder" option is enabled ContentBrowserDataSubsystem.h  

TArray< FName > GetAvailableDataSources()

 Get the list of current available data sources. ContentBrowserDataSubsystem.h
  • BlueprintCallable
  • Category="ContentBrowser"

const TArray< FName > & GetDefaultPathViewSpecialSortFolders()

 Returns reference to default list of paths that appear first in content browser based on internal or invariant paths ContentBrowserDataSubsystem.h  
Permission list that controls whether content in a given folder path can be edited. ContentBrowserDataSubsystem.h  

FContentBrowserItem GetItemAtPath ( const FName InPath,
const EContentBrowserItemTypeFilter InItemTypeFilter
) const

 Get the first item (folder and/or file) that exists at the given virtual path. ContentBrowserDataSubsystem.h
  • BlueprintCallable
  • Category="ContentBrowser"

TArray< FContentBrowserItem > GetItemsAtPath ( const FName InPath,
const EContentBrowserItemTypeFilter InItemTypeFilter
) const

 Get the items (folders and/or files) that exist at the given virtual path. ContentBrowserDataSubsystem.h
  • BlueprintCallable
  • Category="ContentBrowser"

TArray< FContentBrowserItem > GetItemsAtUserProvidedPath ( const FStringView InPath,
const EContentBrowserItemTypeFilter InItemTypeFilter
) const

 Get the items (folders and/or files) that exist at the given user provided path. ContentBrowserDataSubsystem.h  

TArray< FContentBrowserItem > GetItemsUnderPath ( const FName InPath,
const FContentBrowserDataFilter& InFilter
) const

 Get the items (folders and/or files) that exist under the given virtual path. ContentBrowserDataSubsystem.h
  • BlueprintCallable
  • Category="ContentBrowser"

const TArray< FName > & GetPathViewSpecialSortFolders()

 Returns reference to list of paths that appear first in content browser based on internal or invariant paths ContentBrowserDataSubsystem.h  

FContentBrowserUsePluginVersePathDelegate & GetUsePluginVersePathDelegate()

 Delegate to check whether the plugin VersePath should be its path in the content browser, if it has one ContentBrowserDataSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   ContentBrowserDataSubsystem.h  

bool IsDiscoveringItems ( TArray< FText >* OutStatus
) const

 Query whether any data sources are currently discovering content, and retrieve optional status messages that can be shown in the UI. ContentBrowserDataSubsystem.h  

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

 Query whether the given virtual folder should be visible in the UI. ContentBrowserDataSubsystem.h  

bool IsFolderVisible ( const FName Path,
const EContentBrowserIsFolderVisibleFlags Flags
) const

 Query whether the given virtual folder should be visible in the UI. ContentBrowserDataSubsystem.h  

bool IsFolderVisibleIfHidingEmpty ( const FName InPath
) const

 Query whether the given virtual folder should be visible if the UI is asking to hide empty content folders. ContentBrowserDataSubsystem.h  

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). ContentBrowserDataSubsystem.h  

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). ContentBrowserDataSubsystem.h  

FContentBrowserGenerateVirtualPathDelegate & OnGenerateVirtualPathPrefix()

 Delegate called to generate a virtual path. Can be set to override default behavior. ContentBrowserDataSubsystem.h  

FOnContentBrowserItemDataDiscoveryComplete & OnItemDataDiscoveryComplete ()

 Delegate called when all active data sources have completed their initial content discovery scan. ContentBrowserDataSubsystem.h  

FOnContentBrowserItemDataRefreshed & OnItemDataRefreshed()

 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. ContentBrowserDataSubsystem.h  

FOnContentBrowserItemDataUpdated & OnItemDataUpdated()

 Delegate called for incremental item data updates from data sources that can provide delta-updates. ContentBrowserDataSubsystem.h  

bool PrioritizeSearchPath ( const FName InPath
)

 If possible, attempt to prioritize content discovery for the given virtual path. ContentBrowserDataSubsystem.h  

void RefreshVirtualPathTreeIfNeeded()

 Rebuild the virtual path tree if rules have changed. ContentBrowserDataSubsystem.h  

FDelegateHandle RegisterCreateHideFolderIfEmptyFilter ( FContentBrowserCreateHideFolderIfEmptyFilter Delegate
)

 Registers/deregisters a delegate used to create a filter used to filter out empty folders. ContentBrowserDataSubsystem.h  

void SetGenerateVirtualPathPrefixDelegate ( const FContentBrowserGenerateVirtualPathDelegate& InDelegate
)

 Set delegate used to generate a virtual path. ContentBrowserDataSubsystem.h  

void SetPathViewSpecialSortFolders ( const TArray< FName >& InSpecialSortFolders
)

 Customize list of folders that appear first in content browser based on internal or invariant paths ContentBrowserDataSubsystem.h  

void SetUsePluginVersePathDelegate ( FContentBrowserUsePluginVersePathDelegate InDelegate
)

 Set delegate to check whether the plugin VersePath should be its path in the content browser, if it has one ContentBrowserDataSubsystem.h  

void SetVirtualPathTreeNeedsRebuild()

 Call when rules of virtual path generation have changed beyond content browser settings. ContentBrowserDataSubsystem.h  

EContentBrowserPathType TryConvertVirtualPath ( const FStringView InPath,
FString& OutPath
) const

   ContentBrowserDataSubsystem.h  

EContentBrowserPathType TryConvertVirtualPath ( const FStringView InPath,
FStringBuilderBase& OutPath
) const

 Converts virtual path back into an internal or invariant path ContentBrowserDataSubsystem.h  

EContentBrowserPathType TryConvertVirtualPath ( const FStringView InPath,
FName& OutPath
) const

   ContentBrowserDataSubsystem.h  

EContentBrowserPathType TryConvertVirtualPath ( const FName InPath,
FName& OutPath
) const

   ContentBrowserDataSubsystem.h  

TArray< FString > TryConvertVirtualPathsToInternal ( const TArray< FString >& InVirtualPaths
) const

 Returns array of paths converted to internal. ContentBrowserDataSubsystem.h  

void UnregisterCreateHideFolderIfEmptyFilter ( FDelegateHandle DelegateHandle
)

   ContentBrowserDataSubsystem.h  

bool UsePluginVersePath ( const TSharedRef< IPlugin >& Plugin
)

 Return whether the plugin VersePath should be its path in the content browser, if it has one ContentBrowserDataSubsystem.h  

Overridden from IContentBrowserItemDataSink

Name Remarks Include Path Unreal Specifiers

virtual void ConvertInternalPathToVirtual ( const FStringView InPath,
FStringBuilderBase& OutPath
)

 Converts an internal path to a virtual path. ContentBrowserDataSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page