UParticleModuleRequired

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Particles/ParticleModuleRequired.h

Include

#include "Particles/ParticleModuleRequired.h"

Syntax

class UParticleModuleRequired : public UParticleModule

Variables

Name Description

Public variable

float

 

AlphaThreshold

Alpha channel values larger than the threshold are considered occupied and will be contained in the bounding geometry.

Public variable

uint32: 1

 

bDelayFirstLoopOnly

If true, the emitter will be delayed only on the first loop.

Public variable

uint32: 1

 

bDurationRecalcEachLoop

If true, recalculate the emitter duration on each loop.

Public variable

uint32: 1

 

bEmitterDelayUseRange

If true, select the emitter delay from the range [EmitterDelayLow..EmitterDelay]

Public variable

uint32: 1

 

bEmitterDurationUseRange

If true, select the emitter duration from the range [EmitterDurationLow..EmitterDuration]

Public variable

uint32: 1

 

bKillOnCompleted

If true, kill the emitter when it completes

Public variable

uint32: 1

 

bKillOnDeactivate

If true, kill the emitter when the particle system is deactivated

Public variable

uint32: 1

 

bOrbitModuleAffectsVelocityAlignment

Ensures that movement generated from the orbit module is applied to velocity-aligned particles

Public variable

TEnumAsByte< en...

 

BoundingMode

More bounding vertices results in reduced overdraw, but adds more triangle overhead.

Public variable

uint32: 1

 

bOverrideSystemMacroUV

Override the system MacroUV settings

Public variable

uint32: 1

 

bRemoveHMDRoll

If true, removes the HMD view roll (e.g. in VR)

Public variable

uint32: 1

 

bScaleUV

Whether to scale the UV or not - ie, the model wasn't setup with sub uvs

Public variable

TArray< struct ...

 

BurstList

The array of burst entries.

Public variable

uint32: 1

 

bUseLegacyEmitterTime

If true, the EmitterTime for the emitter will be calculated by modulating the SecondsSinceCreation by the EmitterDuration.

Public variable

uint32: 1

 

bUseLocalSpace

If true, update the emitter in local space

Public variable

uint32: 1

 

bUseMaxDrawCount

If true, use the MaxDrawCount to limit the number of particles rendered.

Public variable

UTexture2D *...

 

CutoutTexture

Texture to generate bounding geometry from.

Public variable

float

 

EmitterDelay

Delay-related.

Public variable

float

 

EmitterDelayLow

The low end of the emitter delay if using a range.

Public variable

float

 

EmitterDuration

How long, in seconds, the emitter will run before looping.

Public variable

float

 

EmitterDurationLow

The low end of the emitter duration if using a range.

Public variable

int32

 

EmitterLoops

The number of times to loop the emitter. 0 indicates loop continuously

Public variable

TEnumAsByte< en...

 

EmitterNormalsMode

Normal generation mode for this emitter LOD.

Public variable

FVector

 

EmitterOrigin

Public variable

FRotator

 

EmitterRotation

Public variable

TEnumAsByte< EP...

 

InterpolationMethod

SubUV-related.

Public variable

FVector

 

MacroUVPosition

Local space position that UVs generated with the ParticleMacroUV material node will be centered on.

Public variable

float

 

MacroUVRadius

World space radius that UVs generated with the ParticleMacroUV material node will tile based on.

Public variable

UMaterialInterf...

 

Material

General.The material to utilize for the emitter at this LOD level.

Public variable

int32

 

MaxDrawCount

The maximum number of particles to DRAW for this emitter.

Public variable

float

 

MaxFacingCameraBlendDistance

The distance at which PSA_FacingCameraDistanceBlend is fully PSA_FacingCameraPosition

Public variable

float

 

MinFacingCameraBlendDistance

The distance at which PSA_FacingCameraDistanceBlend is fully PSA_Square

Public variable

TArray< FName >

 

NamedMaterialOverrides

Named material overrides for this emitter.

Public variable

FVector

 

NormalsCylinderDirection

When EmitterNormalsMode is ENM_Cylindrical, particle normals are created to face away from the cylinder going through NormalsSphereCenter in the direction NormalsCylinderDirection.

Public variable

FVector

 

NormalsSphereCenter

When EmitterNormalsMode is ENM_Spherical, particle normals are created to face away from NormalsSphereCenter.

Public variable

TEnumAsByte< en...

 

OpacitySourceMode

Public variable

TEnumAsByte< EP...

 

ParticleBurstMethod

Burst-related.The method to utilize when burst-emitting particles

Public variable

int32

 

RandomImageChanges

The number of times to change a random image over the life of the particle.

Public variable

float

 

RandomImageTime

The amount of time (particle-relative, 0.0 to 1.0) to 'lock' on a random sub image 0.0 = change every frame 1.0 = select a random image at spawn and hold for the life of the particle

Public variable

TEnumAsByte< EP...

 

ScreenAlignment

The screen alignment to utilize for the emitter at this LOD level.

Public variable

TEnumAsByte< en...

 

SortMode

The sorting mode to use for this emitter.

Public variable

FRawDistributio...

 

SpawnRate

Spawn-related.The rate at which to spawn particles

Public variable

int32

 

SubImages_Horizontal

The number of sub-images horizontally in the texture

Public variable

int32

 

SubImages_Vertical

The number of sub-images vertically in the texture

Public variable

EParticleUVFlip...

 

UVFlippingMode

Controls UV Flipping for this emitter.

Constructors

Name Description

Public function

UParticleModuleRequired

(
    const FObjectInitializer& ObjectIn...
)

Functions

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

bool

 

GenerateLODModuleValues

(
    UParticleModule* SourceModule,
    float Percentage,
    UParticleLODLevel* LODLevel
)

Helper function used by the editor to auto-generate LOD values from a source module and a percentage value used to scale its values.

Public function Virtual Const

EModuleType

 

GetModuleType()

Retrieve the ModuleType of this module.

Public function Virtual

bool

 

IsValidForLODLevel

(
    UParticleLODLevel* LODLevel,
    FString& OutErrorString
)

Returns true if the module is valid for the provided LOD level.

Public function Virtual

void

 

SetToSensibleDefaults

(
    UParticleEmitter* Owner
)

For Cascade.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

FinishDestroy()

Called to finish destroying the object.

Public function Virtual

bool

 

IsReadyForFinishDestroy()

Called to check if the object is ready for FinishDestroy.

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.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PreEditChange

(
    UProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally

Public function Virtual

void

 

Serialize

(
    FStructuredArchive::FRecord Record
)

Handles reading, writing, and reference collecting using FArchive.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback