UParticleModuleColor

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Particles/Color/ParticleModuleColor.h

Include

#include "Particles/Color/ParticleModuleColor.h"

Syntax

class UParticleModuleColor : public UParticleModuleColorBase

Variables

Name Description

Public variable

uint8: 1

 

bClampAlpha

If true, the alpha value will be clamped to the [0..1] range.

Public variable

FRawDistributio...

 

StartAlpha

Initial alpha for a particle as a function of Emitter time.

Public variable

FRawDistributio...

 

StartColor

Initial color for a particle as a function of Emitter time.

Constructors

Name Description

Public function

UParticleModuleColor

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

InitializeDefaults()

Initializes the default values for this property

Public function

void

 

SpawnEx

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

Extended version of spawn, allows for using a random stream for distribution value retrieval

Overridden from UParticleModule

Name Description

Public function Virtual

bool

 

AddModuleCurvesToEditor

(
    UInterpCurveEdSetup* EdSetup,
    TArray< const FCurveEdEntry* >...
)

Add all curve-editable Objects within this module to the curve editor.

Public function Virtual

void

 

CompileModule

(
    FParticleEmitterBuildInfo& Emitter...
)

Called once to compile the effects of this module on runtime simulation.

Public function Virtual

void

 

SetToSensibleDefaults

(
    UParticleEmitter* Owner
)

For Cascade.

Public function Virtual

void

 

Spawn

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

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

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.