UNiagaraSettings Class Reference

Static Public Member Functions
Static Functions
static UClass	StaticClass ()

Public Attributes
AsyncGpuTraceDI
TArray< ENDICollisionQuery_AsyncGpuTraceProvider >	NDICollisionQuery_AsyncGpuTraceProviderOrder
	Defines how traces tagged as 'Project Default' will be interpreted when using the AsyncGpuTrace data interface. The system will go through (starting at element 0) to find the first provider that is available.
LightRenderer
float32	DefaultLightInverseExposureBlend
	The default InverseExposureBlend used for the light renderer.
Niagara
TArray< FSoftObjectPath >	AdditionalParameterEnums
bool	bShowConvertibleInputsInStack
	If true then the "link input" menu will also show variables of different types, as long as there is a conversion script for them.
TArray< FSoftObjectPath >	AdditionalPayloadTypes
ENiagaraCompilationMode	CompilationMode
bool	bSystemsSupportLargeWorldCoordinates
	If true then active effects rebase the simulation positions to not lose precision. Can be turned off if not needed to skip unnecessary rebasing calculations.
bool	bEnforceStrictStackTypes
	If set to true, types like positions and vectors cannot be assigned to each other without an explicit conversion step. If false, type checks are loosened and some types can be implicitly converted into each other. It is recommended to not disable this when working with large world coordinates.
bool	bExperimentalVMEnabled
	True indicates that we will generate byte code for the new optimized VM. Control over whether the new VM will be used when executing NiagaraScripts will also take into account the overrides on the system (bDisableExperimentalVM) and the cvars fx.NiagaraScript.StripByteCodeOnLoad and fx.ForceExecVMPath.
bool	bStatelessEmittersEnabled
	Enables Lightweight Emitters experimental feature. Statless emitters are lightweight fixed function emitters, they are not fully programmable like regular emitters and do not run scripts on the CPU. Particle data is extrapolated per frame for the current particle age. This means we never store particle data, we only generate it on demand. Systems that contain only lightweight emitters and no system script modules can take advantage of a much faster path to execute. There is no guarantee on backwards compatability for this feature currently. Do not ship lightweight content. **.
bool	bAccurateQuatInterpolation
	If set to true, quaternion attributes will be interpolated via slerp instead of lerp in interpolated spawn scripts.
ENiagaraCompileErrorSeverity	InvalidNamespaceWriteSeverity
	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.
bool	bLimitDeltaTime
	Whether to limit the max tick delta time or not.
float32	MaxDeltaTimePerTick
	Limits the delta time per tick for emitters to prevent simulation spikes due to frame lags.
FSoftObjectPath	DefaultEffectType
	Default effect type to use for effects that don't define their own. Can be null.
FSoftObjectPath	RequiredEffectType
	Specifies a required effect type which must be used for effects in the project.
bool	bAllowCreateActorFromSystemWithNoEffectType
	Should we allow placing a Niagara System in the editor into a level which has no effect type assigned?
FLinearColor	PositionPinTypeColor
	Position pin type color. The other pin colors are defined in the general editor settings.
ENiagaraStripScriptByteCodeOption	ByteCodeStripOption
	Controls how byte code will be stripped when loading assets that have multiple sets of bytecode (i.e. optimized).
TArray< FSoftObjectPath >	AdditionalParameterTypes
Renderer
ENiagaraDefaultRendererPixelCoverageMode	DefaultPixelCoverageMode
	The default setting for pixel coverage mode when automatic is set on the Niagara Renderer.
TMap< FString, FText >	ComponentRendererWarningsPerClass
	Info texts that the component renderer shows the user depending on the selected component class.
ETextureRenderTargetFormat	DefaultRenderTargetFormat
	The default render target format used by all Niagara Render Target Data Interfaces unless overridden.
ENiagaraGpuBufferFormat	DefaultGridFormat
	The default buffer format used by all Niagara Grid Data Interfaces unless overridden.
ENiagaraDefaultRendererMotionVectorSetting	DefaultRendererMotionVectorSetting
	The default setting for motion vectors in Niagara renderers.
ENiagaraDefaultSortPrecision	DefaultSortPrecision
	The default setting for sorting precision when automatic is set on the Niagara Renderer.
ENiagaraDefaultGpuTranslucentLatency	DefaultGpuTranslucentLatency
	The default setting for Gpu simulation translucent draw latency.
Scalability
TArray< FText >	QualityLevels
	The quality levels Niagara uses.
TArray< FNiagaraPlatformSetRedirect >	PlatformSetRedirects
SimCache
int64	SimCacheMaxCPUMemoryVolumetrics
	Max memory in megabytes for total CPU memory for cached volumetric data.
FString	SimCacheAuxiliaryFileBasePath
	Base path for auxiliary files written out during the generation of a Niagara Sim Cache (ie: volume files).
SimulationCaching
int	QuickSimCacheCaptureFrameCount
	The number of frames to capture when capturing a Sim Cache from the Niagara Component Details Panel. *.
SkeletalMeshDI
ENDISkelMesh_AdjacencyTriangleIndexFormat	NDISkelMesh_AdjacencyTriangleIndexFormat
	Controls the format used for specifying triangle indexes in adjacency buffers. Changing this setting requires restarting the editor.
ENDISkelMesh_GpuMaxInfluences	NDISkelMesh_GpuMaxInfluences
	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.
bool	NDISkelMesh_Support16BitIndexWeight
	Enabled support for 16 bit bone index & bone weight, optional to reduce shader complexity. Changing this setting requires restarting the editor.
ENDISkelMesh_GpuUniformSamplingFormat	NDISkelMesh_GpuUniformSamplingFormat
	Controls the format used for uniform sampling on the GPU. Changing this setting requires restarting the editor.
bool	NDISkelMesh_SupportReadingDeformedGeometry
	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. Changing this setting requires restarting the editor. Note: Enabling this does add additional branches to the skel mesh data reading.
StaticMeshDI
bool	NDIStaticMesh_AllowDistanceFields
	When enabled the static mesh data interface is allowed to sample from the distance field data (if present) on the GPU. Enabling this feature will move all systems that contain static mesh samples into PostRenderOpaque tick group regardless of the features used. Changing this setting requires restarting the editor.
Viewport
bool	bSystemViewportInOrbitMode
	Sets the default navigation behavior for the system preview viewport.

Member Function Documentation

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

AdditionalParameterEnums

TArray<FSoftObjectPath> AdditionalParameterEnums

AdditionalParameterTypes

TArray<FSoftObjectPath> AdditionalParameterTypes

AdditionalPayloadTypes

TArray<FSoftObjectPath> AdditionalPayloadTypes

bAccurateQuatInterpolation

bool bAccurateQuatInterpolation

If set to true, quaternion attributes will be interpolated via slerp instead of lerp in interpolated spawn scripts.

bAllowCreateActorFromSystemWithNoEffectType

bool bAllowCreateActorFromSystemWithNoEffectType

Should we allow placing a Niagara System in the editor into a level which has no effect type assigned?

bEnforceStrictStackTypes

bool bEnforceStrictStackTypes

If set to true, types like positions and vectors cannot be assigned to each other without an explicit conversion step. If false, type checks are loosened and some types can be implicitly converted into each other. It is recommended to not disable this when working with large world coordinates.

bExperimentalVMEnabled

bool bExperimentalVMEnabled

True indicates that we will generate byte code for the new optimized VM. Control over whether the new VM will be used when executing NiagaraScripts will also take into account the overrides on the system (bDisableExperimentalVM) and the cvars fx.NiagaraScript.StripByteCodeOnLoad and fx.ForceExecVMPath.

bLimitDeltaTime

bool bLimitDeltaTime

Whether to limit the max tick delta time or not.

bShowConvertibleInputsInStack

bool bShowConvertibleInputsInStack

If true then the "link input" menu will also show variables of different types, as long as there is a conversion script for them.

bStatelessEmittersEnabled

bool bStatelessEmittersEnabled

Enables Lightweight Emitters experimental feature. Statless emitters are lightweight fixed function emitters, they are not fully programmable like regular emitters and do not run scripts on the CPU. Particle data is extrapolated per frame for the current particle age. This means we never store particle data, we only generate it on demand. Systems that contain only lightweight emitters and no system script modules can take advantage of a much faster path to execute. There is no guarantee on backwards compatability for this feature currently. Do not ship lightweight content. **.

bSystemsSupportLargeWorldCoordinates

bool bSystemsSupportLargeWorldCoordinates

If true then active effects rebase the simulation positions to not lose precision. Can be turned off if not needed to skip unnecessary rebasing calculations.

bSystemViewportInOrbitMode

bool bSystemViewportInOrbitMode

Sets the default navigation behavior for the system preview viewport.

ByteCodeStripOption

ENiagaraStripScriptByteCodeOption ByteCodeStripOption

Controls how byte code will be stripped when loading assets that have multiple sets of bytecode (i.e. optimized).

CompilationMode

ENiagaraCompilationMode CompilationMode

ComponentRendererWarningsPerClass

TMap<FString,FText> ComponentRendererWarningsPerClass

Info texts that the component renderer shows the user depending on the selected component class.

DefaultEffectType

FSoftObjectPath DefaultEffectType

Default effect type to use for effects that don't define their own. Can be null.

DefaultGpuTranslucentLatency

ENiagaraDefaultGpuTranslucentLatency DefaultGpuTranslucentLatency

The default setting for Gpu simulation translucent draw latency.

DefaultGridFormat

ENiagaraGpuBufferFormat DefaultGridFormat

The default buffer format used by all Niagara Grid Data Interfaces unless overridden.

DefaultLightInverseExposureBlend

float32 DefaultLightInverseExposureBlend

The default InverseExposureBlend used for the light renderer.

DefaultPixelCoverageMode

ENiagaraDefaultRendererPixelCoverageMode DefaultPixelCoverageMode

The default setting for pixel coverage mode when automatic is set on the Niagara Renderer.

DefaultRendererMotionVectorSetting

ENiagaraDefaultRendererMotionVectorSetting DefaultRendererMotionVectorSetting

The default setting for motion vectors in Niagara renderers.

DefaultRenderTargetFormat

ETextureRenderTargetFormat DefaultRenderTargetFormat

The default render target format used by all Niagara Render Target Data Interfaces unless overridden.

DefaultSortPrecision

ENiagaraDefaultSortPrecision DefaultSortPrecision

The default setting for sorting precision when automatic is set on the Niagara Renderer.

InvalidNamespaceWriteSeverity

ENiagaraCompileErrorSeverity InvalidNamespaceWriteSeverity

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.

MaxDeltaTimePerTick

float32 MaxDeltaTimePerTick

Limits the delta time per tick for emitters to prevent simulation spikes due to frame lags.

NDICollisionQuery_AsyncGpuTraceProviderOrder

TArray<ENDICollisionQuery_AsyncGpuTraceProvider> NDICollisionQuery_AsyncGpuTraceProviderOrder

Defines how traces tagged as 'Project Default' will be interpreted when using the AsyncGpuTrace data interface. The system will go through (starting at element 0) to find the first provider that is available.

NDISkelMesh_AdjacencyTriangleIndexFormat

ENDISkelMesh_AdjacencyTriangleIndexFormat NDISkelMesh_AdjacencyTriangleIndexFormat

Controls the format used for specifying triangle indexes in adjacency buffers. Changing this setting requires restarting the editor.

NDISkelMesh_GpuMaxInfluences

ENDISkelMesh_GpuMaxInfluences NDISkelMesh_GpuMaxInfluences

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.

NDISkelMesh_GpuUniformSamplingFormat

ENDISkelMesh_GpuUniformSamplingFormat NDISkelMesh_GpuUniformSamplingFormat

Controls the format used for uniform sampling on the GPU. Changing this setting requires restarting the editor.

NDISkelMesh_Support16BitIndexWeight

bool NDISkelMesh_Support16BitIndexWeight

Enabled support for 16 bit bone index & bone weight, optional to reduce shader complexity. Changing this setting requires restarting the editor.

NDISkelMesh_SupportReadingDeformedGeometry

bool NDISkelMesh_SupportReadingDeformedGeometry

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. Changing this setting requires restarting the editor. Note: Enabling this does add additional branches to the skel mesh data reading.

NDIStaticMesh_AllowDistanceFields

bool NDIStaticMesh_AllowDistanceFields

When enabled the static mesh data interface is allowed to sample from the distance field data (if present) on the GPU. Enabling this feature will move all systems that contain static mesh samples into PostRenderOpaque tick group regardless of the features used. Changing this setting requires restarting the editor.

PlatformSetRedirects

TArray<FNiagaraPlatformSetRedirect> PlatformSetRedirects

PositionPinTypeColor

FLinearColor PositionPinTypeColor

Position pin type color. The other pin colors are defined in the general editor settings.

QualityLevels

TArray<FText> QualityLevels

The quality levels Niagara uses.

QuickSimCacheCaptureFrameCount

int QuickSimCacheCaptureFrameCount

The number of frames to capture when capturing a Sim Cache from the Niagara Component Details Panel. *.

RequiredEffectType

FSoftObjectPath RequiredEffectType

Specifies a required effect type which must be used for effects in the project.

SimCacheAuxiliaryFileBasePath

FString SimCacheAuxiliaryFileBasePath

Base path for auxiliary files written out during the generation of a Niagara Sim Cache (ie: volume files).

SimCacheMaxCPUMemoryVolumetrics

int64 SimCacheMaxCPUMemoryVolumetrics

Max memory in megabytes for total CPU memory for cached volumetric data.