Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraEditor > UNiagaraEditorSettings

Light Theme

Dark Theme

UNiagaraEditorSettings

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDeveloperSettings

UNiagaraEditorSettings

References

Module	NiagaraEditor
Header	/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraEditorSettings.h
Include	#include "NiagaraEditorSettings.h"

Syntax

UCLASS(Config=Niagara, defaultconfig, Meta=(DisplayName="Niagara"))
class UNiagaraEditorSettings : public UDeveloperSettings

Variables

	Name	Description
bool	bEnableBaker	Enables the Niagara Baker to be used within the system editor.
FSoftObjectPath	DefaultDynamicInputScript	Niagara script to duplicate as the base of all new script assets created.
FSoftObjectPath	DefaultFunctionScript	Niagara script to duplicate as the base of all new script assets created.
FSoftObjectPath	DefaultModuleScript	Niagara script to duplicate as the base of all new script assets created.
FSoftObjectPath	DefaultScript	Niagara script to duplicate as the base of all new script assets created.
TArray< FNiagar...	GraphCreationShortcuts	Shortcut key bindings that if held down while doing a mouse click, will spawn the specified type of Niagara node.
FSoftObjectPath	RequiredSystemUpdateScript	Niagara script which is required in the system update script to control system state.
FOnNiagaraEdito...	SettingsChangedDelegate

Constructors

	Name	Description
	UNiagaraEditorSettings ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
const TArray...	GetAllNamespaceMetadata()
const TArray...	GetAllNamespaceModifierMetadata()
bool	GetAutoCompile()	Gets whether or not auto-compile is enabled in the editors.
bool	GetAutoPlay()	Gets whether or not simulations should start playing automatically when the emitter or system editor is opened, or when the data is changed in the editor.
const TArray...	GetCurveTemplates()
FNiagaraName...	GetDefaultNamespaceMetadata()
FNiagaraName...	GetDefaultNamespaceModifierMetadata()
bool	GetDisplayAdvancedParameterPanelCategories()	Gets whether or not to display advanced categories for the parameter panel.
const TMap< ...	GetHLSLKeywordReplacementsMap()
const FGuid ...	GetIdForUsage ( ENiagaraScriptUsage Usage )
FNiagaraName...	GetMetaDataForId ( const FGuid& NamespaceId )
FNiagaraName...	GetMetaDataForNamespaceModifier ( FName NamespaceModifier )
FNiagaraName...	GetMetaDataForNamespaces ( TArray< FName > Namespaces )
FNiagaraNewA...	GetNewAssetDailogConfig ( FName InDialogConfigKey )
TArray< floa...	GetPlaybackSpeeds()
bool	GetResetDependentSystemsWhenEditingEmitters()	Gets whether or not to reset all components that include the system that is currently being reset
bool	GetResetSimulationOnChange()	Gets whether or not the simulation should reset when a value on the emitter or system is changed.
bool	GetResimulateOnChangeWhilePaused()	Gets whether or not to rerun the simulation to the current time when making modifications while paused.
FLinearColor	GetSourceColor ( EScriptSource Source )
bool	IsShowEmitterExecutionOrder()
bool	IsShowGridInViewport()
bool	IsShowInstructionsCount()
bool	IsShowParticleCountsInViewport()
FOnNiagaraEd...	OnSettingsChanged()	Gets a multicast delegate which is called whenever one of the parameters in this settings object changes.
void	SetAutoCompile ( bool bInAutoCompile )	Sets whether or not auto-compile is enabled in the editors.
void	SetAutoPlay ( bool bInAutoPlay )	Sets whether or not simulations should start playing automatically when the emitter or system editor is opened, or when the data is changed in the editor.
void	SetDisplayAdvancedParameterPanelCategories ( bool bInDisplayAdvancedParameterPan... )	Sets whether or not to display advanced categories for the parameter panel.
void	SetNewAssetDialogConfig ( FName InDialogConfigKey, const FNiagaraNewAssetDialogConfig ... )
void	SetResetDependentSystemsWhenEditingEmitters ( bool bInResetDependentSystemsWhenEd... )	Sets whether or not to reset all components that include the system that is currently being reset
void	SetResetSimulationOnChange ( bool bInResetSimulationOnChange )	Sets whether or not the simulation should reset when a value on the emitter or system is changed.
void	SetResimulateOnChangeWhilePaused ( bool bInResimulateOnChangeWhilePaus... )	Sets whether or not to rerun the simulation to the current time when making modifications while paused.
void	SetShowEmitterExecutionOrder ( bool bShowEmitterExecutionOrder )
void	SetShowGridInViewport ( bool bShowGridInViewport )
void	SetShowInstructionsCount ( bool bShowInstructionsCount )
void	SetShowParticleCountsInViewport ( bool bShowParticleCountsInViewport )

Overridden from UDeveloperSettings

		Name	Description
	FName	GetCategoryName()	Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.
	FText	GetSectionText()	Gets the section text, uses the classes DisplayName by default.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	UObject interface

Typedefs

Name	Description
FOnNiagaraEditorSettingsChanged