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

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

   
Name FVersionedNiagaraEmitterData
Type struct
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraEmitter.h
Include Path #include "NiagaraEmitter.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FVersionedNiagaraEmitterData

Constructors

Name Remarks Include Path Unreal Specifiers

FVersionedNiagaraEmitterData()

   NiagaraEmitter.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AddEmitterDefaultViewState ENiagaraEmitterDefaultSummaryState This determines how emitters will be added to a system by default. NiagaraEmitter.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Asset Options"
  • Meta=(SegmentedDisplay)
AllocationMode EParticleAllocationMode The emitter needs to allocate memory for the particles each tick. NiagaraEmitter.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Emitter"
  • Meta=(SegmentedDisplay)
AttributesToPreserve TArray< FString > 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. NiagaraEmitter.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Emitter"
bDeprecated bool If this emitter version is no longer meant to be used, this option should be set. NiagaraEmitter.h  
bDeterminism bool Toggles whether to globally make the random number generator be deterministic or non-deterministic. NiagaraEmitter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Emitter"
bGpuAlwaysRunParticleUpdateScript uint32 GPU scripts were incorrectly running both particle spawn & update, CPU only runs spawn when interpolated spawning is disabled. NiagaraEmitter.h  
bLocalSpace bool Toggles whether or not the particles within this emitter are relative to the emitter origin or in global space. NiagaraEmitter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Emitter"
bRequiresPersistentIDs uint32 Creates a stable Identifier (Particles.ID) which does not vary from frame to frame. NiagaraEmitter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Emitter"
CalculateBoundsMode ENiagaraEmitterCalculateBoundMode How should we calculate bounds for the emitter. NiagaraEmitter.h
  • EditAnywhere
  • Category="Emitter"
  • Meta=(SegmentedDisplay)
DeprecationMessage FText Message to display when the script is deprecated. NiagaraEmitter.h  
EmitterDependencies TArray< FNiagaraDataInterfaceEmitterBinding > List of emitter dependencies to use when calculating the execution order for emitter particle scripts. NiagaraEmitter.h
  • EditAnywhere
  • Category="Emitter"
EmitterSpawnScriptProps FNiagaraEmitterScriptProperties   NiagaraEmitter.h  
EmitterUpdateScriptProps FNiagaraEmitterScriptProperties   NiagaraEmitter.h  
EventHandlerScriptProps TArray< FNiagaraEventScriptProperties >   NiagaraEmitter.h
  • Meta=(NiagaraNoMerge)
FixedBounds FBox The fixed bounding box value. NiagaraEmitter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Emitter"
  • Meta=(EditConditionHides, EditCondition="CalculateBoundsMode == ENiagaraEmitterCalculateBoundMode::Fixed")
GraphSource TObjectPtr< UNiagaraScriptSourceBase > 'Source' data/graphs for the scripts used by this emitter. NiagaraEmitter.h  
InterpolatedSpawnMode ENiagaraInterpolatedSpawnMode This defines if newly spawned particles run only the spawn script on the first frame or both spawn and update with optional parameter interpolation. NiagaraEmitter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Emitter"
  • Meta=(SegmentedDisplay)
MaxGPUParticlesSpawnPerFrame int32 An override on the max number of GPU particles we expect to spawn in a single frame. NiagaraEmitter.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Emitter"
  • Meta=(EditCondition="SimTarget == ENiagaraSimTarget::GPUComputeSim", DisplayName="Max GPU Particles Spawn per Frame", EditConditionHides)
ParentScratchPads TObjectPtr< UNiagaraScratchPadContainer >   NiagaraEmitter.h  
Platforms FNiagaraPlatformSet   NiagaraEmitter.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(DisplayInScalabilityContext)
PreAllocationCount int32 The emitter will allocate at least this many particles on it's first tick. NiagaraEmitter.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Emitter"
  • Meta=(EditCondition="AllocationMode != EParticleAllocationMode::AutomaticEstimate", EditConditionHides)
PythonUpdateScript FString Python script to run when updating to this script version. NiagaraEmitter.h  
RandomSeed int32 An emitter-based seed for the deterministic random number generator. NiagaraEmitter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Emitter"
  • Meta=(EditCondition="bDeterminism", EditConditionHides="true")
RendererBindings FNiagaraParameterStore   NiagaraEmitter.h  
RendererBindingsExternalObjects TArray< FNiagaraExternalUObjectInfo >   NiagaraEmitter.h  
ResolvedDIBindings TMap< FNiagaraVariableBase, FNiagaraVariableBase >   NiagaraEmitter.h  
ScalabilityOverrides FNiagaraEmitterScalabilityOverrides   NiagaraEmitter.h
  • EditAnywhere
  • Category="Scalability"
  • Meta=(DisplayInScalabilityContext)
ScratchPads TObjectPtr< UNiagaraScratchPadContainer >   NiagaraEmitter.h  
ScriptAsset FFilePath Asset reference to a python script to run when updating to this script version. NiagaraEmitter.h  
SimTarget ENiagaraSimTarget   NiagaraEmitter.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Emitter"
  • Meta=(SegmentedDisplay)
SpawnScriptProps FNiagaraEmitterScriptProperties   NiagaraEmitter.h  
UpdateScriptExecution ENiagaraPythonUpdateScriptReference Reference to a python script that is executed when the user updates from a previous version to this version. NiagaraEmitter.h  
UpdateScriptProps FNiagaraEmitterScriptProperties   NiagaraEmitter.h  
Version FNiagaraAssetVersion   NiagaraEmitter.h  
VersionChangeDescription FText What changed in this version compared to the last? Displayed to the user when upgrading to a new script version. NiagaraEmitter.h  
VersionedParent FVersionedNiagaraEmitter   NiagaraEmitter.h  
VersionedParentAtLastMerge FVersionedNiagaraEmitter   NiagaraEmitter.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsAllowedToExecute uint32 Can this emitter run with the current scalability settings, etc NiagaraEmitter.h  
bNeedsPartialDepthTexture uint32 Indicates we use the partial depth textures. NiagaraEmitter.h  
BoundsCalculators TArray< TSharedPtr< FNiagaraBoundsCalculator >, TInlineAllocator< 1 > > Optional list of bounds calculators. NiagaraEmitter.h  
bRequiresViewUniformBuffer uint32 Indicates that the GPU script requires the view uniform buffer. NiagaraEmitter.h  
CachedTraversalData TSharedPtr< FNiagaraGraphCachedDataBase, ESPMode::ThreadSafe >   NiagaraEmitter.h  
CurrentScalabilitySettings FNiagaraEmitterScalabilitySettings   NiagaraEmitter.h
  • Transient
DebugSimName FString   NiagaraEmitter.h  
EditorData TObjectPtr< UNiagaraEditorDataBase > Data used by the editor to maintain UI state etc.. NiagaraEmitter.h  
EditorParameters TObjectPtr< UNiagaraEditorParametersAdapterBase > Wrapper for editor only parameters. NiagaraEmitter.h  
GPUComputeScript TObjectPtr< UNiagaraScript >   NiagaraEmitter.h  
MaxAllocationCount uint32 Maximum instance allocations size for the emitter, can be larger than MaxInstanceCount NiagaraEmitter.h  
MaxInstanceCount uint32 Maximum number of instances we can create for this emitter. NiagaraEmitter.h  
PSOPrecacheResult EPSOPrecacheResult   NiagaraEmitter.h  
RendererProperties TArray< TObjectPtr< UNiagaraRendererProperties > >   NiagaraEmitter.h  
RuntimeEstimation FMemoryRuntimeEstimation   NiagaraEmitter.h  
SharedEventGeneratorIds TArray< FName >   NiagaraEmitter.h  
SimStageExecutionData FNiagaraSimStageExecutionDataPtr   NiagaraEmitter.h  
SimStageExecutionLoopEditorData TArray< FNiagaraSimStageExecutionLoopEditorData >   NiagaraEmitter.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Emitter"
  • Meta=(DisplayName="Sim Stage Loops")
SimStageExecutionLoops TArray< FNiagaraSimStageExecutionLoopData >   NiagaraEmitter.h  
SimulationStages TArray< TObjectPtr< UNiagaraSimulationStageBase > >   NiagaraEmitter.h
  • Meta=(NiagaraNoMerge)
UNiagaraEmitter friend   NiagaraEmitter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddRuntimeAllocation ( uint64 ReporterHandle,
int32 AllocationCount
)

 This is used by the emitter instances to report runtime allocations to reduce reallocation in future simulation runs. NiagaraEmitter.h  

bool AreAllScriptAndSourcesSynchronized()

   NiagaraEmitter.h  

bool BuildParameterStoreRendererBindings ( FNiagaraParameterStore& ParameterStore
) const

   NiagaraEmitter.h  

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

   NiagaraEmitter.h  

void CacheFromShaderCompiled()

   NiagaraEmitter.h  

void ClearRuntimeAllocationEstimate ( uint64 ReportHandle
)

   NiagaraEmitter.h  

void CopyFrom ( const FVersionedNiagaraEmitterData& Source
)

   NiagaraEmitter.h  

bool DidPSOPrecacheFail()

   NiagaraEmitter.h  

void ForEachEnabledRenderer ( TAction Func
) const

   NiagaraEmitter.h  

void ForEachEnabledRendererWithIndex ( TAction Func
) const

   NiagaraEmitter.h  

void ForEachPlatformSet ( TAction Func
)

   NiagaraEmitter.h  

void ForEachRenderer ( TAction Func
) const

   NiagaraEmitter.h  

void ForEachScript ( TAction Func
) const

   NiagaraEmitter.h  

void GatherCompiledParticleAttributes ( TArray< FNiagaraVariableBase >& OutVariables
) const

   NiagaraEmitter.h  

void GatherStaticVariables ( TArray< FNiagaraVariable >& OutVars
) const

   NiagaraEmitter.h  

TConstArrayView< TSharedPtr< FNiagaraBoundsCalculator > > GetBoundsCalculators()

   NiagaraEmitter.h  

const FNiagaraEmitterScalabilityOverride & GetCurrentOverrideSettings()

   NiagaraEmitter.h  

const TCHAR * GetDebugSimName()

   NiagaraEmitter.h  

UNiagaraEditorDataBase * GetEditorData()

   NiagaraEmitter.h  

UNiagaraEditorParametersAdapterBase * GetEditorParameters()

   NiagaraEmitter.h  
Gets a pointer to an event handler by script usage id. NiagaraEmitter.h  

const TArray< FNiagaraEventScriptProperties > & GetEventHandlers()

   NiagaraEmitter.h  
  NiagaraEmitter.h  
  NiagaraEmitter.h  

uint32 GetMaxAllocationCount()

   NiagaraEmitter.h  

uint32 GetMaxInstanceCount()

   NiagaraEmitter.h  

int32 GetMaxParticleCountEstimate()

 Returns the number of max expected particles for memory allocations. NiagaraEmitter.h  
  NiagaraEmitter.h  

FVersionedNiagaraEmitter GetParentAtLastMerge()

   NiagaraEmitter.h  

const TArray< UNiagaraRendererProperties * > & GetRenderers()

   NiagaraEmitter.h  

const FNiagaraEmitterScalabilitySettings & GetScalabilitySettings()

   NiagaraEmitter.h  

UNiagaraScript * GetScript ( ENiagaraScriptUsage Usage,
FGuid UsageId
) const

   NiagaraEmitter.h  

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

   NiagaraEmitter.h  

FNiagaraSimStageExecutionDataPtr GetSimStageExcecutionData()

   NiagaraEmitter.h  

UNiagaraSimulationStageBase * GetSimulationStageById ( FGuid ScriptUsageId
) const

   NiagaraEmitter.h  

const TArray< UNiagaraSimulationStageBase * > & GetSimulationStages()

   NiagaraEmitter.h  

void InvalidateCompileResults()

   NiagaraEmitter.h  

bool IsAllowedByScalability()

 Returns true if this emitter's platform filter allows it on this platform and quality level. NiagaraEmitter.h  

bool IsAllowedToExecute()

   NiagaraEmitter.h  

bool IsEventGeneratorShared ( FName EventGeneratorId
) const

 Gets whether or not the supplied event generator id matches an event generator which is shared between the particle spawn and update scrips. NiagaraEmitter.h  

bool IsReadyToRun()

   NiagaraEmitter.h  

bool IsSynchronizedWithParent()

   NiagaraEmitter.h  

bool IsValid()

   NiagaraEmitter.h  

bool NeedsPartialDepthTexture()

   NiagaraEmitter.h  

void PostInitProperties ( UNiagaraEmitter* Outer
)

   NiagaraEmitter.h  

void PostLoad ( UNiagaraEmitter& Emitter,
int32 NiagaraVer
)

   NiagaraEmitter.h  

FGraphEventArray PrecacheComputePSOs ( const UNiagaraEmitter& NiagaraEmitter
)

   NiagaraEmitter.h  

void RebuildRendererBindings ( const UNiagaraEmitter& Emitter
)

   NiagaraEmitter.h  

void RemoveParent()

   NiagaraEmitter.h  

void Reparent ( const FVersionedNiagaraEmitter& InParent
)

   NiagaraEmitter.h  

bool RequiresPersistentIDs()

   NiagaraEmitter.h  

bool RequiresViewUniformBuffer()

   NiagaraEmitter.h  

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

   NiagaraEmitter.h  

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

   NiagaraEmitter.h  

bool UsesCollection ( const UNiagaraParameterCollection* Collection
) const

   NiagaraEmitter.h  

bool UsesEmitter ( const UNiagaraEmitter& InEmitter
) const

   NiagaraEmitter.h  

bool UsesInterpolatedSpawning()

   NiagaraEmitter.h  

bool UsesScript ( const UNiagaraScript* Script
) const

   NiagaraEmitter.h  

Static

Name Remarks Include Path Unreal Specifiers

static FBox GetDefaultFixedBounds()

   NiagaraEmitter.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bInterpolatedSpawning_DEPRECATED uint32   NiagaraEmitter.h
  • Meta=(DeprecatedProperty)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page