1. Epic GamesDeveloper
  3. FVersionedNiagaraEmitterData

FVersionedNiagaraEmitterData

Struct containing all of the data that can be different between different emitter versions.

API > API/Plugins > API/Plugins/Niagara

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraEmitter.h
Include #include "NiagaraEmitter.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FVersionedNiagaraEmitterData

Remarks

Struct containing all of the data that can be different between different emitter versions.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta ENiagaraEmitterDefaultSummaryState AddEmitterDefaultViewState This determines how emitters will be added to a system by default.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite EParticleAllocationMode AllocationMode The emitter needs to allocate memory for the particles each tick.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay TArray< FString > AttributesToPreserve An allow list of Particle attributes (e.g. "Particle.Position" or "Particle.Age") that will not be removed from the DataSet even if they aren't read by the VM.
Public variable UProperty bool bDeprecated If this emitter version is no longer meant to be used, this option should be set.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bDeterminism Toggles whether to globally make the random number generator be deterministic or non-deterministic.
Public variable UProperty uint32: 1 bGpuAlwaysRunParticleUpdateScript GPU scripts were incorrectly running both particle spawn & update, CPU only runs spawn when interpolated spawning is disabled.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bInterpolatedSpawning When enabled, this will spawn using interpolated parameter values and perform a partial update at spawn time.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bLocalSpace Toggles whether or not the particles within this emitter are relative to the emitter origin or in global space.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bRequiresPersistentIDs Creates a stable Identifier (Particles.ID) which does not vary from frame to frame.
Public variable UProperty Category, EditAnywhere, Meta ENiagaraEmitterCalculateBoundMode CalculateBoundsMode How should we calculate bounds for the emitter.
Public variable UProperty FText DeprecationMessage Message to display when the script is deprecated.
Public variable UProperty Category, EditAnywhere TArray< FNiagaraDataInterfaceEmitterBinding > EmitterDependencies List of emitter dependencies to use when calculating the execution order for emitter particle scripts.
Public variable UProperty FNiagaraEmitterScriptProperties EmitterSpawnScriptProps  
Public variable UProperty FNiagaraEmitterScriptProperties EmitterUpdateScriptProps  
Public variable UProperty Meta TArray< FNiagaraEventScriptProperties > EventHandlerScriptProps  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FBox FixedBounds The fixed bounding box value.
Public variable UProperty TObjectPtr< UNiagaraScriptSourceBase > GraphSource 'Source' data/graphs for the scripts used by this emitter.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int32 MaxGPUParticlesSpawnPerFrame An override on the max number of GPU particles we expect to spawn in a single frame.
Public variable UProperty TObjectPtr< UNiagaraScratchPadContainer > ParentScratchPads  
Public variable UProperty Category, EditAnywhere, Meta FNiagaraPlatformSet Platforms  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta int32 PreAllocationCount The emitter will allocate at least this many particles on it's first tick.
Public variable UProperty FString PythonUpdateScript Python script to run when updating to this script version.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 RandomSeed An emitter-based seed for the deterministic random number generator.
Public variable UProperty FNiagaraParameterStore RendererBindings  
Public variable UProperty TArray< FNiagaraExternalUObjectInfo > RendererBindingsExternalObjects  
Public variable UProperty TMap< FNiagaraVariableBase, FNiagaraVariableBase > ResolvedDIBindings  
Public variable UProperty Category, EditAnywhere, Meta FNiagaraEmitterScalabilityOverrides ScalabilityOverrides  
Public variable UProperty TObjectPtr< UNiagaraScratchPadContainer > ScratchPads  
Public variable UProperty FFilePath ScriptAsset Asset reference to a python script to run when updating to this script version.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite ENiagaraSimTarget SimTarget  
Public variable UProperty FNiagaraEmitterScriptProperties SpawnScriptProps  
Public variable UProperty ENiagaraPythonUpdateScriptReference UpdateScriptExecution Reference to a python script that is executed when the user updates from a previous version to this version.
Public variable UProperty FNiagaraEmitterScriptProperties UpdateScriptProps  
Public variable UProperty FNiagaraAssetVersion Version  
Public variable UProperty FText VersionChangeDescription What changed in this version compared to the last? Displayed to the user when upgrading to a new script version.
Public variable UProperty FVersionedNiagaraEmitter VersionedParent  
Public variable UProperty FVersionedNiagaraEmitter VersionedParentAtLastMerge  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function int32

AddRuntimeAllocation ( uint64 ReporterHandle,
int32 AllocationCount
)

 This is used by the emitter instances to report runtime allocations to reduce reallocation in future simulation runs.
Public function Const bool  
Public function Const bool  
Public function void

CacheFromCompiledData ( const FNiagaraDataSetCompiledData* CompiledData,
const UNiagaraEmitter& Emitter
)

  
Public function void  
Public function void  
Public function void  
Public function Const bool  
Public function Const void

ForEachEnabledRenderer ( TAction Func
)

  
Public function void

ForEachPlatformSet ( TAction Func
)

  
Public function Const void

ForEachRenderer ( TAction Func
)

  
Public function Const void

ForEachScript ( TAction Func
)

  
Public function Const void  
Public function Const void  
Public function Const TConstArrayView< TSharedPtr< FNiagaraBoundsCalculator > >  
Public function Const const FNiagaraEmitterScalabilityOverride &  
Public function Const const TCHAR *  
Public function Static FBox  
Public function Const UNiagaraEditorDataBase *  
Public function UNiagaraEditorParametersAdapterBase *  
Public function FNiagaraEventScriptProperties *

GetEventHandlerByIdUnsafe ( FGuid ScriptUsageId
)

 Gets a pointer to an event handler by script usage id.
Public function Const const TArray< FNiagaraEventScriptProperties > &  
Public function UNiagaraScript *  
Public function Const const UNiagaraScript *  
Public function Const uint32  
Public function Const uint32  
Public function int32 Returns the number of max expected particles for memory allocations.
Public function Const FVersionedNiagaraEmitter  
Public function Const FVersionedNiagaraEmitter  
Public function Const const TArray< UNiagaraRendererProperties * > &  
Public function Const const FNiagaraEmitterScalabilitySettings &  
Public function UNiagaraScript *

GetScript ( ENiagaraScriptUsage Usage,
FGuid UsageId
)

  
Public function Const void

GetScripts ( TArray< UNiagaraScript* >& OutScripts,
bool bCompilableOnly,
bool bEnabledOnly
)

  
Public function Const FNiagaraSimStageExecutionDataPtr  
Public function Const UNiagaraSimulationStageBase *

GetSimulationStageById ( FGuid ScriptUsageId
)

  
Public function Const const TArray< UNiagaraSimulationStageBase * > &  
Public function void  
Public function Const bool Returns true if this emitter's platform filter allows it on this platform and quality level.
Public function Const bool  
Public function Const bool

IsEventGeneratorShared ( FName EventGeneratorId
)

 Gets whether or not the supplied event generator id matches an event generator which is shared between the particle spawn and update scrips.
Public function Const bool  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function Const bool  
Public function void  
Public function void

PostLoad ( UNiagaraEmitter& Emitter,
int32 NiagaraVer
)

  
Public function FGraphEventArray

PrecacheComputePSOs ( const UNiagaraEmitter& NiagaraEmitter
)

  
Public function void  
Public function void  
Public function void

Reparent ( const FVersionedNiagaraEmitter& InParent
)

  
Public function Const bool  
Public function Const bool  
Public function void

SyncEmitterAlias ( const FString& InOldName,
const UNiagaraEmitter& InEmitter
)

  
Public function void

UpdateDebugName ( const UNiagaraEmitter& Emitter,
const FNiagaraDataSetCompiledData* CompiledData
)

  
Public function Const bool  
Public function Const bool

UsesEmitter ( const UNiagaraEmitter& InEmitter
)

  
Public function Const bool

UsesScript ( const UNiagaraScript* Script
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page