Navigation
Unreal Engine C++ API Reference > Plugins > Niagara
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraCommon.h |
| Include | #include "NiagaraCommon.h" |
Syntax
enum ENiagaraScriptUsage
&123;
Function,
Module,
DynamicInput,
ParticleSpawnScript,
ParticleSpawnScriptInterpolated,
ParticleUpdateScript,
ParticleEventScript,
ParticleSimulationStageScript,
ParticleGPUComputeScript,
EmitterSpawnScript,
EmitterUpdateScript,
SystemSpawnScript,
SystemUpdateScript,
&125;
Values
| Name | Description |
|---|---|
| Function | The script defines a function for use in modules. |
| Module | The script defines a module for use in particle, emitter, or system scripts. |
| DynamicInput | The script defines a dynamic input for use in particle, emitter, or system scripts. |
| ParticleSpawnScript | The script is called when spawning particles. |
| ParticleSpawnScriptInterpolated | Particle spawn script that handles intra-frame spawning and also pulls in the update script. |
| ParticleUpdateScript | The script is called to update particles every frame. |
| ParticleEventScript | The script is called to update particles in response to an event. |
| ParticleSimulationStageScript | The script is called as a particle simulation stage. |
| ParticleGPUComputeScript | The script is called to update particles on the GPU. |
| EmitterSpawnScript | The script is called once when the emitter spawns. |
| EmitterUpdateScript | The script is called every frame to tick the emitter. |
| SystemSpawnScript | The script is called once when the system spawns. |
| SystemUpdateScript | The script is called every frame to tick the system. |
Remarks
Defines different usages for a niagara script.