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

UParticleModuleLight

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UParticleModule

UParticleModuleLightBase

UParticleModuleLight

UParticleModuleLight_Seeded

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Particles/Light/ParticleModuleLight.h
Include	#include "Particles/Light/ParticleModuleLight.h"

Syntax

class UParticleModuleLight : public UParticleModuleLightBase

Variables

	Name	Description
bool	bAffectsTranslucency	Whether lights from this module should affect translucency.
bool	bHighQualityLights	Converts the particle lights into high quality lights as if they came from a PointLightComponent.
bool	bPreviewLightRadius	Will draw wireframe spheres to preview the light radius if enabled.
FRawDistributio...	BrightnessOverLife	Brightness scale for the light, which can be setup as a curve over the particle's lifetime.
bool	bShadowCastingLights	Whether to cast shadows from the particle lights.
bool	bUseInverseSquaredFalloff	Whether to use physically based inverse squared falloff from the light.
FRawDistributio...	ColorScaleOverLife	Scale that is applied to the particle's color to calculate the light's color, and can be setup as a curve over the particle's lifetime.
FRawDistributio...	LightExponent	Provides the light's exponent when inverse squared falloff is disabled.
FLightingChanne...	LightingChannels	Channels that this light should affect.
FRawDistributio...	RadiusScale	Scales the particle's radius, to calculate the light's radius.
float	SpawnFraction	Fraction of particles in this emitter to create lights on.
float	VolumetricScatteringIntensity	Intensity of the volumetric scattering from this light. This scales Intensity and LightColor.

Constructors

	Name	Description
	UParticleModuleLight ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	void	InitializeDefaults()	Initializes the default values for this property
	void	SpawnEx ( FParticleEmitterInstance* Owne..., int32 Offset, float SpawnTime, FRandomStream* InRandomStream, FBaseParticle* ParticleBase )

Overridden from UParticleModule

	Name	Description
bool	CanTickInAnyThread()	Return false if this emitter requires a game thread tick
EModuleType	GetModuleType()	Retrieve the ModuleType of this module.
void	Render3DPreview ( FParticleEmitterInstance* Owne..., const FSceneView* View, FPrimitiveDrawInterface* PDI )	Render the modules 3D visualization helper primitive.
uint32	RequiredBytes ( UParticleModuleTypeDataBase* T... )	Returns the number of bytes that the module requires in the particle payload block.
void	SetToSensibleDefaults ( UParticleEmitter* Owner )	For Cascade.
void	Spawn ( FParticleEmitterInstance* Owne..., int32 Offset, float SpawnTime, FBaseParticle* ParticleBase )	Called on a particle that is freshly spawned by the emitter.
void	Update ( FParticleEmitterInstance* Owne..., int32 Offset, float DeltaTime )	Called on a particle that is being updated by its emitter.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.