1. Epic GamesDeveloper
  3. UParticleModuleLight

UParticleModuleLight

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Particles > API/Runtime/Engine/Particles/Light

Inheritance Hierarchy

References

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

Syntax

UCLASS (EditInlineNew, HideCategories=Object, MinimalAPI, Meta=(DisplayName="Light"))  
class UParticleModuleLight : public UParticleModuleLightBase

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bAffectsTranslucency Whether lights from this module should affect translucency.
Public variable UProperty Category, EditAnywhere bool bHighQualityLights Converts the particle lights into high quality lights as if they came from a PointLightComponent.
Public variable UProperty Category, EditAnywhere, Meta uint32: 1 bOverrideInverseExposureBlend When enabled we will override the project default setting with our local setting.
Public variable UProperty Category, EditAnywhere Transient bool bPreviewLightRadius Will draw wireframe spheres to preview the light radius if enabled.
Public variable UProperty Category, EditAnywhere FRawDistributionFloat BrightnessOverLife Brightness scale for the light, which can be setup as a curve over the particle's lifetime.
Public variable UProperty Category, EditAnywhere bool bShadowCastingLights Whether to cast shadows from the particle lights.
Public variable UProperty Category, EditAnywhere bool bUseInverseSquaredFalloff Whether to use physically based inverse squared falloff from the light.
Public variable UProperty Category, EditAnywhere FRawDistributionVector 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.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly float InverseExposureBlend Blend Factor used to blend between Intensity and Intensity/Exposure.
Public variable UProperty Category, EditAnywhere FRawDistributionFloat LightExponent Provides the light's exponent when inverse squared falloff is disabled.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly FLightingChannels LightingChannels Channels that this light should affect.
Public variable UProperty Category, EditAnywhere FRawDistributionFloat RadiusScale Scales the particle's radius, to calculate the light's radius.
Public variable UProperty Category, EditAnywhere float SpawnFraction Fraction of particles in this emitter to create lights on.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float VolumetricScatteringIntensity Intensity of the volumetric scattering from this light. This scales Intensity and LightColor.

Constructors

  Type Name Description
Public function  

UParticleModuleLight ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Initializes the default values for this property
Public function void

SpawnEx ( FParticleEmitterInstance* Owner,
int32 Offset,
float SpawnTime,
FRandomStream* InRandomStream,
FBaseParticle* ParticleBase
)

  

Overridden from UParticleModule

  Type Name Description
Public function Virtual bool Return false if this emitter requires a game thread tick
Public function Virtual Const EModuleType Retrieve the ModuleType of this module.
Public function Virtual void Render the modules 3D visualization helper primitive.
Public function Virtual uint32 Returns the number of bytes that the module requires in the particle payload block.
Public function Virtual void For Cascade.
Public function Virtual void

Spawn ( FParticleEmitterInstance* Owner,
int32 Offset,
float SpawnTime,
FBaseParticle* ParticleBase
)

 Called on a particle that is freshly spawned by the emitter.
Public function Virtual void

Update ( FParticleEmitterInstance* Owner,
int32 Offset,
float DeltaTime
)

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

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page