bIsShowHardReferences

bIsShowHardReferences

#Overview

name: bIsShowHardReferences

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 bIsShowHardReferences is to control the visibility of hard references in the Reference Viewer tool within the Unreal Engine editor. It is used in the Asset Management system, specifically in the Reference Viewer functionality.

This setting variable is primarily used by the AssetManagerEditor plugin, which is part of the Unreal Engine’s asset management and visualization tools. The variable is defined and used within the ReferenceViewerSettings class, which is responsible for managing various settings for the Reference Viewer.

The value of this variable is set through the SetShowHardReferencesEnabled function in the ReferenceViewerSettings class. This function also saves the configuration, suggesting that the setting persists between editor sessions.

The bIsShowHardReferences variable interacts with other settings in the ReferenceViewerSettings class, such as bIsShowEditorOnlyReferences and bIsShowFilteredPackagesOnly. These settings collectively control what types of references are displayed in the Reference Viewer.

Developers should be aware that this variable affects the visualization of asset dependencies in the Reference Viewer. Enabling or disabling hard references can significantly change the complexity and information displayed in the asset dependency graph.

Best practices when using this variable include:

1. Consider the project’s needs when deciding whether to show or hide hard references.
2. Use it in conjunction with other reference visibility settings for a comprehensive view of asset dependencies.
3. Be mindful of performance implications when showing all hard references in large projects.
4. Ensure that changes to this setting are communicated to the team, as it can affect how asset dependencies are perceived and managed.

#Setting Variables

#References In INI files

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

• INI Section: /Script/AssetManagerEditor.ReferenceViewerSettings
• Raw value: True
• Is Array: False

#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:21

Scope (from outer to inner):

file
function     bool UReferenceViewerSettings::IsShowHardReferences

Source code excerpt:

bool UReferenceViewerSettings::IsShowHardReferences() const
{
	return bIsShowHardReferences;
}

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

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

Scope (from outer to inner):

file
function     void UReferenceViewerSettings::SetShowHardReferencesEnabled

Source code excerpt:

void UReferenceViewerSettings::SetShowHardReferencesEnabled(bool bNewEnabled)
{
	bIsShowHardReferences = bNewEnabled;
	SaveConfig();
}

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

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

Scope (from outer to inner):

file
class        class UReferenceViewerSettings : public UObject

Source code excerpt:

	/* Show/Hide Hard References */
	UPROPERTY(config)
	bool bIsShowHardReferences;
	
	/* Show/Hide EditorOnly References */
	UPROPERTY(config)
	bool bIsShowEditorOnlyReferences;
	
	/* Show/Hide Management Assets (i.e. PrimaryAssetIds) */