bIsShowDependencies

bIsShowDependencies

#Overview

name: bIsShowDependencies

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 bIsShowDependencies is to control whether dependencies are displayed in the Reference Viewer tool within the Unreal Engine editor. This setting variable is part of the Asset Management system, specifically for the Reference Viewer functionality.

The Unreal Engine subsystem that relies on this setting variable is the Asset Manager Editor plugin, which is part of the editor toolset. This can be seen from the file paths in the Callsites section, which are all within the AssetManagerEditor plugin.

The value of this variable is set through the SetShowDependencies function in the ReferenceViewerSettings class. It’s also saved to the configuration file when changed, as evidenced by the SaveConfig() call in the setter function.

This variable interacts with other settings in the ReferenceViewerSettings class, such as MaxSearchDependencyDepth, which determines how deep to search for dependencies when bIsShowDependencies is true.

Developers should be aware that this variable affects the visualization of asset dependencies in the Reference Viewer. When enabled, it will show the dependencies of selected assets, which can impact the performance and complexity of the view if there are many interconnected assets.

Best practices when using this variable include:

  1. Use it in conjunction with MaxSearchDependencyDepth to control the depth of dependency display and prevent overwhelming visualizations.
  2. Consider performance implications when enabling this for projects with complex asset relationships.
  3. Utilize this feature during asset audits or when trying to understand the relationship between different assets in the project.
  4. Remember that changes to this setting are saved to the configuration, so it will persist between editor sessions.

#Setting Variables

#References In INI files

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

Scope (from outer to inner):

file
function     bool UReferenceViewerSettings::IsShowDependencies

Source code excerpt:

bool UReferenceViewerSettings::IsShowDependencies() const
{
	return bIsShowDependencies;
}

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

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

Scope (from outer to inner):

file
function     void UReferenceViewerSettings::SetShowDependencies

Source code excerpt:

void UReferenceViewerSettings::SetShowDependencies(const bool bNewEnabled)
{
	bIsShowDependencies = bNewEnabled;
	SaveConfig();
}

int32 UReferenceViewerSettings::GetSearchDependencyDepthLimit() const
{
	return MaxSearchDependencyDepth;

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

Scope (from outer to inner):

file
class        class UReferenceViewerSettings : public UObject

Source code excerpt:

	/* Whether to display the Dependencies */
	UPROPERTY(config)
	bool bIsShowDependencies;
	
	/* How deep to search dependanies */
	UPROPERTY(config)
	int32 MaxSearchDependencyDepth; 
	
	/* Whether or not to limit how many siblings can appear */