Navigation
Unreal Engine C++ API Reference > Plugins > Niagara
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UNiagaraMergeable
- UNiagaraSimulationStageBase
- UNiagaraSimulationStageGeneric
References
Module | Niagara |
Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSimulationStageBase.h |
Include | #include "NiagaraSimulationStageBase.h" |
Syntax
UCLASS (Meta=(DisplayName="Generic Simulation Stage"), MinimalAPI)
class UNiagaraSimulationStageGeneric : public UNiagaraSimulationStageBase
Variables
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
uint32: 1 | bDisablePartialParticleUpdate | Disables the ability to read / write from the same particle buffer, i.e. only update position and no other attributes. |
![]() ![]() ![]() |
uint32: 1 | bGpuDispatchForceLinear | When enabled we force the dispatch to be linear (i.e. one dimension is used). |
![]() ![]() ![]() |
uint32: 1 | bOverrideGpuDispatchNumThreads | When enabled we use a custom number of threads for the dispatch. |
![]() ![]() ![]() |
uint32: 1 | bParticleIterationStateEnabled | When enabled we iterate over the subset of particles that satisfy the binding & range selected. |
![]() ![]() ![]() |
FNiagaraVariableDataInterfaceBinding | DataInterface | Source data interface to use for the simulation stage. |
![]() ![]() ![]() |
ENiagaraDirectDispatchElementType | DirectDispatchElementType | Customizes what the element count means for a direct dispatch. |
![]() ![]() ![]() |
ENiagaraGpuDispatchType | DirectDispatchType | Dimensions to use for dispatch. |
![]() ![]() ![]() |
FNiagaraParameterBindingWithValue | ElementCountX | Integer binding to override the number of elements the stage will execute along X. |
![]() ![]() ![]() |
FNiagaraParameterBindingWithValue | ElementCountY | Integer binding to override the number of elements the stage will execute along Y. |
![]() ![]() ![]() |
FNiagaraParameterBindingWithValue | ElementCountZ | Integer binding to override the number of elements the stage will execute along Z. |
![]() ![]() ![]() |
FNiagaraVariableAttributeBinding | EnabledBinding | Optional bool binding allowing scripts to control if the simulation stage is enabled or not. |
![]() ![]() ![]() |
ENiagaraSimStageExecuteBehavior | ExecuteBehavior | Controls when the simulation stage should execute, only valid for data interface iteration stages |
![]() ![]() ![]() |
ENiagaraIterationSource | IterationSource | Select what we should be iterating over, particles or data interfaces. |
![]() ![]() ![]() |
FNiagaraParameterBindingWithValue | NumIterations | Number of times (or iterations) the simulation stage will execute in a row. |
![]() ![]() ![]() |
FNiagaraParameterBindingWithValue | OverrideGpuDispatchNumThreadsX | Parameter binding / constant value for Num Threads X |
![]() ![]() ![]() |
FNiagaraParameterBindingWithValue | OverrideGpuDispatchNumThreadsY | Parameter binding / constant value for Num Threads Y |
![]() ![]() ![]() |
FNiagaraParameterBindingWithValue | OverrideGpuDispatchNumThreadsZ | Parameter binding / constant value for Num Threads Z |
![]() ![]() ![]() |
FNiagaraVariableAttributeBinding | ParticleIterationStateBinding | Particle state attribute binding, when enabled we will only allow particles who pass the state range check to be processed. |
![]() ![]() ![]() |
FIntPoint | ParticleIterationStateRange | The inclusive range used to check particle state binding against when enabled. |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | RemoveVariable
(
const FNiagaraVariableBase& OldVariable, |
|
![]() ![]() |
void | RenameEmitter
(
const FName& InOldName, |
|
![]() ![]() |
void | RenameVariable
(
const FNiagaraVariableBase& OldVariable, |
Overridden from UNiagaraSimulationStageBase
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
bool | AppendCompileHash
(
FNiagaraCompileHashVisitor* InVisitor |
|
![]() ![]() ![]() |
bool | FillCompilationData
(
TArray< FNiagaraSimulationStageCompilationData >& CompilationSimStageData |
|
![]() ![]() ![]() |
FName | Return the FName to use in place of the default for the location in the stack context. |
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. |
Deprecated Variables
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
uint32: 1 | bOverrideGpuDispatchType_DEPRECATED | |
![]() ![]() |
uint32: 1 | bSpawnOnly_DEPRECATED | |
![]() ![]() |
FNiagaraVariableAttributeBinding | ElementCountBinding_DEPRECATED | Deprecated Properties. |
![]() ![]() |
FNiagaraVariableAttributeBinding | ElementCountXBinding_DEPRECATED | |
![]() ![]() |
FNiagaraVariableAttributeBinding | ElementCountYBinding_DEPRECATED | |
![]() ![]() |
FNiagaraVariableAttributeBinding | ElementCountZBinding_DEPRECATED | |
![]() ![]() |
int32 | Iterations_DEPRECATED | |
![]() ![]() |
FNiagaraVariableAttributeBinding | NumIterationsBinding_DEPRECATED | |
![]() ![]() |
FIntVector | OverrideGpuDispatchNumThreads_DEPRECATED | |
![]() ![]() |
ENiagaraGpuDispatchType | OverrideGpuDispatchType_DEPRECATED |