bIsShowFilteredPackagesOnly

bIsShowFilteredPackagesOnly

#Overview

name: bIsShowFilteredPackagesOnly

The value of this variable can be defined or overridden in .ini config files. 1 .ini config file referencing this setting variable.

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of bIsShowFilteredPackagesOnly is to control the display of filtered packages in the Reference Viewer, which is part of Unreal Engine’s asset management and visualization system.

This setting variable is primarily used within the Asset Manager Editor plugin, specifically in the Reference Viewer component. It’s part of the asset management and visualization system in Unreal Engine, helping developers to understand and manage asset dependencies.

The value of this variable is set through the UReferenceViewerSettings::SetShowFilteredPackagesOnlyEnabled function, which also saves the configuration. It’s a boolean value, so it can be either true or false.

This variable interacts with other settings in the UReferenceViewerSettings class, such as bIsCompactMode, which controls the compact view mode of the Reference Viewer.

Developers should be aware that this variable affects how search results are displayed in the Reference Viewer. When set to true, it will only show filtered packages, which can help focus on specific assets or dependencies.

Best practices for using this variable include:

  1. Use it to streamline the view when working with large projects with many assets.
  2. Toggle it on and off as needed to get different perspectives on asset dependencies.
  3. Consider the impact on performance and usability when deciding whether to show all packages or only filtered ones.
  4. Use in conjunction with other Reference Viewer settings for optimal asset visualization and management.
  5. Remember to save the configuration after changing the value to persist the setting across editor sessions.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:982, section: [/Script/AssetManagerEditor.ReferenceViewerSettings]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Plugins/Editor/AssetManagerEditor/Source/AssetManagerEditor/Private/ReferenceViewer/ReferenceViewerSettings.cpp:26

Scope (from outer to inner):

file
function     bool UReferenceViewerSettings::IsShowFilteredPackagesOnly

Source code excerpt:

bool UReferenceViewerSettings::IsShowFilteredPackagesOnly() const
{
	return bIsShowFilteredPackagesOnly;
}

bool UReferenceViewerSettings::IsCompactMode() const
{
	return bIsCompactMode;
}

#Loc: <Workspace>/Engine/Plugins/Editor/AssetManagerEditor/Source/AssetManagerEditor/Private/ReferenceViewer/ReferenceViewerSettings.cpp:100

Scope (from outer to inner):

file
function     void UReferenceViewerSettings::SetShowFilteredPackagesOnlyEnabled

Source code excerpt:

void UReferenceViewerSettings::SetShowFilteredPackagesOnlyEnabled(bool bNewEnabled)
{
	bIsShowFilteredPackagesOnly = bNewEnabled;
	SaveConfig();
}

void UReferenceViewerSettings::SetCompactModeEnabled(bool bNewEnabled)
{
	bIsCompactMode = bNewEnabled;

#Loc: <Workspace>/Engine/Plugins/Editor/AssetManagerEditor/Source/AssetManagerEditor/Public/ReferenceViewer/ReferenceViewerSettings.h:177

Scope (from outer to inner):

file
class        class UReferenceViewerSettings : public UObject

Source code excerpt:

	/* Whether to filter the search results or just select them  */
	UPROPERTY(config)
	bool bIsShowFilteredPackagesOnly;
	
	/* Whether to show the nodes in a compact (no thumbnail) view */
	UPROPERTY(config)
	bool bIsCompactMode;

	/* Whether to show external referencers or collapsed owner asset */