UParticleModuleSpawnPerUnit

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Particles/Spawn/ParticleModuleSpawnPerUnit.h

Include

#include "Particles/Spawn/ParticleModuleSpawnPerUnit.h"

Syntax

class UParticleModuleSpawnPerUnit : public UParticleModuleSpawnBase

Variables

Name Description

Public variable

uint32: 1

 

bIgnoreMovementAlongX

If true, ignore the X-component of the movement

Public variable

uint32: 1

 

bIgnoreMovementAlongY

If true, ignore the Y-component of the movement

Public variable

uint32: 1

 

bIgnoreMovementAlongZ

If true, ignore the Z-component of the movement

Public variable

uint32: 1

 

bIgnoreSpawnRateWhenMoving

If true, process the default spawn rate when not moving...

Public variable

float

 

MaxFrameDistance

The maximum valid movement for a single frame.

Public variable

float

 

MovementTolerance

The tolerance for moving vs.

Public variable

FRawDistributio...

 

SpawnPerUnit

The amount to spawn per meter distribution. The value is retrieved using the EmitterTime.

Public variable

float

 

UnitScalar

The scalar to apply to the distance traveled.

Constructors

Name Description

Public function

UParticleModuleSpawnPerUnit

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

InitializeDefaults()

Initializes the default values for this property

Overridden from UParticleModuleSpawnBase

Name Description

Public function Virtual

bool

 

GetSpawnAmount

(
    FParticleEmitterInstance* Owne...,
    int32 Offset,
    float OldLeftover,
    float DeltaTime,
    int32& Number,
    float& Rate
)

Retrieve the spawn amount this module is contributing.

Overridden from UParticleModule

Name Description

Public function Virtual

void

 

CompileModule

(
    FParticleEmitterBuildInfo& Emitter...
)

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

Public function Virtual

uint32

 

RequiredBytesPerInstance()

Returns the number of bytes the module requires in the emitters 'per-instance' data block.

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.

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