Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Particles > API/Runtime/Engine/Particles/Spawn
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
UCLASS (EditInlineNew, HideCategories=Object, HideCategories=ParticleModuleSpawnBase, MinimalAPI,
Meta=(DisplayName="Spawn"))
class UParticleModuleSpawn : public UParticleModuleSpawnBase
Variables
| Type | Name | Description | |
|---|---|---|---|
| uint32: 1 | bApplyGlobalSpawnRateScale | If true, the SpawnRate will be scaled by the global CVar r.EmitterSpawnRateScale | |
| TArray< FParticleBurst > | BurstList | The array of burst entries. | |
| FRawDistributionFloat | BurstScale | Scale all burst entries by this amount. | |
| TEnumAsByte< EParticleBurstMethod > | ParticleBurstMethod | The method to utilize when burst-emitting particles. | |
| FRawDistributionFloat | Rate | The rate at which to spawn particles. | |
| FRawDistributionFloat | RateScale | The scalar to apply to the rate. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UParticleModuleSpawn
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| float | |||
| void | Initializes the default values for this property |
Overridden from UParticleModuleSpawnBase
| Type | Name | Description | |
|---|---|---|---|
| float | Retrieve the estimated spawn rate for this module... | ||
| int32 | Retrieve the maximum number of particles this module could burst. | ||
| float | Retrieve the maximum spawn rate for this module... | ||
| bool | GetSpawnAmount
(
FParticleEmitterInstance* Owner, |
Retrieve the spawn amount this module is contributing. |
Overridden from UParticleModule
| Type | Name | Description | |
|---|---|---|---|
| bool | GenerateLODModuleValues
(
UParticleModule* SourceModule, |
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
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | 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. |