Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UParticleModuleSpawn |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Particles/Spawn/ParticleModuleSpawn.h |
| Include Path | #include "Particles/Spawn/ParticleModuleSpawn.h" |
Syntax
UCLASS (EditInlineNew, HideCategories=Object, HideCategories=ParticleModuleSpawnBase, MinimalAPI,
Meta=(DisplayName="Spawn"))
class UParticleModuleSpawn : public UParticleModuleSpawnBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UParticleModule → UParticleModuleSpawnBase → UParticleModuleSpawn
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UParticleModuleSpawn
(
const FObjectInitializer& ObjectInitializer |
Particles/Spawn/ParticleModuleSpawn.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bApplyGlobalSpawnRateScale | uint32 | If true, the SpawnRate will be scaled by the global CVar r.EmitterSpawnRateScale | Particles/Spawn/ParticleModuleSpawn.h |
|
| BurstList | TArray< FParticleBurst > | The array of burst entries. | Particles/Spawn/ParticleModuleSpawn.h |
|
| BurstScale | FRawDistributionFloat | Scale all burst entries by this amount. | Particles/Spawn/ParticleModuleSpawn.h |
|
| ParticleBurstMethod | TEnumAsByte< EParticleBurstMethod > | The method to utilize when burst-emitting particles. | Particles/Spawn/ParticleModuleSpawn.h |
|
| Rate | FRawDistributionFloat | The rate at which to spawn particles. | Particles/Spawn/ParticleModuleSpawn.h |
|
| RateScale | FRawDistributionFloat | The scalar to apply to the rate. | Particles/Spawn/ParticleModuleSpawn.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetGlobalRateScale() |
Particles/Spawn/ParticleModuleSpawn.h | ||
void InitializeDefaults() |
Initializes the default values for this property | Particles/Spawn/ParticleModuleSpawn.h |
Overridden from UParticleModuleSpawnBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual float GetEstimatedSpawnRate () |
Retrieve the estimated spawn rate for this module... | Particles/Spawn/ParticleModuleSpawn.h | |
virtual int32 GetMaximumBurstCount () |
Retrieve the maximum number of particles this module could burst. | Particles/Spawn/ParticleModuleSpawn.h | |
virtual float GetMaximumSpawnRate () |
Retrieve the maximum spawn rate for this module... | Particles/Spawn/ParticleModuleSpawn.h | |
virtual bool GetSpawnAmount
(
const FContext& Context, |
Retrieve the spawn amount this module is contributing. | Particles/Spawn/ParticleModuleSpawn.h |
Overridden from UParticleModule
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual 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. | Particles/Spawn/ParticleModuleSpawn.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Particles/Spawn/ParticleModuleSpawn.h | ||
virtual void PostInitProperties() |
Particles/Spawn/ParticleModuleSpawn.h | ||
virtual void PostLoad() |
Particles/Spawn/ParticleModuleSpawn.h |