bIsShowSoftReferences

bIsShowSoftReferences

#Overview

name: bIsShowSoftReferences

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 bIsShowSoftReferences is to control the visibility of soft references in the Reference Viewer tool within the Unreal Engine editor. This setting variable is part of the asset management and visualization system.

The Unreal Engine subsystem that relies on this setting variable is the Asset Manager Editor plugin, specifically the Reference Viewer component. 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 SetShowSoftReferencesEnabled function in the UReferenceViewerSettings class. This function also saves the configuration, suggesting that the setting is persistent across editor sessions.

This variable interacts with another similar variable, bIsShowHardReferences, which controls the visibility of hard references in the Reference Viewer. These two variables work together to provide comprehensive control over the types of references displayed.

Developers must be aware that this variable affects the visualization of asset dependencies in the Reference Viewer tool. Enabling or disabling soft references can significantly change the information presented to users, potentially affecting their understanding of asset relationships within the project.

Best practices when using this variable include:

  1. Considering the needs of your project team when deciding whether to show or hide soft references.
  2. Educating team members about the difference between soft and hard references and how this setting affects the Reference Viewer’s output.
  3. Regularly reviewing this setting to ensure it aligns with current project requirements and workflow.
  4. Using this setting in conjunction with bIsShowHardReferences to get a complete picture of asset dependencies when necessary.
  5. Being mindful of performance implications when showing both soft and hard references in large projects, as it may increase the amount of data displayed in the Reference Viewer.

#Setting Variables

#References In INI files

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

Scope (from outer to inner):

file
function     bool UReferenceViewerSettings::IsShowSoftReferences

Source code excerpt:

bool UReferenceViewerSettings::IsShowSoftReferences() const
{
	return bIsShowSoftReferences;
}

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

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

Scope (from outer to inner):

file
function     void UReferenceViewerSettings::SetShowSoftReferencesEnabled

Source code excerpt:

void UReferenceViewerSettings::SetShowSoftReferencesEnabled(bool bNewEnabled)
{
	bIsShowSoftReferences = bNewEnabled;
	SaveConfig();
}

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

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

Scope (from outer to inner):

file
class        class UReferenceViewerSettings : public UObject

Source code excerpt:

	/* Show/Hide Soft References */
	UPROPERTY(config)
	bool bIsShowSoftReferences;
	
	/* Show/Hide Hard References */
	UPROPERTY(config)
	bool bIsShowHardReferences;
	
	/* Show/Hide EditorOnly References */