Skip to main content

niagara kit

330 tools. Generated from the plugin source; do not edit by hand.

Guide​

The niagara kit edits Niagara systems, emitters, stack modules, renderers, user parameters, parameter collections and effect types, drives Niagara components in the level and in PIE, and runs audits, finders and batch edits over folders. It is loaded only when the Niagara plugin is enabled and supports UE 4.27 and 5.x; tools that need a newer engine are hidden (minEngine in annotations.uea).

Start here​

niagara.create {"folder":"/Game/FX","name":"NS_Sparks"}
niagara.add_emitter {"system":"/Game/FX/NS_Sparks","emitterAsset":"Fountain","name":"Sparks"}
niagara.add_user_parameters {"system":"/Game/FX/NS_Sparks","parameters":["SpawnRate:float=50","Tint:color=(R=1,G=0.5,B=0,A=1)"]}
niagara.set_sprite_renderer {"system":"/Game/FX/NS_Sparks","emitter":"Sparks","values":["Material=/Game/FX/M_Spark","Alignment=VelocityAligned","SortMode=ViewDepth"]}
niagara.set_renderer_binding {"system":"/Game/FX/NS_Sparks","emitter":"Sparks","renderer":"0","binding":"ColorBinding","attribute":"Particles.Color"}
niagara.compile {"system":"/Game/FX/NS_Sparks"}
niagara.wait_compile {"system":"/Game/FX/NS_Sparks"}
niagara.validate_renderers {"system":"/Game/FX/NS_Sparks"}
niagara.spawn_actor {"system":"/Game/FX/NS_Sparks","actor":"SparksFX","location":{"x":0,"y":0,"z":100}}
niagara.capture_component_state {"actor":"SparksFX"}

emitterAsset accepts an asset path or a template name from /Niagara/DefaultAssets/Templates/Emitters (Fountain, DirectionalBurst, LocationBasedRibbon, HangingParticulates, SimpleSpriteBurst, UpwardMeshBurst... on both engines).

Addressing​

ArgumentForm
systemasset path (/Game/FX/NS_Sparks) or a unique asset name
emitteremitter handle name or index inside the system
rendererindex from list_renderers, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind; several are an error that lists the indices, never a pick. The typed *_<kind>_renderer tools accept an empty renderer with the same rule.
user parameter nameSpawnRate or User.SpawnRate
collection parameter namefriendly name (Wind) or the full NPC.<Namespace>.Wind
actor / name (components)actor label; name is the Niagara component name and may be omitted when the actor owns one

Every mutator records its transaction and marks the asset dirty; renderer and emitter mutators request compilation. Replies carry the resolved objects (paths, indices, types) so a second read is rarely needed.

Systems​

Start with niagara.create_from_template (SimpleExplosion, RadialBurst, DirectionalBurst) or a recipe: recipe_fountain, recipe_burst (variant omni|directional|sprite|mesh), recipe_beam (dynamic|static), recipe_ribbon, recipe_smoke (2 s warmup, fixed bounds), recipe_sparks (Sparks + Embers handles). The gpu, localSpace and boundsExtent options apply to every recipe; ribbons and beams are CPU only. niagara.list finds systems (GPU flag, effect type).

  • create, duplicate, rename (same name is a no-op), delete, save, get, list_emitters, list_templates, export_summary, get_stats, validate.
  • compile requests compilation; get_compile_status polls; wait_compile waits until the VM scripts are compiled and fails if compilation is still pending.
  • Read before editing: get_properties, get_system_simulation, get_system_metadata, get_scalability, get_effect_type.
  • set_properties writes any reflected UNiagaraSystem property from Unreal text; typed controls (set_warmup, set_fixed_bounds, set_determinism...) wrap it. Grouped setters change only the fields you pass (strings; empty = unchanged; "default" clears a rendering override): set_system_simulation (warmup; determinism, seed and fixed tick need 5.0+), set_system_rendering (5.0+), set_system_performance, set_system_metadata.
  • Scalability: add/set/remove_scalability_override on the system (quality levels "Low,High" or "all"; distance and instance fields turn their override flags on). On the effect type: set_effect_type_settings (update frequency, cull reaction), add/set/remove_effect_type_scalability, add/remove_effect_type_emitter_scalability (spawn-count scale).
  • Effect types: create_effect_type, then set_effect_type; set_system_cull_reaction and set_system_significance_handler edit the effect type assigned to the system.
  • Compile loop: niagara.compile → niagara.wait_compile → niagara.get_compile_errors / niagara.validate (typed issues with the fixing tool) → list_system_scripts / get_script_source.
  • Compare and move: diff_system A B. export_recipe (optional absolute .json file) then import_recipe (inline recipe or file) rebuilds a system from emitter source assets, property overrides and user parameters; emitters without a parent asset are listed under skipped.

Emitters​

Every emitter argument takes a handle name, an index or the handle id GUID; prefer the id from handles[] because indices change after niagara.reorder_emitter. Handles are addressed by name or index: add_emitter, duplicate_emitter, rename_emitter, remove_emitter, set_emitter_enabled, set_emitter_isolated, get_emitter, set_emitter_properties and its typed controls, event handlers and simulation stages. Typed groups: get/set_emitter_simulation (cpu/gpu, local space, determinism, seed, interpolated spawn), get/set_emitter_allocation, get/set_emitter_bounds (dynamic, fixed, or programmable on 5.1+, plus a min/max box), get/set_emitter_lifecycle (Emitter State Loop Duration/Delay/Count; linked or dynamic inputs are reported as not found). Scalability: get_emitter_scalability, set_emitter_platforms, add/remove_emitter_scalability_override.

Events: list_event_generators; add_event_handler creates an empty event stack (source emitter, event name, execution mode, spawn number), then add modules with the module tools on event:<usageId>.

Inheritance: get_emitter_inheritance, set_emitter_parent (reparent + merge), sync_emitter_with_parent, remove_emitter_parent; on 5.1+ set_emitter_parent_version, and on standalone emitter assets enable/add/expose/delete/list_emitter_versions (versions as GUID or "1.1"; 1.0 and the exposed version cannot be deleted). Inspect: list_emitter_attributes (after compile), diff_emitter, get_emitter_asset, set_emitter_asset_metadata.

Gotchas: every emitter mutation requests a compile — call wait_compile before reading compiled data. 4.27 has no emitter versions, system determinism or rendering overrides. get_dependencies reflects saved packages only.

Renderers​

Kinds and schema. list_renderer_fields {"kind":"mesh"} returns the settable fields of a kind with their types (bool, int, float, enum:<Enum>, object:<Class>, class:<Base>, struct:<Struct>) and the kind's attribute bindings. The schema holds the fields present on UE 4.27 and 5.x; the decal kind exists on UE 5.2+.

Kindget / setTypical fields
spriteget_sprite_renderer / set_sprite_rendererMaterial, Alignment, FacingMode, SortMode, PivotInUVSpace, SubImageSize, bSubImageBlend, cutout, camera-distance culling, RendererVisibility
meshget_mesh_renderer / set_mesh_rendererFacingMode, SortMode, locked axis, frustum/camera culling, flipbook, bOverrideMaterials
ribbonget_ribbon_renderer / set_ribbon_rendererMaterial, FacingMode, UV0Settings/UV1Settings, Shape, MultiPlaneCount, TubeSubdivisions, tessellation
lightget_light_renderer / set_light_rendererRadiusScale, DefaultExponent, ColorAdd, falloff and translucency flags
componentget_component_renderer / set_component_rendererComponentType (class), ComponentCountLimit, bAssignComponentsOnParticleID
decal (5.2+)get_decal_renderer / set_decal_rendererMaterial, SourceMode, DecalScreenSizeFade

Every kind also accepts bIsEnabled, SortOrderHint and MotionVectorSetting. A setter takes values: ["Field=Value", ...]; every entry is checked against the schema before anything is written, object fields take asset paths (None clears), class fields take class names. addIfMissing: true creates the renderer when the emitter has none of that kind (upsert). The reply lists every field with its new value and changed[].

Structure. add_renderer (one kind or a comma list), remove_renderer, duplicate_renderer (same or targetEmitter), reorder_renderer (newIndex, UE 5.2+), set_renderer_enabled, set_renderer_material (sprite, ribbon, decal), set_renderer_sort_order, get_renderer, list_renderers.

Meshes and material overrides (mesh renderers): list_renderer_meshes, add_renderer_mesh (mesh, optional scale, pivotOffset), set_renderer_mesh (index; empty fields keep their value), remove_renderer_mesh, set_mesh_pivot (every entry). Override slots: list_material_overrides, add_material_override (turns bOverrideMaterials on), set_material_override, remove_material_override (turns it off when the list empties).

Visibility. get_renderer_visibility returns the RendererVisibility tag value, the attribute bound to RendererVisibilityTagBinding and the enabled flag; set_renderer_visibility takes an integer visibility. A renderer draws only particles whose visibility tag equals its value.

Bindings. list_renderer_bindings shows each binding (ColorBinding, PositionBinding, SpriteSizeBinding...) with the bound attribute, type, whether it reads particle data and whether the emitter provided it at the last compile. set_renderer_binding binds an attribute (Particles.Color, Particles.MyScale, User.Tint) through the engine binding API; reset_renderer_binding restores the class default; get_renderer_binding reads one. validate_renderer_bindings reports bindings the emitter does not provide, and validate_renderers checks every enabled renderer of a system (sim-target support, missing material, empty mesh list, override flag without slots, component type, unresolved bindings). Run validation after compile + wait_compile: binding existence is refreshed by compilation.

The older single-field wrappers (set_sprite_alignment, set_sprite_facing, set_mesh_sort, set_ribbon_uv, set_light_radius, set_component_template...) remain; they now require a renderer of their kind. set_renderer_property writes any reflected property path for advanced cases.

Parameters​

User parameters. add_user_parameter / add_user_parameters ("Name:type=value"), get_user_parameter (type, kind, value, floats, object path), list_user_parameters, rename_user_parameter, remove_user_parameter, list_parameter_types, audit_user_parameters (every parameter with its default, plus issues: outside the User. namespace, unset object or data interface, duplicate friendly names), copy_user_parameters (definitions and values to another system; overwrite replaces same-typed parameters).

TypeSetGet
float, int, bool, vec3, vec4, colorset_user_parameter or set_user_parameter_<type>get_user_parameter
vec2, quatset_user_parameter_vec2 / _quatget_user_parameter_vec2 / _quat
position (5.0+)set_user_parameter_position ((X=..,Y=..,Z=..), double precision kept)get_user_parameter_position
matrixset_user_parameter_matrix (values: 16 floats, row-major)get_user_parameter_matrix
objectset_user_parameter_object (any asset)get_user_parameter_object
texture, render target, materialset_user_parameter_texture / _render_target / _materialmatching get_
static mesh (5.0+)set_user_parameter_static_meshget_user_parameter_static_mesh
data interfaceadd_user_data_interface (dataInterfaceClass), set_user_parameter_data_interface (values: ["Field=Value"], editable fields only)get_user_parameter_data_interface (fields as Field:Type=Value)

Typed setters check the parameter's type (a mismatch is E_INVALID_ARG naming the real type) and accept addIfMissing: true to create the parameter with the tool's type. Object setters take an asset path or None. list_data_interface_classes lists usable data interface classes (NiagaraDataInterfaceTexture, NiagaraDataInterfaceCurve, ...); add_user_parameter also accepts di:<Class>, matrix, object, texture, texture_render_target, material, and on 5.0+ position / static_mesh (numeric value defaults apply to numeric types only).

Collections. create_parameter_collection, get_parameter_collection, add_collection_parameter(s), get_collection_parameter (typed default), set_collection_parameter and typed setters, rename_collection_parameter (collection, default instance and every instance asset; same name is a no-op), remove_collection_parameter, duplicate_collection (UE 5.3+, the engine gives the copy a unique namespace), audit_collection (parameters outside the namespace, unset objects, instances that lack or keep stale parameters).

Instances and overrides. create_parameter_collection_instance, get_collection_instance (parent, namespace, every value with its override flag), list_collection_instances (instance assets under /Game whose parent is the collection), set_collection_instance_parent, set_collection_instance_parameter, list_collection_overrides, get_collection_override, set_collection_override (marks the parameter overridden, optional value typed by the collection parameter), remove_collection_override (clears the flag and restores the collection default).

Modules and stack editing​

list_script_assets / get_script_asset, add_module, add_set_parameters_module.

  • Addressing. A stack is usage: systemSpawn/systemUpdate (leave emitter empty), or emitterSpawn, emitterUpdate, particleSpawn, particleUpdate, event:<index|guid>, stage:<index|guid|name> (with emitter). A module is its GUID (from list_modules), its index, or its unique name. An input is its name or display name; Parent/Child reaches the inputs of a dynamic input.
  • Recipe: 1) niagara.list_stacks {system}; 2) niagara.add_module {system, emitter, usage:'particleUpdate', moduleScript:'/Niagara/Modules/...', index} (5.1+), keep module.guid; 3) niagara.list_module_inputs {…, module:<guid>} (5.2+); 4) niagara.set_module_input {…, input:'SpawnRate', value:'25'}, or set_linked_input {parameter:'User.Rate'} (5.6+), or set_dynamic_input {dynamicInputScript:'/Niagara/DynamicInputs/UniformRange/UniformRangedFloat'} then set_module_input {input:'SpawnRate/Minimum'}; 5) reset_module_input to undo an override; 6) list_stack_issues / apply_stack_issue {issue:''} applies the first fix of every fixable issue; 7) wait_compile.
  • Values: numbers, true/false, enum entry names, or UE struct text such as (X=0,Y=0,Z=100) or (R=1,G=0,B=0,A=1).
  • Simulation stages: add_simulation_stage {name}, then modules via usage:'stage:<name>', then set_simulation_stage / move_simulation_stage / remove_simulation_stage. set_event_handler edits source emitter/event, execution mode and spawn counts.
  • Gotchas: mutators request a compile (poll with wait_compile); module moves are not supported (delete and re-add); UE 4.27 has the graph tools only (list, enable, set-parameters modules, event handlers, simulation stages) — input editing and issues need 5.2+; inherited modules cannot be deleted, disable them with set_module_enabled.

Level components​

Editor world (RequiresWorld): spawn_actor, delete_actor, add_component, list_components, list_level_components (every Niagara component of the level, optional system filter, with counts), get_component, capture_component_state, activate, deactivate, reset_component, set_component_asset, set_component_age, set_component_auto_activate, set_component_visibility (visible, propagateToChildren), set_component_rendering_enabled (hide while simulating), set_component_tick_enabled (enabled, optional tickBehavior: UsePrereqs, UseComponentTickGroup, ForceTickFirst, ForceTickLast).

Instance parameters: list_component_parameters, get_component_parameter, set_component_parameter and the typed set_component_* setters (property is the variable name, e.g. User.SpawnRate), set_component_actor (assign a level actor to an object user parameter), set_component_object (object, material, render target; texture and static mesh on 5.0+; the setter follows the parameter's type).

capture_component_state returns asset, active/paused/visible/rendering/tick/auto-activate flags, tick behavior, desired and simulation age, location, per-emitter particle counts and every override parameter value.

PIE (live)​

RequiresPIE tools act on the play world: spawn_test_actor (actor whose root is a Niagara component named NiagaraSmokeComponent), spawn_at_location, spawn_attached, set_live_parameter, set_paused, get_system_bounds, capture_live_component_state, list_particle_counts (every component, optional system filter, per-emitter live and spawned counts and execution state), get_particle_counts, set_live_visibility, activate_live_component, deactivate_live_component, reset_live_component, seek_live_component (value = age in seconds), advance_live_component (tickCount ticks of tickDelta seconds, synchronously), kill_all (deactivate immediately, optional system filter). Engine templates such as /Niagara/DefaultAssets/Templates/Systems/RadialBurst work in any project. GPU emitters report counts one frame late.

Batch, audits and finders​

All batch tools scan a folder recursively (empty means /Game), continue past failures and return items[] (asset, status: changed, unchanged, wouldChange, matched, valid, invalid, failed, detail) plus processed, changed, failed. Mutating batches take dryRun (default true): run once with it, read items[], then run with dryRun: false.

ToolDoes
batch_compilerequests compilation of every system
batch_validatesystem validity, emitters without renderers and every renderer check
batch_set_scalabilityassigns one effect type (None clears)
batch_replace_materialswaps from → to in sprite/ribbon/decal materials and mesh override slots
batch_set_renderer_fieldwrites one schema field on every renderer of a kind
batch_set_user_parametersets a numeric user parameter default where it exists (type-checked)
batch_rename_user_parameterrenames a user parameter and requests compilation
batch_audit_user_parametersuser parameter schema audit per system
batch_set_fixed_boundssets the same fixed bounds everywhere
find_by_parameter / find_by_script / find_by_renderer / find_by_data_interface / find_by_mesh / find_by_effect_type / find_by_emitter_parent / find_by_material / find_gpu_systemsfinders; find_by_script inspects the loaded stack graphs, so unsaved systems are found too

recipe (fountain, burst, ribbon_trail), list_recipes and audit complete the theme.

Recipes​

Tinted sprite burst driven from Blueprint.

  1. create, add_emitter {"emitterAsset":"SimpleSpriteBurst","name":"Burst"}.
  2. add_user_parameters {"parameters":["Tint:color=(R=1,G=0.2,B=0,A=1)","Size:float=20"]}.
  3. Bind or reference them in modules (see the stack editing section), set_renderer_binding for renderer inputs that should read User. data.
  4. compile, wait_compile, validate_renderers.
  5. In the level: spawn_actor, set_component_parameter {"property":"User.Tint","type":"color",...}.

Mesh debris. add_renderer {"type":"mesh"}, add_renderer_mesh {"mesh":"/Game/Rocks/SM_Rock"}, set_renderer_mesh {"index":0,"scale":"(X=0.5,Y=0.5,Z=0.5)"}, add_material_override {"material":"/Game/Rocks/M_Rock_Dirty"}, set_mesh_renderer {"values":["FacingMode=Velocity","bEnableFrustumCulling=true"]}.

Texture-driven effect. add_user_data_interface {"name":"Mask","dataInterfaceClass":"NiagaraDataInterfaceTexture"}, set_user_parameter_data_interface {"name":"Mask","values":["Texture=/Game/FX/T_Mask"]}; or a plain texture parameter: set_user_parameter_texture {"name":"Mask","asset":"/Game/FX/T_Mask","addIfMissing":true}.

Project-wide material swap. batch_replace_material {"folder":"/Game/FX","from":"/Game/FX/M_Old","to":"/Game/FX/M_New"} (dry run), check items[], repeat with "dryRun": false, then batch_compile.

PIE check. Start PIE, spawn_test_actor {"system":"/Game/FX/NS_Sparks","actor":"FXProbe"}, get_particle_counts {"actor":"FXProbe"}, seek_live_component {"actor":"FXProbe","value":1.5}, capture_live_component_state {"actor":"FXProbe"}, kill_all.

Gotchas​

  • Compile after emitter, renderer or parameter changes; mutators already request it and replies say so. Binding existence (existsOnSource) and system validity reflect the last compile.
  • Engine templates are read-only; add them to your own system or copy them with create_emitter_asset + parent.
  • A field or parameter that does not exist on the running engine fails with E_INVALID_ARG or E_NOT_SUPPORTED naming the minimum engine; nothing is silently skipped or guessed.
  • Renderer kind lookups never pick "the first" of several: pass the index when an emitter has two renderers of a kind.
  • Position and static mesh parameter types, component texture/static-mesh setters: UE 5.0+. Decal renderers and reorder_renderer: UE 5.2+. duplicate_collection: UE 5.3+.
  • Level tools use the editor world; *_live_*, particle counts and kill_all need PIE.

Tools​

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

niagara.activate (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
systemstringrequired. Niagara system asset path.
namestringComponent name.

Returns: component, system, active, message.

niagara.activate_live_component (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

Activates (restarts) a Niagara component in the PIE world.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.add_collection_parameter (risk 2, mutates, requires plugin Niagara, smoke)​

Adds a parameter to a collection; name is the friendly name (the NPC namespace is added) and value an optional default.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
namestringrequired. Parameter name.
typestringUE type name. Default TEXT("float").
valuestringText-import value.

Returns: parameters, count, message.

niagara.add_collection_parameters (risk 2, mutates, requires plugin Niagara, smoke)​

Adds several collection parameters in one call; each entry is "Name:type=value".

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
parametersarray of stringrequired. Entries "Name:type=value".

Returns: parameters, count, message.

niagara.add_component (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
systemstringrequired. Niagara system asset path.
namestringComponent name.

Returns: component, system, active, message.

niagara.add_effect_type_emitter_scalability (risk 2, mutates, requires plugin Niagara, smoke)​

Appends an emitter spawn-count scaling entry (quality levels + scale) to an effect type.

ArgumentTypeDescription
systemstringNiagara system asset path (used to find the effect type when effectType is empty).
effectTypestringEffect type asset path.
indexintegerEntry index for remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic.
scaleSpawnCountbooleanScale spawn counts on these quality levels. Default true.
spawnCountScalenumberSpawn count multiplier (0..1 typical). Default 1.0f.

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.add_effect_type_scalability (risk 2, mutates, requires plugin Niagara, smoke)​

Appends a per-quality system scalability setting to an effect type (distance and instance culling).

ArgumentTypeDescription
systemstringNiagara system asset path (system overrides) or empty when effectType is given.
effectTypestringEffect type asset path (effect-type tools; empty uses the system's effect type).
indexintegerEntry index for set/remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it.
cullByDistancestringCull by distance: true/false (empty leaves it). Setting distance fields turns their override on.
maxDistancestringMaximum distance in cm (empty leaves it).
cullMaxInstanceCountstringCull when the effect type exceeds maxInstances: true/false (empty leaves it).
maxInstancesstringMaximum instances of this effect type (empty leaves it).
cullPerSystemMaxInstanceCountstringCull when this system exceeds maxSystemInstances: true/false (empty leaves it).
maxSystemInstancesstringMaximum instances of this system (empty leaves it).

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.add_emitter (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterAssetstringrequired. Emitter asset path or common alias such as Fountain.
namestringHandle name. Default TEXT("Emitter").

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.add_emitter_scalability_override (risk 2, mutates, requires plugin Niagara, smoke)​

Adds a spawn-count scalability override for the given quality levels.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
indexintegerOverride index for remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic.
spawnCountScalenumberSpawn count multiplier for the override (add); negative leaves the spawn count unscaled. Default 1.0f.

Returns: handle, qualityLevelMask, overrides, count, message, compileStatus.

niagara.add_emitter_version (risk 2, mutates, UE 5.1+, requires plugin Niagara, smoke)​

Adds a version (major >= 1, not 1.0, not existing) copied from the closest lower version.

ArgumentTypeDescription
emitterAssetstringrequired. Standalone emitter asset path.
versionstringVersion selector: GUID or major.minor.
majorintegerMajor version for add_emitter_version (>= 1). Default 1.
minorintegerMinor version for add_emitter_version. Default 1.

Returns: asset, versioningEnabled, exposedVersion, versions, count, message.

niagara.add_event_handler (risk 2, mutates, requires plugin Niagara, smoke)​

Adds an event handler (event receiver) with a new, empty event script stack, like the stack's Add Event Handler action; returns the handlers with their usage ids. Add modules to the new stack with the module tools (script event:).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
handlerstringEvent handler index or script usage GUID (get/remove).
sourceEmitterstringEmitter handle that generates the events (name, index or id; add).
eventNamestringSource event name, e.g. LocationEvent, DeathEvent, CollisionEvent (add).
executionModestringeveryParticle, spawnedParticles, or singleParticle. Default TEXT("everyParticle").
spawnNumberintegerSpawn count for spawned-particles execution. Default 0.
maxEventsPerFrameintegerMaximum events consumed per frame (0 = unlimited). Default 0.

Returns: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.

niagara.add_material_override (risk 2, mutates, requires plugin Niagara, smoke)​

Appends a material override slot to a mesh renderer and turns bOverrideMaterials on.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringMesh renderer index; empty means the only mesh renderer.
indexintegerOverride slot index (set/remove). Default -1.
materialstringMaterial asset path (add/set).

Returns: renderer, overrideMaterials, overrides, count, message.

niagara.add_module (risk 2, mutates, UE 5.1+, requires plugin Niagara, smoke)​

Adds a module script to any stack (system, emitter, particle, event:, stage:) at an index; returns the new module GUID and the stack. UE 5.1+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
moduleScriptstringrequired. Niagara module script asset path (usage Module), e.g. /Niagara/Modules/Emitter/SpawnRate.
usagestringTarget stack usage (see list_stacks), default systemSpawn. Default TEXT("systemSpawn").
indexintegerZero-based insert position in the stack; -1 appends. Default -1.
namestringOptional suggested module name (made unique by the engine).
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stacks, module, count, compileStatus, message.

niagara.add_renderer (risk 2, mutates, requires plugin Niagara, smoke)​

Adds one or more renderers to an emitter: type is sprite, mesh, ribbon, light, component or decal (UE 5.2+), or a comma-separated list of them.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
typestringrequired. sprite, mesh, ribbon, light, component or decal (UE 5.2+), or a comma-separated list of them.

Returns: renderers, count, message.

niagara.add_renderer_mesh (risk 2, mutates, requires plugin Niagara, smoke)​

Appends a mesh entry (static mesh, optional scale and pivot offset) to a mesh renderer.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringMesh renderer index; empty means the only mesh renderer.
indexintegerMesh entry index (set/remove). Default -1.
meshstringStatic mesh asset path (add/set; empty keeps the current mesh on set).
scalestringScale as (X=..,Y=..,Z=..); empty keeps the current value.
pivotOffsetstringPivot offset as (X=..,Y=..,Z=..); empty keeps the current value.

Returns: renderer, meshes, count, message.

niagara.add_scalability_override (risk 2, mutates, requires plugin Niagara, smoke)​

Appends a system scalability override for the given quality levels and turns scalability overriding on; distance/instance fields set their override flags.

ArgumentTypeDescription
systemstringNiagara system asset path (system overrides) or empty when effectType is given.
effectTypestringEffect type asset path (effect-type tools; empty uses the system's effect type).
indexintegerEntry index for set/remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it.
cullByDistancestringCull by distance: true/false (empty leaves it). Setting distance fields turns their override on.
maxDistancestringMaximum distance in cm (empty leaves it).
cullMaxInstanceCountstringCull when the effect type exceeds maxInstances: true/false (empty leaves it).
maxInstancesstringMaximum instances of this effect type (empty leaves it).
cullPerSystemMaxInstanceCountstringCull when this system exceeds maxSystemInstances: true/false (empty leaves it).
maxSystemInstancesstringMaximum instances of this system (empty leaves it).

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.add_set_parameters_module (risk 2, mutates, requires plugin Niagara, smoke)​

Adds a Set Parameters (assignment) module writing one typed parameter to any stack; returns the module and the stack.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringTarget stack usage (see list_stacks), default systemSpawn. Default TEXT("systemSpawn").
namestringrequired. Parameter to write. Without a namespace the stack's own namespace is used (System., Emitter. or Particles.).
typestringfloat, int, bool, vec2, vec3, vec4, quat or color. Default TEXT("float").
valuestringDefault value in the pin text format (e.g. 1.0, (X=1,Y=2,Z=3), (R=1,G=0,B=0,A=1)).
indexintegerZero-based insert position in the stack; -1 appends. Default -1.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stacks, module, count, compileStatus, message.

niagara.add_simulation_stage (risk 2, mutates, requires plugin Niagara, smoke)​

Adds a generic simulation stage with an empty stack (script + graph output) at an index.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
stagestringSimulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage.
namestringStage name when adding; new name when setting (empty keeps it).
indexintegerTarget zero-based index (add: insert position, -1 appends; move: required destination). Default -1.
enabledstringtrue/false to enable or disable the stage; empty keeps it.
iterationSourcestringParticles or DataInterface (DirectSet on engines that have it); empty keeps it.
disablePartialParticleUpdatestringtrue/false for Disable Partial Particle Update; empty keeps it.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, emitter, stages, stage, count, compileStatus, message.

niagara.add_user_data_interface (risk 2, mutates, requires plugin Niagara, smoke)​

Adds a data interface user parameter of the given class (the data interface object is created with the class defaults).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.
dataInterfaceClassstringrequired. Data interface class, e.g. NiagaraDataInterfaceTexture or NiagaraDataInterfaceCurve (see niagara.list_data_interface_classes).

Returns: owner, parameter, fields, message.

niagara.add_user_parameter (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.add_user_parameters (risk 2, mutates, requires plugin Niagara, smoke)​

Adds several user parameters in one call; each entry is "Name:type=value" (type defaults to float, value is optional). Stops at the first failing entry.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
parametersarray of stringrequired. Entries "Name:type=value"; type is float, int, bool, vec2, vec3, vec4, quat or color.

Returns: parameters, count, message.

niagara.advance_live_component (risk 2, mutates, requires plugin Niagara, requires PIE)​

Runs the simulation of an active PIE Niagara component forward by tickCount ticks of tickDelta seconds, synchronously. Needs a live system instance: a component activated in the current frame has none until the world ticks (Niagara defers activation until the system and its PSOs are ready).

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.
tickCountintegerrequired. Number of simulation ticks to run (1-600).
tickDeltanumberSeconds per tick (0-0.5]. Default 0.0333f.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.apply_stack_issue (risk 2, mutates, UE 5.2+, requires plugin Niagara, smoke)​

Applies a stack-issue fix (by issue and fix id/index); with an empty issue applies the first fix of every fixable issue. UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index (only that emitter's stack). Empty = the system stack and every emitter stack.
issuestringIssue unique id (from list_stack_issues) or zero-based index. Empty: get lists every issue; apply applies the first fix of every fixable issue.
fixstringFix unique id or zero-based index within the issue; empty = the issue's first fix (apply_stack_issue).
compilebooleanRequest a system compile after applying fixes (default true). Default true.

Returns: system, issues, issue, applied, count, compileStatus, message.

niagara.audit (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
dryRunbooleanReport what would change without editing. Default true.

Returns: scripts, count, message.

niagara.audit_collection (risk 0, requires plugin Niagara, smoke)​

Audits a collection's schema and defaults: parameters outside its namespace, unset objects, and instances whose parameters drifted from the collection.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.

Returns: asset, collection, namespace, parameters, related, count, issues, message.

niagara.audit_user_parameters (risk 0, requires plugin Niagara, smoke)​

Audits the user parameter schema of a system: every parameter with type and default, plus issues (outside the User namespace, unset object/data interface, duplicate friendly names).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: owner, parameters, count, issues, message.

niagara.batch_audit_user_parameters (risk 0, requires plugin Niagara, smoke)​

Audits the user parameter schema of every system in the folder (namespace, unset objects/data interfaces, duplicate friendly names).

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
dryRunbooleanReport what would change without editing. Default true.

Returns: items, processed, changed, failed, dryRun, message.

niagara.batch_compile (risk 2, mutates, requires plugin Niagara, dryRun, smoke)​

Requests compilation of every system in the folder; items[] lists each system as changed, wouldChange or failed (with the reason).

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
dryRunbooleanReport what would change without editing. Default true.

Returns: items, processed, changed, failed, dryRun, message.

niagara.batch_rename_user_parameter (risk 2, mutates, requires plugin Niagara, dryRun, smoke)​

Renames a user parameter on every system in the folder that exposes it and requests compilation (the new name must be free on each system).

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
namestringrequired. Current user parameter name, with or without the User. prefix.
newNamestringrequired. New user parameter name.
dryRunbooleanReport what would change without editing. Default true.

Returns: items, processed, changed, failed, dryRun, message.

niagara.batch_replace_material (risk 2, mutates, requires plugin Niagara, dryRun, smoke)​

Replaces a material in every renderer material slot (sprite/ribbon/decal Material, mesh override slots) of the folder's systems.

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
fromstringrequired. Material to replace (asset path).
tostringrequired. Replacement material (asset path).
dryRunbooleanReport what would change without editing. Default true.

Returns: items, processed, changed, failed, dryRun, message.

niagara.batch_set_fixed_bounds (risk 2, mutates, requires plugin Niagara, dryRun, smoke)​

Sets the same fixed bounds on every system in the folder.

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
min{x,y,z}required. Minimum corner.
max{x,y,z}required. Maximum corner.
dryRunbooleanReport what would change without editing. Default true.

Returns: items, processed, changed, failed, dryRun, message.

niagara.batch_set_renderer_field (risk 2, mutates, requires plugin Niagara, dryRun, smoke)​

Writes one schema field (list_renderer_fields) on every renderer of a kind in the folder's systems.

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
kindstringrequired. Renderer kind: sprite, mesh, ribbon, light, component or decal (UE 5.2+).
fieldstringrequired. Schema field of that kind (niagara.list_renderer_fields).
valuestringrequired. Unreal text value.
dryRunbooleanReport what would change without editing. Default true.

Returns: items, processed, changed, failed, dryRun, message.

niagara.batch_set_scalability (risk 2, mutates, requires plugin Niagara, dryRun, smoke)​

Assigns one effect type (the scalability settings container) to every system in the folder; None clears it.

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
effectTypestringrequired. Effect type asset path (its scalability settings apply to every system); None clears it.
dryRunbooleanReport what would change without editing. Default true.

Returns: items, processed, changed, failed, dryRun, message.

niagara.batch_set_user_parameter (risk 2, mutates, requires plugin Niagara, dryRun, smoke)​

Sets the default of a user parameter on every system in the folder that exposes it (type-checked; other types fail per asset).

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
namestringrequired. User parameter name, with or without the User. prefix.
typestringrequired. float, int, bool, vec2, vec3, vec4, quat or color; systems whose parameter has another type fail.
valuestringrequired. Unreal text value.
dryRunbooleanReport what would change without editing. Default true.

Returns: items, processed, changed, failed, dryRun, message.

niagara.batch_validate (risk 0, requires plugin Niagara, smoke)​

Validates every system in the folder: system validity, emitters without renderers and every renderer check of niagara.validate_renderers.

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
dryRunbooleanReport what would change without editing. Default true.

Returns: items, processed, changed, failed, dryRun, message.

niagara.cancel_compile (risk 2, mutates, requires plugin Niagara, smoke)​

Cancels the system's in-flight compilations (they are requested again by the next compile).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.capture_component_state (risk 0, requires plugin Niagara, requires world, smoke)​

Captures the full state of a level Niagara component: asset, activity, pause, visibility, rendering, tick, age, location, particle counts and every override parameter value.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.capture_live_component_state (risk 0, requires plugin Niagara, requires PIE, smoke)​

Captures the same state for a Niagara component in the PIE world.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.compile (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.copy_user_parameters (risk 2, mutates, requires plugin Niagara, smoke)​

Copies user parameters (definition, default value, object or data interface settings) from one system to another.

ArgumentTypeDescription
systemstringrequired. Source Niagara system asset path.
targetSystemstringrequired. Destination Niagara system asset path.
namesarray of stringUser parameter names to copy (with or without User.); empty copies every user parameter.
overwritebooleanReplace parameters that already exist on the destination with the same type. Default false.

Returns: owner, parameters, count, issues, message.

niagara.create (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.create_effect_type (risk 2, mutates, requires plugin Niagara, smoke)​

Creates a Niagara effect type asset (scalability, cull reaction and significance settings shared by systems).

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.create_emitter_asset (risk 2, mutates, requires plugin Niagara, smoke)​

Creates a standalone emitter asset: a copy of parent (asset path or template alias such as Fountain) or, without parent, the editor's default empty emitter.

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare emitter asset name.
parentstringOptional parent/template emitter asset path.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.create_from_template (risk 2, mutates, requires plugin Niagara, smoke)​

Creates a system as a copy of a template system (engine templates: SimpleExplosion, RadialBurst, DirectionalBurst), exactly like the New System wizard: template description and category are cleared and a compile is requested.

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.
templatestringrequired. Template system path or a bare name under /Niagara/DefaultAssets/Templates/Systems (SimpleExplosion, RadialBurst, DirectionalBurst).

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.create_parameter_collection (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare collection name.

Returns: parameters, count, message.

niagara.create_parameter_collection_instance (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
collectionstringrequired. Parent collection asset path.
folderstringrequired. Content folder under /Game.
namestringrequired. Bare instance asset name.

Returns: parameters, count, message.

niagara.deactivate (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
systemstringrequired. Niagara system asset path.
namestringComponent name.

Returns: component, system, active, message.

niagara.deactivate_live_component (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

Deactivates a Niagara component in the PIE world (existing particles finish).

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.delete (risk 3, mutates, destructive, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: message, compileStatus.

niagara.delete_actor (risk 3, mutates, destructive, requires plugin Niagara, requires world, smoke)​

Deletes an editor-level actor that owns a Niagara component (refuses other actors).

ArgumentTypeDescription
actorstringrequired. Actor label/name.

Returns: message, compileStatus.

niagara.delete_emitter_version (risk 3, mutates, destructive, UE 5.1+, requires plugin Niagara, smoke)​

Deletes a version (never the exposed version or 1.0).

ArgumentTypeDescription
emitterAssetstringrequired. Standalone emitter asset path.
versionstringVersion selector: GUID or major.minor.
majorintegerMajor version for add_emitter_version (>= 1). Default 1.
minorintegerMinor version for add_emitter_version. Default 1.

Returns: asset, versioningEnabled, exposedVersion, versions, count, message.

niagara.diff_emitter (risk 0, requires plugin Niagara, smoke)​

Compares two emitter handles (same or different systems): editable emitter data, renderer classes, event handler and simulation stage counts.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path of the first emitter.
emitterstringrequired. First handle name, index or id.
otherSystemstringSystem of the second emitter (empty = same system).
otherEmitterstringrequired. Second handle name, index or id.

Returns: a, b, identical, differences, count.

niagara.diff_system (risk 0, requires plugin Niagara, smoke)​

Compares two systems: editable system properties, emitter handles present in one only, emitter data per shared handle name, renderer classes and user parameters.

ArgumentTypeDescription
systemstringrequired. First Niagara system asset path.
otherstringrequired. Second Niagara system asset path.

Returns: a, b, identical, differences, count.

niagara.duplicate (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Source system asset path.
folderstringrequired. Destination folder.
newNamestringrequired. Bare destination name.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.duplicate_collection (risk 2, mutates, UE 5.3+, requires plugin Niagara, smoke)​

Duplicates a parameter collection; the engine gives the copy a unique namespace (UE 5.3+).

ArgumentTypeDescription
collectionstringrequired. Source parameter collection asset path.
folderstringrequired. Destination folder under /Game.
newNamestringrequired. Bare destination asset name.

Returns: asset, collection, namespace, parameters, related, count, issues, message.

niagara.duplicate_emitter (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
newNamestringNew handle name for rename.
valuebooleanNew enabled/isolated state. Default false.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.duplicate_renderer (risk 2, mutates, requires plugin Niagara, smoke)​

Copies a renderer (all settings) into the same or another emitter of the system.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index that owns the renderer.
rendererstringrequired. Renderer index to copy.
targetEmitterstringDestination emitter handle name or index; empty copies inside the same emitter.

Returns: renderers, count, message.

niagara.enable_emitter_versioning (risk 2, mutates, UE 5.1+, requires plugin Niagara, smoke)​

Enables versioning on a standalone emitter asset (the current data becomes version 1.0).

ArgumentTypeDescription
emitterAssetstringrequired. Standalone emitter asset path.
versionstringVersion selector: GUID or major.minor.
majorintegerMajor version for add_emitter_version (>= 1). Default 1.
minorintegerMinor version for add_emitter_version. Default 1.

Returns: asset, versioningEnabled, exposedVersion, versions, count, message.

niagara.export_recipe (risk 0, requires plugin Niagara, smoke)​

Exports a portable recipe (emitters by source asset, emitter and system property overrides, user parameters); optional file writes it as JSON.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
filestringOptional absolute .json file to write; empty returns the recipe only.

Returns: recipe, file, asset, handles, message, compileStatus.

niagara.export_summary (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: scripts, count, message.

niagara.expose_emitter_version (risk 2, mutates, UE 5.1+, requires plugin Niagara, smoke)​

Makes a version (GUID or major.minor) the exposed one that new users inherit from.

ArgumentTypeDescription
emitterAssetstringrequired. Standalone emitter asset path.
versionstringVersion selector: GUID or major.minor.
majorintegerMajor version for add_emitter_version (>= 1). Default 1.
minorintegerMinor version for add_emitter_version. Default 1.

Returns: asset, versioningEnabled, exposedVersion, versions, count, message.

niagara.find_by_data_interface (risk 0, requires plugin Niagara, smoke)​

Finds systems that use a data interface class anywhere (user parameters or module inputs).

ArgumentTypeDescription
dataInterfaceClassstringrequired. Data interface class, e.g. NiagaraDataInterfaceTexture.
folderstringContent folder searched recursively; empty means /Game.

Returns: items, processed, changed, failed, dryRun, message.

niagara.find_by_effect_type (risk 0, requires plugin Niagara, smoke)​

Finds systems assigned to an effect type (None finds systems without one).

ArgumentTypeDescription
effectTypestringrequired. Effect type asset path; None finds systems without an effect type.
folderstringContent folder searched recursively; empty means /Game.

Returns: items, processed, changed, failed, dryRun, message.

niagara.find_by_emitter_parent (risk 0, requires plugin Niagara, smoke)​

Finds systems whose emitters were created from (inherit) an emitter asset or template.

ArgumentTypeDescription
emitterstringrequired. Emitter asset path (or template name) the system emitters were created from.
folderstringContent folder searched recursively; empty means /Game.

Returns: items, processed, changed, failed, dryRun, message.

niagara.find_by_material (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
materialstringrequired. Material asset path.
folderstringContent folder searched recursively; empty means /Game.

Returns: scripts, count, message.

niagara.find_by_mesh (risk 0, requires plugin Niagara, smoke)​

Finds systems whose mesh renderers draw a static mesh.

ArgumentTypeDescription
meshstringrequired. Static mesh asset path.
folderstringContent folder searched recursively; empty means /Game.

Returns: items, processed, changed, failed, dryRun, message.

niagara.find_by_parameter (risk 0, requires plugin Niagara, smoke)​

Finds systems exposing a user parameter (optionally of one type).

ArgumentTypeDescription
namestringrequired. User parameter name, with or without the User. prefix.
typestringOptional kit type label to require (float, texture, di:...).
folderstringContent folder searched recursively; empty means /Game.

Returns: items, processed, changed, failed, dryRun, message.

niagara.find_by_renderer (risk 0, requires plugin Niagara, smoke)​

Finds systems with a renderer of a kind (items list emitter and renderer index).

ArgumentTypeDescription
kindstringrequired. Renderer kind: sprite, mesh, ribbon, light, component or decal (UE 5.2+).
folderstringContent folder searched recursively; empty means /Game.

Returns: items, processed, changed, failed, dryRun, message.

niagara.find_by_script (risk 0, requires plugin Niagara, smoke)​

Finds systems whose emitter or system stacks call a module, function or dynamic-input script (loaded graphs, saved or not).

ArgumentTypeDescription
scriptstringrequired. Niagara module, function or dynamic-input script asset path.
folderstringContent folder searched recursively; empty means /Game.

Returns: items, processed, changed, failed, dryRun, message.

niagara.find_gpu_systems (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
folderstringContent folder searched recursively; empty means /Game.
dryRunbooleanReport what would change without editing. Default true.

Returns: scripts, count, message.

niagara.get (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.get_collection_instance (risk 0, requires plugin Niagara, smoke)​

Returns a collection instance: parent collection, namespace, every parameter with value and override flag.

ArgumentTypeDescription
instancestringrequired. Parameter collection instance asset path.

Returns: asset, collection, namespace, parameters, related, count, issues, message.

niagara.get_collection_override (risk 0, requires plugin Niagara, smoke)​

Returns one parameter of a collection instance with its override flag and value.

ArgumentTypeDescription
instancestringrequired. Parameter collection instance asset path.
namestringrequired. Friendly or full (NPC.) parameter name.

Returns: owner, parameter, fields, message.

niagara.get_collection_parameter (risk 0, requires plugin Niagara, smoke)​

Returns a collection parameter with its type and default value (from the collection's default instance).

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
namestringrequired. Friendly or full (NPC.) parameter name.

Returns: owner, parameter, fields, message.

niagara.get_compile_errors (risk 0, requires plugin Niagara, smoke)​

Returns every warning and error of the last compile of all system and emitter scripts.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: events, errorCount, warningCount, compileStatus.

niagara.get_compile_status (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.get_component (risk 0, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
systemstringrequired. Niagara system asset path.
namestringComponent name.

Returns: component, system, active, message.

niagara.get_component_parameter (risk 0, requires plugin Niagara, requires world, smoke)​

Returns one override (instance) parameter of a level Niagara component with its type and value.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.
parameterstringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_component_renderer (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.get_decal_renderer (risk 0, UE 5.2+, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.get_dependencies (risk 0, requires plugin Niagara, smoke)​

Returns the list of asset packages the system depends on (emitter parents, scripts, materials, meshes, collections, effect type).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: paths, count, message.

niagara.get_effect_type (risk 0, requires plugin Niagara, smoke)​

Returns an effect type (by path, or the system's): update frequency, cull reaction, significance handler, per-quality system settings and emitter spawn scaling.

ArgumentTypeDescription
systemstringNiagara system asset path (system overrides) or empty when effectType is given.
effectTypestringEffect type asset path (effect-type tools; empty uses the system's effect type).
indexintegerEntry index for set/remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it.
cullByDistancestringCull by distance: true/false (empty leaves it). Setting distance fields turns their override on.
maxDistancestringMaximum distance in cm (empty leaves it).
cullMaxInstanceCountstringCull when the effect type exceeds maxInstances: true/false (empty leaves it).
maxInstancesstringMaximum instances of this effect type (empty leaves it).
cullPerSystemMaxInstanceCountstringCull when this system exceeds maxSystemInstances: true/false (empty leaves it).
maxSystemInstancesstringMaximum instances of this system (empty leaves it).

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.get_emitter (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.get_emitter_allocation (risk 0, requires plugin Niagara, smoke)​

Returns the allocation group: allocation mode, preallocation count and the engine's current max particle count estimate.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.get_emitter_asset (risk 0, requires plugin Niagara, smoke)​

Returns a standalone emitter asset: parent, versioning, renderer/event/stage counts, metadata and editable data of the exposed version.

ArgumentTypeDescription
emitterAssetstringrequired. Standalone emitter asset path.
versionstringVersion selector: GUID or major.minor.
majorintegerMajor version for add_emitter_version (>= 1). Default 1.
minorintegerMinor version for add_emitter_version. Default 1.

Returns: asset, parent, versioningEnabled, exposedVersion, renderers, eventHandlers, simulationStages, fields, message.

niagara.get_emitter_bounds (risk 0, requires plugin Niagara, smoke)​

Returns the bounds group: calculation mode (dynamic/fixed/programmable) and the fixed box.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.get_emitter_execution_order (risk 0, requires plugin Niagara, smoke)​

Returns emitter handles in simulation execution order (dependency-sorted by the last compile) with overlap-group starts.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: order, startsNewGroup, count, message.

niagara.get_emitter_inheritance (risk 0, requires plugin Niagara, smoke)​

Returns inheritance: parent asset and version, parent snapshot at last merge, synchronization state and the parent's versions (UE 5.1+).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.

niagara.get_emitter_lifecycle (risk 0, requires plugin Niagara, smoke)​

Returns the Emitter State lifecycle inputs that have local values (Loop Duration, Loop Delay, Loop Count...), read from the emitter scripts' rapid-iteration parameters.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.get_emitter_parent (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.get_emitter_scalability (risk 0, requires plugin Niagara, smoke)​

Returns the emitter's enabled quality levels and its spawn-count scalability overrides.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: handle, qualityLevelMask, overrides, count, message, compileStatus.

niagara.get_emitter_simulation (risk 0, requires plugin Niagara, smoke)​

Returns the simulation group of an emitter: sim target, local space, determinism, seed, interpolated spawning, persistent ids and the engine-specific tick/GPU fields.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.get_event_handler (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
handlerstringEvent handler index or script usage GUID (get/remove).
sourceEmitterstringEmitter handle that generates the events (name, index or id; add).
eventNamestringSource event name, e.g. LocationEvent, DeathEvent, CollisionEvent (add).
executionModestringeveryParticle, spawnedParticles, or singleParticle. Default TEXT("everyParticle").
spawnNumberintegerSpawn count for spawned-particles execution. Default 0.
maxEventsPerFrameintegerMaximum events consumed per frame (0 = unlimited). Default 0.

Returns: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.

niagara.get_light_renderer (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.get_mesh_renderer (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.get_module (risk 0, requires plugin Niagara, smoke)​

Returns one module (by GUID, index or unique name) and its stack.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
enabledbooleanNew enabled state (set_module_enabled). Default true.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stacks, module, count, compileStatus, message.

niagara.get_module_input (risk 0, UE 5.2+, requires plugin Niagara, smoke)​

Returns one module input with its value mode and value. UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
inputstringInput path: input name or display name (spaces and case ignored); 'Parent/Child' addresses an input of the dynamic input set on Parent. Empty on list_module_inputs lists every input.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stack, module, inputs, input, count, compileStatus, message.

niagara.get_parameter_collection (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.

Returns: parameters, count, message.

niagara.get_particle_counts (risk 0, requires plugin Niagara, requires PIE, smoke)​

Returns the per-emitter live particle counts of one PIE Niagara component.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.

Returns: components, count, particles, message.

niagara.get_properties (risk 0, requires plugin Niagara, smoke)​

Returns every editable system property (name, C++ type, value text) - the read side of niagara.set_properties.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: target, fields, count, message, compileStatus.

niagara.get_renderer (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind.

Returns: renderers, count, message.

niagara.get_renderer_binding (risk 0, requires plugin Niagara, smoke)​

Returns one attribute binding of a renderer.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index.
bindingstringrequired. Binding property name from niagara.list_renderer_bindings, e.g. ColorBinding.
attributestringAttribute to bind (set only), e.g. Particles.Color or User.MyColor.

Returns: renderer, kind, bindings, count, message.

niagara.get_renderer_visibility (risk 0, requires plugin Niagara, smoke)​

Returns a renderer's visibility tag value, the attribute bound to its visibility tag and its enabled state.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind.

Returns: renderer, kind, visibility, tagBinding, enabled, message.

niagara.get_ribbon_renderer (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.get_scalability (risk 0, requires plugin Niagara, smoke)​

Returns the system scalability state: effect type, override switch, typed overrides (quality mask + fields), platforms and local-player culling override.

ArgumentTypeDescription
systemstringNiagara system asset path (system overrides) or empty when effectType is given.
effectTypestringEffect type asset path (effect-type tools; empty uses the system's effect type).
indexintegerEntry index for set/remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it.
cullByDistancestringCull by distance: true/false (empty leaves it). Setting distance fields turns their override on.
maxDistancestringMaximum distance in cm (empty leaves it).
cullMaxInstanceCountstringCull when the effect type exceeds maxInstances: true/false (empty leaves it).
maxInstancesstringMaximum instances of this effect type (empty leaves it).
cullPerSystemMaxInstanceCountstringCull when this system exceeds maxSystemInstances: true/false (empty leaves it).
maxSystemInstancesstringMaximum instances of this system (empty leaves it).

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.get_script_asset (risk 0, requires plugin Niagara, smoke)​

Describes one Niagara script asset: path, class and last compile status.

ArgumentTypeDescription
scriptstringrequired. Niagara script asset path (get_script_asset) or empty to list every script asset.
filterstringOptional case-insensitive filter on the asset path or class name (list_script_assets).

Returns: scripts, count, message.

niagara.get_script_source (risk 0, requires plugin Niagara, smoke)​

Returns one script (system or emitter, by usage and usage id): source graph class/node count/change id, compile events and its rapid-iteration parameters with values.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name, index or id; empty selects the system scripts.
usagestringsystemSpawn, systemUpdate, emitterSpawn, emitterUpdate, particleSpawn, particleUpdate, event, simulationStage or gpuCompute (list tools: empty = all).
usageIdstringUsage GUID for event and simulation-stage scripts (empty = first of that usage).

Returns: script, sourceClass, graphNodes, graphChangeId, events, parameters.

niagara.get_simulation_stage (risk 0, requires plugin Niagara, smoke)​

Returns one simulation stage (index, usage GUID or name) or, with an empty stage, every stage.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
stagestringSimulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage.
namestringStage name when adding; new name when setting (empty keeps it).
indexintegerTarget zero-based index (add: insert position, -1 appends; move: required destination). Default -1.
enabledstringtrue/false to enable or disable the stage; empty keeps it.
iterationSourcestringParticles or DataInterface (DirectSet on engines that have it); empty keeps it.
disablePartialParticleUpdatestringtrue/false for Disable Partial Particle Update; empty keeps it.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, emitter, stages, stage, count, compileStatus, message.

niagara.get_sprite_renderer (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.get_stack_issue (risk 0, UE 5.2+, requires plugin Niagara, smoke)​

Returns one stack issue (by id or index) with its fixes; an empty issue lists every issue. UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index (only that emitter's stack). Empty = the system stack and every emitter stack.
issuestringIssue unique id (from list_stack_issues) or zero-based index. Empty: get lists every issue; apply applies the first fix of every fixable issue.
fixstringFix unique id or zero-based index within the issue; empty = the issue's first fix (apply_stack_issue).
compilebooleanRequest a system compile after applying fixes (default true). Default true.

Returns: system, issues, issue, applied, count, compileStatus, message.

niagara.get_stats (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: valid, emitterCount, bounds, compileStatus, message.

niagara.get_system_bounds (risk 0, requires plugin Niagara, requires PIE, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
systemstringrequired. Niagara system asset path.
namestringComponent name.

Returns: bounds, message.

niagara.get_system_metadata (risk 0, requires plugin Niagara, smoke)​

Returns asset metadata: description, category and library visibility (UE 5.0+) or expose-to-library (UE 4.27), thumbnail state and package metadata tags.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: target, fields, count, message, compileStatus.

niagara.get_system_simulation (risk 0, requires plugin Niagara, smoke)​

Returns the simulation settings group: warmup, determinism, random seed and fixed tick (fields that exist on this engine).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: target, fields, count, message, compileStatus.

niagara.get_user_parameter (risk 0, requires plugin Niagara, smoke)​

Returns a user parameter with its type and current default (value, object or data interface).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_data_interface (risk 0, requires plugin Niagara, smoke)​

Returns a data interface user parameter: its class, object and editable fields (Field:Type=Value).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_material (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_matrix (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_object (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_position (risk 0, UE 5.0+, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_quat (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_render_target (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_static_mesh (risk 0, UE 5.0+, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_texture (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.get_user_parameter_vec2 (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.

Returns: owner, parameter, fields, message.

niagara.import_recipe (risk 2, mutates, requires plugin Niagara, smoke)​

Creates a system from a recipe given inline or as a JSON file written by niagara.export_recipe.

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.
recipeUeaNiagaraSysRecipeInline recipe (as returned by niagara.export_recipe). Give either recipe or file.
filestringAbsolute .json file written by niagara.export_recipe. Give either recipe or file.

Returns: recipe, file, asset, handles, message, compileStatus.

niagara.kill_all (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

Immediately deactivates every Niagara component of the PIE world (optionally only one system) and reports how many were stopped.

ArgumentTypeDescription
systemstringOnly components playing this system (asset path); empty means every Niagara component.

Returns: components, count, particles, message.

niagara.list (risk 0, requires plugin Niagara, smoke)​

Lists Niagara systems under a folder with emitter count, effect type and GPU usage.

ArgumentTypeDescription
folderstringFolder to search (default /Game). Default TEXT("/Game").
nameContainsstringOnly names containing this text (case-insensitive).
recursivebooleanInclude sub-folders. Default true.

Returns: systems, count.

niagara.list_collection_instances (risk 0, requires plugin Niagara, smoke)​

Lists the collection instance assets under /Game whose parent is the collection.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.

Returns: asset, collection, namespace, parameters, related, count, issues, message.

niagara.list_collection_overrides (risk 0, requires plugin Niagara, smoke)​

Lists the parameters a collection instance overrides, with their values.

ArgumentTypeDescription
instancestringrequired. Parameter collection instance asset path.

Returns: asset, collection, namespace, parameters, related, count, issues, message.

niagara.list_component_parameters (risk 0, requires plugin Niagara, requires world, smoke)​

Lists the override (instance) parameters of a level Niagara component with their values.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.

Returns: owner, parameters, count, issues, message.

niagara.list_components (risk 0, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
systemstringrequired. Niagara system asset path.
namestringComponent name.

Returns: components, count, message.

niagara.list_data_interface_classes (risk 0, requires plugin Niagara, smoke)​

Lists the data interface classes usable as dataInterfaceClass / di: parameter types.

ArgumentTypeDescription
namestringProperty name (as declared by the engine).
typestringC++ type of the property.
valuestringValue as Unreal property text (the same form the setters accept).

Returns: classes, count.

niagara.list_effect_types (risk 0, requires plugin Niagara, smoke)​

Lists Niagara effect type assets under a folder.

ArgumentTypeDescription
folderstringFolder to search (default /Game). Default TEXT("/Game").
nameContainsstringOnly names containing this text (case-insensitive).
recursivebooleanInclude sub-folders. Default true.

Returns: paths, count, message.

niagara.list_emitter_assets (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
namestringProperty name (as declared by the engine).
typestringC++ type of the property.
valuestringValue as Unreal property text (the same form the setters accept).

Returns: scripts, count, message.

niagara.list_emitter_attributes (risk 0, requires plugin Niagara, smoke)​

Lists the particle attributes of the compiled emitter (name and type); compile the system first.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: handle, attributes, count, message.

niagara.list_emitter_properties (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.

niagara.list_emitter_versions (risk 0, UE 5.1+, requires plugin Niagara, smoke)​

Lists the versions of a standalone emitter asset with the exposed version.

ArgumentTypeDescription
emitterAssetstringrequired. Standalone emitter asset path.
versionstringVersion selector: GUID or major.minor.
majorintegerMajor version for add_emitter_version (>= 1). Default 1.
minorintegerMinor version for add_emitter_version. Default 1.

Returns: asset, versioningEnabled, exposedVersion, versions, count, message.

niagara.list_emitters (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: emitters, count, handles.

niagara.list_event_generators (risk 0, requires plugin Niagara, smoke)​

Lists the events the emitter's compiled particle scripts generate (event id, payload, max per frame) and which handles consume them.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: handle, generators, count, message.

niagara.list_event_handlers (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.

niagara.list_level_components (risk 0, requires plugin Niagara, requires world, smoke)​

Lists every Niagara component of the editor level (optionally one system) with actor, system, activity and particle counts.

ArgumentTypeDescription
systemstringOnly components playing this system (asset path); empty means every Niagara component.

Returns: components, count, particles, message.

niagara.list_material_overrides (risk 0, requires plugin Niagara, smoke)​

Lists the material override slots of a mesh renderer (OverrideMaterials) and the bOverrideMaterials flag.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringMesh renderer index; empty means the only mesh renderer.
indexintegerOverride slot index (set/remove). Default -1.
materialstringMaterial asset path (add/set).

Returns: renderer, overrideMaterials, overrides, count, message.

niagara.list_module_inputs (risk 0, UE 5.2+, requires plugin Niagara, smoke)​

Lists a module's inputs (path, type, value mode, local value, link, dynamic input, data interface). Pass input to list the children of a dynamic input. UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
inputstringInput path: input name or display name (spaces and case ignored); 'Parent/Child' addresses an input of the dynamic input set on Parent. Empty on list_module_inputs lists every input.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stack, module, inputs, input, count, compileStatus, message.

niagara.list_modules (risk 0, requires plugin Niagara, smoke)​

Lists the modules of one stack (usage) in execution order: GUID, index, name, script, kind, enabled.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index. Empty = system stacks only (list_stacks: system + every emitter).
usagestringStack usage (systemSpawn, systemUpdate, emitterSpawn, emitterUpdate, particleSpawn, particleUpdate, event:<i

Returns: system, stacks, module, count, compileStatus, message.

niagara.list_parameter_types (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
namestringProperty name (as declared by the engine).
typestringC++ type of the property.
valuestringValue as Unreal property text (the same form the setters accept).

Returns: parameters, count, message.

niagara.list_particle_counts (risk 0, requires plugin Niagara, requires PIE, smoke)​

Lists every Niagara component of the PIE world (optionally one system) with per-emitter live particle counts.

ArgumentTypeDescription
systemstringOnly components playing this system (asset path); empty means every Niagara component.

Returns: components, count, particles, message.

niagara.list_recipes (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
namestringProperty name (as declared by the engine).
typestringC++ type of the property.
valuestringValue as Unreal property text (the same form the setters accept).

Returns: scripts, count, message.

niagara.list_renderer_bindings (risk 0, requires plugin Niagara, smoke)​

Lists a renderer's attribute bindings with the bound attribute, its type and whether the emitter provides it.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind.

Returns: renderer, kind, bindings, count, message.

niagara.list_renderer_fields (risk 0, requires plugin Niagara, smoke)​

Lists the settable fields (name and type) and attribute bindings of a renderer kind.

ArgumentTypeDescription
kindstringrequired. Renderer kind: sprite, mesh, ribbon, light, component or decal (UE 5.2+).

Returns: kind, class, fields, bindings.

niagara.list_renderer_meshes (risk 0, requires plugin Niagara, smoke)​

Lists the mesh entries of a mesh renderer (mesh, scale, pivot offset).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringMesh renderer index; empty means the only mesh renderer.
indexintegerMesh entry index (set/remove). Default -1.
meshstringStatic mesh asset path (add/set; empty keeps the current mesh on set).
scalestringScale as (X=..,Y=..,Z=..); empty keeps the current value.
pivotOffsetstringPivot offset as (X=..,Y=..,Z=..); empty keeps the current value.

Returns: renderer, meshes, count, message.

niagara.list_renderers (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: renderers, count, message.

niagara.list_script_assets (risk 0, requires plugin Niagara, smoke)​

Lists Niagara script assets (modules, functions, dynamic inputs), optionally filtered by path or class.

ArgumentTypeDescription
scriptstringrequired. Niagara script asset path (get_script_asset) or empty to list every script asset.
filterstringOptional case-insensitive filter on the asset path or class name (list_script_assets).

Returns: scripts, count, message.

niagara.list_simulation_stages (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.

niagara.list_stack_issues (risk 0, UE 5.2+, requires plugin Niagara, smoke)​

Lists the stack issues (errors, warnings, info) of the system stack and one or every emitter stack, with their fixes. UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index (only that emitter's stack). Empty = the system stack and every emitter stack.
issuestringIssue unique id (from list_stack_issues) or zero-based index. Empty: get lists every issue; apply applies the first fix of every fixable issue.
fixstringFix unique id or zero-based index within the issue; empty = the issue's first fix (apply_stack_issue).
compilebooleanRequest a system compile after applying fixes (default true). Default true.

Returns: system, issues, issue, applied, count, compileStatus, message.

niagara.list_stacks (risk 0, requires plugin Niagara, smoke)​

Lists the script stacks (usage selector, usage GUID, modules in order) of the system and of one or every emitter.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index. Empty = system stacks only (list_stacks: system + every emitter).
usagestringStack usage (systemSpawn, systemUpdate, emitterSpawn, emitterUpdate, particleSpawn, particleUpdate, event:<i

Returns: system, stacks, module, count, compileStatus, message.

niagara.list_system_scripts (risk 0, requires plugin Niagara, smoke)​

Lists the system and emitter scripts with usage, usage id, compile status, VM op count, error/warning counts and rapid-iteration parameter counts.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name, index or id; empty selects the system scripts.
usagestringsystemSpawn, systemUpdate, emitterSpawn, emitterUpdate, particleSpawn, particleUpdate, event, simulationStage or gpuCompute (list tools: empty = all).
usageIdstringUsage GUID for event and simulation-stage scripts (empty = first of that usage).

Returns: scripts, count.

niagara.list_templates (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
namestringProperty name (as declared by the engine).
typestringC++ type of the property.
valuestringValue as Unreal property text (the same form the setters accept).

Returns: scripts, count, message.

niagara.list_user_parameters (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: parameters, count, message.

niagara.move_simulation_stage (risk 2, mutates, requires plugin Niagara, smoke)​

Moves a simulation stage to a new index (execution order).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
stagestringSimulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage.
namestringStage name when adding; new name when setting (empty keeps it).
indexintegerTarget zero-based index (add: insert position, -1 appends; move: required destination). Default -1.
enabledstringtrue/false to enable or disable the stage; empty keeps it.
iterationSourcestringParticles or DataInterface (DirectSet on engines that have it); empty keeps it.
disablePartialParticleUpdatestringtrue/false for Disable Partial Particle Update; empty keeps it.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, emitter, stages, stage, count, compileStatus, message.

niagara.recipe (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
recipestringrequired. Recipe name from niagara.list_recipes.
folderstringrequired. Destination folder under /Game.
namestringrequired. Bare system asset name.
dryRunbooleanOnly check that the recipe template exists. Default false.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.recipe_beam (risk 2, mutates, requires plugin Niagara, smoke)​

Beam recipe: ribbon beam between two points. Variants: dynamic (default, DynamicBeam), static (StaticBeam).

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.
variantstringRecipe variant (see the tool description; empty = default variant).
gpubooleanSimulate the recipe emitters on the GPU. Default false.
localSpacebooleanSimulate in local space (particles follow the component). Default false.
boundsExtentnumberHalf size of fixed system bounds in cm; 0 keeps the recipe default. Default 0.0f.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.recipe_burst (risk 2, mutates, requires plugin Niagara, smoke)​

Burst recipe: one-shot sprite burst. Variants: omni (default, OmnidirectionalBurst), directional (DirectionalBurst), sprite (SimpleSpriteBurst), mesh (UpwardMeshBurst).

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.
variantstringRecipe variant (see the tool description; empty = default variant).
gpubooleanSimulate the recipe emitters on the GPU. Default false.
localSpacebooleanSimulate in local space (particles follow the component). Default false.
boundsExtentnumberHalf size of fixed system bounds in cm; 0 keeps the recipe default. Default 0.0f.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.recipe_fountain (risk 2, mutates, requires plugin Niagara, smoke)​

Fountain recipe: continuous upward sprite fountain (engine Fountain emitter). Variants: default.

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.
variantstringRecipe variant (see the tool description; empty = default variant).
gpubooleanSimulate the recipe emitters on the GPU. Default false.
localSpacebooleanSimulate in local space (particles follow the component). Default false.
boundsExtentnumberHalf size of fixed system bounds in cm; 0 keeps the recipe default. Default 0.0f.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.recipe_ribbon (risk 2, mutates, requires plugin Niagara, smoke)​

Ribbon recipe: trail ribbon following the component (LocationBasedRibbon).

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.
variantstringRecipe variant (see the tool description; empty = default variant).
gpubooleanSimulate the recipe emitters on the GPU. Default false.
localSpacebooleanSimulate in local space (particles follow the component). Default false.
boundsExtentnumberHalf size of fixed system bounds in cm; 0 keeps the recipe default. Default 0.0f.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.recipe_smoke (risk 2, mutates, requires plugin Niagara, smoke)​

Smoke/ambient recipe: slow hanging particulates with 2 s warmup so the volume is already filled when it appears (HangingParticulates).

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.
variantstringRecipe variant (see the tool description; empty = default variant).
gpubooleanSimulate the recipe emitters on the GPU. Default false.
localSpacebooleanSimulate in local space (particles follow the component). Default false.
boundsExtentnumberHalf size of fixed system bounds in cm; 0 keeps the recipe default. Default 0.0f.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.recipe_sparks (risk 2, mutates, requires plugin Niagara, smoke)​

Sparks recipe: an omnidirectional spark burst plus a continuous ember fountain, two handles Sparks and Embers.

ArgumentTypeDescription
folderstringrequired. Content folder under /Game.
namestringrequired. Bare asset name.
variantstringRecipe variant (see the tool description; empty = default variant).
gpubooleanSimulate the recipe emitters on the GPU. Default false.
localSpacebooleanSimulate in local space (particles follow the component). Default false.
boundsExtentnumberHalf size of fixed system bounds in cm; 0 keeps the recipe default. Default 0.0f.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.remove_collection_override (risk 2, mutates, requires plugin Niagara, smoke)​

Clears an instance override and restores the collection default value.

ArgumentTypeDescription
instancestringrequired. Parameter collection instance asset path.
namestringrequired. Friendly or full (NPC.) parameter name.

Returns: owner, parameter, fields, message.

niagara.remove_collection_parameter (risk 3, mutates, destructive, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
namestringrequired. Parameter name.
typestringUE type name. Default TEXT("float").
valuestringText-import value.

Returns: parameters, count, message.

niagara.remove_effect_type_emitter_scalability (risk 2, mutates, requires plugin Niagara, smoke)​

Removes the effect type emitter scaling entry at index.

ArgumentTypeDescription
systemstringNiagara system asset path (used to find the effect type when effectType is empty).
effectTypestringEffect type asset path.
indexintegerEntry index for remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic.
scaleSpawnCountbooleanScale spawn counts on these quality levels. Default true.
spawnCountScalenumberSpawn count multiplier (0..1 typical). Default 1.0f.

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.remove_effect_type_scalability (risk 2, mutates, requires plugin Niagara, smoke)​

Removes the effect type system scalability setting at index.

ArgumentTypeDescription
systemstringNiagara system asset path (system overrides) or empty when effectType is given.
effectTypestringEffect type asset path (effect-type tools; empty uses the system's effect type).
indexintegerEntry index for set/remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it.
cullByDistancestringCull by distance: true/false (empty leaves it). Setting distance fields turns their override on.
maxDistancestringMaximum distance in cm (empty leaves it).
cullMaxInstanceCountstringCull when the effect type exceeds maxInstances: true/false (empty leaves it).
maxInstancesstringMaximum instances of this effect type (empty leaves it).
cullPerSystemMaxInstanceCountstringCull when this system exceeds maxSystemInstances: true/false (empty leaves it).
maxSystemInstancesstringMaximum instances of this system (empty leaves it).

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.remove_emitter (risk 3, mutates, destructive, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: message, compileStatus.

niagara.remove_emitter_parent (risk 2, mutates, requires plugin Niagara, smoke)​

Breaks inheritance: the emitter keeps its current stack but no longer follows a parent.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.

niagara.remove_emitter_scalability_override (risk 2, mutates, requires plugin Niagara, smoke)​

Removes the emitter scalability override at index.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
indexintegerOverride index for remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic.
spawnCountScalenumberSpawn count multiplier for the override (add); negative leaves the spawn count unscaled. Default 1.0f.

Returns: handle, qualityLevelMask, overrides, count, message, compileStatus.

niagara.remove_event_handler (risk 3, mutates, destructive, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
handlerstringEvent handler index or script usage GUID (get/remove).
sourceEmitterstringEmitter handle that generates the events (name, index or id; add).
eventNamestringSource event name, e.g. LocationEvent, DeathEvent, CollisionEvent (add).
executionModestringeveryParticle, spawnedParticles, or singleParticle. Default TEXT("everyParticle").
spawnNumberintegerSpawn count for spawned-particles execution. Default 0.
maxEventsPerFrameintegerMaximum events consumed per frame (0 = unlimited). Default 0.

Returns: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.

niagara.remove_material_override (risk 3, mutates, destructive, requires plugin Niagara, smoke)​

Removes one override slot (index); bOverrideMaterials is turned off when the list becomes empty.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringMesh renderer index; empty means the only mesh renderer.
indexintegerOverride slot index (set/remove). Default -1.
materialstringMaterial asset path (add/set).

Returns: renderer, overrideMaterials, overrides, count, message.

niagara.remove_module (risk 3, mutates, destructive, UE 5.2+, requires plugin Niagara, smoke)​

Deletes a module and its input nodes through the stack view model (the stack's Delete). UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
enabledbooleanNew enabled state (set_module_enabled). Default true.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stacks, module, count, compileStatus, message.

niagara.remove_renderer (risk 3, mutates, destructive, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind.

Returns: message, compileStatus.

niagara.remove_renderer_mesh (risk 3, mutates, destructive, requires plugin Niagara, smoke)​

Removes one mesh entry (index) from a mesh renderer.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringMesh renderer index; empty means the only mesh renderer.
indexintegerMesh entry index (set/remove). Default -1.
meshstringStatic mesh asset path (add/set; empty keeps the current mesh on set).
scalestringScale as (X=..,Y=..,Z=..); empty keeps the current value.
pivotOffsetstringPivot offset as (X=..,Y=..,Z=..); empty keeps the current value.

Returns: renderer, meshes, count, message.

niagara.remove_scalability_override (risk 2, mutates, requires plugin Niagara, smoke)​

Removes the system scalability override at index.

ArgumentTypeDescription
systemstringNiagara system asset path (system overrides) or empty when effectType is given.
effectTypestringEffect type asset path (effect-type tools; empty uses the system's effect type).
indexintegerEntry index for set/remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it.
cullByDistancestringCull by distance: true/false (empty leaves it). Setting distance fields turns their override on.
maxDistancestringMaximum distance in cm (empty leaves it).
cullMaxInstanceCountstringCull when the effect type exceeds maxInstances: true/false (empty leaves it).
maxInstancesstringMaximum instances of this effect type (empty leaves it).
cullPerSystemMaxInstanceCountstringCull when this system exceeds maxSystemInstances: true/false (empty leaves it).
maxSystemInstancesstringMaximum instances of this system (empty leaves it).

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.remove_simulation_stage (risk 3, mutates, destructive, requires plugin Niagara, smoke)​

Removes a simulation stage and the graph nodes of its stack.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
stagestringSimulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage.
namestringStage name when adding; new name when setting (empty keeps it).
indexintegerTarget zero-based index (add: insert position, -1 appends; move: required destination). Default -1.
enabledstringtrue/false to enable or disable the stage; empty keeps it.
iterationSourcestringParticles or DataInterface (DirectSet on engines that have it); empty keeps it.
disablePartialParticleUpdatestringtrue/false for Disable Partial Particle Update; empty keeps it.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, emitter, stages, stage, count, compileStatus, message.

niagara.remove_user_parameter (risk 3, mutates, destructive, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.rename (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Source system asset path.
folderstringrequired. Destination folder.
newNamestringrequired. Bare destination name.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.rename_collection_parameter (risk 2, mutates, requires plugin Niagara, smoke)​

Renames a collection parameter (friendly name; the namespace is kept) in the collection, its default instance and every instance asset. Same name is a no-op.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
namestringrequired. Current friendly or full (NPC.) name.
newNamestringrequired. New friendly name (the collection namespace is added).

Returns: asset, collection, namespace, parameters, related, count, issues, message.

niagara.rename_emitter (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
newNamestringNew handle name for rename.
valuebooleanNew enabled/isolated state. Default false.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.rename_user_parameter (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.reorder_emitter (risk 2, mutates, requires plugin Niagara, smoke)​

Moves an emitter handle to a new position in the system (handle ids, names and data are preserved); returns the handles in the new order.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
indexintegerrequired. Destination zero-based emitter index.

Returns: emitters, count, handles.

niagara.reorder_renderer (risk 2, mutates, UE 5.2+, requires plugin Niagara, smoke)​

Moves a renderer to another index of its emitter's renderer list (UE 5.2+).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index to move.
newIndexintegerrequired. Destination index in the emitter's renderer list.

Returns: renderers, count, message.

niagara.reset_component (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
systemstringrequired. Niagara system asset path.
namestringComponent name.

Returns: component, system, active, message.

niagara.reset_live_component (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

Resets the simulation of a Niagara component in the PIE world.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.reset_module_input (risk 2, mutates, UE 5.2+, requires plugin Niagara, smoke)​

Resets a module input to its default (removes overrides, links, dynamic inputs and data interfaces). UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
inputstringInput path: input name or display name (spaces and case ignored); 'Parent/Child' addresses an input of the dynamic input set on Parent. Empty on list_module_inputs lists every input.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stack, module, inputs, input, count, compileStatus, message.

niagara.reset_renderer_binding (risk 2, mutates, requires plugin Niagara, smoke)​

Resets one attribute binding to the renderer class default.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index.
bindingstringrequired. Binding property name from niagara.list_renderer_bindings, e.g. ColorBinding.
attributestringAttribute to bind (set only), e.g. Particles.Color or User.MyColor.

Returns: renderer, kind, bindings, count, message.

niagara.save (risk 2, requires plugin Niagara)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: message, compileStatus.

niagara.seek_live_component (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

Seeks a PIE Niagara component to a simulation age in seconds (value).

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
valuenumberrequired. New value.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.set_collection_instance_parameter (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
instancestringrequired. Collection instance asset path.
namestringrequired. Parameter name.
typestringUE type name. Default TEXT("float").
valuestringText-import value.

Returns: parameters, count, message.

niagara.set_collection_instance_parent (risk 2, mutates, requires plugin Niagara, smoke)​

Re-parents a collection instance asset to another collection.

ArgumentTypeDescription
instancestringrequired. Parameter collection instance asset path.
collectionstringrequired. New parent collection asset path.

Returns: asset, collection, namespace, parameters, related, count, issues, message.

niagara.set_collection_override (risk 2, mutates, requires plugin Niagara, smoke)​

Marks a collection instance parameter as overridden and optionally sets its value (typed by the collection parameter).

ArgumentTypeDescription
instancestringrequired. Parameter collection instance asset path.
namestringrequired. Friendly or full (NPC.) parameter name.
valuestringUnreal text value; the type comes from the collection parameter. Empty keeps the current value.

Returns: owner, parameter, fields, message.

niagara.set_collection_parameter (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
namestringrequired. Parameter name.
typestringUE type name. Default TEXT("float").
valuestringText-import value.

Returns: parameters, count, message.

niagara.set_collection_parameter_bool (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
namestringrequired. Parameter name.
typestringUE type name. Default TEXT("float").
valuestringText-import value.

Returns: parameters, count, message.

niagara.set_collection_parameter_color (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
namestringrequired. Parameter name.
typestringUE type name. Default TEXT("float").
valuestringText-import value.

Returns: parameters, count, message.

niagara.set_collection_parameter_float (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
namestringrequired. Parameter name.
typestringUE type name. Default TEXT("float").
valuestringText-import value.

Returns: parameters, count, message.

niagara.set_collection_parameter_vector (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
collectionstringrequired. Parameter collection asset path.
namestringrequired. Parameter name.
typestringUE type name. Default TEXT("float").
valuestringText-import value.

Returns: parameters, count, message.

niagara.set_component_actor (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

Assigns an actor of the level to an object user parameter of a level Niagara component (SetVariableActor).

ArgumentTypeDescription
actorstringrequired. Actor label/name that owns the Niagara component.
namestringNiagara component name; may be omitted when the actor owns exactly one.
parameterstringrequired. Object user parameter name, with or without the User. prefix.
targetActorstringrequired. Label/name of the actor to assign.

Returns: owner, parameter, fields, message.

niagara.set_component_age (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
valuenumberrequired. New value.

Returns: component, system, active, message.

niagara.set_component_asset (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
systemstringrequired. Niagara system asset path.

Returns: component, system, active, message.

niagara.set_component_auto_activate (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_component_bool (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_component_color (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_component_float (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_component_int (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_component_object (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

Sets an object, material, render-target, texture (UE 5.0+) or static mesh (UE 5.0+) user parameter on a level Niagara component; the setter follows the parameter's type.

ArgumentTypeDescription
actorstringrequired. Actor label/name that owns the Niagara component.
namestringNiagara component name; may be omitted when the actor owns exactly one.
parameterstringrequired. Object, texture, material, static mesh or render-target user parameter name.
assetstringrequired. Asset path or unique asset name.

Returns: owner, parameter, fields, message.

niagara.set_component_parameter (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_component_quat (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_component_renderer (risk 2, mutates, requires plugin Niagara, smoke)​

Writes component renderer fields (ComponentType class, ComponentCountLimit, particle-ID assignment, visualization).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.
valuesarray of stringrequired. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None.
addIfMissingbooleanAdd a renderer of this kind to the emitter when it has none. Default false.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.set_component_rendering_enabled (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

Turns rendering of a level Niagara component on or off while the simulation keeps running.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.
enabledbooleanrequired. New flag value.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.set_component_template (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the component renderer's template component (TemplateComponent object text; None clears it).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_component_tick_enabled (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

Enables or disables ticking of a level Niagara component and optionally sets its tick behavior (UsePrereqs, UseComponentTickGroup, ForceTickFirst, ForceTickLast).

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.
enabledbooleanrequired. Enable (true) or disable (false) component ticking.
tickBehaviorstringOptional tick behavior: UsePrereqs, UseComponentTickGroup, ForceTickFirst or ForceTickLast. Empty keeps it.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.set_component_vec3 (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_component_visibility (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

Shows or hides a level Niagara component (optionally its attached children too).

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.
visiblebooleanrequired. Show (true) or hide (false) the component.
propagateToChildrenbooleanApply the visibility to attached children too. Default false.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.set_data_interface_input (risk 2, mutates, UE 5.7+, requires plugin Niagara, smoke)​

Sets a data-interface input to a new data interface of the given class, optionally with property values (5.8+). UE 5.7+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
inputstringrequired. Input path of a data-interface input (see list_module_inputs).
dataInterfaceClassstringrequired. Data-interface class, e.g. NiagaraDataInterfaceCurve. Must derive from the input's type.
propertiesarray of stringOptional 'Property=Value' pairs applied to the new data interface (UE text import). UE 5.8+.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stack, module, inputs, input, count, compileStatus, message.

niagara.set_decal_renderer (risk 2, mutates, UE 5.2+, requires plugin Niagara, smoke)​

Writes decal renderer fields (Material, SourceMode, RendererVisibility, DecalScreenSizeFade); UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.
valuesarray of stringrequired. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None.
addIfMissingbooleanAdd a renderer of this kind to the emitter when it has none. Default false.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.set_determinism (risk 2, mutates, UE 5.0+, requires plugin Niagara, smoke)​

Enables deterministic simulation for the whole system (system-level determinism exists from UE 5.0).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
valuebooleanNew flag value. Default false.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_dynamic_input (risk 2, mutates, UE 5.2+, requires plugin Niagara, smoke)​

Drives a module input with a dynamic-input script; its own inputs become 'Input/Child' paths. UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
inputstringrequired. Input path (see list_module_inputs).
dynamicInputScriptstringrequired. Dynamic-input script asset path, e.g. /Niagara/DynamicInputs/UniformRange/UniformRangedFloat. Must be one of the dynamic inputs the stack offers for the input's type.
namestringOptional suggested node name.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stack, module, inputs, input, count, compileStatus, message.

niagara.set_effect_type (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
effectTypestringEffect type asset path. Empty clears it.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_effect_type_scalability (risk 2, mutates, requires plugin Niagara, smoke)​

Edits the effect type system scalability setting at index (only the given fields change).

ArgumentTypeDescription
systemstringNiagara system asset path (system overrides) or empty when effectType is given.
effectTypestringEffect type asset path (effect-type tools; empty uses the system's effect type).
indexintegerEntry index for set/remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it.
cullByDistancestringCull by distance: true/false (empty leaves it). Setting distance fields turns their override on.
maxDistancestringMaximum distance in cm (empty leaves it).
cullMaxInstanceCountstringCull when the effect type exceeds maxInstances: true/false (empty leaves it).
maxInstancesstringMaximum instances of this effect type (empty leaves it).
cullPerSystemMaxInstanceCountstringCull when this system exceeds maxSystemInstances: true/false (empty leaves it).
maxSystemInstancesstringMaximum instances of this system (empty leaves it).

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.set_effect_type_settings (risk 2, mutates, requires plugin Niagara, smoke)​

Sets effect type scalars: update frequency, cull reaction and (UE 5.0+) local-player culling.

ArgumentTypeDescription
systemstringNiagara system asset path (used when effectType is empty).
effectTypestringEffect type asset path.
updateFrequencystringSpawnOnly, Low, Medium, High or Continuous (empty leaves it).
cullReactionstringDeactivate, DeactivateImmediate, DeactivateResume or DeactivateImmediateResume (empty leaves it).
allowCullingForLocalPlayersstringtrue/false: allow scalability culling of effects owned by local players (UE 5.0+; empty leaves it).

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.set_emitter_allocation (risk 2, mutates, requires plugin Niagara, smoke)​

Sets allocation mode (AutomaticEstimate, ManualEstimate, FixedCount on UE 5.0+) and preallocation count.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
allocationModestringAutomaticEstimate, ManualEstimate or FixedCount (FixedCount UE 5.0+); empty leaves it.
preAllocationCountstringParticles to preallocate for manual modes; empty leaves it.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_allocation_mode (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_asset_metadata (risk 2, mutates, requires plugin Niagara, smoke)​

Sets standalone emitter asset metadata: description, category, library visibility and (UE 5.4+) inheritable.

ArgumentTypeDescription
emitterAssetstringrequired. Standalone emitter asset path.
descriptionstringAsset description (empty leaves it; "none" clears it).
categorystringLibrary category (empty leaves it; "none" clears it).
libraryVisibilitystringUnexposed, Library or Hidden (UE 5.0+); UE 4.27 accepts Unexposed or Library. Empty leaves it.
inheritablestringtrue/false: other emitters may inherit from this one (UE 5.4+); empty leaves it.

Returns: asset, parent, versioningEnabled, exposedVersion, renderers, eventHandlers, simulationStages, fields, message.

niagara.set_emitter_bounds (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the bounds mode and/or fixed box (box written when min and max differ).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
modestringdynamic or fixed (programmable on UE 5.1+); empty leaves it.
min{x,y,z}Minimum corner of the fixed box; the box is written when min and max differ.
max{x,y,z}Maximum corner of the fixed box.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_bounds_calculation (risk 2, mutates, requires plugin Niagara, smoke)​

Bounds calculation: Dynamic or Fixed (UE 5.1+ also Programmable); older engines map it to bFixedBounds.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_determinism (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_enabled (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
newNamestringNew handle name for rename.
valuebooleanNew enabled/isolated state. Default false.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_event_generator (risk 2, mutates, requires plugin Niagara, smoke)​

Replaces the emitter's event handler array (EventHandlerScriptProps) with Unreal property text; () clears it.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_fixed_bounds (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_gpu_spawn_limit (risk 2, mutates, UE 5.0+, requires plugin Niagara, smoke)​

Maximum GPU particles spawned per frame (UE 5.0+).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_interpolation (risk 2, mutates, requires plugin Niagara, smoke)​

Interpolated spawning: true/false, or on UE 5.6+ an ENiagaraInterpolatedSpawnMode name (NoInterpolation, RunUpdateScript, Interpolation).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_isolated (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
newNamestringNew handle name for rename.
valuebooleanNew enabled/isolated state. Default false.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_lifecycle (risk 2, mutates, requires plugin Niagara, smoke)​

Sets Emitter State lifecycle values (loop duration/delay/count, delay-first-loop, recalculate-each-loop) exactly as the stack's local value editor does; requests a compile.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
loopDurationstringEmitter State "Loop Duration" seconds; empty leaves it.
loopDelaystringEmitter State "Loop Delay" seconds; empty leaves it.
loopCountstringEmitter State "Loop Count" (loop behavior Multiple only); empty leaves it.
delayFirstLoopOnlystringEmitter State "Delay First Loop Only" true/false; empty leaves it.
recalculateDurationEachLoopstringEmitter State "Recalculate Duration Each Loop" true/false; empty leaves it.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_local_space (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_parent (risk 2, mutates, requires plugin Niagara, smoke)​

Reparents an emitter to another emitter asset and merges the parent's stack, as the editor's Update Parent Emitter action does.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
parentstringNew parent emitter asset path (set_emitter_parent).
versionstringParent version: GUID or major.minor (set_emitter_parent_version; set_emitter_parent defaults to the exposed version).

Returns: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.

niagara.set_emitter_parent_version (risk 2, mutates, UE 5.1+, requires plugin Niagara, smoke)​

Switches the parent version the emitter inherits from and merges it (parent must use versioning).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
parentstringNew parent emitter asset path (set_emitter_parent).
versionstringParent version: GUID or major.minor (set_emitter_parent_version; set_emitter_parent defaults to the exposed version).

Returns: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.

niagara.set_emitter_persistent_ids (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_platforms (risk 2, mutates, requires plugin Niagara, smoke)​

Restricts the emitter to the given effect quality levels (all = every level).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
indexintegerOverride index for remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic.
spawnCountScalenumberSpawn count multiplier for the override (add); negative leaves the spawn count unscaled. Default 1.0f.

Returns: handle, qualityLevelMask, overrides, count, message, compileStatus.

niagara.set_emitter_preallocation (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_properties (risk 2, mutates, requires plugin Niagara, smoke)​

Sets a reflected emitter property (versioned emitter data on UE 5.1+, the emitter object before) from Unreal property text.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_random_seed (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_scalability (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_sim_stage_enabled (risk 2, mutates, UE ≤4.27, requires plugin Niagara, smoke)​

Enables simulation stages on the emitter (the switch exists on UE 4.27 only; later engines always enable them).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_simulation (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the simulation group in one validated transaction (only given fields change; fields missing on this engine return E_NOT_SUPPORTED). Requests a compile.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
simTargetstringCPUSim or GPUComputeSim (also cpu/gpu); empty leaves it.
localSpacestringtrue/false simulate in local space; empty leaves it.
determinismstringtrue/false deterministic random numbers; empty leaves it.
randomSeedstringRandom seed used when deterministic; empty leaves it.
interpolatedSpawnstringtrue/false interpolated spawning; empty leaves it.
requiresPersistentIdsstringtrue/false persistent particle ids; empty leaves it.
maxGpuParticlesSpawnPerFramestringGPU particles spawned per frame limit (UE 5.0+); empty leaves it.
combineEventSpawnstringtrue/false combine event spawns (UE 4.27 to 5.2); empty leaves it.
maxDeltaTimePerTickstringMaximum delta time per tick in seconds, 0 removes the limit (UE 4.27 to 5.2); empty leaves it.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_emitter_simulation_target (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.
propertystringrequired. Reflected emitter data property, for example SimTarget or bLocalSpace.
valuestringrequired. UE text-import value.

Returns: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.

niagara.set_event_handler (risk 2, mutates, requires plugin Niagara, smoke)​

Edits an event handler's source emitter/event, execution mode, spawn counts and event budget.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
handlerstringrequired. Event handler index or script usage GUID.
sourceEmitterstringSource emitter handle name or index whose events are received; empty keeps the current source.
sourceEventNamestringSource event name, e.g. LocationEvent, DeathEvent, CollisionEvent; empty keeps it.
executionModestringeveryParticle, spawnedParticles or singleParticle; empty keeps it.
spawnNumberintegerParticles spawned per event (spawnedParticles mode); -1 keeps it. Default -1.
maxEventsPerFrameintegerMaximum events consumed per frame (0 = unlimited); -1 keeps it. Default -1.
randomSpawnNumberstringtrue/false to spawn a random count between minSpawnNumber and spawnNumber; empty keeps it.
minSpawnNumberintegerMinimum random spawn count; -1 keeps it. Default -1.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, emitter, handlers, handler, count, compileStatus, message.

niagara.set_fixed_bounds (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
min{x,y,z}required. Minimum fixed-bound coordinate.
max{x,y,z}required. Maximum fixed-bound coordinate.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_light_color (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the light renderer's color offset added to the particle color (ColorAdd, vector text).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_light_radius (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the light renderer's radius scale (RadiusScale).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_light_renderer (risk 2, mutates, requires plugin Niagara, smoke)​

Writes light renderer fields (RadiusScale, DefaultExponent, ColorAdd, falloff and translucency flags...).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.
valuesarray of stringrequired. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None.
addIfMissingbooleanAdd a renderer of this kind to the emitter when it has none. Default false.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.set_linked_input (risk 2, mutates, UE 5.6+, requires plugin Niagara, smoke)​

Links a module input to a namespaced parameter (User., Engine., Emitter., Particles., System.). UE 5.6+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
inputstringrequired. Input path (see list_module_inputs).
parameterstringrequired. Namespaced parameter to read, e.g. User.SpawnCount, Engine.DeltaTime, Emitter.Age. It takes the input's type.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stack, module, inputs, input, count, compileStatus, message.

niagara.set_live_parameter (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_live_visibility (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

Shows or hides a Niagara component in the PIE world.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringNiagara component name; may be omitted when the actor owns exactly one.
visiblebooleanrequired. Show (true) or hide (false) the component.
propagateToChildrenbooleanApply the visibility to attached children too. Default false.

Returns: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.

niagara.set_material_override (risk 2, mutates, requires plugin Niagara, smoke)​

Replaces the material of one override slot (index) of a mesh renderer.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringMesh renderer index; empty means the only mesh renderer.
indexintegerOverride slot index (set/remove). Default -1.
materialstringMaterial asset path (add/set).

Returns: renderer, overrideMaterials, overrides, count, message.

niagara.set_mesh_facing (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_mesh_pivot (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the pivot offset of every mesh entry of a mesh renderer (FVector text); an empty mesh list gets one default entry.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_mesh_renderer (risk 2, mutates, requires plugin Niagara, smoke)​

Writes mesh renderer fields (FacingMode, SortMode, locked axis, frustum/camera culling, flipbook, bOverrideMaterials...); meshes and material overrides have their own tools.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.
valuesarray of stringrequired. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None.
addIfMissingbooleanAdd a renderer of this kind to the emitter when it has none. Default false.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.set_mesh_sort (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_module_enabled (risk 2, mutates, requires plugin Niagara, smoke)​

Enables or disables a stack module (FNiagaraStackGraphUtilities::SetModuleIsEnabled).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
enabledbooleanNew enabled state (set_module_enabled). Default true.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stacks, module, count, compileStatus, message.

niagara.set_module_input (risk 2, mutates, UE 5.2+, requires plugin Niagara, smoke)​

Sets a module input to a local value (rapid-iteration constant or static value), replacing links/dynamic inputs. UE 5.2+.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringEmitter handle name or index; empty for systemSpawn/systemUpdate.
usagestringrequired. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn.
modulestringrequired. Module node GUID, zero-based index in the stack, or exact unique function name.
inputstringrequired. Input path (see list_module_inputs).
valuestringrequired. Local value: float/int as a number, bool as true/false, enum by entry name or number, other types in UE struct text, e.g. (X=0,Y=0,Z=100) or (R=1,G=0.5,B=0,A=1).
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, stack, module, inputs, input, count, compileStatus, message.

niagara.set_paused (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

No description.

ArgumentTypeDescription
actorstringrequired. Actor label/name.
namestringComponent name.
propertystringrequired. Variable name or reflected property.
typestringUE type name. Default TEXT("float").
valuestringrequired. Text-import value.

Returns: component, system, active, message.

niagara.set_properties (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_renderer_binding (risk 2, mutates, requires plugin Niagara, smoke)​

Binds a renderer input (ColorBinding, PositionBinding...) to an attribute such as Particles.Color or User.MyColor, through the engine's binding API.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index.
bindingstringrequired. Binding property name from niagara.list_renderer_bindings, e.g. ColorBinding.
attributestringAttribute to bind (set only), e.g. Particles.Color or User.MyColor.

Returns: renderer, kind, bindings, count, message.

niagara.set_renderer_enabled (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_renderer_material (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the Material of a sprite, ribbon or decal renderer; mesh renderers use the material override tools.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
materialstringrequired. Material asset path.

Returns: message, compileStatus.

niagara.set_renderer_mesh (risk 2, mutates, requires plugin Niagara, smoke)​

Edits one mesh entry (index): mesh, scale and/or pivot offset; empty fields keep their value.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringMesh renderer index; empty means the only mesh renderer.
indexintegerMesh entry index (set/remove). Default -1.
meshstringStatic mesh asset path (add/set; empty keeps the current mesh on set).
scalestringScale as (X=..,Y=..,Z=..); empty keeps the current value.
pivotOffsetstringPivot offset as (X=..,Y=..,Z=..); empty keeps the current value.

Returns: renderer, meshes, count, message.

niagara.set_renderer_property (risk 2, mutates, requires plugin Niagara, smoke)​

Writes any reflected renderer property from Unreal text (advanced; prefer the typed set__renderer tools).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_renderer_sort_order (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_renderer_visibility (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the visibility tag value a renderer draws with (RendererVisibility; sprite, mesh, light, component and decal renderers).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index.
visibilityintegerVisibility tag value the renderer draws with (compared with the RendererVisibilityTag attribute). Default 0.

Returns: renderer, kind, visibility, tagBinding, enabled, message.

niagara.set_ribbon_facing (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_ribbon_renderer (risk 2, mutates, requires plugin Niagara, smoke)​

Writes ribbon renderer fields (Material, FacingMode, UV0Settings/UV1Settings, Shape, tessellation...).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.
valuesarray of stringrequired. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None.
addIfMissingbooleanAdd a renderer of this kind to the emitter when it has none. Default false.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.set_ribbon_tessellation (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_ribbon_uv (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the UV0 tiling length of a ribbon renderer (UV0Settings.TilingLength).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_scalability_override (risk 2, mutates, requires plugin Niagara, smoke)​

Edits the system scalability override at index (only the given fields change).

ArgumentTypeDescription
systemstringNiagara system asset path (system overrides) or empty when effectType is given.
effectTypestringEffect type asset path (effect-type tools; empty uses the system's effect type).
indexintegerEntry index for set/remove. Default -1.
qualityLevelsstringEffect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it.
cullByDistancestringCull by distance: true/false (empty leaves it). Setting distance fields turns their override on.
maxDistancestringMaximum distance in cm (empty leaves it).
cullMaxInstanceCountstringCull when the effect type exceeds maxInstances: true/false (empty leaves it).
maxInstancesstringMaximum instances of this effect type (empty leaves it).
cullPerSystemMaxInstanceCountstringCull when this system exceeds maxSystemInstances: true/false (empty leaves it).
maxSystemInstancesstringMaximum instances of this system (empty leaves it).

Returns: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.

niagara.set_simulation_stage (risk 2, mutates, requires plugin Niagara, smoke)​

Renames, enables/disables a simulation stage or sets its iteration source and partial-update flag.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
stagestringSimulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage.
namestringStage name when adding; new name when setting (empty keeps it).
indexintegerTarget zero-based index (add: insert position, -1 appends; move: required destination). Default -1.
enabledstringtrue/false to enable or disable the stage; empty keeps it.
iterationSourcestringParticles or DataInterface (DirectSet on engines that have it); empty keeps it.
disablePartialParticleUpdatestringtrue/false for Disable Partial Particle Update; empty keeps it.
compilebooleanRequest a system compile after the change (default true). Default true.

Returns: system, emitter, stages, stage, count, compileStatus, message.

niagara.set_sprite_alignment (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_sprite_cutout (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_sprite_facing (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_sprite_pivot (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_sprite_renderer (risk 2, mutates, requires plugin Niagara, smoke)​

Writes sprite renderer fields (Material, Alignment, FacingMode, SortMode, PivotInUVSpace, SubImageSize, cutout, camera distance culling...).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringRenderer index from niagara.list_renderers; empty means the only renderer of this kind.
valuesarray of stringrequired. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None.
addIfMissingbooleanAdd a renderer of this kind to the emitter when it has none. Default false.

Returns: system, emitter, index, kind, class, enabled, fields, changed, message.

niagara.set_sprite_sort (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_sprite_sub_uv (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind when the emitter has exactly one renderer of that kind.
propertystringrequired. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field).
valuestringrequired. UE text-import value.

Returns: message, compileStatus.

niagara.set_system_allow_culling_for_local_players (risk 2, mutates, UE 5.0+, requires plugin Niagara, smoke)​

Overrides the effect type's allow-culling-for-local-players flag on this system (UE 5.0+).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_auto_deactivate (risk 2, mutates, UE ≤5.3, requires plugin Niagara, smoke)​

Sets whether the system deactivates automatically when all emitters finish (the flag exists up to UE 5.3).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_cull_reaction (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the cull reaction (Deactivate, DeactivateImmediate, DeactivateResume, DeactivateImmediateResume) on the system's effect type.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_fixed_bounds_mode (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_metadata (risk 2, mutates, requires plugin Niagara, smoke)​

Sets asset metadata: description, category (UE 5.0+) and library visibility.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
descriptionstringAsset description shown in the asset picker (empty leaves it; "none" clears it).
categorystringLibrary category (UE 5.0+; empty leaves it; "none" clears it).
libraryVisibilitystringUnexposed, Library or Hidden (UE 5.0+); UE 4.27 accepts Unexposed or Library. Empty leaves it.

Returns: target, fields, count, message, compileStatus.

niagara.set_system_override_scalability (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_performance (risk 2, mutates, requires plugin Niagara, smoke)​

Sets cook/edit performance switches: rapid-iteration baking, attribute compression and trimming, debug switches.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
bakeOutRapidIterationstringtrue/false bake rapid-iteration parameters while editing (empty leaves it).
bakeOutRapidIterationOnCookstringtrue/false bake rapid-iteration parameters on cook (empty leaves it).
compressAttributesstringtrue/false compress particle attributes (empty leaves it).
trimAttributesstringtrue/false trim unused attributes while editing (empty leaves it).
trimAttributesOnCookstringtrue/false trim unused attributes on cook (empty leaves it).
disableDebugSwitchesstringtrue/false disable debug switches (empty leaves it).

Returns: target, fields, count, message, compileStatus.

niagara.set_system_rendering (risk 2, mutates, UE 5.0+, requires plugin Niagara, smoke)​

Sets default rendering overrides of the system (cast shadow, decals, custom depth, stencil; translucency sort on UE 5.1+); "default" clears an override.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
castShadowstringtrue/false overrides component cast shadow; "default" removes the override; empty leaves it.
receivesDecalsstringtrue/false receives decals; "default" removes the override; empty leaves it.
renderCustomDepthstringtrue/false render custom depth; "default" removes the override; empty leaves it.
customDepthStencilValuestringCustom depth stencil value 0-255; "default" removes the override; empty leaves it.
translucencySortPrioritystringTranslucency sort priority (UE 5.1+); "default" removes the override; empty leaves it.
translucencySortDistanceOffsetstringTranslucency sort distance offset (UE 5.1+); "default" removes the override; empty leaves it.

Returns: target, fields, count, message, compileStatus.

niagara.set_system_scalability_override (risk 2, mutates, requires plugin Niagara, smoke)​

Replaces the system scalability overrides (FNiagaraSystemScalabilityOverrides text, e.g. (Overrides=())).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_significance_handler (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the significance handler of the system's effect type: Distance, Age, a handler class path, or None.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_simulation (risk 2, mutates, requires plugin Niagara, smoke)​

Sets the simulation settings group; UE 5.0-only fields are rejected with E_NOT_SUPPORTED on 4.27. Requests a compile.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
warmupTimestringWarmup seconds (empty leaves it).
warmupTickCountstringWarmup tick count (empty leaves it).
warmupTickDeltastringWarmup tick delta in seconds (empty leaves it).
determinismstringtrue/false deterministic simulation (UE 5.0+; empty leaves it).
randomSeedstringRandom seed used when deterministic (UE 5.0+; empty leaves it).
fixedTickDeltastringtrue/false fixed tick delta (UE 5.0+; empty leaves it).
fixedTickDeltaTimestringFixed tick delta seconds (UE 5.0+; empty leaves it).

Returns: target, fields, count, message, compileStatus.

niagara.set_system_thumbnail_age (risk 2, mutates, UE ≤5.0, requires plugin Niagara, smoke)​

Marks the system thumbnail as out of date (the flag exists up to UE 5.0).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_trim_attributes (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_warmup_tick_count (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_system_warmup_tick_delta (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
propertystringrequired. Reflected system property name.
valuestringrequired. UE text-import value.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.set_user_parameter (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.set_user_parameter_bool (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.set_user_parameter_color (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.set_user_parameter_data_interface (risk 2, mutates, requires plugin Niagara, smoke)​

Writes editable fields of a data interface user parameter (Field=Value entries; object fields take asset paths).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. Data interface user parameter name.
valuesarray of stringrequired. Field=Value entries; fields must be editable properties of the data interface class (see niagara.get_user_parameter_data_interface). Object fields take asset paths.

Returns: owner, parameter, fields, message.

niagara.set_user_parameter_float (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.set_user_parameter_int (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.set_user_parameter_material (risk 2, mutates, requires plugin Niagara, smoke)​

Sets a material user parameter (UMaterialInterface asset; None clears it).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.
assetstringrequired. Asset path or unique asset name; None clears the value.
addIfMissingbooleanCreate the user parameter with the tool's object type when it does not exist yet. Default false.

Returns: owner, parameter, fields, message.

niagara.set_user_parameter_matrix (risk 2, mutates, requires plugin Niagara, smoke)​

Sets a 4x4 matrix user parameter from sixteen floats (row-major).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.
valuesarray of numberrequired. Sixteen floats in row-major order (M[0][0], M[0][1] ... M[3][3]).
addIfMissingbooleanCreate the user parameter as a matrix when it does not exist yet. Default false.

Returns: owner, parameter, fields, message.

niagara.set_user_parameter_object (risk 2, mutates, requires plugin Niagara, smoke)​

Sets a generic UObject user parameter to any asset (None clears it).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.
assetstringrequired. Asset path or unique asset name; None clears the value.
addIfMissingbooleanCreate the user parameter with the tool's object type when it does not exist yet. Default false.

Returns: owner, parameter, fields, message.

niagara.set_user_parameter_position (risk 2, mutates, UE 5.0+, requires plugin Niagara, smoke)​

Sets a position user parameter (large-world position type, UE 5.0+); value is (X=..,Y=..,Z=..).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.
valuestringrequired. Unreal text value, e.g. (X=1,Y=2) for vec2, (X=1,Y=2,Z=3) for position, (X=0,Y=0,Z=0,W=1) for quat.
addIfMissingbooleanCreate the user parameter with this type when it does not exist yet. Default false.

Returns: owner, parameter, fields, message.

niagara.set_user_parameter_quat (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.set_user_parameter_render_target (risk 2, mutates, requires plugin Niagara, smoke)​

Sets a texture render target user parameter (UTextureRenderTarget asset; None clears it).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.
assetstringrequired. Asset path or unique asset name; None clears the value.
addIfMissingbooleanCreate the user parameter with the tool's object type when it does not exist yet. Default false.

Returns: owner, parameter, fields, message.

niagara.set_user_parameter_static_mesh (risk 2, mutates, UE 5.0+, requires plugin Niagara, smoke)​

Sets a static mesh user parameter (UE 5.0+; None clears it).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.
assetstringrequired. Asset path or unique asset name; None clears the value.
addIfMissingbooleanCreate the user parameter with the tool's object type when it does not exist yet. Default false.

Returns: owner, parameter, fields, message.

niagara.set_user_parameter_texture (risk 2, mutates, requires plugin Niagara, smoke)​

Sets a texture user parameter (UTexture asset; None clears it).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without the User. prefix.
assetstringrequired. Asset path or unique asset name; None clears the value.
addIfMissingbooleanCreate the user parameter with the tool's object type when it does not exist yet. Default false.

Returns: owner, parameter, fields, message.

niagara.set_user_parameter_vec2 (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.set_user_parameter_vec3 (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.set_user_parameter_vec4 (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
namestringrequired. User parameter name, with or without User. prefix.
newNamestringNew name for rename operations.
typestringUE type name: float, int, bool, vec2, vec3, vec4, quat, color. Default TEXT("float").
valuestringText-import default value.

Returns: parameters, count, message.

niagara.set_warmup (risk 2, mutates, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
secondsnumberrequired. Warmup seconds.

Returns: asset, emitterCount, compileStatus, message, handles.

niagara.spawn_actor (risk 2, mutates, requires plugin Niagara, requires world, smoke)​

Places a Niagara actor in the editor level with the given system, label and location.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
actorstringOptional actor label for the spawned test actor.
location{x,y,z}Spawn location.
namestringComponent name.

Returns: component, system, active, message.

niagara.spawn_at_location (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
actorstringOptional actor label for the spawned test actor.
location{x,y,z}Spawn location.
namestringComponent name.

Returns: component, system, active, message.

niagara.spawn_attached (risk 2, mutates, requires plugin Niagara, requires PIE, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
actorstringrequired. Existing actor label/name to attach to.
componentstringOptional component name on the actor.
location{x,y,z}Relative location.

Returns: component, system, active, message.

niagara.spawn_test_actor (risk 2, mutates, requires plugin Niagara, requires PIE, requires world, smoke)​

Spawns a PIE test actor whose root is a Niagara component (named NiagaraSmokeComponent) playing the system.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
actorstringOptional actor label for the spawned test actor.
location{x,y,z}Spawn location.
namestringComponent name.

Returns: component, system, active, message.

niagara.sync_emitter_with_parent (risk 2, mutates, requires plugin Niagara, smoke)​

Pulls the parent's changes into the emitter (merge) when it is not synchronized.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Handle name, index or handle id GUID.

Returns: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.

niagara.validate (risk 0, requires plugin Niagara, smoke)​

No description.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: valid, ready, compileStatus, errors, message, issues, warningCount.

niagara.validate_renderer_bindings (risk 0, requires plugin Niagara, smoke)​

Checks a renderer's bindings: every non-particle binding must read a variable the emitter provides (state of the last compile).

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.
emitterstringrequired. Emitter handle name or index.
rendererstringrequired. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind.

Returns: valid, checked, issues, message.

niagara.validate_renderers (risk 0, requires plugin Niagara, smoke)​

Validates every enabled renderer of a system against its kind's schema: sim-target support, material, meshes, component type, overrides and bindings.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: valid, checked, issues, message.

niagara.wait_compile (risk 0, requires plugin Niagara, smoke)​

Blocks until the system's pending compilation (VM scripts, not GPU shaders) has finished, using Niagara's own wait, and returns the final status.

ArgumentTypeDescription
systemstringrequired. Niagara system asset path.

Returns: asset, emitterCount, compileStatus, message, handles.