UParticleModuleEventGenerator

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Particles/Event/ParticleModuleEventGenerator.h

Include

#include "Particles/Event/ParticleModuleEventGenerator.h"

Syntax

class UParticleModuleEventGenerator : public UParticleModuleEventBase

Variables

Name Description

Public variable

TArray< struct ...

 

Events

Constructors

Name Description

Public function

UParticleModuleEventGenerator

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

bool

 

HandleParticleBurst

(
    FParticleEmitterInstance* Owne...,
    FParticleEventInstancePayload*...,
    const int32 ParticleCount
)

Called when a particle bursts and an event payload is present.

Public function Virtual

bool

 

HandleParticleCollision

(
    FParticleEmitterInstance* Owne...,
    FParticleEventInstancePayload*...,
    FParticleCollisionPayload* Col...,
    FHitResult* Hit,
    FBaseParticle* CollideParticle,
    FVector& CollideDirection
)

Called when a particle collides and an event payload is present.

Public function Virtual

bool

 

HandleParticleKilled

(
    FParticleEmitterInstance* Owne...,
    FParticleEventInstancePayload*...,
    FBaseParticle* DeadParticle
)

Called when a particle is killed and an event payload is present.

Public function Virtual

bool

 

HandleParticleSpawned

(
    FParticleEmitterInstance* Owne...,
    FParticleEventInstancePayload*...,
    FBaseParticle* NewParticle
)

Called when a particle is spawned and an event payload is present.

Overridden from UParticleModule

Name Description

Public function Virtual

uint32

 

PrepPerInstanceBlock

(
    FParticleEmitterInstance* Owne...,
    void* InstData
)

Allows the module to prep its 'per-instance' data block.

Public function Virtual

uint32

 

RequiredBytes

(
    UParticleModuleTypeDataBase* T...
)

Returns the number of bytes that the module requires in the particle payload block.

Public function Virtual

uint32

 

RequiredBytesPerInstance()

Returns the number of bytes the module requires in the emitters 'per-instance' data block.

Public function Virtual

void

 

Spawn

(
    FParticleEmitterInstance* Owne...,
    int32 Offset,
    float SpawnTime,
    FBaseParticle* ParticleBase
)

Called on a particle that is freshly spawned by the emitter.

Public function Virtual

void

 

Update

(
    FParticleEmitterInstance* Owne...,
    int32 Offset,
    float DeltaTime
)

Called on a particle that is being updated by its emitter.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally