UNiagaraEditorSettings

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NiagaraEditor

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraEditorSettings.h

Include

#include "NiagaraEditorSettings.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Niagara, defaultconfig, Meta=(DisplayName="Niagara"))
class UNiagaraEditorSettings : public UDeveloperSettings

Variables

Name Description

Public variable UProperty Category, EditAnywhere Config

bool

 

bEnableBaker

Enables the Niagara Baker to be used within the system editor.

Public variable UProperty Category, EditAnywhere Config

FSoftObjectPath

 

DefaultDynamicInputScript

Niagara script to duplicate as the base of all new script assets created.

Public variable UProperty Category, EditAnywhere Config

FSoftObjectPath

 

DefaultFunctionScript

Niagara script to duplicate as the base of all new script assets created.

Public variable UProperty Category, EditAnywhere Config

FSoftObjectPath

 

DefaultModuleScript

Niagara script to duplicate as the base of all new script assets created.

Public variable UProperty Category, EditAnywhere Config

FSoftObjectPath

 

DefaultScript

Niagara script to duplicate as the base of all new script assets created.

Public variable UProperty Category, EditAnywhere Config

TArray< FNiagar...

 

GraphCreationShortcuts

Shortcut key bindings that if held down while doing a mouse click, will spawn the specified type of Niagara node.

Public variable UProperty Category, EditAnywhere Config

FSoftObjectPath

 

RequiredSystemUpdateScript

Niagara script which is required in the system update script to control system state.

Protected variable

FOnNiagaraEdito...

 

SettingsChangedDelegate

Constructors

Name Description

Public function

UNiagaraEditorSettings

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

const TArray...

 

GetAllNamespaceMetadata()

Public function Const

const TArray...

 

GetAllNamespaceModifierMetadata()

Public function Const

bool

 

GetAutoCompile()

Gets whether or not auto-compile is enabled in the editors.

Public function Const

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.

Public function Const

const TArray...

 

GetCurveTemplates()

Public function Const

FNiagaraName...

 

GetDefaultNamespaceMetadata()

Public function Const

FNiagaraName...

 

GetDefaultNamespaceModifierMetadata()

Public function Const

bool

 

GetDisplayAdvancedParameterPanelCategories()

Gets whether or not to display advanced categories for the parameter panel.

Public function Const

const TMap< ...

 

GetHLSLKeywordReplacementsMap()

Public function Const

FNiagaraName...

 

GetMetaDataForId

(
    const FGuid& NamespaceId
)

Public function Const

FNiagaraName...

 

GetMetaDataForNamespaceModifier

(
    FName NamespaceModifier
)

Public function Const

FNiagaraName...

 

GetMetaDataForNamespaces

(
    TArray< FName > Namespaces
)

Public function Const

FNiagaraNewA...

 

GetNewAssetDailogConfig

(
    FName InDialogConfigKey
)

Public function Const

TArray< floa...

 

GetPlaybackSpeeds()

Public function Const

bool

 

GetResetDependentSystemsWhenEditingEmitters()

Gets whether or not to reset all components that include the system that is currently being reset

Public function Const

bool

 

GetResetSimulationOnChange()

Gets whether or not the simulation should reset when a value on the emitter or system is changed.

Public function Const

bool

 

GetResimulateOnChangeWhilePaused()

Gets whether or not to rerun the simulation to the current time when making modifications while paused.

Public function Const

FLinearColor

 

GetSourceColor

(
    EScriptSource Source
)

Public function Static

FOnNiagaraEd...

 

OnSettingsChanged()

Gets a multicast delegate which is called whenever one of the parameters in this settings object changes.

Public function

void

 

SetAutoCompile

(
    bool bInAutoCompile
)

Sets whether or not auto-compile is enabled in the editors.

Public function

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.

Public function

void

 

SetDisplayAdvancedParameterPanelCategories

(
    bool bInDisplayAdvancedParameterPan...
)

Sets whether or not to display advanced categories for the parameter panel.

Public function

void

 

SetNewAssetDialogConfig

(
    FName InDialogConfigKey,
    const FNiagaraNewAssetDialogConfig ...
)

Public function

void

 

SetResetDependentSystemsWhenEditingEmitters

(
    bool bInResetDependentSystemsWhenEd...
)

Sets whether or not to reset all components that include the system that is currently being reset

Public function

void

 

SetResetSimulationOnChange

(
    bool bInResetSimulationOnChange
)

Sets whether or not the simulation should reset when a value on the emitter or system is changed.

Public function

void

 

SetResimulateOnChangeWhilePaused

(
    bool bInResimulateOnChangeWhilePaus...
)

Sets whether or not to rerun the simulation to the current time when making modifications while paused.

Overridden from UDeveloperSettings

Name Description

Public function Virtual Const

FName

 

GetCategoryName()

Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.

Public function Virtual Const

FText

 

GetSectionText()

Gets the section text, uses the classes DisplayName by default.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

UObject interface

Typedefs

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss