FVersionedNiagaraEmitterData Struct Reference

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

Public Member Functions
Functions
bool	GetbInterpolatedSpawning () const
	When enabled, this will spawn using interpolated parameter values and perform a partial update at spawn time. This adds significant additional cost for spawning but will produce much smoother spawning for high spawn rates, erratic frame rates and fast moving emitters.
void	SetbInterpolatedSpawning (bool Value)
	When enabled, this will spawn using interpolated parameter values and perform a partial update at spawn time. This adds significant additional cost for spawning but will produce much smoother spawning for high spawn rates, erratic frame rates and fast moving emitters.
bool	GetbRequiresPersistentIDs () const
	Creates a stable Identifier (Particles.ID) which does not vary from frame to frame. This comes at a small memory and performance cost. This allows external objects to track the same particle over multiple frames. Particle arrays are tightly packed and a particle's actual index in the array may change from frame to frame. This optionally lets you use a lookup table to track a particle by index in the lookup table.
void	SetbRequiresPersistentIDs (bool Value)
	Creates a stable Identifier (Particles.ID) which does not vary from frame to frame. This comes at a small memory and performance cost. This allows external objects to track the same particle over multiple frames. Particle arrays are tightly packed and a particle's actual index in the array may change from frame to frame. This optionally lets you use a lookup table to track a particle by index in the lookup table.
FVersionedNiagaraEmitterData &	opAssign (FVersionedNiagaraEmitterData Other)

Public Attributes
Asset Options
ENiagaraEmitterDefaultSummaryState	AddEmitterDefaultViewState
	This determines how emitters will be added to a system by default. If summary view is setup, consider setting this to 'Summary'.
Emitter
int	RandomSeed
	An emitter-based seed for the deterministic random number generator.
ENiagaraSimTarget	SimTarget
ENiagaraEmitterCalculateBoundMode	CalculateBoundsMode
	How should we calculate bounds for the emitter. Note: If this is greyed out it means fixed bounds are enabled in the System Properties and these bounds are therefore ignored.
FBox	FixedBounds
	The fixed bounding box value. CalculateBoundsMode is the condition whether the fixed bounds can be edited. Note: If this is greyed out it means fixed bounds are enabled in the System Properties and these bounds are therefore ignored.
bool	bDeterminism
	Toggles whether to globally make the random number generator be deterministic or non-deterministic. Any random calculation that is set to the emitter defaults will inherit this value. It is still possible to tweak individual random to be deterministic or not. In this case deterministic means that it will return the same results for the same configuration of the emitter as long as delta time is not variable. Any changes to the emitter's individual scripts will adjust the results.
int	MaxGPUParticlesSpawnPerFrame
	An override on the max number of GPU particles we expect to spawn in a single frame. A value of 0 means it'll use fx.MaxNiagaraGPUParticlesSpawnPerFrame.
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. Used in conjunction with UNiagaraSystem::bTrimAttributes.
bool	bLocalSpace
	Toggles whether or not the particles within this emitter are relative to the emitter origin or in global space.
EParticleAllocationMode	AllocationMode
	The emitter needs to allocate memory for the particles each tick. To prevent reallocations, the emitter should allocate as much memory as is needed for the max particle count. This setting controls if the allocation size should be automatically determined or manually entered.
int	PreAllocationCount
	The emitter will allocate at least this many particles on it's first tick. This can aid performance by avoiding many allocations as an emitter ramps up to it's max size.
TArray< FNiagaraSimStageExecutionLoopEditorData >	SimStageExecutionLoopEditorData
Scalability
FNiagaraPlatformSet	Platforms
FNiagaraEmitterScalabilityOverrides	ScalabilityOverrides
Variables
bool	bRequiresPersistentIDs
bool	bInterpolatedSpawning

Detailed Description

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

Member Function Documentation

GetbInterpolatedSpawning()

bool GetbInterpolatedSpawning

(

)

const

When enabled, this will spawn using interpolated parameter values and perform a partial update at spawn time. This adds significant additional cost for spawning but will produce much smoother spawning for high spawn rates, erratic frame rates and fast moving emitters.

GetbRequiresPersistentIDs()

bool GetbRequiresPersistentIDs

(

)

const

Creates a stable Identifier (Particles.ID) which does not vary from frame to frame. This comes at a small memory and performance cost. This allows external objects to track the same particle over multiple frames. Particle arrays are tightly packed and a particle's actual index in the array may change from frame to frame. This optionally lets you use a lookup table to track a particle by index in the lookup table.

opAssign()

FVersionedNiagaraEmitterData & opAssign

(

FVersionedNiagaraEmitterData

Other

)

SetbInterpolatedSpawning()

void SetbInterpolatedSpawning

(

bool

Value

)

When enabled, this will spawn using interpolated parameter values and perform a partial update at spawn time. This adds significant additional cost for spawning but will produce much smoother spawning for high spawn rates, erratic frame rates and fast moving emitters.

SetbRequiresPersistentIDs()

void SetbRequiresPersistentIDs

(

bool

Value

)

Creates a stable Identifier (Particles.ID) which does not vary from frame to frame. This comes at a small memory and performance cost. This allows external objects to track the same particle over multiple frames. Particle arrays are tightly packed and a particle's actual index in the array may change from frame to frame. This optionally lets you use a lookup table to track a particle by index in the lookup table.

Member Data Documentation

AddEmitterDefaultViewState

ENiagaraEmitterDefaultSummaryState AddEmitterDefaultViewState

This determines how emitters will be added to a system by default. If summary view is setup, consider setting this to 'Summary'.

AllocationMode

EParticleAllocationMode AllocationMode

The emitter needs to allocate memory for the particles each tick. To prevent reallocations, the emitter should allocate as much memory as is needed for the max particle count. This setting controls if the allocation size should be automatically determined or manually entered.

AttributesToPreserve

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. Used in conjunction with UNiagaraSystem::bTrimAttributes.

bDeterminism

bool bDeterminism

Toggles whether to globally make the random number generator be deterministic or non-deterministic. Any random calculation that is set to the emitter defaults will inherit this value. It is still possible to tweak individual random to be deterministic or not. In this case deterministic means that it will return the same results for the same configuration of the emitter as long as delta time is not variable. Any changes to the emitter's individual scripts will adjust the results.

bInterpolatedSpawning

bool bInterpolatedSpawning

bLocalSpace

bool bLocalSpace

Toggles whether or not the particles within this emitter are relative to the emitter origin or in global space.

bRequiresPersistentIDs

bool bRequiresPersistentIDs

CalculateBoundsMode

ENiagaraEmitterCalculateBoundMode CalculateBoundsMode

How should we calculate bounds for the emitter. Note: If this is greyed out it means fixed bounds are enabled in the System Properties and these bounds are therefore ignored.

FixedBounds

FBox FixedBounds

The fixed bounding box value. CalculateBoundsMode is the condition whether the fixed bounds can be edited. Note: If this is greyed out it means fixed bounds are enabled in the System Properties and these bounds are therefore ignored.

MaxGPUParticlesSpawnPerFrame

int MaxGPUParticlesSpawnPerFrame

An override on the max number of GPU particles we expect to spawn in a single frame. A value of 0 means it'll use fx.MaxNiagaraGPUParticlesSpawnPerFrame.

Platforms

FNiagaraPlatformSet Platforms

PreAllocationCount

int PreAllocationCount

The emitter will allocate at least this many particles on it's first tick. This can aid performance by avoiding many allocations as an emitter ramps up to it's max size.

RandomSeed

int RandomSeed

An emitter-based seed for the deterministic random number generator.

ScalabilityOverrides

FNiagaraEmitterScalabilityOverrides ScalabilityOverrides

SimStageExecutionLoopEditorData

TArray<FNiagaraSimStageExecutionLoopEditorData> SimStageExecutionLoopEditorData

SimTarget

ENiagaraSimTarget SimTarget