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 > Runtime > Engine > FParticleEmitterInstance

Light Theme

Dark Theme

FParticleEmitterInstance

Windows

MacOS

Linux

Inheritance Hierarchy

FParticleBeam2EmitterInstance

FParticleMeshEmitterInstance

FParticleSpriteEmitterInstance

FParticleTrailsEmitterInstance_Base

	FParticleAnimTrailEmitterInstance
	FParticleRibbonEmitterInstance

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/ParticleEmitterInstances.h
Include	#include "ParticleEmitterInstances.h"

Syntax

struct FParticleEmitterInstance

Variables

	Name	Description
int32	ActiveParticles	The number of particles currently active in the emitter.
uint32: 1	bAxisLockEnabled	Whether axis lock is enabled, cached here to avoid finding it from the module each frame
bool	bEmitterIsDone	True if the emitter has no active particles and will no longer spawn any in the future
uint32: 1	bEnabled	Component can disable Tick and Rendering of this emitter.
uint32: 1	bFakeBurstsWhenSpawningSupressed	When true and spawning is supressed, the bursts will be faked so that when spawning is enabled again, the bursts don't fire late.
uint32: 1	bHaltSpawning	If true, halt spawning for this instance.
uint32: 1	bHaltSpawningExternal	If true, this emitter has been disabled by game code and some systems to re-enable are not allowed.
uint32: 1	bIgnoreComponentScale	If true, the emitter ignores the component's scale. (Mesh emitters only).
uint32: 1	bIsBeam	Hack: Make sure this is a Beam type to avoid casting from/to wrong types.
uint32: 1	bKillOnCompleted	If true, kill this emitter instance when it has completed.
uint32: 1	bKillOnDeactivate	If true, kill this emitter instance when it is deactivated.
uint32: 1	bRequiresLoopNotification	If true, the emitter has modules that require loop notification.
uint32: 1	bRequiresSorting	Whether this emitter requires sorting as specified by artist.
TArray< struct ...	BurstFired	The BurstFire information.
int32	CameraPayloadOffset	The offset to the Camera payload in the particle data.
UParticleSystem...	Component	The component who owns it.
float	CurrentDelay	The emitter's delay for the current loop
UParticleLODLev...	CurrentLODLevel	The currently set LOD level.
int32	CurrentLODLevelIndex	The index of the currently set LOD level.
UMaterialInterf...	CurrentMaterial	The material to render this instance with.
int32	DynamicParameterDataOffset	The offset to the dynamic parameter payload in the particle data
float	EmitterDuration	The current duration fo the emitter instance.
TArray< float >	EmitterDurations	The emitter duration at each LOD level for the instance.
float	EmitterTime
FMatrix	EmitterToSimulation	Transform from emitter local space to simulation space.
int32	EventCount	Number of events this emitter has generated...
TArray< class U...	HighQualityLights
uint8 *	InstanceData	Pointer to the instance data array.
int32	InstancePayloadSize	The size of the Instance data array.
int32	IsRenderDataDirty	Flag indicating if the render data is dirty.
float	LastDeltaTime	The amount of time simulated in the previous time step.
float	LastTickDurationMs	How long did the last tick take?
int32	LightDataOffset	Offset to the light module data payload.
float	LightVolumetricScatteringIntensity
FVector	Location	The location of the emitter instance
TEnumAsByte< EP...	LockAxisFlags	Axis lock flags, cached here to avoid finding it from the module each frame
int32	LoopCount	The number of loops completed by the instance.
int32	MaxActiveParticles	The maximum number of active particles that can be held in the particle data array.
int32	MaxEventCount
int32	MaxVertexIndex
FVector	OldLocation	The previous location of the instance.
int32	OrbitModuleOffset	The offset to the Orbit module payload in the particle data.
FBox	ParticleBoundingBox	The bounding box for the particles.
uint32	ParticleCounter	Monotonically increasing counter.
uint8 *	ParticleData	Pointer to the particle data array.
uint16 *	ParticleIndices	Pointer to the particle index array.
int32	ParticleSize	The total size of a particle (in bytes).
int32	ParticleStride	The stride between particles in the ParticleData array.
int32	PayloadOffset	The offset to the particle data.
FVector2D	PivotOffset	The PivotOffset applied to the vertex positions
FVector	PositionOffsetThisTick	Position offset for each particle. Will be reset to zero at the end of the tick
float	SecondsSinceCreation	The number of seconds that have passed since the instance was created.
FMatrix	SimulationToWorld	Transform from simulation space to world space.
int32	SortMode	The sort mode to use for this emitter as specified by artist.
float	SpawnFraction	The fraction of time left over from spawning.
UParticleEmitte...	SpriteTemplate	The template this instance is based on.
int32	SubUVDataOffset	The offset to the SubUV payload in the particle data.
int32	TrianglesToRender	The number of triangles to render
int32	TypeDataInstanceOffset	The offset to the TypeData instance payload.
int32	TypeDataOffset	The offset to the TypeData payload in the particle data.

Constructors

	Name	Description
	FParticleEmitterInstance()	Constructor

Destructors

	Name	Description
	~FParticleEmitterInstance()	Destructor

Functions

	Name	Description
void	ApplyWorldOffset ( FVector InOffset, bool bWorldShift )	Called on world origin changes.
void	BeginTrail()	Begins the trail.
void	CalculateOrbitOffset ( FOrbitChainModuleInstancePayload& ..., FVector& AccumOffset, FVector& AccumRotation, FVector& AccumRotationRate, float DeltaTime, FVector& Result, FMatrix& RotationMat )	Calculate the orbit offset data.
uint32	CalculateParticleStride ( uint32 ParticleSize )	Calculate the stride of a single particle for this instance
void	CheckEmitterFinished()	Called from Tick to determine whether the emitter will no longer spawn particles checks for emitters with 0 loops, infinite lifetime, and no continuous spawning (only bursts) and sets bEmitterIsDone if the last burst lies in the past and there are no active particles bEmitterIsDone is checked for all emitters by ParticleSystemComponent tick, and the particle system is deactivated if it's true for all emitters, and if bAutoDeactivate is set on the ParticleSystem
void	CheckSpawnCount ( int32 InNewCount, int32 InMaxCount )
void	EndTrail()	Ends the trail.
void	FakeBursts()	Advances the bursts as though they were fired with out actually firing them.
bool	FillReplayData ( FDynamicEmitterReplayDataBase& Out... )	Captures dynamic replay data for this particle system.
void	FixupParticleIndices()	Fixup particle indices to only have valid entries.
void	ForceSpawn ( float DeltaTime, int32 InSpawnCount, int32 InBurstCount, FVector& InLocation, FVector& InVelocity )	Spawn/burst the given particles...
void	ForceUpdateBoundingBox()	Update the bounding box for the emitter Force the bounding box to be updated.
void	GatherMaterialRelevance ( FMaterialRelevance* OutMateria..., const UParticleLODLevel* LODLe..., ERHIFeatureLevel::Type InFeatureLev... )	Gathers material relevance flags for this emitter instance.
void	GetAllocatedSize ( int32& OutNum, int32& OutMax )	Retrieve the allocated size of this instance.
bool	GetBeamEndPoint ( FVector& OutEndPoint )
bool	GetBeamSourcePoint ( int32 SourceIndex, FVector& OutSourcePoint )
bool	GetBeamSourceStrength ( int32 SourceIndex, float& OutSourceStrength )
bool	GetBeamSourceTangent ( int32 SourceIndex, FVector& OutTangentPoint )
bool	GetBeamTargetPoint ( int32 TargetIndex, FVector& OutTargetPoint )
bool	GetBeamTargetStrength ( int32 TargetIndex, float& OutTargetStrength )
bool	GetBeamTargetTangent ( int32 TargetIndex, FVector& OutTangentPoint )
FBox	GetBoundingBox()	Retrieve the bounding box for the instance
float	GetCurrentBurstRateOffset ( float& DeltaTime, int32& Burst )	Get the current burst rate offset (delta time is artificially increased to generate bursts)
UParticleLOD...	GetCurrentLODLevelChecked()	Retrieves the current LOD level and asserts that it is valid.
UMaterialInt...	GetCurrentMaterial()	Get the current material to render with.
FDynamicEmit...	GetDynamicData ( bool bSelected, ERHIFeatureLevel::Type InFeatureLev... )	Retrieves the dynamic data for the emitter
int32	GetMeshRotationOffset()	Returns the offset to the mesh rotation payload, if any.
uint32	GetModuleDataOffset ( UParticleModule* Module )	Get offset for particle payload data for a particular module
uint8 *	GetModuleInstanceData ( UParticleModule* Module )	Get pointer to emitter instance payload data for a particular module
FParticleRan...	GetModuleRandomSeedInstanceData ( UParticleModule* Module )	Get pointer to emitter instance random seed payload data for a particular module
int32	GetOrbitPayloadOffset()	Get the offset of the orbit payload.
FBaseParticl...	GetParticle ( int32 Index )	Retrieve the particle at the given index
FBaseParticl...	GetParticleDirect ( int32 InDirectIndex )	Get the particle at the given direct index
int32	GetParticleDirectIndex ( int32 InIndex )	Get the physical index of the particle at the given index (ie, the contents of ParticleIndices[InIndex])
FVector	GetParticleLocationWithOrbitOffset ( FBaseParticle* Particle )	Get the position of the particle taking orbit in to account.
FDynamicEmit...	GetReplayData()	Retrieves replay data for the emitter
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	Returns resource size, similar to UObject function
void	GetScreenAlignmentAndScale ( int32& OutScreenAlign, FVector& OutScale )	Returns the screen alignment and scale of the component.
uint8 *	GetTypeDataModuleInstanceData()	Get the pointer to the instance data allocated for type data module.
UWorld *	GetWorld()
bool	HasActiveParticles()	Returns whether the system has any active particles.
bool	HasCompleted()	Has the instance completed it's run?
void	Init()	Initialize the instance
void	InitParameters ( UParticleEmitter* InTemplate, UParticleSystemComponent* InCo... )
bool	IsDynamicDataRequired ( UParticleLODLevel* CurrentLODL... )	Checks some common values for GetDynamicData validity
bool	IsMeshRotationActive()	Returns true if mesh rotation is active.
bool	IsTrailEmitter()
void	KillParticle ( int32 Index )	Kill the particle at the given instance
void	KillParticles()	Kill off any dead particles. (Remove them from the active array)
void	KillParticlesForced ( bool bFireEvents )	Force kill all particles in the emitter.
void	OnDeactivateSystem()	Called when the particle system is deactivating...
void	OnEmitterInstanceKilled ( FParticleEmitterInstance* Inst... )	When an emitter is killed, this will check other emitters and clean up anything pointing to this one
void	ParticlePrefetch()
void	PostSpawn ( FBaseParticle* Particle, float InterpolationPercentage, float SpawnTime )	Handle any post-spawning actions required by the instance
void	PreSpawn ( FBaseParticle* Particle, const FVector& InitialLocation, const FVector& InitialVelocity )	Handle any pre-spawning actions required for particles
void	ProcessParticleEvents ( float DeltaTime, bool bSuppressSpawning )	Process received events.
uint32	RequiredBytes()	Retrieved the per-particle bytes that this emitter type requires.
void	ResetBurstList()	Reset the burst list information for the instance
void	ResetParticleParameters ( float DeltaTime )	Reset the particle parameters
bool	Resize ( int32 NewMaxActiveParticles, bool bSetMaxActiveCount )	Ensures enough memory is allocated for the requested number of particles.
void	Rewind()	Rewind the instance.
void	SetBeamEndPoint ( FVector NewEndPoint )
void	SetBeamSourcePoint ( FVector NewSourcePoint, int32 SourceIndex )
void	SetBeamSourceStrength ( float NewSourceStrength, int32 SourceIndex )
void	SetBeamSourceTangent ( FVector NewTangentPoint, int32 SourceIndex )
void	SetBeamTargetPoint ( FVector NewTargetPoint, int32 TargetIndex )
void	SetBeamTargetStrength ( float NewTargetStrength, int32 TargetIndex )
void	SetBeamTargetTangent ( FVector NewTangentPoint, int32 TargetIndex )
void	SetCurrentLODIndex ( int32 InLODIndex, bool bInFullyProcess )	Set the LOD to the given index
void	SetFakeBurstWhenSpawningSupressed ( bool bInFakeBurstsWhenSpawningSupre... )
void	SetHaltSpawning ( bool bInHaltSpawning )	Set the HaltSpawning flag
void	SetHaltSpawningExternal ( bool bInHaltSpawning )	Set the bHaltSpawningExternal flag
void	SetMeshMaterials ( const TArray< UMaterialInterface&#... )	Sets the materials with which mesh particles should be rendered.
void	SetTrailSourceData ( FName InFirstSocketName, FName InSecondSocketName, ETrailWidthMode InWidthMode, float InWidth )	Sets the data that defines this trail.
void	SetupEmitterDuration()	Calculates the emitter duration for the instance.
float	Spawn ( float DeltaTime )	Spawn particles for this emitter instance
void	SpawnParticles ( int32 Count, float StartTime, float Increment, const FVector& InitialLocation, const FVector& InitialVelocity, FParticleEventInstancePayload*... )	Spawn the indicated number of particles.
void	Tick ( float DeltaTime, bool bSuppressSpawning )	Tick the instance.
float	Tick_EmitterTimeSetup ( float DeltaTime, UParticleLODLevel* CurrentLODL... )	Tick sub-function that handles EmitterTime setup, looping, etc.
void	Tick_MaterialOverrides ( int32 EmitterIndex )	Ticks the emitter's material overrides.
void	Tick_ModuleFinalUpdate ( float DeltaTime, UParticleLODLevel* CurrentLODL... )	Tick sub-function that handles module FINAL updates
void	Tick_ModulePostUpdate ( float DeltaTime, UParticleLODLevel* CurrentLODL... )	Tick sub-function that handles module post updates
void	Tick_ModuleUpdate ( float DeltaTime, UParticleLODLevel* CurrentLODL... )	Tick sub-function that handles module updates
float	Tick_SpawnParticles ( float DeltaTime, UParticleLODLevel* CurrentLODL..., bool bSuppressSpawning, bool bFirstTime )	Tick sub-function that handles spawning of particles
void	UpdateBoundingBox ( float DeltaTime )	Update the bounding box for the emitter
void	UpdateOrbitData ( float DeltaTime )
void	UpdateTransforms()	Updates all internal transforms.
bool	UseLocalSpace()	True if this emitter emits in local space

Constants

Name	Description
PeakActiveParticleUpdateDelta	The maximum DeltaTime allowed for updating PeakActiveParticle tracking.

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

Take our survey

Dismiss