1. Epic GamesDeveloper
  3. UNiagaraEditorSettings

UNiagaraEditorSettings

API > API/Plugins > API/Plugins/NiagaraEditor

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Config&61;Niagara, defaultconfig, Meta&61;&40;DisplayName&61;"Niagara"&41;, MinimalAPI&41;  
class UNiagaraEditorSettings : public UDeveloperSettings

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere Config bool bAlwaysZoomToFitSystemGraph If true then the system editor will zoom to fit all emitters when opening an asset.
Public variable UProperty Category, EditAnywhere Config bool bSimplifyStackNodesAtLowResolution If true then emitter and system nodes will show a simplified representation on low zoom levels.
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 ENiagaraAddDefaultsTrackMode DefaultsSequencerSubtracks  
Public variable UProperty Category, EditAnywhere Config TArray< TSoftObjectPtr< UNiagaraValidationRuleSet > > DefaultValidationRuleSets Validation rules applied to all Niagara systems.
Public variable UProperty Category, EditAnywhere Config TArray< FNiagaraSpawnShortcut > 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, Meta Config int32 LowResolutionNodeMaxNameChars The max number of chars before names on the low resolution nodes are truncated.
Public variable UProperty Category, EditAnywhere Config ENiagaraCategoryExpandState RendererCategoryExpandState  
Public variable UProperty Category, EditAnywhere Config FSoftObjectPath RequiredSystemUpdateScript Niagara script which is required in the system update script to control system state.
Protected variable FOnNiagaraEditorSettingsChanged SettingsChangedDelegate  

Constructors

  Type Name Description
Public function  

UNiagaraEditorSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const FAssetRegistryTag

CreateClassUsageAssetRegistryTag ( const UObject* SourceObject
)

  
Public function FNiagaraParameterPanelSectionStorage &

FindOrAddParameterPanelSectionStorage ( FGuid PanelSectionId,
bool& bOutAdded
)

  
Public function Const const TArray< FNiagaraNamespaceMetadata > &  
Public function Const const TArray< FNiagaraNamespaceMetadata > &  
Public function Const int32  
Public function Const bool Gets whether or not auto-compile is enabled in the editors.
Public function Const bool 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< FNiagaraCurveTemplate > &  
Public function Const FNiagaraNamespaceMetadata  
Public function Const FNiagaraNamespaceMetadata  
Public function Const bool Gets whether or not to display advanced categories for the parameter panel.
Public function Const bool  
Public function Const float  
Public function Const const TMap< FString, FString > &  
Public function Const const FGuid &  
Public function Const FNiagaraNamespaceMetadata

GetMetaDataForId ( const FGuid& NamespaceId
)

  
Public function Const FNiagaraNamespaceMetadata

GetMetaDataForNamespaceModifier ( FName NamespaceModifier
)

  
Public function Const FNiagaraNamespaceMetadata  
Public function Const FNiagaraNewAssetDialogConfig

GetNewAssetDailogConfig ( FName InDialogConfigKey
)

  
Public function Const TArray< float >  
Public function Const bool Gets whether or not to reset all components that include the system that is currently being reset
Public function Const bool Gets whether or not the simulation should reset when a value on the emitter or system is changed.
Public function Const bool Gets whether or not to rerun the simulation to the current time when making modifications while paused.
Public function Const FLinearColor  
Public function Const bool  
Public function Const bool  
Public function Const const FNiagaraViewportSharedSettings &  
Public function Const bool

IsAllowedAssetByClassUsage ( const FAssetData& InAssetData
)

  
Public function Const bool

IsAllowedAssetObjectByClassUsage ( const UObject& InAssetObject
)

  
Public function Const bool

IsAllowedClass ( const UClass* InClass
)

 Returns whether or not the supplied class can be used in the current editor context.
Public function Const bool

IsAllowedClassPath ( const FTopLevelAssetPath& InClassPath
)

 Returns whether or not the class referenced by the supplied class path can be used in the current editor context.
Public function Const bool

IsAllowedTypeDefinition ( const FNiagaraTypeDefinition& InTypeDefinition
)

 Returns whether or not the supplied niagara type definition can be used in the current editor context.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Static FOnNiagaraEditorSettingsChanged & 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

SetAutoExposureValue ( bool bInUseAutoExposure
)

  
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 bInDisplayAdvancedParameterPanelCategories
)

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

SetNewAssetDialogConfig ( FName InDialogConfigKey,
const FNiagaraNewAssetDialogConfig& InNewAssetDialogConfig
)

  
Public function void

SetOnIsClassAllowed ( 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 allowed.
Public function void

SetOnIsClassPathAllowed ( const FOnIsClassPathAllowed& InOnIsClassPathAllowed
)

 Sets a delegate that allows external code to restrict which features can be used within the niagara editor by filtering which classes are allowed by class path.
Public function void

SetOnShouldFilterAssetByClassUsage ( const FOnShouldFilterAssetByClassUsage& 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.
Public function void

SetResetDependentSystemsWhenEditingEmitters ( bool bInResetDependentSystemsWhenEditingEmitters
)

 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 bInResimulateOnChangeWhilePaused
)

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

SetShowEmitterExecutionOrder ( bool bShowEmitterExecutionOrder
)

  
Public function void

SetShowGpuTickInformation ( bool bShowGpuTickInformation
)

  
Public function void

SetShowGridInViewport ( bool bShowGridInViewport
)

  
Public function void

SetShowInstructionsCount ( bool bShowInstructionsCount
)

  
Public function void

SetShowMemoryInfo ( bool bInShowInfo
)

  
Public function void

SetShowParticleCountsInViewport ( bool bShowParticleCountsInViewport
)

  
Public function void

SetUseAutoExposure ( bool bInUseAutoExposure
)

  
Public function void

SetViewportSharedSettings ( const FNiagaraViewportSharedSettings& InViewportSharedSettings
)

  

Overridden from UDeveloperSettings

  Type Name Description
Public function Virtual Const FName Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.
Public function Virtual Const FText Gets the section text, uses the classes DisplayName by default.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 UObject interface

Typedefs

Name Description
FOnIsClassAllowed  
FOnIsClassPathAllowed  
FOnNiagaraEditorSettingsChanged  
FOnShouldFilterAssetByClassUsage  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page