UParticleModuleSpawn

Windows
MacOS
Linux

Inheritance Hierarchy

Syntax

class UParticleModuleSpawn : public UParticleModuleSpawnBase

Variables

Name Description

Public variable

uint32: 1

 

bApplyGlobalSpawnRateScale

If true, the SpawnRate will be scaled by the global CVar r.EmitterSpawnRateScale

Public variable

TArray< FPartic...

 

BurstList

The array of burst entries.

Public variable

FRawDistributio...

 

BurstScale

Scale all burst entries by this amount.

Public variable

TEnumAsByte< EP...

 

ParticleBurstMethod

The method to utilize when burst-emitting particles.

Public variable

FRawDistributio...

 

Rate

The rate at which to spawn particles.

Public variable

FRawDistributio...

 

RateScale

The scalar to apply to the rate.

Constructors

Name Description

Public function

UParticleModuleSpawn

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

float

 

GetGlobalRateScale()

Public function

void

 

InitializeDefaults()

Initializes the default values for this property

Overridden from UParticleModuleSpawnBase

Name Description

Public function Virtual

float

 

GetEstimatedSpawnRate()

Retrieve the estimated spawn rate for this module...

Public function Virtual

int32

 

GetMaximumBurstCount()

Retrieve the maximum number of particles this module could burst.

Public function Virtual

float

 

GetMaximumSpawnRate()

Retrieve the maximum spawn rate for this module...

Public function Virtual

bool

 

GetSpawnAmount

(
    FParticleEmitterInstance* Owne...,
    int32 Offset,
    float OldLeftover,
    float DeltaTime,
    int32& Number,
    float& Rate
)

Retrieve the spawn amount this module is contributing.

Overridden from UParticleModule

Name Description

Public function Virtual

bool

 

GenerateLODModuleValues

(
    UParticleModule* SourceModule,
    float Percentage,
    UParticleLODLevel* LODLevel
)

Helper function used by the editor to auto-generate LOD values from a source module and a percentage value used to scale its values.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

References

Module

Engine

Header

Runtime/Engine/Classes/Particles/Spawn/ParticleModuleSpawn.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback