bShowEmitterExecutionOrder

bShowEmitterExecutionOrder

#Overview

name: bShowEmitterExecutionOrder

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 bShowEmitterExecutionOrder is to control the display of emitter execution order information in the Niagara editor viewport. This setting is part of the Niagara visual effects system in Unreal Engine 5.

This setting variable is primarily used within the Niagara Editor module, which is a part of the Niagara plugin for Unreal Engine. It’s specifically utilized in the NiagaraEditorSettings class, which manages various editor-specific settings for the Niagara system.

The value of this variable is set through the SetShowEmitterExecutionOrder function in the UNiagaraEditorSettings class. It’s stored in the ViewportSettings struct of the UNiagaraEditorSettings object and is configured to be saved to the config file (as indicated by the UPROPERTY(config) macro).

This variable interacts with other viewport-related settings in the NiagaraEditorSettings, such as bShowGpuTickInformation and bShowMemoryInfo. These settings collectively control what information is displayed in the Niagara editor viewport.

Developers should be aware that changing this setting will affect the visual feedback provided in the Niagara editor. When enabled, it will show the order in which emitters are executed, which can be crucial for understanding and optimizing the behavior of complex Niagara effects.

Best practices when using this variable include:

1. Enable it when debugging or optimizing the execution order of emitters in a Niagara system.
2. Consider disabling it when not actively working on emitter execution order to reduce visual clutter in the editor.
3. Use it in conjunction with other debug visualization options (like GPU tick information and memory info) for a comprehensive understanding of the Niagara system’s performance.
4. Remember that this setting is editor-only and won’t affect the final build of the game.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Plugins/FX/Niagara/Config/BaseNiagara.ini:104, 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:350

Scope (from outer to inner):

file
function     bool UNiagaraEditorSettings::IsShowEmitterExecutionOrder

Source code excerpt:

bool UNiagaraEditorSettings::IsShowEmitterExecutionOrder() const
{
	return ViewportSettings.bShowEmitterExecutionOrder;
}

void UNiagaraEditorSettings::SetShowEmitterExecutionOrder(bool bInShowEmitterExecutionOrder)
{
	if (this->ViewportSettings.bShowEmitterExecutionOrder != bInShowEmitterExecutionOrder)
	{
		this->ViewportSettings.bShowEmitterExecutionOrder = bInShowEmitterExecutionOrder;
		SaveConfig();		
	}
}

bool UNiagaraEditorSettings::IsShowGpuTickInformation() const
{

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

Scope: file

Source code excerpt:

	UPROPERTY(config)
	bool bShowEmitterExecutionOrder = false;

	UPROPERTY(config)
	bool bShowGpuTickInformation = false;

	UPROPERTY(config)
	bool bShowMemoryInfo = false;

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

Scope (from outer to inner):

file
class        class UNiagaraEditorSettings : public UDeveloperSettings

Source code excerpt:

	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);
	NIAGARAEDITOR_API bool IsShowStatelessInfo() const;
	NIAGARAEDITOR_API void SetShowStatelessInfo(bool bInShowInfo);