UParticleModuleSpawnBase

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Particles/Spawn/ParticleModuleSpawnBase.h

Include

#include "Particles/Spawn/ParticleModuleSpawnBase.h"

Syntax

class UParticleModuleSpawnBase : public UParticleModule

Variables

Name Description

Public variable

uint32: 1

 

bProcessBurstList

If true, the BurstList of the SpawnModule of the emitter will be processed.

Public variable

uint32: 1

 

bProcessSpawnRate

If true, the SpawnRate of the SpawnModule of the emitter will be processed.

Constructors

Name Description

Public function

UParticleModuleSpawnBase

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

bool

 

GetBurstCount

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

Retrieve the burst count this module is contributing.

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 Const

EModuleType

 

GetModuleType()

Retrieve the ModuleType of this module.