unreal.NiagaraEmitter

class unreal.NiagaraEmitter(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Niagara Emitters are particle spawners that can be reused for different effects by putting them into Niagara Systems. Emitters render their particles using different renderers, such as Sprite Renderers or Mesh Renderers to produce different effects.

C++ Source:

• Plugin: Niagara

• Module: Niagara

• File: NiagaraEmitter.h

Editor Properties: (see get_editor_property/set_editor_property)

• allocation_mode (ParticleAllocationMode): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘AllocationMode’ is deprecated.

• attributes_to_preserve (Array[str]): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘AttributesToPreserve’ is deprecated.

• category (Text): [Read-Write] Category to collate this emitter into for “add new emitter” dialogs.

• determinism (bool): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bDeterminism’ is deprecated.

• editor_data (NiagaraEditorDataBase): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EditorData’ is deprecated.

• editor_parameters (NiagaraEditorParametersAdapterBase): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EditorParameters’ is deprecated.

• emitter_spawn_script_props (NiagaraEmitterScriptProperties): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EmitterSpawnScriptProps’ is deprecated.

• emitter_update_script_props (NiagaraEmitterScriptProperties): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EmitterUpdateScriptProps’ is deprecated.

• event_handler_script_props (Array[NiagaraEventScriptProperties]): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EventHandlerScriptProps’ is deprecated.

• gpu_compute_script (NiagaraScript): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘GPUComputeScript’ is deprecated.

• graph_source (NiagaraScriptSourceBase): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘GraphSource’ is deprecated.

• interpolated_spawning (bool): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bInterpolatedSpawning’ is deprecated.

• library_visibility (NiagaraScriptLibraryVisibility): [Read-Write] If this emitter is exposed to the library, or should be explicitly hidden.

• local_space (bool): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bLocalSpace’ is deprecated.

• max_gpu_particles_spawn_per_frame (uint32): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘MaxGPUParticlesSpawnPerFrame’ is deprecated.

• parent (NiagaraEmitter): [Read-Write] deprecated: Property ‘Parent’ is deprecated.

• parent_at_last_merge (NiagaraEmitter): [Read-Write] deprecated: Property ‘ParentAtLastMerge’ is deprecated.

• parent_scratch_pad_scripts (Array[NiagaraScript]): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ParentScratchPadScripts’ is deprecated.

• platforms (NiagaraPlatformSet): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘Platforms’ is deprecated.

• pre_allocation_count (int32): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘PreAllocationCount’ is deprecated.

• random_seed (int32): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘RandomSeed’ is deprecated.

• renderer_bindings (NiagaraParameterStore): [Read-Write] deprecated: Property ‘RendererBindings’ is deprecated.

• renderer_properties (Array[NiagaraRendererProperties]): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘RendererProperties’ is deprecated.

• requires_persistent_i_ds (bool): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bRequiresPersistentIDs’ is deprecated.

• scalability_overrides (NiagaraEmitterScalabilityOverrides): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ScalabilityOverrides’ is deprecated.

• scratch_pad_scripts (Array[NiagaraScript]): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ScratchPadScripts’ is deprecated.

• shared_event_generator_ids (Array[Name]): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SharedEventGeneratorIds’ is deprecated.

• sim_target (NiagaraSimTarget): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SimTarget’ is deprecated.

• simulation_stages (Array[NiagaraSimulationStageBase]): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SimulationStages’ is deprecated.

• spawn_script_props (NiagaraEmitterScriptProperties): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SpawnScriptProps’ is deprecated.

• template_asset_description (Text): [Read-Write]

• template_specification (NiagaraScriptTemplateSpecification): [Read-Write]

• update_script_props (NiagaraEmitterScriptProperties): [Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘UpdateScriptProps’ is deprecated.

property allocation_mode: ParticleAllocationMode

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘AllocationMode’ is deprecated.

Type:

(ParticleAllocationMode)

property attributes_to_preserve: None

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘AttributesToPreserve’ is deprecated.

Type:

(Array[str])

property determinism: bool

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bDeterminism’ is deprecated.

Type:

(bool)

property editor_data: NiagaraEditorDataBase

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EditorData’ is deprecated.

Type:

(NiagaraEditorDataBase)

property editor_parameters: NiagaraEditorParametersAdapterBase

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EditorParameters’ is deprecated.

Type:

(NiagaraEditorParametersAdapterBase)

property emitter_spawn_script_props: NiagaraEmitterScriptProperties

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EmitterSpawnScriptProps’ is deprecated.

Type:

(NiagaraEmitterScriptProperties)

property emitter_update_script_props: NiagaraEmitterScriptProperties

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EmitterUpdateScriptProps’ is deprecated.

Type:

(NiagaraEmitterScriptProperties)

property event_handler_script_props: None

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EventHandlerScriptProps’ is deprecated.

Type:

(Array[NiagaraEventScriptProperties])

property gpu_compute_script: NiagaraScript

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘GPUComputeScript’ is deprecated.

Type:

(NiagaraScript)

property graph_source: NiagaraScriptSourceBase

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘GraphSource’ is deprecated.

Type:

(NiagaraScriptSourceBase)

property interpolated_spawning: bool

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bInterpolatedSpawning’ is deprecated.

Type:

(bool)

property local_space: bool

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bLocalSpace’ is deprecated.

Type:

(bool)

property max_gpu_particles_spawn_per_frame: int

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘MaxGPUParticlesSpawnPerFrame’ is deprecated.

Type:

(uint32)

property parent: NiagaraEmitter

[Read-Write] deprecated: Property ‘Parent’ is deprecated.

Type:

(NiagaraEmitter)

property parent_at_last_merge: NiagaraEmitter

[Read-Write] deprecated: Property ‘ParentAtLastMerge’ is deprecated.

Type:

(NiagaraEmitter)

property parent_scratch_pad_scripts: None

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ParentScratchPadScripts’ is deprecated.

Type:

(Array[NiagaraScript])

property platforms: NiagaraPlatformSet

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘Platforms’ is deprecated.

Type:

(NiagaraPlatformSet)

property pre_allocation_count: int

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘PreAllocationCount’ is deprecated.

Type:

(int32)

property random_seed: int

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘RandomSeed’ is deprecated.

Type:

(int32)

property renderer_bindings: NiagaraParameterStore

[Read-Write] deprecated: Property ‘RendererBindings’ is deprecated.

Type:

(NiagaraParameterStore)

property renderer_properties: None

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘RendererProperties’ is deprecated.

Type:

(Array[NiagaraRendererProperties])

property requires_persistent_i_ds: bool

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bRequiresPersistentIDs’ is deprecated.

Type:

(bool)

property scalability_overrides: NiagaraEmitterScalabilityOverrides

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ScalabilityOverrides’ is deprecated.

Type:

(NiagaraEmitterScalabilityOverrides)

property scratch_pad_scripts: None

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ScratchPadScripts’ is deprecated.

Type:

(Array[NiagaraScript])

property shared_event_generator_ids: None

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SharedEventGeneratorIds’ is deprecated.

Type:

(Array[Name])

property sim_target: NiagaraSimTarget

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SimTarget’ is deprecated.

Type:

(NiagaraSimTarget)

property simulation_stages: None

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SimulationStages’ is deprecated.

Type:

(Array[NiagaraSimulationStageBase])

property spawn_script_props: NiagaraEmitterScriptProperties

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SpawnScriptProps’ is deprecated.

Type:

(NiagaraEmitterScriptProperties)

property update_script_props: NiagaraEmitterScriptProperties

[Read-Write] Use property in struct returned from GetEmitterData() instead deprecated: Property ‘UpdateScriptProps’ is deprecated.

Type:

(NiagaraEmitterScriptProperties)