/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSystem.h
A Niagara System contains multiple Niagara Emitters to create various effects. Niagara Systems can be placed in the world, unlike Emitters, and expose User Parameters to configure an effect at runtime.
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Meta=(LoadBehavior="LazyOnDemand"), MinimalAPI) class UNiagaraSystem : public [UFXSystemAsset](API\Runtime\Engine\Particles\UFXSystemAsset), public [INiagaraParameterDefinitionsSubscriber](API\Plugins\Niagara\INiagaraParameterDefinitionsSubs-)
TArray<TUnique...
ActiveCompilations
int32
ActiveInstances
Total active instances of this system.
FGuid
AssetGuid
TObjectPtr<UNi...
BakerGeneratedSettings
Generated data baker settings, will be null until we have generated at least once.
TObjectPtr<UNi...
BakerSettings
Settings used inside the baker
uint32:  1
bAllDIsPostSimulateCanOverlapFrames
uint32:  1
bAllDIsPostStageCanOverlapTickGroups
bool
bAllowCullingForLocalPlayers
uint32:  1
bAllowCullingForLocalPlayersOverride
The override value for bAllowCullingForLocalPlayers from the Effect Type.
bool
bAutoDeactivate
uint32:  1
bBakeOutRapidIteration
When enable constant values are baked into the scripts while editing the system, this will increase iteration times but improve performance.
uint32:  1
bBakeOutRapidIterationOnCook
When enabled constant values are baked into scripts to improve performance.
uint8:  1
bCastShadow
When enabled this is the default value set on the component.
bool
bCompilationReentrantGuard
uint32:  1
bCompileForEdit
When enabled we compile for the edit path, which can result in slower system performance but faster editor responsiveness.
uint32:  1
bCompressAttributes
Toggles whether or not emitters within this system will try and compress their particle attributes.
bool
bDeterminism
When disabled we will generate a RandomSeed per instance on reset which is not deterministic.
uint32:  1
bDisableDebugSwitches
When enable debug switches are disabled while editing the system.
uint32:  1
bDisableDebugSwitchesOnCook
When enabled debug switches are disabled when compiling the system.
uint8:  1
bDisableExperimentalVM
If true, disables experimental VM, if available
bool
bDumpDebugEmitterInfo
bool
bDumpDebugSystemInfo
uint32:  1
bFixedBounds
Whether or not fixed bounds are enabled.
bool
bFixedTickDelta
bool
bFullyLoaded
uint32:  1
bHasAnyGPUEmitters
uint32:  1
bHasDIsWithPostSimulateTick
uint32:  1
bIgnoreParticleReadsForAttributeTrim
If true ParticleReads will not absolutely prevent attribute trimming - User must ensure that the appropriate attributes are preserved on the source emitter!
bool
bIsolateEnabled
uint32:  1
bIsReadyToRunCached
uint32:  1
bIsValidCached
uint32:  1
bLwcEnabledSettingCached
uint32:  1
bNeedsAsyncOptimize
bool
bNeedsGPUContextInitForDataInterfaces
uint32:  1
bNeedsRequestCompile
When set the system needs to compile before it can be activated.
uint32:  1
bNeedsSortedSignificanceCull
uint32:  1
bOverrideAllowCullingForLocalPlayers
Controls whether we should override the Effect Type value for bAllowCullingForLocalPlayers.
uint8:  1
bOverrideCastShadow
Various optional overrides for component properties when spawning a system.
uint8:  1
bOverrideCustomDepthStencilValue
uint8:  1
bOverrideCustomDepthStencilWriteMask
uint8:  1
bOverrideReceivesDecals
uint8:  1
bOverrideRenderCustomDepth
bool
bOverrideScalabilitySettings
uint8:  1
bOverrideTranslucencySortDistanceOffset
uint8:  1
bOverrideTranslucencySortPriority
uint8:  1
bReceivesDecals
When enabled this is the default value set on the component. Whether the primitive receives decals.
uint8:  1
bRenderCustomDepth
When enabled this is the default value set on the component.
bool
bRequireCurrentFrameData
When enabled, we follow the settings on theUNiagaraComponentfor tick order.
uint8:  1
bSupportLargeWorldCoordinates
If true then position type values will be rebased on system activation to fit into a float precision vector.
uint32:  1
bTrimAttributes
When enabled we trim particle attributes while editing the system.
uint32:  1
bTrimAttributesOnCook
If true Particle attributes will be removed from the DataSet if they are unnecessary (are never read by ParameterMap)
TSharedPtr<FNi...
CachedTraversalData
FText
Category
Category of this system.
FString
CrashReporterTag
FNiagaraSystemS...
CurrentScalabilitySettings
Scalability settings.
int32
CustomDepthStencilValue
When enabled this is the default value set on the component.
ERendererStenci...
CustomDepthStencilWriteMask
When enabled this is the default value set on the component. Mask used for stencil buffer writes.
TObjectPtr<UNi...
EditorData
Data used by the editor to maintain UI state etc..
FNiagaraParamet...
EditorOnlyAddedParameters
TObjectPtr<UNi...
EditorParameters
Wrapper for editor only parameters.
TObjectPtr<UNi...
EffectType
An effect types defines settings shared between systems, for example scalability and validation rules.
TArray<TShared...
EmitterCompiledData
TArray<FNiagar...
EmitterExecutionOrder
Array of emitter indices sorted by execution priority.
TArray<FNiagar...
EmitterExecutionStateAccessors
TArray<FNiagar...
EmitterHandles
Handles to the emitter this System will simulate.
TArray<TArray<...
EmitterSpawnInfoAccessors
FNiagaraUserRed...
ExposedParameters
Variables exposed to the outside work for tweaking
FBox
FixedBounds
The fixed bounding box value for the whole system.
float
FixedTickDeltaTime
If activated, the system ticks with a fixed delta time instead of the varying game thread delta time.
ENiagaraScriptL...
LibraryVisibility
If this system is exposed to the library, or should be explicitly hidden.
TOptional< floa...
MaxDeltaTime
FNiagaraMessage...
MessageStore
FOnScalabilityC...
OnScalabilityChangedDelegate
A multicast delegate that is called whenever the effect type or the effect type values are changed
FOnSystemCompil...
OnSystemCompiledDelegate
A multicast delegate which is called whenever the script has been compiled (successfully or not).
FOnSystemPostEd...
OnSystemPostEditChangeDelegate
A multicast delegate which is called whenever this system's properties are changed.
TArray<TObject...
ParameterCollectionOverrides
TArray<FParame...
ParameterDefinitionsSubscriptions
Subscriptions to definitions of parameters.
FGraphEventRef
PSOPrecacheCompletionEvent
int32
RandomSeed
Seed used for system script random number generator.
TArray<FNiagar...
RendererCompletionOrder
Array of renderer indices to notify system Completion, in order of execution
TArray< int32 >
RendererDrawOrder
Precomputed emitter renderer draw order, since emitters & renderers are not dynamic we can do this.
TArray<FNiagar...
RendererPostTickOrder
Array of renderer indices to notify system PostTick, in order of execution
TArray<TObject...
ScratchPadScripts
FGraphEventRef
ScriptOptimizationCompletionEvent
TUniquePtr<FNi...
StaticBuffers
FNiagaraSystemC...
SystemCompiledData
FNiagaraDataSet...
SystemExecutionStateAccessor
FNiagaraSystemS...
SystemScalabilityOverrides
TObjectPtr<UNi...
SystemSpawnScript
The script which defines the System parameters, and which generates the bindings from System parameter to emitter parameter.
TObjectPtr<UNi...
SystemUpdateScript
The script which defines the System parameters, and which generates the bindings from System parameter to emitter parameter.
FText
TemplateAssetDescription
ENiagaraScriptT...
TemplateSpecification
If this system is a regular system, a template or a behavior example.
TObjectPtr< cla...
ThumbnailImage
Internal: The thumbnail image.
float
TranslucencySortDistanceOffset
When enabled this is the default value set on the component.
int32
TranslucencySortPriority
When enabled this is the default value set on the component.
FNiagaraSystemU...
UpdateContext
FRenderCommandF...
WaitRenderCommandsFence
int32
WarmupTickCount
Number of ticks to process for warmup. You can set by this or by time via WarmupTime.
float
WarmupTickDelta
Delta time to use for warmup ticks.
float
WarmupTime
Warm up time in seconds.