bLimitSearchDepth

bLimitSearchDepth

#Overview

name: bLimitSearchDepth

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 bLimitSearchDepth is to control whether the search depth for asset references and dependencies should be limited in the Reference Viewer tool within Unreal Engine’s Asset Manager Editor.

This setting variable is primarily used by the Asset Manager Editor plugin, specifically in the Reference Viewer subsystem. It’s part of the ReferenceViewerSettings class, which manages configuration options for the Reference Viewer tool.

The value of this variable is set through the UReferenceViewerSettings::SetSearchDepthLimitEnabled() function, which also saves the configuration. It’s a boolean value stored as a config property, meaning it persists between editor sessions.

bLimitSearchDepth interacts with other variables in the ReferenceViewerSettings class, such as SearchDepthLimit, which determines the actual depth limit when bLimitSearchDepth is true.

Developers should be aware that enabling this setting will restrict the depth of reference searches in the Reference Viewer. This can be useful for large projects where unrestricted searches might be time-consuming or resource-intensive.

Best practices for using this variable include:

  1. Enable it for large projects to improve performance of the Reference Viewer.
  2. Use it in conjunction with SearchDepthLimit to fine-tune the search depth.
  3. Consider the trade-off between search speed and comprehensiveness when deciding whether to enable it.
  4. Be aware that limiting search depth may hide some distant references, so it should be used judiciously.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:968, 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:6

Scope (from outer to inner):

file
function     bool UReferenceViewerSettings::IsSearchDepthLimited

Source code excerpt:

bool UReferenceViewerSettings::IsSearchDepthLimited() const
{
	return bLimitSearchDepth;
}

bool UReferenceViewerSettings::IsSearchBreadthLimited() const
{
	return bLimitSearchBreadth;
}

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

Scope (from outer to inner):

file
function     void UReferenceViewerSettings::SetSearchDepthLimitEnabled

Source code excerpt:

void UReferenceViewerSettings::SetSearchDepthLimitEnabled(bool bNewEnabled)
{
	bLimitSearchDepth = bNewEnabled;
	SaveConfig();
}

void UReferenceViewerSettings::SetSearchBreadthLimitEnabled(bool bNewEnabled)
{
	bLimitSearchBreadth = bNewEnabled;

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

Scope (from outer to inner):

file
class        class UReferenceViewerSettings : public UObject

Source code excerpt:

	/* Whether to limit the search depth for Referencers & Dependencies */
	UPROPERTY(config)
	bool bLimitSearchDepth;
	
	/* Whether to display the Referencers */
	UPROPERTY(config)
	bool bIsShowReferencers;
	
	/* How deep to search references */