ShowFriendlyPropertyNames

ShowFriendlyPropertyNames

#Overview

name: ShowFriendlyPropertyNames

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 4 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of ShowFriendlyPropertyNames is to control the display of property names in the Unreal Engine editor, specifically in the property editor system. It determines whether property names should be shown in a more human-readable format or in their raw, code-specific format.

This setting variable is primarily used within the PropertyEditor module of Unreal Engine. It affects how property names are displayed in various parts of the editor interface where properties are visible, such as the Details panel.

The value of this variable is set in the editor’s project-specific configuration file (GEditorPerProjectIni). It is loaded during the initialization of the FPropertySettings class.

ShowFriendlyPropertyNames interacts with other property display settings, such as ShowHiddenProperties and ExpandDistributions, which are part of the same FPropertySettings class.

Developers should be aware that this setting affects the readability of property names throughout the editor. When enabled, it converts property names to a more user-friendly format, which can be helpful for non-technical users or for improving overall editor usability. However, it may also make it slightly more difficult to match property names with their exact code representations.

Best practices when using this variable include:

  1. Consider the target users of your project when deciding whether to enable or disable this setting.
  2. Be consistent in its usage across your project to maintain a uniform editor experience.
  3. When documenting properties or creating tutorials, be aware of whether this setting is enabled, as it will affect how property names appear in the editor.
  4. If you’re developing custom editor tools that display property names, consider respecting this setting for consistency with the rest of the editor interface.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:475, section: [PropertySettings]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Editor/PropertyEditor/Private/ItemPropertyNode.cpp:530

Scope (from outer to inner):

file
function     FText FItemPropertyNode::GetDisplayName

Source code excerpt:

		{
			// This item is not a member of an array, get a traditional display name
			if ( FPropertySettings::Get().ShowFriendlyPropertyNames() )
			{
				//We are in "readable display name mode"../ Make a nice name
				FinalDisplayName = PropertyPtr->GetDisplayNameText();
				if ( FinalDisplayName.IsEmpty() )
				{
					FString PropertyDisplayName;

#Loc: <Workspace>/Engine/Source/Editor/PropertyEditor/Private/ItemPropertyNode.cpp:701

Scope (from outer to inner):

file
function     FText FItemPropertyNode::GetDisplayName

Source code excerpt:

				}

				if (FPropertySettings::Get().ShowFriendlyPropertyNames())
				{
					TypeName = FName::NameToDisplayString(TypeName, false);
				}

				FinalDisplayName = FText::Format(FormatText, FText::FromString(TypeName));
			}

#Loc: <Workspace>/Engine/Source/Editor/PropertyEditor/Private/PropertyNode.cpp:44

Scope (from outer to inner):

file
function     FPropertySettings::FPropertySettings

Source code excerpt:

{
	GConfig->GetBool(TEXT("PropertySettings"), TEXT("ShowHiddenProperties"), bShowHiddenProperties, GEditorPerProjectIni);
	GConfig->GetBool(TEXT("PropertySettings"), TEXT("ShowFriendlyPropertyNames"), bShowFriendlyPropertyNames, GEditorPerProjectIni);
	GConfig->GetBool(TEXT("PropertySettings"), TEXT("ExpandDistributions"), bExpandDistributions, GEditorPerProjectIni);
}

DEFINE_LOG_CATEGORY(LogPropertyNode);

static FObjectPropertyNode* NotifyFindObjectItemParent(FPropertyNode* InNode)

#Loc: <Workspace>/Engine/Source/Editor/PropertyEditor/Private/PropertyNode.h:87

Scope (from outer to inner):

file
class        class FPropertySettings
function     bool ShowFriendlyPropertyNames

Source code excerpt:

public:
	static FPropertySettings& Get();
	bool ShowFriendlyPropertyNames() const { return bShowFriendlyPropertyNames; }
	bool ShowHiddenProperties() const { return bShowHiddenProperties; }
	bool ExpandDistributions() const { return bExpandDistributions; }
private:
	FPropertySettings();
private:
	bool bShowFriendlyPropertyNames;