bShowInstructionsCount

bShowInstructionsCount

#Overview

name: bShowInstructionsCount

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 bShowInstructionsCount is to control the display of instruction count information in the Niagara editor viewport for Unreal Engine’s visual effects system.

This setting variable is primarily used by the Niagara plugin, which is part of Unreal Engine’s visual effects system. Specifically, it’s used within the NiagaraEditor module, as evident from the file paths containing “NiagaraEditor” in the callsites.

The value of this variable is set through the UNiagaraEditorSettings class, which inherits from UDeveloperSettings. It can be modified using the SetShowInstructionsCount() function, which also saves the configuration when the value changes.

This variable interacts with other viewport-related settings in the UNiagaraEditorSettings class, such as bShowParticleCountsInViewport and bShowEmitterExecutionOrder. These settings collectively control what information is displayed in the Niagara editor viewport.

Developers should be aware that this is a configuration property (marked with UPROPERTY(config)), meaning its value persists between editor sessions. Changes to this setting will affect the editor’s behavior across multiple sessions until explicitly changed again.

Best practices when using this variable include:

1. Use the provided getter (IsShowInstructionsCount()) and setter (SetShowInstructionsCount()) methods instead of directly accessing the variable.
2. Be mindful of performance implications when enabling this setting, as displaying instruction counts may have a minor impact on editor performance.
3. Consider using this setting in conjunction with other debug visualization options to get a comprehensive view of the Niagara system’s performance and behavior.
4. Remember that this setting is primarily for development and debugging purposes, and should typically be disabled in release builds or when not actively debugging instruction-related issues.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Plugins/FX/Niagara/Config/BaseNiagara.ini:102, section: [/Script/NiagaraEditor.NiagaraEditorSettings]

• INI Section: /Script/NiagaraEditor.NiagaraEditorSettings
• Raw value: False
• Is Array: False

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Private/NiagaraEditorSettings.cpp:322

Scope (from outer to inner):

file
function     bool UNiagaraEditorSettings::IsShowInstructionsCount

Source code excerpt:

bool UNiagaraEditorSettings::IsShowInstructionsCount() const
{
	return ViewportSettings.bShowInstructionsCount;
}

void UNiagaraEditorSettings::SetShowInstructionsCount(bool bInShowInstructionsCount)
{
	if (this->ViewportSettings.bShowInstructionsCount != bInShowInstructionsCount)
	{
		this->ViewportSettings.bShowInstructionsCount = bInShowInstructionsCount;
		SaveConfig();
	}
}

bool UNiagaraEditorSettings::IsShowParticleCountsInViewport() const
{

#Loc: <Workspace>/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraEditorSettings.h:317

Scope: file

Source code excerpt:

	UPROPERTY(config)
	bool bShowInstructionsCount = false;
	
	UPROPERTY(config)
	bool bShowParticleCountsInViewport = false;

	UPROPERTY(config)
	bool bShowEmitterExecutionOrder = false;

#Loc: <Workspace>/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraEditorSettings.h:609

Scope (from outer to inner):

file
class        class UNiagaraEditorSettings : public UDeveloperSettings

Source code excerpt:

public:
	NIAGARAEDITOR_API bool IsShowInstructionsCount() const;
	NIAGARAEDITOR_API void SetShowInstructionsCount(bool bShowInstructionsCount);
	NIAGARAEDITOR_API bool IsShowEmitterExecutionOrder() const;
	NIAGARAEDITOR_API void SetShowEmitterExecutionOrder(bool bShowEmitterExecutionOrder);
	NIAGARAEDITOR_API bool IsShowGpuTickInformation() const;
	NIAGARAEDITOR_API void SetShowGpuTickInformation(bool bShowGpuTickInformation);
	NIAGARAEDITOR_API bool IsShowMemoryInfo() const;
	NIAGARAEDITOR_API void SetShowMemoryInfo(bool bInShowInfo);