UParticleEmitter

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UParticleEmitter

UParticleSpriteEmitter

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Particles/ParticleEmitter.h
Include	#include "Particles/ParticleEmitter.h"

Syntax

class UParticleEmitter : public UObject

Variables

	Name	Description
uint8: 1	bAxisLockEnabled
uint8: 1	bCollapsed	This value indicates the emitter should be drawn 'collapsed' in Cascade
uint8: 1	bCookedOut	If true, then this emitter was 'cooked out' by the cooker.
uint8: 1	bDisabledLODsKeepEmitterAlive	When true, if the current LOD is disabled the emitter will be kept alive.
uint8: 1	bDisableWhenInsignficant	When true, emitters deemed insignificant will have their tick and render disabled Instantly.
uint8: 1	bIsSoloing	If true, then show only this emitter in the editor
uint8: 1	bMeshRotationActive
uint8: 1	bRemoveHMDRollInVR	Particle alignment overrides
uint8: 1	bRequiresLoopNotification
uint8: 1	bUseLegacySpawningBehavior	If true, maintains some legacy spawning behavior.
int32	CameraPayloadOffset
uint8: 1	ConvertedModules
uint32	DetailModeBitmask	Detail mode: Set flags reflecting which system detail mode you want the emitter to be ticked and rendered in
FString	DetailModeDisplay
int32	DynamicParameterDataOffset
FColor	EmitterEditorColor	The color of the emitter in the curve editor and debug rendering modes.
FName	EmitterName	General variables.
TEnumAsByte< en...	EmitterRenderMode	How to render the emitter particles.
int32	InitialAllocationCount	Performance/LOD Data.
int32	LightDataOffset
float	LightVolumetricScatteringIntensity
TEnumAsByte< EP...	LockAxisFlags
TArray< TObject...	LODLevels	'Private' data - not required by the editor
float	MaxFacingCameraBlendDistance
TArray< class U...	MeshMaterials	Materials collected from any MeshMaterial modules
float	MinFacingCameraBlendDistance
TMap< UParticle...	ModuleInstanceOffsetMap	Map module pointers to their offset into the instance data.
TMap< UParticle...	ModuleOffsetMap	Map module pointers to their offset into the particle data.
TMap< UParticle...	ModuleRandomSeedInstanceOffsetMap	Map module pointers to their offset into the instance data.
TArray< UPartic...	ModulesNeedingInstanceData	Array of modules that want emitter instance data.
TArray< UPartic...	ModulesNeedingRandomSeedInstanceData	Array of modules that want emitter random seed instance data.
int32	ParticleSize
int32	PeakActiveParticles
FVector2D	PivotOffset
float	QualityLevelSpawnRateScale
int32	ReqInstanceBytes
EParticleSignif...	SignificanceLevel	The significance level required of this emitter's owner for this emitter to be active.
USubUVAnimation...	SubUVAnimation	SubUV animation asset to use for cutout geometry.
int32	SubUVDataOffset
int32	TypeDataInstanceOffset
int32	TypeDataOffset

Constructors

	Name	Description
	UParticleEmitter ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddEmitterCurvesToEditor ( UInterpCurveEdSetup* EdSetup )	For Cascade
bool	AutogenerateLowestLODLevel ( bool bDuplicateHighest )	Autogenerate the lowest LOD level...
void	AutoPopulateInstanceProperties ( UParticleSystemComponent* PSys... )
void	Build()	Builds data needed for simulation by the emitter from all modules.
void	CacheEmitterModuleInfo()	Pre-calculate data size/offset and other info from modules in this Emitter
bool	CalculateMaxActiveParticleCount()	CalculateMaxActiveParticleCount Determine the maximum active particles that could occur with this emitter.
void	ChangeEditorColor ( FColor& Color, UInterpCurveEdSetup* EdSetup )
FParticleEmi...	CreateInstance ( UParticleSystemComponent* InCo... )
int32	CreateLODLevel ( int32 LODLevel, bool bGenerateModuleData )	CreateLODLevel Creates the given LOD level.
void	EditorUpdateCurrentLOD ( FParticleEmitterInstance* Inst... )	This will update the LOD of the particle in the editor.
UParticleLOD...	GetCurrentLODLevel ( FParticleEmitterInstance* Inst... )	GetCurrentLODLevel Returns the currently set LODLevel.
FName &	GetEmitterName()
UParticleLOD...	GetLODLevel ( int32 LODLevel )	GetLODLevel Returns the given LODLevel.
void	GetParametersUtilized ( TArray< FString >& ParticleSysPara..., TArray< FString >& ParticleParamet... )	Retrieve the parameters associated with this particle system.
float	GetQualityLevelSpawnRateMult()	Calculate spawn rate multiplier based on global effects quality level and emitter's quality scale
TStatId	GetStatID ( bool bForDeferredUse )	Stat id of this object, 0 if nobody asked for it yet Returns the stat ID of the object...
TStatId	GetStatIDRT ( bool bForDeferredUse )
bool	HasAnyEnabledLODs()	Returns true if the is emitter has any enabled LODs, false otherwise.
bool	IsLODLevelValid ( int32 LODLevel )	IsLODLevelValid Returns true if the given LODLevel is one of the array entries.
bool	IsSignificant ( EParticleSignificanceLevel Required... )	Creates this stat ID for the emitter...and handle a null this pointerReturns if this emitter is considered significant for the passed requirement.
void	RemoveEmitterCurvesFromEditor ( UInterpCurveEdSetup* EdSetup )
void	SetEmitterName ( FName Name )
void	SetLODCount ( int32 LODCount )
void	SetToSensibleDefaults()	Sets up this emitter with sensible defaults so we can see some particles as soon as its created.
void	UpdateDetailModeDisplayString()	Update the at-a-glance display for detail mode.
void	UpdateModuleLists()

Overridden from UObject

	Name	Description
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	TEnumAsByte< ED...	DetailMode_DEPRECATED	If detail mode is >= system detail mode, primitive won't be rendered.