Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UParticleModuleSpawn

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UParticleModule

UParticleModuleSpawnBase

UParticleModuleSpawn

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Particles/Spawn/ParticleModuleSpawn.h
Include	#include "Particles/Spawn/ParticleModuleSpawn.h"

Syntax

class UParticleModuleSpawn : public UParticleModuleSpawnBase

Variables

	Name	Description
uint32: 1	bApplyGlobalSpawnRateScale	If true, the SpawnRate will be scaled by the global CVar r.EmitterSpawnRateScale
TArray< FPartic...	BurstList	The array of burst entries.
FRawDistributio...	BurstScale	Scale all burst entries by this amount.
TEnumAsByte< EP...	ParticleBurstMethod	The method to utilize when burst-emitting particles.
FRawDistributio...	Rate	The rate at which to spawn particles.
FRawDistributio...	RateScale	The scalar to apply to the rate.

Constructors

	Name	Description
	UParticleModuleSpawn ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	float	GetGlobalRateScale()
	void	InitializeDefaults()	Initializes the default values for this property

Overridden from UParticleModuleSpawnBase

	Name	Description
float	GetEstimatedSpawnRate()	Retrieve the estimated spawn rate for this module...
int32	GetMaximumBurstCount()	Retrieve the maximum number of particles this module could burst.
float	GetMaximumSpawnRate()	Retrieve the maximum spawn rate for this module...
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
	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.

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.