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

> Unreal Engine API Reference > Runtime > Engine > Particles > Spawn > UParticleModuleSpawn > UParticleModuleSpawn::GetSpawnAmount

Light Theme

Dark Theme

UParticleModuleSpawn::GetSpawnAmount

Retrieve the spawn amount this module is contributing.

Windows

MacOS

Linux

Override Hierarchy

UParticleModuleSpawnBase::GetSpawnAmount()

UParticleModuleSpawn::GetSpawnAmount()

References

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

Syntax

virtual bool GetSpawnAmount
(
    FParticleEmitterInstance * Owner,
    int32 Offset,
    float OldLeftover,
    float DeltaTime,
    int32 & Number,
    float & Rate
)

Remarks

Retrieve the spawn amount this module is contributing. Note that if multiple Spawn-specific modules are present, if any one of them ignores the SpawnRate processing it will be ignored.

Returns

bool false if the SpawnRate should be ignored. true if the SpawnRate should still be processed.

Parameters

Parameter	Description
Owner	The particle emitter instance that is spawning.
Offset	The offset into the particle payload for the module.
OldLeftover	The bit of timeslice left over from the previous frame.
DeltaTime	The time that has expired since the last frame.
Number	The number of particles to spawn. (OUTPUT)
Rate	The spawn rate of the module. (OUTPUT)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss