1. Epic GamesDeveloper
  3. UNiagaraSettings

UNiagaraSettings

API > API/Plugins > API/Plugins/Niagara

   
Name UNiagaraSettings
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSettings.h
Include Path #include "NiagaraSettings.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraSettings ( const FObjectInitializer& ObjectInitializer
)

   NiagaraSettings.h  

Typedefs

Name Type Remarks Include Path
FOnNiagaraSettingsChanged TMulticastDelegate_TwoParams< void, const FName &, const UNiagaraSettings * >   NiagaraSettings.h

Constants

Name Type Remarks Include Path
SettingsChangedDelegate FOnNiagaraSettingsChanged   NiagaraSettings.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AdditionalParameterEnums TArray< FSoftObjectPath >   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(AllowedClasses="/Script/CoreUObject.Enum")
AdditionalParameterTypes TArray< FSoftObjectPath >   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(AllowedClasses="/Script/CoreUObject.ScriptStruct")
AdditionalPayloadTypes TArray< FSoftObjectPath >   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(AllowedClasses="/Script/CoreUObject.ScriptStruct")
bAccurateQuatInterpolation bool If set to true, quaternion attributes will be interpolated via slerp instead of lerp in interpolated spawn scripts. NiagaraSettings.h
  • Config
  • EditAnywhere
  • AdvancedDisplay
  • Category=Niagara
bAllowCreateActorFromSystemWithNoEffectType bool Should we allow placing a Niagara System in the editor into a level which has no effect type assigned? NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
bEnforceStrictStackTypes bool If set to true, types like positions and vectors cannot be assigned to each other without an explicit conversion step. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(DisplayName="Enforce strict type checks in the graph")
bGenerateMetaDataOnCompile bool   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
bLimitDeltaTime bool Whether to limit the max tick delta time or not. NiagaraSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Niagara"
  • Meta=(InlineEditConditionToggle)
bShowConvertibleInputsInStack bool If true then the "link input" menu will also show variables of different types, as long as there is a conversion script for them. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
bSystemsSupportLargeWorldCoordinates bool If true then active effects rebase the simulation positions to not lose precision. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(ConfigRestartRequired=true)
bSystemViewportInOrbitMode bool Sets the default navigation behavior for the system preview viewport. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Viewport
ByteCodeStripOption ENiagaraStripScriptByteCodeOption Controls how byte code will be stripped when loading assets that have multiple sets of bytecode (i.e. optimized). NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(DisplayName="Option for how to strip bytecode")
CompilationMode ENiagaraCompilationMode   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(DisplayName="Option for how to compile Niagara scripts")
ComponentRendererWarningsPerClass TMap< FString, FText > Info texts that the component renderer shows the user depending on the selected component class. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Renderer
DefaultEffectType FSoftObjectPath Default effect type to use for effects that don't define their own. Can be null. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(AllowedClasses="/Script/Niagara.NiagaraEffectType")
DefaultGpuTranslucentLatency ENiagaraDefaultGpuTranslucentLatency The default setting for Gpu simulation translucent draw latency. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Renderer
DefaultGridFormat ENiagaraGpuBufferFormat The default buffer format used by all Niagara Grid Data Interfaces unless overridden. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Renderer
DefaultLightInverseExposureBlend float The default InverseExposureBlend used for the light renderer. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=LightRenderer
DefaultPixelCoverageMode ENiagaraDefaultRendererPixelCoverageMode The default setting for pixel coverage mode when automatic is set on the Niagara Renderer. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Renderer
DefaultRendererMotionVectorSetting ENiagaraDefaultRendererMotionVectorSetting The default setting for motion vectors in Niagara renderers NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Renderer
DefaultRenderTargetFormat TEnumAsByte< ETextureRenderTargetFormat > The default render target format used by all Niagara Render Target Data Interfaces unless overridden. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Renderer
DefaultSortPrecision ENiagaraDefaultSortPrecision The default setting for sorting precision when automatic is set on the Niagara Renderer. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Renderer
InvalidNamespaceWriteSeverity ENiagaraCompileErrorSeverity If the Niagara compiler sees that a script writes to a namespace that is read only (e.g. a particle script writing to a system attribute), what should it do. NiagaraSettings.h
  • Config
  • EditAnywhere
  • AdvancedDisplay
  • Category=Niagara
LargeWorldCoordinateMaxTilesBeforeReset uint32 The maximum tiles we can cross before forcing a simulation to reset, if the tile update mode is set to RebaseOrResetSimulation. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(EditCondition="bSystemsSupportLargeWorldCoordinates", EditConditionHides)
LargeWorldCoordinateTileUpdateMode ENiagaraLwcTileUpdateMode Controls how we respond to a system instance crossing large world coordinate tiles. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
  • Meta=(EditCondition="bSystemsSupportLargeWorldCoordinates", EditConditionHides)
MaxDeltaTimePerTick float Limits the delta time per tick for emitters to prevent simulation spikes due to frame lags. NiagaraSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Niagara"
  • Meta=(EditCondition="bLimitDeltaTime", ForceUnits=s)
NDICollisionQuery_AsyncGpuTraceProviderOrder TArray< TEnumAsByte< ENDICollisionQuery_AsyncGpuTraceProvider::Type > > Defines how traces tagged as 'Project Default' will be interpreted when using the AsyncGpuTrace data interface. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=AsyncGpuTraceDI
  • Meta=(DisplayName="Trace Provider Priorities (Experimental)", ConfigRestartRequired=true)
NDISkelMesh_AdjacencyTriangleIndexFormat TEnumAsByte< ENDISkelMesh_AdjacencyTriangleIndexFormat::Type >   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=SkeletalMeshDI
  • Meta=(DisplayName="Adjacency Triangle Index Format", ToolTip="Controls the format used for specifying triangle indexes in adjacency buffers. Changing this setting requires restarting the editor.", ConfigRestartRequired=true)
NDISkelMesh_GpuMaxInfluences TEnumAsByte< ENDISkelMesh_GpuMaxInfluences::Type >   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=SkeletalMeshDI
  • Meta=(DisplayName="Gpu Max Bone Influences", ToolTip="Controls the maximum number of influences we allow the Skeletal Mesh Data Interface to use on the GPU. Changing this setting requires restarting the editor.", ConfigRestartRequired=true)
NDISkelMesh_GpuUniformSamplingFormat TEnumAsByte< ENDISkelMesh_GpuUniformSamplingFormat::Type >   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=SkeletalMeshDI
  • Meta=(DisplayName="Gpu Uniform Sampling Format", ToolTip="Controls the format used for uniform sampling on the GPU. Changing this setting requires restarting the editor.", ConfigRestartRequired=true)
NDISkelMesh_Support16BitIndexWeight bool   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=SkeletalMeshDI
  • Meta=(DisplayName="Support 16 bit index & weights", ToolTip="Enabled support for 16 bit bone index & bone weight, optional to reduce shader complexity. Changing this setting requires restarting the editor.", ConfigRestartRequired=true)
NDISkelMesh_SupportReadingDeformedGeometry bool When enabled we will read deformed geometry if available, i.e. data from the deformed graph / skin cache When disable we will only read from the default vertex data which does not include morph targets, skin, etc. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=SkeletalMeshDI
  • Meta=(DisplayName="Support Reading Deformed Geometry", ConfigRestartRequired=true)
NDIStaticMesh_AllowDistanceFields bool When enabled the static mesh data interface is allowed to sample from the distance field data (if present) on the GPU. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=StaticMeshDI
  • Meta=(DisplayName="Allow Distance Fields (Experimental)", ConfigRestartRequired=true)
PlatformSetRedirects TArray< FNiagaraPlatformSetRedirect >   NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Scalability
PositionPinTypeColor FLinearColor Position pin type color. The other pin colors are defined in the general editor settings. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Niagara
QualityLevels TArray< FText > The quality levels Niagara uses. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=Scalability
QuickSimCacheCaptureFrameCount int32 The number of frames to capture when capturing a Sim Cache from the Niagara Component Details Panel. NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=SimulationCaching
  • Meta=(UIMin=1)
SimCacheAuxiliaryFileBasePath FString Base path for auxiliary files written out during the generation of a Niagara Sim Cache (ie: volume files). NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=SimCache
  • Meta=(DisplayName="Sim Cache Auxiliary File Base Path", ConfigRestartRequired=false)
SimCacheMaxCPUMemoryVolumetrics int64 Max memory in megabytes for total CPU memory for cached volumetric data NiagaraSettings.h
  • Config
  • EditAnywhere
  • Category=SimCache
  • Meta=(DisplayName="Sim Cache Max CPU Memory For Volumetrics", ConfigRestartRequired=false)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddEnumParameterType ( UEnum* Enum
)

   NiagaraSettings.h  

UNiagaraEffectType * GetDefaultEffectType()

   NiagaraSettings.h  

Overridden from UDeveloperSettings

Name Remarks Include Path Unreal Specifiers

virtual FName GetCategoryName()

   NiagaraSettings.h  

virtual FText GetSectionText()

   NiagaraSettings.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static FOnNiagaraSettingsChanged & OnSettingsChanged()

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page