unreal.NiagaraEmitter
¶
- class unreal.NiagaraEmitter(outer: Optional[Object] = None, name: Union[Name, str] = 'None')¶
Bases:
Object
UNiagaraEmitter stores the attributes of an FNiagaraEmitterInstance that need to be serialized and are used for its initialization
C++ Source:
Plugin: Niagara
Module: Niagara
File: NiagaraEmitter.h
Editor Properties: (see get_editor_property/set_editor_property)
allocation_mode
(ParticleAllocationMode): [Read-Write] Allocation Mode: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘AllocationMode’ is deprecated.attributes_to_preserve
(Array[str]): [Read-Write] Attributes to Preserve: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘AttributesToPreserve’ is deprecated.category
(Text): [Read-Write] Category: Category to collate this emitter into for “add new emitter” dialogs.combine_event_spawn
(bool): [Read-Write] Combine Event Spawn: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bCombineEventSpawn’ is deprecated.determinism
(bool): [Read-Write] Determinism: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bDeterminism’ is deprecated.editor_data
(NiagaraEditorDataBase): [Read-Write] Editor Data: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EditorData’ is deprecated.editor_parameters
(NiagaraEditorParametersAdapterBase): [Read-Write] Editor Parameters: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EditorParameters’ is deprecated.emitter_spawn_script_props
(NiagaraEmitterScriptProperties): [Read-Write] Emitter Spawn Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EmitterSpawnScriptProps’ is deprecated.emitter_update_script_props
(NiagaraEmitterScriptProperties): [Read-Write] Emitter Update Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EmitterUpdateScriptProps’ is deprecated.event_handler_script_props
(Array[NiagaraEventScriptProperties]): [Read-Write] Event Handler Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EventHandlerScriptProps’ is deprecated.gpu_compute_script
(NiagaraScript): [Read-Write] GPUCompute Script: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘GPUComputeScript’ is deprecated.graph_source
(NiagaraScriptSourceBase): [Read-Write] Graph Source: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘GraphSource’ is deprecated.interpolated_spawning
(bool): [Read-Write] Interpolated Spawning: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bInterpolatedSpawning’ is deprecated.library_visibility
(NiagaraScriptLibraryVisibility): [Read-Write] Library Visibility: If this emitter is exposed to the library, or should be explicitly hidden.limit_delta_time
(bool): [Read-Write] Limit Delta Time: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bLimitDeltaTime’ is deprecated.local_space
(bool): [Read-Write] Local Space: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bLocalSpace’ is deprecated.max_delta_time_per_tick
(float): [Read-Write] Max Delta Time Per Tick: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘MaxDeltaTimePerTick’ is deprecated.max_gpu_particles_spawn_per_frame
(uint32): [Read-Write] Max GPUParticles Spawn Per Frame: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘MaxGPUParticlesSpawnPerFrame’ is deprecated.parent
(NiagaraEmitter): [Read-Write] Parent deprecated: Property ‘Parent’ is deprecated.parent_at_last_merge
(NiagaraEmitter): [Read-Write] Parent at Last Merge deprecated: Property ‘ParentAtLastMerge’ is deprecated.parent_scratch_pad_scripts
(Array[NiagaraScript]): [Read-Write] Parent Scratch Pad Scripts: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ParentScratchPadScripts’ is deprecated.platforms
(NiagaraPlatformSet): [Read-Write] Platforms: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘Platforms’ is deprecated.pre_allocation_count
(int32): [Read-Write] Pre Allocation Count: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘PreAllocationCount’ is deprecated.random_seed
(int32): [Read-Write] Random Seed: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘RandomSeed’ is deprecated.renderer_bindings
(NiagaraParameterStore): [Read-Write] Renderer Bindings deprecated: Property ‘RendererBindings’ is deprecated.renderer_properties
(Array[NiagaraRendererProperties]): [Read-Write] Renderer Properties: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘RendererProperties’ is deprecated.requires_persistent_i_ds
(bool): [Read-Write] Requires Persistent IDs: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bRequiresPersistentIDs’ is deprecated.scalability_overrides
(NiagaraEmitterScalabilityOverrides): [Read-Write] Scalability Overrides: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ScalabilityOverrides’ is deprecated.scratch_pad_scripts
(Array[NiagaraScript]): [Read-Write] Scratch Pad Scripts: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ScratchPadScripts’ is deprecated.shared_event_generator_ids
(Array[Name]): [Read-Write] Shared Event Generator Ids: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SharedEventGeneratorIds’ is deprecated.sim_target
(NiagaraSimTarget): [Read-Write] Sim Target: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SimTarget’ is deprecated.simulation_stages
(Array[NiagaraSimulationStageBase]): [Read-Write] Simulation Stages: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SimulationStages’ is deprecated.spawn_script_props
(NiagaraEmitterScriptProperties): [Read-Write] Spawn Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SpawnScriptProps’ is deprecated.template_asset_description
(Text): [Read-Write] Template Asset Descriptiontemplate_specification
(NiagaraScriptTemplateSpecification): [Read-Write] Template Specificationupdate_script_props
(NiagaraEmitterScriptProperties): [Read-Write] Update Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘UpdateScriptProps’ is deprecated.
- property allocation_mode: ParticleAllocationMode¶
[Read-Write] Allocation Mode: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘AllocationMode’ is deprecated.
- Type:
- property attributes_to_preserve: Array[str]¶
[Read-Write] Attributes to Preserve: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘AttributesToPreserve’ is deprecated.
- property combine_event_spawn: bool¶
[Read-Write] Combine Event Spawn: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bCombineEventSpawn’ is deprecated.
- Type:
(bool)
- property determinism: bool¶
[Read-Write] Determinism: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bDeterminism’ is deprecated.
- Type:
(bool)
- property editor_data: NiagaraEditorDataBase¶
[Read-Write] Editor Data: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EditorData’ is deprecated.
- Type:
- property editor_parameters: NiagaraEditorParametersAdapterBase¶
[Read-Write] Editor Parameters: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EditorParameters’ is deprecated.
- property emitter_spawn_script_props: NiagaraEmitterScriptProperties¶
[Read-Write] Emitter Spawn Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EmitterSpawnScriptProps’ is deprecated.
- Type:
- property emitter_update_script_props: NiagaraEmitterScriptProperties¶
[Read-Write] Emitter Update Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EmitterUpdateScriptProps’ is deprecated.
- Type:
- property event_handler_script_props: Array[NiagaraEventScriptProperties]¶
[Read-Write] Event Handler Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘EventHandlerScriptProps’ is deprecated.
- Type:
- property gpu_compute_script: NiagaraScript¶
[Read-Write] GPUCompute Script: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘GPUComputeScript’ is deprecated.
- Type:
- property graph_source: NiagaraScriptSourceBase¶
[Read-Write] Graph Source: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘GraphSource’ is deprecated.
- Type:
- property interpolated_spawning: bool¶
[Read-Write] Interpolated Spawning: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bInterpolatedSpawning’ is deprecated.
- Type:
(bool)
- property limit_delta_time: bool¶
[Read-Write] Limit Delta Time: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bLimitDeltaTime’ is deprecated.
- Type:
(bool)
- property local_space: bool¶
[Read-Write] Local Space: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bLocalSpace’ is deprecated.
- Type:
(bool)
- property max_delta_time_per_tick: float¶
[Read-Write] Max Delta Time Per Tick: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘MaxDeltaTimePerTick’ is deprecated.
- Type:
(float)
- property max_gpu_particles_spawn_per_frame: int¶
[Read-Write] Max GPUParticles Spawn Per Frame: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘MaxGPUParticlesSpawnPerFrame’ is deprecated.
- Type:
(uint32)
- property parent: NiagaraEmitter¶
[Read-Write] Parent deprecated: Property ‘Parent’ is deprecated.
- Type:
- property parent_at_last_merge: NiagaraEmitter¶
[Read-Write] Parent at Last Merge deprecated: Property ‘ParentAtLastMerge’ is deprecated.
- Type:
- property parent_scratch_pad_scripts: Array[NiagaraScript]¶
[Read-Write] Parent Scratch Pad Scripts: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ParentScratchPadScripts’ is deprecated.
- Type:
- property platforms: NiagaraPlatformSet¶
[Read-Write] Platforms: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘Platforms’ is deprecated.
- Type:
- property pre_allocation_count: int¶
[Read-Write] Pre Allocation Count: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘PreAllocationCount’ is deprecated.
- Type:
(int32)
- property random_seed: int¶
[Read-Write] Random Seed: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘RandomSeed’ is deprecated.
- Type:
(int32)
- property renderer_bindings: NiagaraParameterStore¶
[Read-Write] Renderer Bindings deprecated: Property ‘RendererBindings’ is deprecated.
- Type:
- property renderer_properties: Array[NiagaraRendererProperties]¶
[Read-Write] Renderer Properties: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘RendererProperties’ is deprecated.
- Type:
- property requires_persistent_i_ds: bool¶
[Read-Write] Requires Persistent IDs: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘bRequiresPersistentIDs’ is deprecated.
- Type:
(bool)
- property scalability_overrides: NiagaraEmitterScalabilityOverrides¶
[Read-Write] Scalability Overrides: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ScalabilityOverrides’ is deprecated.
- property scratch_pad_scripts: Array[NiagaraScript]¶
[Read-Write] Scratch Pad Scripts: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘ScratchPadScripts’ is deprecated.
- Type:
[Read-Write] Shared Event Generator Ids: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SharedEventGeneratorIds’ is deprecated.
- property sim_target: NiagaraSimTarget¶
[Read-Write] Sim Target: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SimTarget’ is deprecated.
- Type:
- property simulation_stages: Array[NiagaraSimulationStageBase]¶
[Read-Write] Simulation Stages: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SimulationStages’ is deprecated.
- Type:
- property spawn_script_props: NiagaraEmitterScriptProperties¶
[Read-Write] Spawn Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘SpawnScriptProps’ is deprecated.
- Type:
- property update_script_props: NiagaraEmitterScriptProperties¶
[Read-Write] Update Script Props: Use property in struct returned from GetEmitterData() instead deprecated: Property ‘UpdateScriptProps’ is deprecated.
- Type: