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

Light Theme

Dark Theme

FNiagaraEmitterInstance

A Niagara particle simulation.

Windows

MacOS

Linux

References

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

Syntax

class FNiagaraEmitterInstance

Remarks

A Niagara particle simulation.

Variables

		Name	Description
	bool	bDumpAfterEvent

Constructors

	Name	Description
	FNiagaraEmitterInstance ( FNiagaraSystemInstance* InPare... )

Destructors

	Name	Description
	~FNiagaraEmitterInstance()

Functions

	Name	Description
void	BindParameters ( bool bExternalOnly )	Void RebindParameterCollection(UNiagaraParameterCollectionInstance* OldInstance, UNiagaraParameterCollectionInstance* NewInstance);
uint32	CalculateEventSpawnCount ( const FNiagaraEventScriptProperties..., TArray< int32, TInlineAllocator< 16..., FNiagaraDataSet* EventSet )	Calculate total number of spawned particles from events; these all come from event handler script with the SpawnedParticles execution mode We get the counts ahead of event processing time so we only have to allocate new particles once TODO: augment for multiple spawning event scripts
void	CalculateFixedBounds ( const FTransform& ToWorldSpace )	Potentially reads back data from the GPU which will introduce a stall and should only be used for debug purposes.
void	DirtyDataInterfaces()
void	Dump()
bool	FindBinding ( const FNiagaraUserParameterBinding ..., TArray< UMaterialInterface* > ... )
FBox	GetBounds()
UNiagaraEmit...	GetCachedEmitter()
FName	GetCachedIDName()
FNiagaraData...	GetData()
FNiagaraData...	GetDataSet ( FNiagaraDataSetID SetID )
const FNiaga...	GetEmitterHandle()
TArray< FNia...	GetEventExecutionContexts()
ENiagaraExec...	GetExecutionState()
FNiagaraComp...	GetGPUContext()
int32	GetNumParticles()	Create a new NiagaraRenderer.
FNiagaraSyst...	GetParentSystemInstance()
const FNiaga...	GetScalabilitySettings()
FNiagaraScri...	GetSpawnExecutionContext()
TArray< FNia...	GetSpawnInfo()
int	GetTotalBytesUsed()
float	GetTotalCPUTimeMS()
int32	GetTotalSpawnedParticles()
FNiagaraScri...	GetUpdateExecutionContext()
bool	HandleCompletion ( bool bForce )
bool	HasTicked()
void	Init ( int32 InEmitterIdx, FNiagaraSystemInstanceID SystemInst... )
bool	IsAllowedToExecute()
bool	IsComplete()
bool	IsDisabled()
bool	IsInactive()
bool	IsReadyToRun()
void	PostTick()	Do any post work such as calculating dynamic bounds.
void	PreTick()	PreTick - handles killing dead particles, emitter death, and buffer swaps
bool	RequiresPersistentIDs()
void	ResetSimulation ( bool bKillExisting )
void	SetExecutionState ( ENiagaraExecutionState InState )
void	SetSystemFixedBoundsOverride ( FBox SystemFixedBounds )
bool	ShouldTick()
void	Tick ( float DeltaSeconds )	PreTick - handles killing dead particles, emitter death, and buffer swaps
void	UnbindParameters ( bool bExternalOnly )
bool	WaitForDebugInfo()

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

Take our survey

Dismiss