UNiagaraSimulationStageGeneric

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSimulationStageBase.h
Include #include "NiagaraSimulationStageBase.h"

Syntax

UCLASS&40;Meta&61;&40;DisplayName&61;"Generic Simulation Stage"&41;, MinimalAPI&41;  
class UNiagaraSimulationStageGeneric : public UNiagaraSimulationStageBase

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay uint32: 1 bDisablePartialParticleUpdate Disables the ability to read / write from the same particle buffer, i.e. only update position and no other attributes.
Public variable UProperty Category, EditAnywhere uint32: 1 bGpuDispatchForceLinear When enabled we force the dispatch to be linear (i.e. one dimension is used).
Public variable UProperty Category, EditAnywhere uint32: 1 bOverrideGpuDispatchNumThreads When enabled we use a custom number of threads for the dispatch.
Public variable UProperty Category, EditAnywhere uint32: 1 bParticleIterationStateEnabled When enabled we iterate over the subset of particles that satisfy the binding & range selected.
Public variable UProperty Category, EditAnywhere FNiagaraVariableDataInterfaceBinding DataInterface Source data interface to use for the simulation stage.
Public variable UProperty Category, EditAnywhere ENiagaraDirectDispatchElementType DirectDispatchElementType Customizes what the element count means for a direct dispatch.
Public variable UProperty Category, EditAnywhere ENiagaraGpuDispatchType DirectDispatchType Dimensions to use for dispatch.
Public variable UProperty Category, EditAnywhere, Meta FNiagaraParameterBindingWithValue ElementCountX Integer binding to override the number of elements the stage will execute along X.
Public variable UProperty Category, EditAnywhere, Meta FNiagaraParameterBindingWithValue ElementCountY Integer binding to override the number of elements the stage will execute along Y.
Public variable UProperty Category, EditAnywhere, Meta FNiagaraParameterBindingWithValue ElementCountZ Integer binding to override the number of elements the stage will execute along Z.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding EnabledBinding Optional bool binding allowing scripts to control if the simulation stage is enabled or not.
Public variable UProperty Category, EditAnywhere ENiagaraSimStageExecuteBehavior ExecuteBehavior Controls when the simulation stage should execute, only valid for data interface iteration stages
Public variable UProperty Category, EditAnywhere ENiagaraIterationSource IterationSource Select what we should be iterating over, particles or data interfaces.
Public variable UProperty Category, EditAnywhere FNiagaraParameterBindingWithValue NumIterations Number of times (or iterations) the simulation stage will execute in a row.
Public variable UProperty Category, EditAnywhere FNiagaraParameterBindingWithValue OverrideGpuDispatchNumThreadsX Parameter binding / constant value for Num Threads X
Public variable UProperty Category, EditAnywhere, Meta FNiagaraParameterBindingWithValue OverrideGpuDispatchNumThreadsY Parameter binding / constant value for Num Threads Y
Public variable UProperty Category, EditAnywhere, Meta FNiagaraParameterBindingWithValue OverrideGpuDispatchNumThreadsZ Parameter binding / constant value for Num Threads Z
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding ParticleIterationStateBinding Particle state attribute binding, when enabled we will only allow particles who pass the state range check to be processed.
Public variable UProperty Category, EditAnywhere FIntPoint ParticleIterationStateRange The inclusive range used to check particle state binding against when enabled.

Functions

  Type Name Description
Public function Virtual void

RemoveVariable ( const FNiagaraVariableBase& OldVariable,
const FVersionedNiagaraEmitter& InEmitter
)

  
Public function Virtual void

RenameEmitter ( const FName& InOldName,
const UNiagaraEmitter* InRenamedEmitter
)

  
Public function Virtual void

RenameVariable ( const FNiagaraVariableBase& OldVariable,
const FNiagaraVariableBase& NewVariable,
const FVersionedNiagaraEmitter& InEmitter
)

  

Overridden from UNiagaraSimulationStageBase

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const FName Return the FName to use in place of the default for the location in the stack context.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

  Type Name Description
Public variable UProperty uint32: 1 bOverrideGpuDispatchType_DEPRECATED  
Public variable UProperty uint32: 1 bSpawnOnly_DEPRECATED  
Public variable UProperty FNiagaraVariableAttributeBinding ElementCountBinding_DEPRECATED Deprecated Properties.
Public variable UProperty FNiagaraVariableAttributeBinding ElementCountXBinding_DEPRECATED  
Public variable UProperty FNiagaraVariableAttributeBinding ElementCountYBinding_DEPRECATED  
Public variable UProperty FNiagaraVariableAttributeBinding ElementCountZBinding_DEPRECATED  
Public variable UProperty int32 Iterations_DEPRECATED  
Public variable UProperty FNiagaraVariableAttributeBinding NumIterationsBinding_DEPRECATED  
Public variable UProperty FIntVector OverrideGpuDispatchNumThreads_DEPRECATED  
Public variable UProperty ENiagaraGpuDispatchType OverrideGpuDispatchType_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page