FNiagaraEventScriptProperties Struct Reference

Public Member Functions
Functions
FNiagaraEventScriptProperties &	opAssign (FNiagaraEventScriptProperties Other)

Public Attributes
Event Handler Options
uint	SpawnNumber
	Controls whether or not particles are spawned as a result of handling the event. Only valid for EScriptExecutionMode::SpawnedParticles. If Random Spawn Number is used, this will act as the maximum spawn range.
uint	MaxEventsPerFrame
	Controls how many events are consumed by this event handler. If there are more events generated than this value, they will be ignored.
FGuid	SourceEmitterID
	Id of the Emitter Handle that generated the event. If all zeroes, the event generator is assumed to be this emitter.
FName	SourceEventName
	The name of the event generated. This will be "Collision" for collision events and the Event Name field on the DataSetWrite node in the module graph for others.
bool	bRandomSpawnNumber
	Whether using a random spawn number.
uint	MinSpawnNumber
	The minimum spawn number when random spawn is used. Spawn Number is used as the maximum range.
bool	UpdateAttributeInitialValues
	Should Event Spawn Scripts modify the Initial values for particle attributes they modify.
EScriptExecutionMode	ExecutionMode
	Controls which particles have the event script run on them.

Member Function Documentation

opAssign()

FNiagaraEventScriptProperties & opAssign

(

FNiagaraEventScriptProperties

Other

)

Member Data Documentation

bRandomSpawnNumber

bool bRandomSpawnNumber

Whether using a random spawn number.

ExecutionMode

EScriptExecutionMode ExecutionMode

Controls which particles have the event script run on them.

MaxEventsPerFrame

uint MaxEventsPerFrame

Controls how many events are consumed by this event handler. If there are more events generated than this value, they will be ignored.

MinSpawnNumber

uint MinSpawnNumber

The minimum spawn number when random spawn is used. Spawn Number is used as the maximum range.

SourceEmitterID

FGuid SourceEmitterID

Id of the Emitter Handle that generated the event. If all zeroes, the event generator is assumed to be this emitter.

SourceEventName

FName SourceEventName

The name of the event generated. This will be "Collision" for collision events and the Event Name field on the DataSetWrite node in the module graph for others.

SpawnNumber

uint SpawnNumber

Controls whether or not particles are spawned as a result of handling the event. Only valid for EScriptExecutionMode::SpawnedParticles. If Random Spawn Number is used, this will act as the maximum spawn range.

UpdateAttributeInitialValues

bool UpdateAttributeInitialValues

Should Event Spawn Scripts modify the Initial values for particle attributes they modify.