1. Epic GamesDeveloper
  3. UNiagaraEditorSettings

UNiagaraEditorSettings

API > API/Plugins > API/Plugins/NiagaraEditor

   
Name UNiagaraEditorSettings
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraEditorSettings.h
Include Path #include "NiagaraEditorSettings.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraEditorSettings ( const FObjectInitializer& ObjectInitializer
)

   NiagaraEditorSettings.h  

Typedefs

Name Type Remarks Include Path
FOnIsClassAllowed TBaseDelegate_OneParam< bool, const UClass * >   NiagaraEditorSettings.h
FOnIsClassPathAllowed TBaseDelegate_OneParam< bool, const FTopLevelAssetPath & >   NiagaraEditorSettings.h
FOnNiagaraEditorSettingsChanged TMulticastDelegate_TwoParams< void, const FString &, const UNiagaraEditorSettings * >   NiagaraEditorSettings.h
FOnShouldFilterAsset TBaseDelegate_OneParam< bool, const FTopLevelAssetPath & >   NiagaraEditorSettings.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAlwaysZoomToFitSystemGraph bool If true then the system editor will zoom to fit all emitters when opening an asset. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
bDisplayPreviewMoviesInTooltips bool Whether we allow using previews in the editor. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Preview"
bExpandModuleNotesByDefault bool Module Notes that were defined in a Module Script will expand by default, if true. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Niagara Stack"
bSimplifyStackNodesAtLowResolution bool If true then emitter and system nodes will show a simplified representation on low zoom levels. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
DefaultDecalRendererMaterial FSoftObjectPath Default material to use with new decal renderers. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Niagara Renderer"
  • Meta=(AllowedClasses="/Script/Engine.MaterialInterface")
DefaultDynamicInputScript FSoftObjectPath Niagara script to duplicate as the base of all new script assets created. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
DefaultEmptyEmitter FSoftObjectPath Niagara emitter to duplicate as the base for minimal emitters. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • DisplayName="Minimal Emitter"
  • Category=Niagara
  • Meta=(AllowedClasses="/Script/Niagara.NiagaraEmitter")
DefaultFunctionScript FSoftObjectPath Niagara script to duplicate as the base of all new script assets created. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
DefaultMeshRendererMesh FSoftObjectPath Default mesh to use with new mesh renderers. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Niagara Renderer"
  • Meta=(AllowedClasses="/Script/Engine.StaticMesh")
DefaultModuleScript FSoftObjectPath Niagara script to duplicate as the base of all new script assets created. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
DefaultRibbonRendererMaterial FSoftObjectPath Default material to use with new ribbon renderers. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Niagara Renderer"
  • Meta=(AllowedClasses="/Script/Engine.MaterialInterface")
DefaultScript FSoftObjectPath Niagara script to duplicate as the base of all new script assets created. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
DefaultSpriteRendererMaterial FSoftObjectPath Default material to use with new sprite renderers. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Niagara Renderer"
  • Meta=(AllowedClasses="/Script/Engine.MaterialInterface")
DefaultsSequencerSubtracks ENiagaraAddDefaultsTrackMode   NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
DefaultValidationRuleSets TArray< TSoftObjectPtr< UNiagaraValidationRuleSet > > Validation rules applied to all Niagara systems. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
EmitterAssetWizardConfiguration FSoftObjectPath The configuration used in the Niagara Asset Wizard when creating an new Niagara Emitter or adding an emitter to a system. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • DisplayName="Emitter Asset Wizard Configuration"
  • Category=Niagara
  • Meta=(AllowedClasses="/Script/UserAssetTagsEditor.TaggedAssetBrowserConfiguration")
GraphCreationShortcuts TArray< FNiagaraSpawnShortcut > Shortcut key bindings that if held down while doing a mouse click, will spawn the specified type of Niagara node. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
LowResolutionNodeMaxNameChars int32 The max number of chars before names on the low resolution nodes are truncated. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(EditCondition="bSimplifyStackNodesAtLowResolution", UIMin=3)
RendererCategoryExpandState ENiagaraCategoryExpandState   NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
RequiredSystemUpdateScript FSoftObjectPath Niagara script which is required in the system update script to control system state. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
ScriptGraphZoomLimitHandling EGraphZoomLimitHandling   NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Niagara Graph"
SystemAssetWizardConfiguration FSoftObjectPath The configuration used in the Niagara Asset Wizard when creating a new Niagara System. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • DisplayName="System Asset Wizard Configuration"
  • Category=Niagara
  • Meta=(AllowedClasses="/Script/UserAssetTagsEditor.TaggedAssetBrowserConfiguration")
TooltipPreviewMovieSize FVector2f The size of the movie previews used in tooltips. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Preview"
  • Meta=(EditCondition="bDisplayPreviewMoviesInTooltips==true")

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionColors FNiagaraActionColors   NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Niagara Colors"
AffectedAssetSearchLimit int32 The maximum amount of asset references that are searched before stopping. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(EditCondition="bDisplayAffectedAssetStats", ClampMin=1)
bAutoCompile bool Whether or not auto-compile is enabled in the editors. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
bAutoPlay bool 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. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=SimulationOptions
bDisplayAdvancedParameterPanelCategories bool Whether or not to display advanced categories for the parameter panel. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
bDisplayAffectedAssetStats bool If true, then the emitter and script editors will show an info message how many downstream asset are affected by a change. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
bForceSilentLoadingOfCachedAssets bool   NiagaraEditorSettings.h
  • Config
bResetDependentSystemsWhenEditingEmitters bool Whether or not to reset all components that include the system currently being reset. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=SimulationOptions
bResetSimulationOnChange bool Whether or not the simulation should reset when a value on the emitter or system is changed. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=SimulationOptions
bResimulateOnChangeWhilePaused bool Whether or not to rerun the simulation to the current time when making modifications while paused. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=SimulationOptions
bUpdateStackValuesOnCommitOnly bool This affects numeric inputs for modules. NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
CachedPlaybackSpeeds TOptional< TArray< float > > This is built using PlaybackSpeeds, populated whenever it is accessed using GetPlaybackSpeeds() NiagaraEditorSettings.h  
CurveEditorSharedSettings FNiagaraCurveEditorSharedSettings   NiagaraEditorSettings.h
  • Config
CurveTemplates TArray< FNiagaraCurveTemplate >   NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
DefaultNamespaceMetadata FNiagaraNamespaceMetadata   NiagaraEditorSettings.h  
DefaultNamespaceModifierMetadata FNiagaraNamespaceMetadata   NiagaraEditorSettings.h  
DefaultNoteColor FLinearColor   NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Niagara Colors"
HLSLKeywordReplacements TMap< FString, FString >   NiagaraEditorSettings.h
  • Config
NamespaceMetadata TArray< FNiagaraNamespaceMetadata >   NiagaraEditorSettings.h  
NamespaceModifierMetadata TArray< FNiagaraNamespaceMetadata >   NiagaraEditorSettings.h  
OnIsClassPathAllowedDelegate FOnIsClassPathAllowed   NiagaraEditorSettings.h  
OnIsClassReferenceableDelegate FOnIsClassAllowed   NiagaraEditorSettings.h  
OnIsClassVisibleDelegate FOnIsClassAllowed   NiagaraEditorSettings.h  
OnShouldFilterAssetByClassUsage FOnShouldFilterAsset   NiagaraEditorSettings.h  
OnShouldFilterAssetInNiagaraAssetBrowser FOnShouldFilterAsset   NiagaraEditorSettings.h  
PlaybackSpeeds TArray< float > Speeds used for slowing down and speeding up the playback speeds NiagaraEditorSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
SystemParameterPanelSectionData TArray< FNiagaraParameterPanelSectionStorage >   NiagaraEditorSettings.h
  • Config
TrackedUsageBaseClasses TArray< UClass * >   NiagaraEditorSettings.h  
ViewportSettings FNiagaraViewportSharedSettings   NiagaraEditorSettings.h
  • Config

Functions

Public

Name Remarks Include Path Unreal Specifiers

FAssetRegistryTag CreateClassUsageAssetRegistryTag ( const UObject* SourceObject
) const

   NiagaraEditorSettings.h  

FNiagaraParameterPanelSectionStorage & FindOrAddParameterPanelSectionStorage ( FGuid PanelSectionId,
bool& bOutAdded
)

   NiagaraEditorSettings.h  

const TArray< FNiagaraNamespaceMetadata > & GetAllNamespaceMetadata()

   NiagaraEditorSettings.h  

const TArray< FNiagaraNamespaceMetadata > & GetAllNamespaceModifierMetadata()

   NiagaraEditorSettings.h  

int32 GetAssetStatsSearchLimit()

   NiagaraEditorSettings.h  

bool GetAutoCompile()

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

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. NiagaraEditorSettings.h  

const TArray< FNiagaraCurveTemplate > & GetCurveTemplates()

   NiagaraEditorSettings.h  

FNiagaraNamespaceMetadata GetDefaultNamespaceMetadata()

   NiagaraEditorSettings.h  

FNiagaraNamespaceMetadata GetDefaultNamespaceModifierMetadata()

   NiagaraEditorSettings.h  

FLinearColor GetDefaultNoteColor()

   NiagaraEditorSettings.h  

bool GetDisplayAdvancedParameterPanelCategories()

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

bool GetDisplayAffectedAssetStats()

   NiagaraEditorSettings.h  

float GetExposureValue()

   NiagaraEditorSettings.h  

bool GetForceSilentLoadingOfCachedAssets()

   NiagaraEditorSettings.h  

const TMap< FString, FString > & GetHLSLKeywordReplacementsMap()

   NiagaraEditorSettings.h  

const FGuid & GetIdForUsage ( ENiagaraScriptUsage Usage
) const

   NiagaraEditorSettings.h  

FNiagaraNamespaceMetadata GetMetaDataForId ( const FGuid& NamespaceId
) const

   NiagaraEditorSettings.h  

FNiagaraNamespaceMetadata GetMetaDataForNamespaceModifier ( FName NamespaceModifier
) const

   NiagaraEditorSettings.h  

FNiagaraNamespaceMetadata GetMetaDataForNamespaces ( TArray< FName > Namespaces
) const

   NiagaraEditorSettings.h  

TArray< float > GetPlaybackSpeeds()

   NiagaraEditorSettings.h  

bool GetResetDependentSystemsWhenEditingEmitters()

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

bool GetResetSimulationOnChange()

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

bool GetResimulateOnChangeWhilePaused()

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

EGraphZoomLimitHandling GetScriptEditorZoomLimitHandling()

   NiagaraEditorSettings.h  

FLinearColor GetSourceColor ( EScriptSource Source
) const

   NiagaraEditorSettings.h  

bool GetUpdateStackValuesOnCommitOnly()

   NiagaraEditorSettings.h  

bool GetUseAutoExposure()

   NiagaraEditorSettings.h  

const FNiagaraViewportSharedSettings & GetViewportSharedSettings()

   NiagaraEditorSettings.h  

bool IsAllowedAssetByClassUsage ( const FAssetData& InAssetData
) const

   NiagaraEditorSettings.h  

bool IsAllowedAssetInNiagaraAssetBrowser ( const FAssetData& InAssetData
) const

   NiagaraEditorSettings.h  

bool IsAllowedAssetObjectByClassUsage ( const UObject& InAssetObject
) const

   NiagaraEditorSettings.h  

bool IsCurveInputSnapEnabled()

   NiagaraEditorSettings.h  

bool IsCurveOutputSnapEnabled()

   NiagaraEditorSettings.h  

bool IsReferenceableClass ( const UClass* InClass
) const

 Returns whether or not the supplied class is valid to be used in the current editor context. NiagaraEditorSettings.h  

bool IsShowEmitterExecutionOrder()

   NiagaraEditorSettings.h  

bool IsShowGpuTickInformation()

   NiagaraEditorSettings.h  

bool IsShowGridInViewport()

   NiagaraEditorSettings.h  

bool IsShowInstructionsCount()

   NiagaraEditorSettings.h  

bool IsShowMemoryInfo()

   NiagaraEditorSettings.h  

bool IsShowParticleCountsInViewport()

   NiagaraEditorSettings.h  

bool IsShowStatelessInfo()

   NiagaraEditorSettings.h  

bool IsVisibleClass ( const UClass* InClass
) const

 Returns whether or not the supplied class is visible for UI purposes in the current editor context. NiagaraEditorSettings.h  

bool IsVisibleTypeDefinition ( const FNiagaraTypeDefinition& InTypeDefinition
) const

 Returns whether or not the supplied niagara type definition can be used in the current editor context. NiagaraEditorSettings.h  

void SetAutoCompile ( bool bInAutoCompile
)

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

void SetAutoExposureValue ( bool bInUseAutoExposure
)

   NiagaraEditorSettings.h  

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. NiagaraEditorSettings.h  

void SetCurveInputSnapEnabled ( bool bEnabled
)

   NiagaraEditorSettings.h  

void SetCurveOutputSnapEnabled ( bool bEnabled
)

   NiagaraEditorSettings.h  

void SetDisplayAdvancedParameterPanelCategories ( bool bInDisplayAdvancedParameterPanelCategories
)

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

void SetOnIsClassReferenceable ( const FOnIsClassAllowed& InOnIsClassAllowed
)

 Sets a delegate that allows external code to restrict which features can be used within the niagara editor by filtering which classes are actually referenceable. NiagaraEditorSettings.h  

void SetOnIsClassVisible ( const FOnIsClassAllowed& InOnIsClassAllowed
)

 Sets a delegate that allows external code to restrict which features can be used within the niagara editor by filtering which classes are visible in various menus. NiagaraEditorSettings.h  

void SetOnShouldFilterAssetByClassUsage ( const FOnShouldFilterAsset& InOnShouldFilterAssetByClassUsage
)

 Sets a delegate that allows external code to restrict which features can be used within the niagara editor by filtering which assets are allowed. NiagaraEditorSettings.h  

void SetOnShouldFilterAssetInNiagaraAssetBrowser ( const FOnShouldFilterAsset& InOnShouldFilterAssetByClassUsage
)

 Sets a delegate that allows external code to restrict what assets will show up in the Niagara Asset Browser. NiagaraEditorSettings.h  

void SetResetDependentSystemsWhenEditingEmitters ( bool bInResetDependentSystemsWhenEditingEmitters
)

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

void SetResetSimulationOnChange ( bool bInResetSimulationOnChange
)

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

void SetResimulateOnChangeWhilePaused ( bool bInResimulateOnChangeWhilePaused
)

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

void SetShowEmitterExecutionOrder ( bool bShowEmitterExecutionOrder
)

   NiagaraEditorSettings.h  

void SetShowGpuTickInformation ( bool bShowGpuTickInformation
)

   NiagaraEditorSettings.h  

void SetShowGridInViewport ( bool bShowGridInViewport
)

   NiagaraEditorSettings.h  

void SetShowInstructionsCount ( bool bShowInstructionsCount
)

   NiagaraEditorSettings.h  

void SetShowMemoryInfo ( bool bInShowInfo
)

   NiagaraEditorSettings.h  

void SetShowParticleCountsInViewport ( bool bShowParticleCountsInViewport
)

   NiagaraEditorSettings.h  

void SetShowStatelessInfo ( bool bInShowInfo
)

   NiagaraEditorSettings.h  

void SetUseAutoExposure ( bool bInUseAutoExposure
)

   NiagaraEditorSettings.h  

void SetViewportSharedSettings ( const FNiagaraViewportSharedSettings& InViewportSharedSettings
)

   NiagaraEditorSettings.h  

Overridden from UDeveloperSettings

Name Remarks Include Path Unreal Specifiers

virtual FName GetCategoryName()

   NiagaraEditorSettings.h  

virtual FText GetSectionText()

   NiagaraEditorSettings.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraEditorSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static FOnNiagaraEditorSettingsChanged & OnSettingsChanged()

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page