Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UParticleModuleEventGenerator::HandleParticleCollision

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

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Particles/Event/ParticleModuleEventGenerator.h
Include	#include "Particles/Event/ParticleModuleEventGenerator.h"
Source	/Engine/Source/Runtime/Engine/Private/Particles/ParticleModules_Event.cpp

Syntax

virtual bool HandleParticleCollision
(
    FParticleEmitterInstance * Owner,
    FParticleEventInstancePayload * EventPayload,
    FParticleCollisionPayload * CollidePayload,
    FHitResult * Hit,
    FBaseParticle * CollideParticle,
    FVector & CollideDirection
)

Remarks

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

Returns

bool true if processed, false if not.

Parameters

Parameter	Description
Owner	Pointer to the owning FParticleEmitterInstance.
EventPayload	Pointer to the event instance payload data.
CollidePayload	Pointer to the collision payload data.
Hit	The CheckResult for the collision.
CollideParticle	Pointer to the particle that has collided.
CollideDirection	The direction the particle was traveling when the collision occurred.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss