1. Epic GamesDeveloper
  3. UParticleEmitter

UParticleEmitter

Unreal Engine C++ API Reference > Runtime > Engine > Particles

Inheritance Hierarchy

References

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

Syntax

class UParticleEmitter : public UObject

Variables

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

Constructors

  Type Name Description
Public function  

UParticleEmitter ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void For Cascade
Public function Virtual bool

AutogenerateLowestLODLevel ( bool bDuplicateHighest
)

 Autogenerate the lowest LOD level...
Public function void  
Public function void

Build ()

 Builds data needed for simulation by the emitter from all modules.
Public function void Pre-calculate data size/offset and other info from modules in this Emitter
Public function Virtual bool CalculateMaxActiveParticleCount Determine the maximum active particles that could occur with this emitter.
Public function void  
Public function Virtual FParticleEmitterInstance *  
Public function int32

CreateLODLevel ( int32 LODLevel,
bool bGenerateModuleData
)

 CreateLODLevel Creates the given LOD level.
Public function void This will update the LOD of the particle in the editor.
Public function UParticleLODLevel * GetCurrentLODLevel Returns the currently set LODLevel.
Public function FName &  
Public function UParticleLODLevel *

GetLODLevel ( int32 LODLevel
)

 GetLODLevel Returns the given LODLevel.
Public function void

GetParametersUtilized ( TArray< FString >& ParticleSysParamList,
TArray< FString >& ParticleParameterList
)

 Retrieve the parameters associated with this particle system.
Public function float Calculate spawn rate multiplier based on global effects quality level and emitter's quality scale
Public function Const TStatId

GetStatID ( bool bForDeferredUse
)

 Stat id of this object, 0 if nobody asked for it yet Returns the stat ID of the object...
Public function Const TStatId

GetStatIDRT ( bool bForDeferredUse
)

  
Public function Const bool Returns true if the is emitter has any enabled LODs, false otherwise.
Public function bool

IsLODLevelValid ( int32 LODLevel
)

 IsLODLevelValid Returns true if the given LODLevel is one of the array entries.
Public function bool

IsSignificant ( EParticleSignificanceLevel RequiredSignificance
)

 Creates this stat ID for the emitter...and handle a null this pointerReturns if this emitter is considered significant for the passed requirement.
Public function void  
Public function void  
Public function Virtual void

SetLODCount ( int32 LODCount
)

  
Public function Virtual void Sets up this emitter with sensible defaults so we can see some particles as soon as its created.
Public function void Update the at-a-glance display for detail mode.
Public function Virtual void  

Overridden from UObject

  Type Name Description
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page