Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > UNiagaraSystem

Light Theme

Dark Theme

UNiagaraSystem

Container for multiple emitters that combine together to create a particle system effect.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UFXSystemAsset

UNiagaraSystem

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSystem.h
Include	#include "NiagaraSystem.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UNiagaraSystem : public UFXSystemAsset

Remarks

Container for multiple emitters that combine together to create a particle system effect.

Variables

	Name	Description
TArray< FNiagar...	ActiveCompilations
bool	bAutoDeactivate
uint32: 1	bBakeOutRapidIteration	Experimental feature that allows us to bake out rapid iteration parameters during the normal compile process.
bool	bDumpDebugEmitterInfo
bool	bDumpDebugSystemInfo
bool	bExposeToLibrary	If this system is exposed to the library.
uint32: 1	bFixedBounds	Whether or not fixed bounds are enabled.
bool	bHasSystemScriptDIsWithPerInstanceData
bool	bIsolateEnabled
bool	bIsTemplateAsset
bool	bOverrideScalabilitySettings
FNiagaraSystemS...	CurrentScalabilitySettings
UNiagaraEditorD...	EditorData	Data used by the editor to maintain UI state etc..
FNiagaraParamet...	EditorOnlyAddedParameters
UNiagaraEffectT...	EffectType
TArray< TShared...	EmitterCompiledData
TArray< FNiagar...	EmitterHandles	Handles to the emitter this System will simulate.
FNiagaraUserRed...	ExposedParameters	Variables exposed to the outside work for tweaking
FBox	FixedBounds	The fixed bounding box value. bFixedBounds is the condition whether the fixed bounds can be edited.
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< UNiagar...	ParameterCollectionOverrides
TArray< UNiagar...	ScratchPadScripts
FNiagaraSystemC...	SystemCompiledData
FNiagaraSystemS...	SystemScalabilityOverrides
UNiagaraScript ...	SystemSpawnScript	/** Category of this system. */
UNiagaraScript ...	SystemUpdateScript	The script which defines the System parameters, and which generates the bindings from System parameter to emitter parameter.
FText	TemplateAssetDescription
UTexture2D *...	ThumbnailImage	Internal: The thumbnail image.
uint32: 1	ThumbnailImageOutOfDate	Internal: Indicates the thumbnail image is out of date.
FNiagaraSystemU...	UpdateContext
TArray< FName >	UserDINamesReadInSystemScripts
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.

Constructors

	Name	Description
	UNiagaraSystem ( const FObjectInitializer& ObjectIn... )
	UNiagaraSystem ( FVTableHelper& Helper )

Functions

	Name	Description
FNiagaraEmit...	AddEmitterHandle ( UNiagaraEmitter& SourceEmitter, FName EmitterName )	Adds a new emitter handle to this System.
void	AddToInstanceCountStat ( int32 NumInstances, bool bSolo )
FNiagaraEmit...	DuplicateEmitterHandle ( const FNiagaraEmitterHandle& Emitt..., FName EmitterName )	Duplicates an existing emitter handle and adds it to the System.
void	ForceGraphToRecompileOnNextCheck()
void	GenerateStatID()
int32 *	GetCycleCounter ( bool bGameThread, bool bConcurrent )
const UNiaga...	GetEditorData()	Gets editor specific data stored with this system.
UNiagaraEdit...	GetEditorData()	Gets editor specific data stored with this system.
UNiagaraEffe...	GetEffectType()
const TArray...	GetEmitterCompiledData()
const FNiaga...	GetEmitterHandle ( int Idx )
FNiagaraEmit...	GetEmitterHandle ( int Idx )
const TArray...	GetEmitterHandles()	Gets an array of the emitter handles.
const TArray...	GetEmitterHandles()	Gets an array of the emitter handles.
FNiagaraUser...	GetExposedParameters()
const FNiaga...	GetExposedParameters()	From the last compile, what are the variables that were exported out of the system for external use?
FBox	GetFixedBounds()
bool	GetIsolateEnabled()
int	GetNumEmitters()
bool	GetOverrideScalabilitySettings()
UNiagaraPara...	GetParameterCollectionOverride ( UNiagaraParameterCollection* C... )
const FNiaga...	GetScalabilitySettings()
TStatId	GetStatID ( bool bGameThread, bool bConcurrent )
const FNiaga...	GetSystemCompiledData()
UNiagaraScri...	GetSystemSpawnScript()	Gets the System script which is used to populate the System parameters and parameter bindings.
UNiagaraScri...	GetSystemUpdateScript()
const TArray...	GetUserDINamesReadInSystemScripts()
int32	GetWarmupTickCount()
float	GetWarmupTickDelta()
float	GetWarmupTime()
bool	HasOutstandingCompilationRequests()	Are there any pending compile requests?
bool	HasSystemScriptDIsWithPerInstanceData()
void	InvalidateActiveCompiles()	Invalidates any active compilation requests which will ignore their results.
bool	IsLooping()
bool	IsReadyToRun()
bool	IsValid()	Returns true if this system is valid and can be instanced. False otherwise.
bool	NeedsLoadForTargetPlatform ( const ITargetPlatform* TargetP... )
bool	NeedsWarmup()
void	OnQualityLevelChanged()
FOnSystemCom...	OnSystemCompiled()	Delegate called when the system's dependencies have all been compiled.
FOnSystemPos...	OnSystemPostEditChange()	Delegate called on PostEditChange.
bool	PollForCompilationComplete()	If we have a pending compile request, is it done with yet?
bool	ReferencesInstanceEmitter ( UNiagaraEmitter& Emitter )	Determines if this system has the supplied emitter as an editable and simulating emitter instance.
void	RefreshSystemParametersFromEmitter ( const FNiagaraEmitterHandle& Emitt... )	Updates the system's rapid iteration parameters from a specific emitter.
void	RemoveEmitterHandle ( const FNiagaraEmitterHandle& Emitt... )	Removes the provided emitter handle.
void	RemoveEmitterHandlesById ( const TSet< FGuid >& HandlesToRemo... )	Removes the emitter handles which have an Id in the supplied set.
void	RemoveSystemParametersForEmitter ( const FNiagaraEmitterHandle& Emitt... )	Removes the system's rapid iteration parameters for a specific emitter.
bool	RequestCompile ( bool bForce, FNiagaraSystemUpdateContext* O... )	Request that any dirty scripts referenced by this system be compiled.
void	RequestCompileForEmitter ( UNiagaraEmitter* InEmitter )
void	SetEffectType ( UNiagaraEffectType* EffectType )
void	SetIsolateEnabled ( bool bIsolate )
void	SetOverrideScalabilitySettings ( bool bOverride )
bool	ShouldAutoDeactivate()
bool	UsesCollection ( const UNiagaraParameterCollection&... )
bool	UsesEmitter ( const UNiagaraEmitter* Emitter )
bool	UsesScript ( const UNiagaraScript* Script )
void	WaitForCompilationComplete()	Blocks until all active compile jobs have finished

Overridden from UObject

	Name	Description
void	BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetP... )	Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects
void	BeginDestroy()	Called before destroying the object.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally
void	PreSave ( const ITargetPlatform* TargetP... )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name	Description
FOnSystemCompiled
FOnSystemPostEditChange

Deprecated Variables

		Name	Description
	TArray< FNiagar...	ScalabilityOverrides_DEPRECATED

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss