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 > FNiagaraSystemInstance

Light Theme

Dark Theme

FNiagaraSystemInstance

Windows

MacOS

Linux

References

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

Syntax

class FNiagaraSystemInstance

Variables

	Name	Description
uint32	ActiveGPUEmitterCount
FInstanceParame...	GatheredInstanceParameters
int32	GPUDataInterfaceInstanceDataSize
bool	GPUParamIncludeInterpolation
uint32	TotalGPUParamSize	Transient data that is accumulated during tick.

Constructors

	Name	Description
	FNiagaraSystemInstance ( UNiagaraComponent* InComponent )	Creates a new niagara System instance with the supplied component.

Destructors

	Name	Description
	~FNiagaraSystemInstance()	Cleanup

Functions

	Name	Description
void	Activate ( EResetMode InResetMode )
void	AdvanceSimulation ( int32 TickCountToSimulate, float TickDeltaSeconds )	Manually advances this system's simulation by the specified number of ticks and tick delta.
bool	AllocateSystemInstance ( UNiagaraComponent* InComponent, TUniquePtr< FNiagaraSystemInstance ... )
void	BeginAsyncWork()
void	BindParameters()	Void RebindParameterCollection(UNiagaraParameterCollectionInstance* OldInstance, UNiagaraParameterCollectionInstance* NewInstance);
void	Cleanup()
void	ClearEventDataSets()
void	Complete()
void	ComponentTick ( float DeltaSeconds, const FGraphEventRef& MyCompletion... )
FNiagaraData...	CreateEventDataSet ( FName EmitterName, FName EventName )
void	Deactivate ( bool bImmediate )
bool	DeallocateSystemInstance ( TUniquePtr< FNiagaraSystemInstance ... )
void	Dump()	Dumps all of this systems info to the log.
void	DumpTickInfo ( FOutputDevice& Ar )	Dumps information about the instances tick to the log
FNiagaraEmit...	EditEmitterParameters ( int32 EmitterIdx )
void	FinalizeTick_GameThread()	Final phase of system instance tick. Must be executed on the game thread.
void *	FindDataInterfaceInstanceData ( UNiagaraDataInterface* Interfa... )	Returns the instance data for a particular interface for this System.
void	FinishCapture()	Only call from within the script execution states. Does nothing if not capturing a frame.
void	FlipParameterBuffers()
TArray< TSha...	GetActiveCaptureResults()	Only call from within the script execution states. Value is null if not capturing a frame.
TSharedPtr< ...	GetActiveCaptureWrite ( const FName& InHandleName, ENiagaraScriptUsage InUsage, const FGuid& InUsageId )	Only call from within the script execution states. Value is nullptr if not capturing a frame.
ENiagaraExec...	GetActualExecutionState()
float	GetAge()
bool	GetAreDataInterfacesInitialized()
NiagaraEmitt...	GetBatcher()
UNiagaraComp...	GetComponent()
const FStrin...	GetCrashReporterTag()
FNiagaraData...	GetDataSet ( FNiagaraDataSetID SetID, FName EmitterName )	Gets a data set either from another emitter or one owned by the System itself.
FNiagaraEmit...	GetEmitterByID ( FGuid InID )
const TArray...	GetEmitterExecutionOrder()
const FNiaga...	GetEmitterParameters ( int32 EmitterIdx, bool PreviousFrame )
TArray< TSha...	GetEmitters()
const TArray...	GetEmitters()
FNiagaraData...	GetEventDataSet ( FName EmitterName, FName EventName )
ERHIFeatureL...	GetFeatureLevel()
const FNiaga...	GetGlobalParameters ( bool PreviousFrame )
FNiagaraSyst...	GetId()
FNiagaraPara...	GetInstanceParameters()
bool	GetIsolateEnabled()
const FBox &	GetLocalBounds()
const FNiaga...	GetOwnerParameters ( bool PreviousFrame )
UNiagaraPara...	GetParameterCollectionInstance ( UNiagaraParameterCollection* C... )
uint32	GetParameterIndex ( bool PreviousFrame )
bool	GetPerInstanceDataAndOffsets ( void*& OutData, uint32& OutDataSize, TMap< TWeakObjectPtr< UNiagaraDataI... )
ENiagaraExec...	GetRequestedExecutionState()
TSharedPtr< ...	GetSimulationForHandle ( const FNiagaraEmitterHandle& Emitt... )	Gets the simulation for the supplied emitter handle.
UNiagaraSyst...	GetSystem()
const FNiaga...	GetSystemParameters ( bool PreviousFrame )
TSharedPtr< ...	GetSystemSimulation()
int32	GetTickCount()
FNiagaraWorl...	GetWorldManager()
bool	HandleCompletion()	Handles completion of the system and returns true if the system is complete.
bool	HasGPUEmitters()	Void SetHasGPUEmitters(bool bInHasGPUEmitters) { bHasGPUEmitters = bInHasGPUEmitters; }
void	Init ( bool bInForceSolo )	Initializes this System instance to simulate the supplied System.
bool	IsComplete()	Int32 GetNumParticles(int32 EmitterIndex) const { return ParameterNumParticleBindings[EmitterIndex].GetValue(); } float GetSpawnCountScale(int32 EmitterIndex) const { return ParameterSpawnCountScaleBindings[EmitterIndex].GetValue(); }
bool	IsDisabled()
bool	IsPaused()
bool	IsPendingSpawn()
bool	IsReadyToRun()
bool	IsSolo()
FOnComplete ...	OnComplete()	Gets a multicast delegate which is called whenever this instance is complete.
FOnDestroyed...	OnDestroyed()
FOnInitializ...	OnInitialized()	Gets a multicast delegate which is called whenever this instance is initialized with an System asset.
FOnReset &	OnReset()	Gets a multicast delegate which is called whenever this instance is reset due to external changes in the source System asset.
bool	QueryCaptureResults ( const FGuid& RequestId, TArray< TSharedPtr< struct FNiagara... )	Poll for previous frame capture requests.
void	RaiseNeedsUIResync()
bool	RequestCapture ( const FGuid& RequestId )	Request that this simulation capture a frame. Cannot capture if disabled or already completed.
bool	RequiresDepthBuffer()
bool	RequiresDistanceFieldData()
bool	RequiresEarlyViewData()
void	Reset ( EResetMode Mode )	Requests the the simulation be reset on the next tick.
void	SetActualExecutionState ( ENiagaraExecutionState InState )
void	SetEmitterEnable ( FName EmitterName, bool bNewEnableState )
void	SetLODDistance ( float InLODDistance, float InMaxLODDistance )
void	SetPaused ( bool bInPaused )
void	SetPendingSpawn ( bool bInValue )
void	SetRequestedExecutionState ( ENiagaraExecutionState InState )
void	SetSolo ( bool bInSolo )
bool	ShouldCaptureThisFrame()	Only call from within the script execution states. Value is false if not capturing a frame.
void	Tick_Concurrent()	Secondary phase of the system instance tick that can be executed on any thread.
void	Tick_GameThread ( float DeltaSeconds )	Initial phase of system instance tick. Must be executed on the game thread.
void	TickDataInterfaces ( float DeltaSeconds, bool bPostSimulate )	Perform per-tick updates on data interfaces that need it.
void	TickInstanceParameters_Concurrent()
void	TickInstanceParameters_GameThread ( float DeltaSeconds )
void	UnbindParameters ( bool bFromComplete )
void	UpdatePrereqs()
bool	UsesCollection ( const UNiagaraParameterCollection&... )	Bool UsesDataInterface(UNiagaraDataInterface* Interface);
bool	UsesEmitter ( const UNiagaraEmitter* Emitter )
bool	UsesScript ( const UNiagaraScript* Script )
void	WaitForAsyncTickAndFinalize ( bool bEnsureComplete )	Blocks until any async work for this system instance has completed, must be called on the GameThread.
void	WaitForAsyncTickDoNotFinalize ( bool bEnsureComplete )	Blocks until any async work for this system instance has completed, must be called on the GameThread.

Classes

	Name	Description
	FInstanceParameters

Enums

	Name	Description
	EResetMode	Defines modes for resetting the System instance.

Typedefs

Name	Description
EmitterEventKey	Registered events for each of the emitters
EventDataSetMap
FOnComplete
FOnDestroyed
FOnInitialized
FOnReset

Constants

Name	Description
ParameterBufferCount

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

Take our survey

Dismiss