FParticleEmitterBuildInfo

Windows
MacOS
Linux

Syntax

struct FParticleEmitterBuildInfo

Variables

Name Description

Public variable

FComposableFloa...

 

AlphaScale

The alpha scale of a particle over time.

Public variable

bool

 

bEnableCollision

Enable collision?

Public variable

uint32: 1

 

bLocalVectorFieldIgnoreComponentTransform

If true, local vector fields ignore the component transform.

Public variable

uint32: 1

 

bLocalVectorFieldTileX

Tile vector field in x axis?

Public variable

uint32: 1

 

bLocalVectorFieldTileY

Tile vector field in y axis?

Public variable

uint32: 1

 

bLocalVectorFieldTileZ

Tile vector field in z axis?

Public variable

uint32: 1

 

bLocalVectorFieldUseFixDT

Use fix delta time in the simulation?

Public variable

uint32: 1

 

bRemoveHMDRoll

Particle alignment overrides

Public variable

uint8

 

CollisionMode

Public variable

float

 

CollisionRadiusBias

Bias applied to the collision radius.

Public variable

float

 

CollisionRadiusScale

Radius scale applied to friction.

Public variable

float

 

CollisionRandomDistribution

Random distribution across the reflection spreading cone when colliding.

Public variable

float

 

CollisionRandomSpread

Factor reflection spreading cone when colliding.

Public variable

uint8

 

CollisionResponse

How particles respond to collision.

Public variable

FComposableVect...

 

ColorScale

The color scale of a particle over time.

Public variable

FVector

 

ConstantAcceleration

Constant acceleration to apply to particles.

Public variable

FComposableFloa...

 

DragCoefficient

Drag coefficient.

Public variable

FComposableFloa...

 

DragScale

Drag scale over life.

Public variable

FRawDistributio...

 

DynamicAlpha

An additional alpha scale for allowing parameters to be used for ColorOverLife modules.

Public variable

FRawDistributio...

 

DynamicAlphaScale

An additional alpha scale for allowing parameters to be used for ColorScaleOverLife modules.

Public variable

FRawDistributio...

 

DynamicColor

An additional color scale for allowing parameters to be used for ColorOverLife modules.

Public variable

FRawDistributio...

 

DynamicColorScale

An additional color scale for allowing parameters to be used for ColorScaleOverLife modules.

Public variable

int32

 

EstimatedMaxActiveParticleCount

The estimated maximum number of particles for this emitter.

Public variable

float

 

Friction

Friction.

Public variable

float

 

GlobalVectorFieldScale

Global vector field scale.

Public variable

float

 

GlobalVectorFieldTightness

Global vector field tightness.

Public variable

UVectorField &#...

 

LocalVectorField

Local vector field.

Public variable

float

 

LocalVectorFieldIntensity

Local vector field intensity.

Public variable

FVector

 

LocalVectorFieldMaxInitialRotation

Maximum initial rotation applied to local vector fields.

Public variable

FVector

 

LocalVectorFieldMinInitialRotation

Minimum initial rotation applied to local vector fields.

Public variable

FVector

 

LocalVectorFieldRotationRate

Local vector field rotation rate.

Public variable

float

 

LocalVectorFieldTightness

Tightness tweak for local vector fields.

Public variable

FTransform

 

LocalVectorFieldTransform

Local vector field transform.

Public variable

float

 

MaxFacingCameraBlendDistance

Public variable

float

 

MaxLifetime

The maximum lifetime of any particle that will spawn.

Public variable

float

 

MaxRotationRate

The maximum rotation rate of particles.

Public variable

FVector2D

 

MaxSize

The maximum size of a particle.

Public variable

FVector2D

 

MaxSizeScaleBySpeed

The maximum amount by which to scale a particle based on its speed.

Public variable

float

 

MinFacingCameraBlendDistance

Public variable

FComposableVect...

 

OrbitInitialRotation

The accumulated orbit initial rotation.

Public variable

FComposableVect...

 

OrbitOffset

The accumulated orbit offset.

Public variable

FComposableVect...

 

OrbitRotationRate

The accumulated orbit rotation rate.

Public variable

FVector2D

 

PivotOffset

An offset in UV space for the positioning of a sprites verticies.

Public variable

FVector

 

PointAttractorPosition

Location of a point source attractor.

Public variable

float

 

PointAttractorRadius

Radius of the point source attractor.

Public variable

FComposableFloa...

 

PointAttractorStrength

Strength of the point attractor.

Public variable

UParticleModule...

 

RequiredModule

The required module.

Public variable

FComposableFloa...

 

Resilience

Collision damping factor.

Public variable

FComposableFloa...

 

ResilienceScaleOverLife

Collision damping factor scale over life.

Public variable

int32

 

ScreenAlignment

Public variable

FComposableVect...

 

SizeScale

How to scale a particle's size over time.

Public variable

FVector2D

 

SizeScaleBySpeed

How much to scale a particle's size based on its speed.

Public variable

UParticleModule...

 

SpawnModule

The spawn module.

Public variable

TArray< class U...

 

SpawnModules

List of spawn modules that need to be invoked at runtime.

Public variable

UParticleModule...

 

SpawnPerUnitModule

The spawn-per-unit module.

Public variable

FComposableFloa...

 

SubImageIndex

The sub-image index over the particle's life time.

Public variable

FComposableFloa...

 

VectorFieldScale

The per-particle vector field scale.

Public variable

FComposableFloa...

 

VectorFieldScaleOverLife

The per-particle vector field scale-over-life.

Constructors

Name Description

Public function

FParticleEmitterBuildInfo()

Default constructor.

References

Module

Engine

Header

Runtime/Engine/Public/ParticleEmitterInstances.h

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