unreal.NiagaraEventHandlerAddAction
¶
- class unreal.NiagaraEventHandlerAddAction(mode=NiagaraEventHandlerAddMode.ADD_EVENT, add_event_generator_options=['None', ['None', 'None', 'None', 'None', 'None']], execution_mode=ScriptExecutionMode.EVERY_PARTICLE, spawn_number=0, max_events_per_frame=0, source_event_name='None', random_spawn_number=False, min_spawn_number=0)¶
Bases:
unreal.StructBase
Niagara Event Handler Add Action
C++ Source:
Plugin: CascadeToNiagaraConverter
Module: CascadeToNiagaraConverter
File: NiagaraStackGraphUtilitiesAdapterLibrary.h
Editor Properties: (see get_editor_property/set_editor_property)
add_event_generator_options
(NiagaraAddEventGeneratorOptions): [Read-Write] Add Event Generator Optionsexecution_mode
(ScriptExecutionMode): [Read-Write] Execution Mode: Controls which particles have the event script run on them.max_events_per_frame
(int32): [Read-Write] Max Events Per Frame: Controls how many events are consumed by this event handler. If there are more events generated than this value, they will be ignored.min_spawn_number
(int32): [Read-Write] Min Spawn Number: The minimum spawn number when random spawn is used. Spawn Number is used as the maximum range.mode
(NiagaraEventHandlerAddMode): [Read-Write] Moderandom_spawn_number
(bool): [Read-Write] Random Spawn Number: Whether using a random spawn number.source_event_name
(Name): [Read-Write] Source Event Name: 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.spawn_number
(int32): [Read-Write] Spawn Number: 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.
- property add_event_generator_options¶
[Read-Write] Add Event Generator Options
- property execution_mode¶
[Read-Write] Execution Mode: Controls which particles have the event script run on them.
- Type
- property max_events_per_frame¶
[Read-Write] Max Events Per Frame: Controls how many events are consumed by this event handler. If there are more events generated than this value, they will be ignored.
- Type
(int32)
- property min_spawn_number¶
[Read-Write] Min Spawn Number: The minimum spawn number when random spawn is used. Spawn Number is used as the maximum range.
- Type
(int32)
- property mode¶
[Read-Write] Mode
- Type
- property random_spawn_number¶
[Read-Write] Random Spawn Number: Whether using a random spawn number.
- Type
(bool)
- property source_event_name¶
[Read-Write] Source Event Name: 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.
- Type
(Name)
- property spawn_number¶
[Read-Write] Spawn Number: 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.
- Type
(int32)