1. Epic GamesDeveloper
  3. UParticleEmitter

UParticleEmitter

API > API/Runtime > API/Runtime/Engine

   
Name UParticleEmitter
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Particles/ParticleEmitter.h
Include Path #include "Particles/ParticleEmitter.h"

Syntax

UCLASS (HideCategories=Object, EditInlineNew, Abstract, MinimalAPI)  
class UParticleEmitter : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UParticleEmitter ( const FObjectInitializer& ObjectInitializer
)

   Particles/ParticleEmitter.h  

Variables

Public

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddEmitterCurvesToEditor ( UInterpCurveEdSetup* EdSetup
)

 For Cascade Particles/ParticleEmitter.h  

virtual bool AutogenerateLowestLODLevel ( bool bDuplicateHighest
)

 Autogenerate the lowest LOD level... Particles/ParticleEmitter.h  

void AutoPopulateInstanceProperties ( UParticleSystemComponent* PSysComp
)

   Particles/ParticleEmitter.h  

void Build()

 Builds data needed for simulation by the emitter from all modules. Particles/ParticleEmitter.h  

void CacheEmitterModuleInfo()

 Pre-calculate data size/offset and other info from modules in this Emitter Particles/ParticleEmitter.h  
CalculateMaxActiveParticleCount Determine the maximum active particles that could occur with this emitter. Particles/ParticleEmitter.h  

void ChangeEditorColor ( FColor& Color,
UInterpCurveEdSetup* EdSetup
)

   Particles/ParticleEmitter.h  

virtual FParticleEmitterInstance * CreateInstance ( IParticleEmitterInstanceOwner& InComponent
)

   Particles/ParticleEmitter.h  

int32 CreateLODLevel ( int32 LODLevel,
bool bGenerateModuleData
)

 CreateLODLevel Creates the given LOD level. Particles/ParticleEmitter.h  
This will update the LOD of the particle in the editor. Particles/ParticleEmitter.h  
GetCurrentLODLevel Returns the currently set LODLevel. Particles/ParticleEmitter.h  

FName & GetEmitterName()

   Particles/ParticleEmitter.h  

UParticleLODLevel * GetLODLevel ( int32 LODLevel
)

 GetLODLevel Returns the given LODLevel. Particles/ParticleEmitter.h  

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

 Retrieve the parameters associated with this particle system. Particles/ParticleEmitter.h  

float GetQualityLevelSpawnRateMult()

 Calculate spawn rate multiplier based on global effects quality level and emitter's quality scale Particles/ParticleEmitter.h  

TStatId GetStatID ( bool bForDeferredUse
) const

 Stat id of this object, 0 if nobody asked for it yet Returns the stat ID of the object... Particles/ParticleEmitter.h  

TStatId GetStatIDRT ( bool bForDeferredUse
) const

   Particles/ParticleEmitter.h  

bool HasAnyEnabledLODs()

 Returns true if the is emitter has any enabled LODs, false otherwise. Particles/ParticleEmitter.h  

bool IsLODLevelValid ( int32 LODLevel
)

 IsLODLevelValid Returns true if the given LODLevel is one of the array entries. Particles/ParticleEmitter.h  

bool IsSignificant ( EParticleSignificanceLevel RequiredSignificance
)

 Creates this stat ID for the emitter...and handle a null this pointer Returns if this emitter is considered significant for the passed requirement. Particles/ParticleEmitter.h  

void RemoveEmitterCurvesFromEditor ( UInterpCurveEdSetup* EdSetup
)

   Particles/ParticleEmitter.h  

void SetEmitterName ( FName Name
)

   Particles/ParticleEmitter.h  

virtual void SetLODCount ( int32 LODCount
)

   Particles/ParticleEmitter.h  

virtual void SetToSensibleDefaults()

 Sets up this emitter with sensible defaults so we can see some particles as soon as its created. Particles/ParticleEmitter.h  

void UpdateDetailModeDisplayString()

 Update the at-a-glance display for detail mode. Particles/ParticleEmitter.h  

virtual void UpdateModuleLists()

   Particles/ParticleEmitter.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsPostLoadThreadSafe()

   Particles/ParticleEmitter.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Particles/ParticleEmitter.h  

virtual void PostLoad()

   Particles/ParticleEmitter.h  

virtual void Serialize ( FArchive& Ar
)

   Particles/ParticleEmitter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page