FNiagaraEmitterInstance

A Niagara particle simulation.

Choose your operating system:

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.

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()
UObject *...	FindBinding ( const FNiagaraVariable& InVariable )
UNiagaraData...	FindDataInterface ( const FNiagaraVariable& InVariable )
bool	GetBoundRendererValue_GT ( const FNiagaraVariableBase& InBase..., const FNiagaraVariableBase& InSubV..., void* OutValueData )
FBox	GetBounds()
UNiagaraEmit...	GetCachedEmitter()
FName	GetCachedIDName()
FNiagaraData...	GetData()
const FNiaga...	GetEmitterHandle()
TArrayView< ...	GetEventExecutionContexts()
ENiagaraExec...	GetExecutionState()
FBox	GetFixedBounds()
FNiagaraComp...	GetGPUContext()
int32	GetInstanceSeed()
int32	GetNumParticles()
FNiagaraSyst...	GetParentSystemInstance()
int32	GetRandomSeed()
const FNiaga...	GetRendererBoundVariables()
FNiagaraPara...	GetRendererBoundVariables()
const FNiaga...	GetScalabilitySettings()
FNiagaraScri...	GetSpawnExecutionContext()
TArray< FNia...	GetSpawnInfo()
int64	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	IsParticleComponentActive ( FObjectKey ComponentKey, int32 ParticleID )
bool	IsReadyToRun()
void	OnPooledReuse()
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	SetFixedBounds ( const FBox& InLocalBounds )
void	SetParticleComponentActive ( FObjectKey ComponentKey, int32 ParticleID )
void	SetSystemFixedBoundsOverride ( FBox SystemFixedBounds )
bool	ShouldTick()
void	Tick ( float DeltaSeconds )	PreTick - handles killing dead particles, emitter death, and buffer swaps
void	TickRapidIterationParameters()
void	UnbindParameters ( bool bExternalOnly )
bool	WaitForDebugInfo()