UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FParticleEmitterBuildInfo Struct Reference

#include <ParticleEmitterInstances.h>

Public Member Functions

 FParticleEmitterBuildInfo ()
 

Public Attributes

class UParticleModuleRequired * RequiredModule
 
class UParticleModuleSpawn * SpawnModule
 
class UParticleModuleSpawnPerUnit * SpawnPerUnitModule
 
TArray< class UParticleModule * > SpawnModules
 
FComposableVectorDistribution OrbitOffset
 
FComposableVectorDistribution OrbitInitialRotation
 
FComposableVectorDistribution OrbitRotationRate
 
FComposableVectorDistribution ColorScale
 
FComposableFloatDistribution AlphaScale
 
FRawDistributionVector DynamicColor
 
FRawDistributionFloat DynamicAlpha
 
FRawDistributionVector DynamicColorScale
 
FRawDistributionFloat DynamicAlphaScale
 
FComposableVectorDistribution SizeScale
 
FVector2D MaxSize
 
FVector2D SizeScaleBySpeed
 
FVector2D MaxSizeScaleBySpeed
 
FComposableFloatDistribution SubImageIndex
 
FComposableFloatDistribution DragCoefficient
 
FComposableFloatDistribution DragScale
 
bool bEnableCollision
 
uint8 CollisionResponse
 
uint8 CollisionMode
 
float CollisionRadiusScale
 
float CollisionRadiusBias
 
float CollisionRandomSpread
 
float CollisionRandomDistribution
 
float Friction
 
FComposableFloatDistribution Resilience
 
FComposableFloatDistribution ResilienceScaleOverLife
 
FVector PointAttractorPosition
 
float PointAttractorRadius
 
FComposableFloatDistribution PointAttractorStrength
 
FComposableFloatDistribution VectorFieldScale
 
FComposableFloatDistribution VectorFieldScaleOverLife
 
float GlobalVectorFieldScale
 
float GlobalVectorFieldTightness
 
class UVectorField * LocalVectorField
 
FTransform LocalVectorFieldTransform
 
float LocalVectorFieldIntensity
 
float LocalVectorFieldTightness
 
FVector LocalVectorFieldMinInitialRotation
 
FVector LocalVectorFieldMaxInitialRotation
 
FVector LocalVectorFieldRotationRate
 
FVector ConstantAcceleration
 
float MaxLifetime
 
float MaxRotationRate
 
int32 EstimatedMaxActiveParticleCount
 
int32 ScreenAlignment
 
FVector2D PivotOffset
 
uint32 bLocalVectorFieldIgnoreComponentTransform: 1
 
uint32 bLocalVectorFieldTileX: 1
 
uint32 bLocalVectorFieldTileY: 1
 
uint32 bLocalVectorFieldTileZ: 1
 
uint32 bLocalVectorFieldUseFixDT: 1
 
uint32 bUseVelocityForMotionBlur: 1
 
uint32 bRemoveHMDRoll: 1
 
float MinFacingCameraBlendDistance
 
float MaxFacingCameraBlendDistance
 

Constructor & Destructor Documentation

◆ FParticleEmitterBuildInfo()

FParticleEmitterBuildInfo::FParticleEmitterBuildInfo ( )

Default constructor.

Member Data Documentation

◆ AlphaScale

FComposableFloatDistribution FParticleEmitterBuildInfo::AlphaScale

The alpha scale of a particle over time.

◆ bEnableCollision

bool FParticleEmitterBuildInfo::bEnableCollision

Enable collision?

◆ bLocalVectorFieldIgnoreComponentTransform

uint32 FParticleEmitterBuildInfo::bLocalVectorFieldIgnoreComponentTransform

If true, local vector fields ignore the component transform.

◆ bLocalVectorFieldTileX

uint32 FParticleEmitterBuildInfo::bLocalVectorFieldTileX

Tile vector field in x axis?

◆ bLocalVectorFieldTileY

uint32 FParticleEmitterBuildInfo::bLocalVectorFieldTileY

Tile vector field in y axis?

◆ bLocalVectorFieldTileZ

uint32 FParticleEmitterBuildInfo::bLocalVectorFieldTileZ

Tile vector field in z axis?

◆ bLocalVectorFieldUseFixDT

uint32 FParticleEmitterBuildInfo::bLocalVectorFieldUseFixDT

Use fix delta time in the simulation?

◆ bRemoveHMDRoll

uint32 FParticleEmitterBuildInfo::bRemoveHMDRoll

Particle alignment overrides

◆ bUseVelocityForMotionBlur

uint32 FParticleEmitterBuildInfo::bUseVelocityForMotionBlur

◆ CollisionMode

uint8 FParticleEmitterBuildInfo::CollisionMode

◆ CollisionRadiusBias

float FParticleEmitterBuildInfo::CollisionRadiusBias

Bias applied to the collision radius.

◆ CollisionRadiusScale

float FParticleEmitterBuildInfo::CollisionRadiusScale

Radius scale applied to friction.

◆ CollisionRandomDistribution

float FParticleEmitterBuildInfo::CollisionRandomDistribution

Random distribution across the reflection spreading cone when colliding.

◆ CollisionRandomSpread

float FParticleEmitterBuildInfo::CollisionRandomSpread

Factor reflection spreading cone when colliding.

◆ CollisionResponse

uint8 FParticleEmitterBuildInfo::CollisionResponse

How particles respond to collision.

◆ ColorScale

FComposableVectorDistribution FParticleEmitterBuildInfo::ColorScale

The color scale of a particle over time.

◆ ConstantAcceleration

FVector FParticleEmitterBuildInfo::ConstantAcceleration

Constant acceleration to apply to particles.

◆ DragCoefficient

FComposableFloatDistribution FParticleEmitterBuildInfo::DragCoefficient

Drag coefficient.

◆ DragScale

FComposableFloatDistribution FParticleEmitterBuildInfo::DragScale

Drag scale over life.

◆ DynamicAlpha

FRawDistributionFloat FParticleEmitterBuildInfo::DynamicAlpha

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

◆ DynamicAlphaScale

FRawDistributionFloat FParticleEmitterBuildInfo::DynamicAlphaScale

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

◆ DynamicColor

FRawDistributionVector FParticleEmitterBuildInfo::DynamicColor

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

◆ DynamicColorScale

FRawDistributionVector FParticleEmitterBuildInfo::DynamicColorScale

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

◆ EstimatedMaxActiveParticleCount

int32 FParticleEmitterBuildInfo::EstimatedMaxActiveParticleCount

The estimated maximum number of particles for this emitter.

◆ Friction

float FParticleEmitterBuildInfo::Friction

Friction.

◆ GlobalVectorFieldScale

float FParticleEmitterBuildInfo::GlobalVectorFieldScale

Global vector field scale.

◆ GlobalVectorFieldTightness

float FParticleEmitterBuildInfo::GlobalVectorFieldTightness

Global vector field tightness.

◆ LocalVectorField

class UVectorField* FParticleEmitterBuildInfo::LocalVectorField

Local vector field.

◆ LocalVectorFieldIntensity

float FParticleEmitterBuildInfo::LocalVectorFieldIntensity

Local vector field intensity.

◆ LocalVectorFieldMaxInitialRotation

FVector FParticleEmitterBuildInfo::LocalVectorFieldMaxInitialRotation

Maximum initial rotation applied to local vector fields.

◆ LocalVectorFieldMinInitialRotation

FVector FParticleEmitterBuildInfo::LocalVectorFieldMinInitialRotation

Minimum initial rotation applied to local vector fields.

◆ LocalVectorFieldRotationRate

FVector FParticleEmitterBuildInfo::LocalVectorFieldRotationRate

Local vector field rotation rate.

◆ LocalVectorFieldTightness

float FParticleEmitterBuildInfo::LocalVectorFieldTightness

Tightness tweak for local vector fields.

◆ LocalVectorFieldTransform

FTransform FParticleEmitterBuildInfo::LocalVectorFieldTransform

Local vector field transform.

◆ MaxFacingCameraBlendDistance

float FParticleEmitterBuildInfo::MaxFacingCameraBlendDistance

◆ MaxLifetime

float FParticleEmitterBuildInfo::MaxLifetime

The maximum lifetime of any particle that will spawn.

◆ MaxRotationRate

float FParticleEmitterBuildInfo::MaxRotationRate

The maximum rotation rate of particles.

◆ MaxSize

FVector2D FParticleEmitterBuildInfo::MaxSize

The maximum size of a particle.

◆ MaxSizeScaleBySpeed

FVector2D FParticleEmitterBuildInfo::MaxSizeScaleBySpeed

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

◆ MinFacingCameraBlendDistance

float FParticleEmitterBuildInfo::MinFacingCameraBlendDistance

◆ OrbitInitialRotation

FComposableVectorDistribution FParticleEmitterBuildInfo::OrbitInitialRotation

The accumulated orbit initial rotation.

◆ OrbitOffset

FComposableVectorDistribution FParticleEmitterBuildInfo::OrbitOffset

The accumulated orbit offset.

◆ OrbitRotationRate

FComposableVectorDistribution FParticleEmitterBuildInfo::OrbitRotationRate

The accumulated orbit rotation rate.

◆ PivotOffset

FVector2D FParticleEmitterBuildInfo::PivotOffset

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

◆ PointAttractorPosition

FVector FParticleEmitterBuildInfo::PointAttractorPosition

Location of a point source attractor.

◆ PointAttractorRadius

float FParticleEmitterBuildInfo::PointAttractorRadius

Radius of the point source attractor.

◆ PointAttractorStrength

FComposableFloatDistribution FParticleEmitterBuildInfo::PointAttractorStrength

Strength of the point attractor.

◆ RequiredModule

class UParticleModuleRequired* FParticleEmitterBuildInfo::RequiredModule

The required module.

◆ Resilience

FComposableFloatDistribution FParticleEmitterBuildInfo::Resilience

Collision damping factor.

◆ ResilienceScaleOverLife

FComposableFloatDistribution FParticleEmitterBuildInfo::ResilienceScaleOverLife

Collision damping factor scale over life.

◆ ScreenAlignment

int32 FParticleEmitterBuildInfo::ScreenAlignment

◆ SizeScale

FComposableVectorDistribution FParticleEmitterBuildInfo::SizeScale

How to scale a particle's size over time.

◆ SizeScaleBySpeed

FVector2D FParticleEmitterBuildInfo::SizeScaleBySpeed

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

◆ SpawnModule

class UParticleModuleSpawn* FParticleEmitterBuildInfo::SpawnModule

The spawn module.

◆ SpawnModules

TArray<class UParticleModule*> FParticleEmitterBuildInfo::SpawnModules

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

◆ SpawnPerUnitModule

class UParticleModuleSpawnPerUnit* FParticleEmitterBuildInfo::SpawnPerUnitModule

The spawn-per-unit module.

◆ SubImageIndex

FComposableFloatDistribution FParticleEmitterBuildInfo::SubImageIndex

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

◆ VectorFieldScale

FComposableFloatDistribution FParticleEmitterBuildInfo::VectorFieldScale

The per-particle vector field scale.

◆ VectorFieldScaleOverLife

FComposableFloatDistribution FParticleEmitterBuildInfo::VectorFieldScaleOverLife

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

The documentation for this struct was generated from the following files: