bIsShowReferencers

bIsShowReferencers

#Overview

name: bIsShowReferencers

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 bIsShowReferencers is to control the display of referencers in the Reference Viewer tool within the Unreal Engine editor. This setting variable is part of the asset management and reference visualization system.

This setting variable is primarily used by the Asset Manager Editor plugin, specifically within the Reference Viewer module. It is defined and used in the UReferenceViewerSettings class, which is part of the AssetManagerEditor module.

The value of this variable is set through the SetShowReferencers() function in the UReferenceViewerSettings class. This function not only sets the value but also saves the configuration, ensuring the setting persists across editor sessions.

The bIsShowReferencers variable interacts with another similar variable, bIsShowDependencies. Together, these two variables control what information is displayed in the Reference Viewer - referencers (assets that reference the selected asset) and dependencies (assets that the selected asset depends on).

Developers should be aware that this variable directly affects the user interface and functionality of the Reference Viewer tool. Changing this setting will impact how asset relationships are visualized in the editor.

Best practices when using this variable include:

  1. Use the provided setter method (SetShowReferencers) to change the value, as it ensures the configuration is saved.
  2. Consider the impact on editor performance when enabling this option, especially for complex projects with many asset relationships.
  3. Use in conjunction with the MaxSearchReferencerDepth setting to control the depth of the reference search, balancing between completeness of information and performance.
  4. Be aware of the interaction with bIsShowDependencies and consider the use case when deciding which or both to enable.
  5. Respect user preferences by not programmatically changing this setting without user consent or clear indication.

#Setting Variables

#References In INI files

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

Scope (from outer to inner):

file
function     bool UReferenceViewerSettings::IsShowReferencers

Source code excerpt:

bool UReferenceViewerSettings::IsShowReferencers() const
{
	return bIsShowReferencers;
}

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

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

Scope (from outer to inner):

file
function     void UReferenceViewerSettings::SetShowReferencers

Source code excerpt:

void UReferenceViewerSettings::SetShowReferencers(const bool bNewEnabled)
{
	bIsShowReferencers = bNewEnabled;
	SaveConfig();
}

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

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

Scope (from outer to inner):

file
class        class UReferenceViewerSettings : public UObject

Source code excerpt:

	/* Whether to display the Referencers */
	UPROPERTY(config)
	bool bIsShowReferencers;
	
	/* How deep to search references */
	UPROPERTY(config)
	int32 MaxSearchReferencerDepth; 
	
	/* Whether to display the Dependencies */