Kit niagara
330 herramientas. Generado a partir del código fuente del plugin; no lo edites a mano.
Las descripciones de las herramientas y de los argumentos se muestran en inglés porque reflejan el schema de las herramientas (el mismo texto que el agente recibe en
tools/list).
Guía
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
| Argument | Form |
|---|---|
system | asset path (/Game/FX/NS_Sparks) or a unique asset name |
emitter | emitter handle name or index inside the system |
renderer | index 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 name | SpawnRate or User.SpawnRate |
collection parameter name | friendly 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.compilerequests compilation;get_compile_statuspolls;wait_compilewaits 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_propertieswrites any reflectedUNiagaraSystemproperty 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_overrideon 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, thenset_effect_type;set_system_cull_reactionandset_system_significance_handleredit 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) thenimport_recipe(inline recipe or file) rebuilds a system from emitter source assets, property overrides and user parameters; emitters without a parent asset are listed underskipped.
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+.
| Kind | get / set | Typical fields |
|---|---|---|
| sprite | get_sprite_renderer / set_sprite_renderer | Material, Alignment, FacingMode, SortMode, PivotInUVSpace, SubImageSize, bSubImageBlend, cutout, camera-distance culling, RendererVisibility |
| mesh | get_mesh_renderer / set_mesh_renderer | FacingMode, SortMode, locked axis, frustum/camera culling, flipbook, bOverrideMaterials |
| ribbon | get_ribbon_renderer / set_ribbon_renderer | Material, FacingMode, UV0Settings/UV1Settings, Shape, MultiPlaneCount, TubeSubdivisions, tessellation |
| light | get_light_renderer / set_light_renderer | RadiusScale, DefaultExponent, ColorAdd, falloff and translucency flags |
| component | get_component_renderer / set_component_renderer | ComponentType (class), ComponentCountLimit, bAssignComponentsOnParticleID |
| decal (5.2+) | get_decal_renderer / set_decal_renderer | Material, 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).
| Type | Set | Get |
|---|---|---|
| float, int, bool, vec3, vec4, color | set_user_parameter or set_user_parameter_<type> | get_user_parameter |
| vec2, quat | set_user_parameter_vec2 / _quat | get_user_parameter_vec2 / _quat |
| position (5.0+) | set_user_parameter_position ((X=..,Y=..,Z=..), double precision kept) | get_user_parameter_position |
| matrix | set_user_parameter_matrix (values: 16 floats, row-major) | get_user_parameter_matrix |
| object | set_user_parameter_object (any asset) | get_user_parameter_object |
| texture, render target, material | set_user_parameter_texture / _render_target / _material | matching get_ |
| static mesh (5.0+) | set_user_parameter_static_mesh | get_user_parameter_static_mesh |
| data interface | add_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(leaveemitterempty), oremitterSpawn,emitterUpdate,particleSpawn,particleUpdate,event:<index|guid>,stage:<index|guid|name>(withemitter). A module is its GUID (fromlist_modules), its index, or its unique name. An input is its name or display name;Parent/Childreaches 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+), keepmodule.guid; 3)niagara.list_module_inputs {…, module:<guid>}(5.2+); 4)niagara.set_module_input {…, input:'SpawnRate', value:'25'}, orset_linked_input {parameter:'User.Rate'}(5.6+), orset_dynamic_input {dynamicInputScript:'/Niagara/DynamicInputs/UniformRange/UniformRangedFloat'}thenset_module_input {input:'SpawnRate/Minimum'}; 5)reset_module_inputto 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 viausage:'stage:<name>', thenset_simulation_stage/move_simulation_stage/remove_simulation_stage.set_event_handleredits 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 withset_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.
| Tool | Does |
|---|---|
batch_compile | requests compilation of every system |
batch_validate | system validity, emitters without renderers and every renderer check |
batch_set_scalability | assigns one effect type (None clears) |
batch_replace_material | swaps from → to in sprite/ribbon/decal materials and mesh override slots |
batch_set_renderer_field | writes one schema field on every renderer of a kind |
batch_set_user_parameter | sets a numeric user parameter default where it exists (type-checked) |
batch_rename_user_parameter | renames a user parameter and requests compilation |
batch_audit_user_parameters | user parameter schema audit per system |
batch_set_fixed_bounds | sets 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_systems | finders; 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.
create,add_emitter {"emitterAsset":"SimpleSpriteBurst","name":"Burst"}.add_user_parameters {"parameters":["Tint:color=(R=1,G=0.2,B=0,A=1)","Size:float=20"]}.- Bind or reference them in modules (see the stack editing section),
set_renderer_bindingfor renderer inputs that should readUser.data. compile,wait_compile,validate_renderers.- 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_ARGorE_NOT_SUPPORTEDnaming 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 andkill_allneed PIE.
Herramientas
Leyenda. riesgo 0 = solo lectura, 1 = operación inofensiva del editor, 2 = modifica un asset, 3 = elimina/reemplaza un asset, 4 = proyecto/configuración/build, 5 = potencialmente destructivo (las llamadas por encima de
MaxAutoRiskrequieren"_confirm": true). modifica = se ejecuta en una transacción (edit.undo la revierte). requiere PIE / requiere mundo = se rechaza sin una sesión PIE / sin un nivel abierto. requiere el plugin = no disponible cuando el plugin está desactivado. dryRun = acepta el argumentodryRun. smoke = cubierto poredit.self_test.
niagara.activate (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
system | string | obligatorio. Niagara system asset path. |
name | string | Component name. |
Devuelve: component, system, active, message.
niagara.activate_live_component (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Activates (restarts) a Niagara component in the PIE world.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.add_collection_parameter (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Adds a parameter to a collection; name is the friendly name (the NPC namespace is added) and value an optional default.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
name | string | obligatorio. Parameter name. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | Text-import value. |
Devuelve: parameters, count, message.
niagara.add_collection_parameters (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Adds several collection parameters in one call; each entry is "Name:type=value".
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
parameters | array of string | obligatorio. Entries "Name:type=value". |
Devuelve: parameters, count, message.
niagara.add_component (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
system | string | obligatorio. Niagara system asset path. |
name | string | Component name. |
Devuelve: component, system, active, message.
niagara.add_effect_type_emitter_scalability (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Appends an emitter spawn-count scaling entry (quality levels + scale) to an effect type.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (used to find the effect type when effectType is empty). |
effectType | string | Effect type asset path. |
index | integer | Entry index for remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. |
scaleSpawnCount | boolean | Scale spawn counts on these quality levels. Valor predeterminado true. |
spawnCountScale | number | Spawn count multiplier (0..1 typical). Valor predeterminado 1.0f. |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.add_effect_type_scalability (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Appends a per-quality system scalability setting to an effect type (distance and instance culling).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (system overrides) or empty when effectType is given. |
effectType | string | Effect type asset path (effect-type tools; empty uses the system's effect type). |
index | integer | Entry index for set/remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it. |
cullByDistance | string | Cull by distance: true/false (empty leaves it). Setting distance fields turns their override on. |
maxDistance | string | Maximum distance in cm (empty leaves it). |
cullMaxInstanceCount | string | Cull when the effect type exceeds maxInstances: true/false (empty leaves it). |
maxInstances | string | Maximum instances of this effect type (empty leaves it). |
cullPerSystemMaxInstanceCount | string | Cull when this system exceeds maxSystemInstances: true/false (empty leaves it). |
maxSystemInstances | string | Maximum instances of this system (empty leaves it). |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.add_emitter (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitterAsset | string | obligatorio. Emitter asset path or common alias such as Fountain. |
name | string | Handle name. Valor predeterminado TEXT("Emitter"). |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.add_emitter_scalability_override (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Adds a spawn-count scalability override for the given quality levels.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
index | integer | Override index for remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. |
spawnCountScale | number | Spawn count multiplier for the override (add); negative leaves the spawn count unscaled. Valor predeterminado 1.0f. |
Devuelve: handle, qualityLevelMask, overrides, count, message, compileStatus.
niagara.add_emitter_version (riesgo 2, modifica, UE 5.1+, requiere el plugin Niagara, smoke)
Adds a version (major >= 1, not 1.0, not existing) copied from the closest lower version.
| Argumento | Tipo | Descripción |
|---|---|---|
emitterAsset | string | obligatorio. Standalone emitter asset path. |
version | string | Version selector: GUID or major.minor. |
major | integer | Major version for add_emitter_version (>= 1). Valor predeterminado 1. |
minor | integer | Minor version for add_emitter_version. Valor predeterminado 1. |
Devuelve: asset, versioningEnabled, exposedVersion, versions, count, message.
niagara.add_event_handler (riesgo 2, modifica, requiere el 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:
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
handler | string | Event handler index or script usage GUID (get/remove). |
sourceEmitter | string | Emitter handle that generates the events (name, index or id; add). |
eventName | string | Source event name, e.g. LocationEvent, DeathEvent, CollisionEvent (add). |
executionMode | string | everyParticle, spawnedParticles, or singleParticle. Valor predeterminado TEXT("everyParticle"). |
spawnNumber | integer | Spawn count for spawned-particles execution. Valor predeterminado 0. |
maxEventsPerFrame | integer | Maximum events consumed per frame (0 = unlimited). Valor predeterminado 0. |
Devuelve: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.
niagara.add_material_override (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Appends a material override slot to a mesh renderer and turns bOverrideMaterials on.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Mesh renderer index; empty means the only mesh renderer. |
index | integer | Override slot index (set/remove). Valor predeterminado -1. |
material | string | Material asset path (add/set). |
Devuelve: renderer, overrideMaterials, overrides, count, message.
niagara.add_module (riesgo 2, modifica, UE 5.1+, requiere el 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+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
moduleScript | string | obligatorio. Niagara module script asset path (usage Module), e.g. /Niagara/Modules/Emitter/SpawnRate. |
usage | string | Target stack usage (see list_stacks), default systemSpawn. Valor predeterminado TEXT("systemSpawn"). |
index | integer | Zero-based insert position in the stack; -1 appends. Valor predeterminado -1. |
name | string | Optional suggested module name (made unique by the engine). |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stacks, module, count, compileStatus, message.
niagara.add_renderer (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
type | string | obligatorio. sprite, mesh, ribbon, light, component or decal (UE 5.2+), or a comma-separated list of them. |
Devuelve: renderers, count, message.
niagara.add_renderer_mesh (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Appends a mesh entry (static mesh, optional scale and pivot offset) to a mesh renderer.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Mesh renderer index; empty means the only mesh renderer. |
index | integer | Mesh entry index (set/remove). Valor predeterminado -1. |
mesh | string | Static mesh asset path (add/set; empty keeps the current mesh on set). |
scale | string | Scale as (X=..,Y=..,Z=..); empty keeps the current value. |
pivotOffset | string | Pivot offset as (X=..,Y=..,Z=..); empty keeps the current value. |
Devuelve: renderer, meshes, count, message.
niagara.add_scalability_override (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (system overrides) or empty when effectType is given. |
effectType | string | Effect type asset path (effect-type tools; empty uses the system's effect type). |
index | integer | Entry index for set/remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it. |
cullByDistance | string | Cull by distance: true/false (empty leaves it). Setting distance fields turns their override on. |
maxDistance | string | Maximum distance in cm (empty leaves it). |
cullMaxInstanceCount | string | Cull when the effect type exceeds maxInstances: true/false (empty leaves it). |
maxInstances | string | Maximum instances of this effect type (empty leaves it). |
cullPerSystemMaxInstanceCount | string | Cull when this system exceeds maxSystemInstances: true/false (empty leaves it). |
maxSystemInstances | string | Maximum instances of this system (empty leaves it). |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.add_set_parameters_module (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Adds a Set Parameters (assignment) module writing one typed parameter to any stack; returns the module and the stack.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | Target stack usage (see list_stacks), default systemSpawn. Valor predeterminado TEXT("systemSpawn"). |
name | string | obligatorio. Parameter to write. Without a namespace the stack's own namespace is used (System., Emitter. or Particles.). |
type | string | float, int, bool, vec2, vec3, vec4, quat or color. Valor predeterminado TEXT("float"). |
value | string | Default value in the pin text format (e.g. 1.0, (X=1,Y=2,Z=3), (R=1,G=0,B=0,A=1)). |
index | integer | Zero-based insert position in the stack; -1 appends. Valor predeterminado -1. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stacks, module, count, compileStatus, message.
niagara.add_simulation_stage (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Adds a generic simulation stage with an empty stack (script + graph output) at an index.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
stage | string | Simulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage. |
name | string | Stage name when adding; new name when setting (empty keeps it). |
index | integer | Target zero-based index (add: insert position, -1 appends; move: required destination). Valor predeterminado -1. |
enabled | string | true/false to enable or disable the stage; empty keeps it. |
iterationSource | string | Particles or DataInterface (DirectSet on engines that have it); empty keeps it. |
disablePartialParticleUpdate | string | true/false for Disable Partial Particle Update; empty keeps it. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, emitter, stages, stage, count, compileStatus, message.
niagara.add_user_data_interface (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Adds a data interface user parameter of the given class (the data interface object is created with the class defaults).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
dataInterfaceClass | string | obligatorio. Data interface class, e.g. NiagaraDataInterfaceTexture or NiagaraDataInterfaceCurve (see niagara.list_data_interface_classes). |
Devuelve: owner, parameter, fields, message.
niagara.add_user_parameter (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.add_user_parameters (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
parameters | array of string | obligatorio. Entries "Name:type=value"; type is float, int, bool, vec2, vec3, vec4, quat or color. |
Devuelve: parameters, count, message.
niagara.advance_live_component (riesgo 2, modifica, requiere el plugin Niagara, requiere 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).
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
tickCount | integer | obligatorio. Number of simulation ticks to run (1-600). |
tickDelta | number | Seconds per tick (0-0.5]. Valor predeterminado 0.0333f. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.apply_stack_issue (riesgo 2, modifica, UE 5.2+, requiere el 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+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index (only that emitter's stack). Empty = the system stack and every emitter stack. |
issue | string | Issue unique id (from list_stack_issues) or zero-based index. Empty: get lists every issue; apply applies the first fix of every fixable issue. |
fix | string | Fix unique id or zero-based index within the issue; empty = the issue's first fix (apply_stack_issue). |
compile | boolean | Request a system compile after applying fixes (default true). Valor predeterminado true. |
Devuelve: system, issues, issue, applied, count, compileStatus, message.
niagara.audit (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: scripts, count, message.
niagara.audit_collection (riesgo 0, requiere el plugin Niagara, smoke)
Audits a collection's schema and defaults: parameters outside its namespace, unset objects, and instances whose parameters drifted from the collection.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
Devuelve: asset, collection, namespace, parameters, related, count, issues, message.
niagara.audit_user_parameters (riesgo 0, requiere el 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).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: owner, parameters, count, issues, message.
niagara.batch_audit_user_parameters (riesgo 0, requiere el plugin Niagara, smoke)
Audits the user parameter schema of every system in the folder (namespace, unset objects/data interfaces, duplicate friendly names).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.batch_compile (riesgo 2, modifica, requiere el plugin Niagara, dryRun, smoke)
Requests compilation of every system in the folder; items[] lists each system as changed, wouldChange or failed (with the reason).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.batch_rename_user_parameter (riesgo 2, modifica, requiere el 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).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
name | string | obligatorio. Current user parameter name, with or without the User. prefix. |
newName | string | obligatorio. New user parameter name. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.batch_replace_material (riesgo 2, modifica, requiere el plugin Niagara, dryRun, smoke)
Replaces a material in every renderer material slot (sprite/ribbon/decal Material, mesh override slots) of the folder's systems.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
from | string | obligatorio. Material to replace (asset path). |
to | string | obligatorio. Replacement material (asset path). |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.batch_set_fixed_bounds (riesgo 2, modifica, requiere el plugin Niagara, dryRun, smoke)
Sets the same fixed bounds on every system in the folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
min | {x,y,z} | obligatorio. Minimum corner. |
max | {x,y,z} | obligatorio. Maximum corner. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.batch_set_renderer_field (riesgo 2, modifica, requiere el plugin Niagara, dryRun, smoke)
Writes one schema field (list_renderer_fields) on every renderer of a kind in the folder's systems.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
kind | string | obligatorio. Renderer kind: sprite, mesh, ribbon, light, component or decal (UE 5.2+). |
field | string | obligatorio. Schema field of that kind (niagara.list_renderer_fields). |
value | string | obligatorio. Unreal text value. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.batch_set_scalability (riesgo 2, modifica, requiere el plugin Niagara, dryRun, smoke)
Assigns one effect type (the scalability settings container) to every system in the folder; None clears it.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
effectType | string | obligatorio. Effect type asset path (its scalability settings apply to every system); None clears it. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.batch_set_user_parameter (riesgo 2, modifica, requiere el 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).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
type | string | obligatorio. float, int, bool, vec2, vec3, vec4, quat or color; systems whose parameter has another type fail. |
value | string | obligatorio. Unreal text value. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.batch_validate (riesgo 0, requiere el plugin Niagara, smoke)
Validates every system in the folder: system validity, emitters without renderers and every renderer check of niagara.validate_renderers.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.cancel_compile (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Cancels the system's in-flight compilations (they are requested again by the next compile).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.capture_component_state (riesgo 0, requiere el plugin Niagara, requiere mundo, 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.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.capture_live_component_state (riesgo 0, requiere el plugin Niagara, requiere PIE, smoke)
Captures the same state for a Niagara component in the PIE world.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.compile (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.copy_user_parameters (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Copies user parameters (definition, default value, object or data interface settings) from one system to another.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Source Niagara system asset path. |
targetSystem | string | obligatorio. Destination Niagara system asset path. |
names | array of string | User parameter names to copy (with or without User.); empty copies every user parameter. |
overwrite | boolean | Replace parameters that already exist on the destination with the same type. Valor predeterminado false. |
Devuelve: owner, parameters, count, issues, message.
niagara.create (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.create_effect_type (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Creates a Niagara effect type asset (scalability, cull reaction and significance settings shared by systems).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.create_emitter_asset (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare emitter asset name. |
parent | string | Optional parent/template emitter asset path. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.create_from_template (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
template | string | obligatorio. Template system path or a bare name under /Niagara/DefaultAssets/Templates/Systems (SimpleExplosion, RadialBurst, DirectionalBurst). |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.create_parameter_collection (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare collection name. |
Devuelve: parameters, count, message.
niagara.create_parameter_collection_instance (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parent collection asset path. |
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare instance asset name. |
Devuelve: parameters, count, message.
niagara.deactivate (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
system | string | obligatorio. Niagara system asset path. |
name | string | Component name. |
Devuelve: component, system, active, message.
niagara.deactivate_live_component (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Deactivates a Niagara component in the PIE world (existing particles finish).
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.delete (riesgo 3, modifica, destructivo, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: message, compileStatus.
niagara.delete_actor (riesgo 3, modifica, destructivo, requiere el plugin Niagara, requiere mundo, smoke)
Deletes an editor-level actor that owns a Niagara component (refuses other actors).
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
Devuelve: message, compileStatus.
niagara.delete_emitter_version (riesgo 3, modifica, destructivo, UE 5.1+, requiere el plugin Niagara, smoke)
Deletes a version (never the exposed version or 1.0).
| Argumento | Tipo | Descripción |
|---|---|---|
emitterAsset | string | obligatorio. Standalone emitter asset path. |
version | string | Version selector: GUID or major.minor. |
major | integer | Major version for add_emitter_version (>= 1). Valor predeterminado 1. |
minor | integer | Minor version for add_emitter_version. Valor predeterminado 1. |
Devuelve: asset, versioningEnabled, exposedVersion, versions, count, message.
niagara.diff_emitter (riesgo 0, requiere el plugin Niagara, smoke)
Compares two emitter handles (same or different systems): editable emitter data, renderer classes, event handler and simulation stage counts.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path of the first emitter. |
emitter | string | obligatorio. First handle name, index or id. |
otherSystem | string | System of the second emitter (empty = same system). |
otherEmitter | string | obligatorio. Second handle name, index or id. |
Devuelve: a, b, identical, differences, count.
niagara.diff_system (riesgo 0, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. First Niagara system asset path. |
other | string | obligatorio. Second Niagara system asset path. |
Devuelve: a, b, identical, differences, count.
niagara.duplicate (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Source system asset path. |
folder | string | obligatorio. Destination folder. |
newName | string | obligatorio. Bare destination name. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.duplicate_collection (riesgo 2, modifica, UE 5.3+, requiere el plugin Niagara, smoke)
Duplicates a parameter collection; the engine gives the copy a unique namespace (UE 5.3+).
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Source parameter collection asset path. |
folder | string | obligatorio. Destination folder under /Game. |
newName | string | obligatorio. Bare destination asset name. |
Devuelve: asset, collection, namespace, parameters, related, count, issues, message.
niagara.duplicate_emitter (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
newName | string | New handle name for rename. |
value | boolean | New enabled/isolated state. Valor predeterminado false. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.duplicate_renderer (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Copies a renderer (all settings) into the same or another emitter of the system.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index that owns the renderer. |
renderer | string | obligatorio. Renderer index to copy. |
targetEmitter | string | Destination emitter handle name or index; empty copies inside the same emitter. |
Devuelve: renderers, count, message.
niagara.enable_emitter_versioning (riesgo 2, modifica, UE 5.1+, requiere el plugin Niagara, smoke)
Enables versioning on a standalone emitter asset (the current data becomes version 1.0).
| Argumento | Tipo | Descripción |
|---|---|---|
emitterAsset | string | obligatorio. Standalone emitter asset path. |
version | string | Version selector: GUID or major.minor. |
major | integer | Major version for add_emitter_version (>= 1). Valor predeterminado 1. |
minor | integer | Minor version for add_emitter_version. Valor predeterminado 1. |
Devuelve: asset, versioningEnabled, exposedVersion, versions, count, message.
niagara.export_recipe (riesgo 0, requiere el plugin Niagara, smoke)
Exports a portable recipe (emitters by source asset, emitter and system property overrides, user parameters); optional file writes it as JSON.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
file | string | Optional absolute .json file to write; empty returns the recipe only. |
Devuelve: recipe, file, asset, handles, message, compileStatus.
niagara.export_summary (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: scripts, count, message.
niagara.expose_emitter_version (riesgo 2, modifica, UE 5.1+, requiere el plugin Niagara, smoke)
Makes a version (GUID or major.minor) the exposed one that new users inherit from.
| Argumento | Tipo | Descripción |
|---|---|---|
emitterAsset | string | obligatorio. Standalone emitter asset path. |
version | string | Version selector: GUID or major.minor. |
major | integer | Major version for add_emitter_version (>= 1). Valor predeterminado 1. |
minor | integer | Minor version for add_emitter_version. Valor predeterminado 1. |
Devuelve: asset, versioningEnabled, exposedVersion, versions, count, message.
niagara.find_by_data_interface (riesgo 0, requiere el plugin Niagara, smoke)
Finds systems that use a data interface class anywhere (user parameters or module inputs).
| Argumento | Tipo | Descripción |
|---|---|---|
dataInterfaceClass | string | obligatorio. Data interface class, e.g. NiagaraDataInterfaceTexture. |
folder | string | Content folder searched recursively; empty means /Game. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.find_by_effect_type (riesgo 0, requiere el plugin Niagara, smoke)
Finds systems assigned to an effect type (None finds systems without one).
| Argumento | Tipo | Descripción |
|---|---|---|
effectType | string | obligatorio. Effect type asset path; None finds systems without an effect type. |
folder | string | Content folder searched recursively; empty means /Game. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.find_by_emitter_parent (riesgo 0, requiere el plugin Niagara, smoke)
Finds systems whose emitters were created from (inherit) an emitter asset or template.
| Argumento | Tipo | Descripción |
|---|---|---|
emitter | string | obligatorio. Emitter asset path (or template name) the system emitters were created from. |
folder | string | Content folder searched recursively; empty means /Game. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.find_by_material (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
material | string | obligatorio. Material asset path. |
folder | string | Content folder searched recursively; empty means /Game. |
Devuelve: scripts, count, message.
niagara.find_by_mesh (riesgo 0, requiere el plugin Niagara, smoke)
Finds systems whose mesh renderers draw a static mesh.
| Argumento | Tipo | Descripción |
|---|---|---|
mesh | string | obligatorio. Static mesh asset path. |
folder | string | Content folder searched recursively; empty means /Game. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.find_by_parameter (riesgo 0, requiere el plugin Niagara, smoke)
Finds systems exposing a user parameter (optionally of one type).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. User parameter name, with or without the User. prefix. |
type | string | Optional kit type label to require (float, texture, di: |
folder | string | Content folder searched recursively; empty means /Game. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.find_by_renderer (riesgo 0, requiere el plugin Niagara, smoke)
Finds systems with a renderer of a kind (items list emitter and renderer index).
| Argumento | Tipo | Descripción |
|---|---|---|
kind | string | obligatorio. Renderer kind: sprite, mesh, ribbon, light, component or decal (UE 5.2+). |
folder | string | Content folder searched recursively; empty means /Game. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.find_by_script (riesgo 0, requiere el plugin Niagara, smoke)
Finds systems whose emitter or system stacks call a module, function or dynamic-input script (loaded graphs, saved or not).
| Argumento | Tipo | Descripción |
|---|---|---|
script | string | obligatorio. Niagara module, function or dynamic-input script asset path. |
folder | string | Content folder searched recursively; empty means /Game. |
Devuelve: items, processed, changed, failed, dryRun, message.
niagara.find_gpu_systems (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder searched recursively; empty means /Game. |
dryRun | boolean | Report what would change without editing. Valor predeterminado true. |
Devuelve: scripts, count, message.
niagara.get (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.get_collection_instance (riesgo 0, requiere el plugin Niagara, smoke)
Returns a collection instance: parent collection, namespace, every parameter with value and override flag.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Parameter collection instance asset path. |
Devuelve: asset, collection, namespace, parameters, related, count, issues, message.
niagara.get_collection_override (riesgo 0, requiere el plugin Niagara, smoke)
Returns one parameter of a collection instance with its override flag and value.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Parameter collection instance asset path. |
name | string | obligatorio. Friendly or full (NPC.) parameter name. |
Devuelve: owner, parameter, fields, message.
niagara.get_collection_parameter (riesgo 0, requiere el plugin Niagara, smoke)
Returns a collection parameter with its type and default value (from the collection's default instance).
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
name | string | obligatorio. Friendly or full (NPC.) parameter name. |
Devuelve: owner, parameter, fields, message.
niagara.get_compile_errors (riesgo 0, requiere el plugin Niagara, smoke)
Returns every warning and error of the last compile of all system and emitter scripts.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: events, errorCount, warningCount, compileStatus.
niagara.get_compile_status (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.get_component (riesgo 0, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
system | string | obligatorio. Niagara system asset path. |
name | string | Component name. |
Devuelve: component, system, active, message.
niagara.get_component_parameter (riesgo 0, requiere el plugin Niagara, requiere mundo, smoke)
Returns one override (instance) parameter of a level Niagara component with its type and value.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
parameter | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_component_renderer (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.get_decal_renderer (riesgo 0, UE 5.2+, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.get_dependencies (riesgo 0, requiere el plugin Niagara, smoke)
Returns the list of asset packages the system depends on (emitter parents, scripts, materials, meshes, collections, effect type).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: paths, count, message.
niagara.get_effect_type (riesgo 0, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (system overrides) or empty when effectType is given. |
effectType | string | Effect type asset path (effect-type tools; empty uses the system's effect type). |
index | integer | Entry index for set/remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it. |
cullByDistance | string | Cull by distance: true/false (empty leaves it). Setting distance fields turns their override on. |
maxDistance | string | Maximum distance in cm (empty leaves it). |
cullMaxInstanceCount | string | Cull when the effect type exceeds maxInstances: true/false (empty leaves it). |
maxInstances | string | Maximum instances of this effect type (empty leaves it). |
cullPerSystemMaxInstanceCount | string | Cull when this system exceeds maxSystemInstances: true/false (empty leaves it). |
maxSystemInstances | string | Maximum instances of this system (empty leaves it). |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.get_emitter (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.get_emitter_allocation (riesgo 0, requiere el plugin Niagara, smoke)
Returns the allocation group: allocation mode, preallocation count and the engine's current max particle count estimate.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.get_emitter_asset (riesgo 0, requiere el plugin Niagara, smoke)
Returns a standalone emitter asset: parent, versioning, renderer/event/stage counts, metadata and editable data of the exposed version.
| Argumento | Tipo | Descripción |
|---|---|---|
emitterAsset | string | obligatorio. Standalone emitter asset path. |
version | string | Version selector: GUID or major.minor. |
major | integer | Major version for add_emitter_version (>= 1). Valor predeterminado 1. |
minor | integer | Minor version for add_emitter_version. Valor predeterminado 1. |
Devuelve: asset, parent, versioningEnabled, exposedVersion, renderers, eventHandlers, simulationStages, fields, message.
niagara.get_emitter_bounds (riesgo 0, requiere el plugin Niagara, smoke)
Returns the bounds group: calculation mode (dynamic/fixed/programmable) and the fixed box.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.get_emitter_execution_order (riesgo 0, requiere el plugin Niagara, smoke)
Returns emitter handles in simulation execution order (dependency-sorted by the last compile) with overlap-group starts.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: order, startsNewGroup, count, message.
niagara.get_emitter_inheritance (riesgo 0, requiere el plugin Niagara, smoke)
Returns inheritance: parent asset and version, parent snapshot at last merge, synchronization state and the parent's versions (UE 5.1+).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.
niagara.get_emitter_lifecycle (riesgo 0, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.get_emitter_parent (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.get_emitter_scalability (riesgo 0, requiere el plugin Niagara, smoke)
Returns the emitter's enabled quality levels and its spawn-count scalability overrides.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: handle, qualityLevelMask, overrides, count, message, compileStatus.
niagara.get_emitter_simulation (riesgo 0, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.get_event_handler (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
handler | string | Event handler index or script usage GUID (get/remove). |
sourceEmitter | string | Emitter handle that generates the events (name, index or id; add). |
eventName | string | Source event name, e.g. LocationEvent, DeathEvent, CollisionEvent (add). |
executionMode | string | everyParticle, spawnedParticles, or singleParticle. Valor predeterminado TEXT("everyParticle"). |
spawnNumber | integer | Spawn count for spawned-particles execution. Valor predeterminado 0. |
maxEventsPerFrame | integer | Maximum events consumed per frame (0 = unlimited). Valor predeterminado 0. |
Devuelve: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.
niagara.get_light_renderer (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.get_mesh_renderer (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.get_module (riesgo 0, requiere el plugin Niagara, smoke)
Returns one module (by GUID, index or unique name) and its stack.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
enabled | boolean | New enabled state (set_module_enabled). Valor predeterminado true. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stacks, module, count, compileStatus, message.
niagara.get_module_input (riesgo 0, UE 5.2+, requiere el plugin Niagara, smoke)
Returns one module input with its value mode and value. UE 5.2+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
input | string | Input 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. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stack, module, inputs, input, count, compileStatus, message.
niagara.get_parameter_collection (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
Devuelve: parameters, count, message.
niagara.get_particle_counts (riesgo 0, requiere el plugin Niagara, requiere PIE, smoke)
Returns the per-emitter live particle counts of one PIE Niagara component.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
Devuelve: components, count, particles, message.
niagara.get_properties (riesgo 0, requiere el plugin Niagara, smoke)
Returns every editable system property (name, C++ type, value text) - the read side of niagara.set_properties.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: target, fields, count, message, compileStatus.
niagara.get_renderer (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind. |
Devuelve: renderers, count, message.
niagara.get_renderer_binding (riesgo 0, requiere el plugin Niagara, smoke)
Returns one attribute binding of a renderer.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index. |
binding | string | obligatorio. Binding property name from niagara.list_renderer_bindings, e.g. ColorBinding. |
attribute | string | Attribute to bind (set only), e.g. Particles.Color or User.MyColor. |
Devuelve: renderer, kind, bindings, count, message.
niagara.get_renderer_visibility (riesgo 0, requiere el plugin Niagara, smoke)
Returns a renderer's visibility tag value, the attribute bound to its visibility tag and its enabled state.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind. |
Devuelve: renderer, kind, visibility, tagBinding, enabled, message.
niagara.get_ribbon_renderer (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.get_scalability (riesgo 0, requiere el plugin Niagara, smoke)
Returns the system scalability state: effect type, override switch, typed overrides (quality mask + fields), platforms and local-player culling override.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (system overrides) or empty when effectType is given. |
effectType | string | Effect type asset path (effect-type tools; empty uses the system's effect type). |
index | integer | Entry index for set/remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it. |
cullByDistance | string | Cull by distance: true/false (empty leaves it). Setting distance fields turns their override on. |
maxDistance | string | Maximum distance in cm (empty leaves it). |
cullMaxInstanceCount | string | Cull when the effect type exceeds maxInstances: true/false (empty leaves it). |
maxInstances | string | Maximum instances of this effect type (empty leaves it). |
cullPerSystemMaxInstanceCount | string | Cull when this system exceeds maxSystemInstances: true/false (empty leaves it). |
maxSystemInstances | string | Maximum instances of this system (empty leaves it). |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.get_script_asset (riesgo 0, requiere el plugin Niagara, smoke)
Describes one Niagara script asset: path, class and last compile status.
| Argumento | Tipo | Descripción |
|---|---|---|
script | string | obligatorio. Niagara script asset path (get_script_asset) or empty to list every script asset. |
filter | string | Optional case-insensitive filter on the asset path or class name (list_script_assets). |
Devuelve: scripts, count, message.
niagara.get_script_source (riesgo 0, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name, index or id; empty selects the system scripts. |
usage | string | systemSpawn, systemUpdate, emitterSpawn, emitterUpdate, particleSpawn, particleUpdate, event, simulationStage or gpuCompute (list tools: empty = all). |
usageId | string | Usage GUID for event and simulation-stage scripts (empty = first of that usage). |
Devuelve: script, sourceClass, graphNodes, graphChangeId, events, parameters.
niagara.get_simulation_stage (riesgo 0, requiere el plugin Niagara, smoke)
Returns one simulation stage (index, usage GUID or name) or, with an empty stage, every stage.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
stage | string | Simulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage. |
name | string | Stage name when adding; new name when setting (empty keeps it). |
index | integer | Target zero-based index (add: insert position, -1 appends; move: required destination). Valor predeterminado -1. |
enabled | string | true/false to enable or disable the stage; empty keeps it. |
iterationSource | string | Particles or DataInterface (DirectSet on engines that have it); empty keeps it. |
disablePartialParticleUpdate | string | true/false for Disable Partial Particle Update; empty keeps it. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, emitter, stages, stage, count, compileStatus, message.
niagara.get_sprite_renderer (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.get_stack_issue (riesgo 0, UE 5.2+, requiere el plugin Niagara, smoke)
Returns one stack issue (by id or index) with its fixes; an empty issue lists every issue. UE 5.2+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index (only that emitter's stack). Empty = the system stack and every emitter stack. |
issue | string | Issue unique id (from list_stack_issues) or zero-based index. Empty: get lists every issue; apply applies the first fix of every fixable issue. |
fix | string | Fix unique id or zero-based index within the issue; empty = the issue's first fix (apply_stack_issue). |
compile | boolean | Request a system compile after applying fixes (default true). Valor predeterminado true. |
Devuelve: system, issues, issue, applied, count, compileStatus, message.
niagara.get_stats (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: valid, emitterCount, bounds, compileStatus, message.
niagara.get_system_bounds (riesgo 0, requiere el plugin Niagara, requiere PIE, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
system | string | obligatorio. Niagara system asset path. |
name | string | Component name. |
Devuelve: bounds, message.
niagara.get_system_metadata (riesgo 0, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: target, fields, count, message, compileStatus.
niagara.get_system_simulation (riesgo 0, requiere el plugin Niagara, smoke)
Returns the simulation settings group: warmup, determinism, random seed and fixed tick (fields that exist on this engine).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: target, fields, count, message, compileStatus.
niagara.get_user_parameter (riesgo 0, requiere el plugin Niagara, smoke)
Returns a user parameter with its type and current default (value, object or data interface).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_data_interface (riesgo 0, requiere el plugin Niagara, smoke)
Returns a data interface user parameter: its class, object and editable fields (Field:Type=Value).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_material (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_matrix (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_object (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_position (riesgo 0, UE 5.0+, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_quat (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_render_target (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_static_mesh (riesgo 0, UE 5.0+, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_texture (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.get_user_parameter_vec2 (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
Devuelve: owner, parameter, fields, message.
niagara.import_recipe (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Creates a system from a recipe given inline or as a JSON file written by niagara.export_recipe.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
recipe | UeaNiagaraSysRecipe | Inline recipe (as returned by niagara.export_recipe). Give either recipe or file. |
file | string | Absolute .json file written by niagara.export_recipe. Give either recipe or file. |
Devuelve: recipe, file, asset, handles, message, compileStatus.
niagara.kill_all (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Immediately deactivates every Niagara component of the PIE world (optionally only one system) and reports how many were stopped.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Only components playing this system (asset path); empty means every Niagara component. |
Devuelve: components, count, particles, message.
niagara.list (riesgo 0, requiere el plugin Niagara, smoke)
Lists Niagara systems under a folder with emitter count, effect type and GPU usage.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Folder to search (default /Game). Valor predeterminado TEXT("/Game"). |
nameContains | string | Only names containing this text (case-insensitive). |
recursive | boolean | Include sub-folders. Valor predeterminado true. |
Devuelve: systems, count.
niagara.list_collection_instances (riesgo 0, requiere el plugin Niagara, smoke)
Lists the collection instance assets under /Game whose parent is the collection.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
Devuelve: asset, collection, namespace, parameters, related, count, issues, message.
niagara.list_collection_overrides (riesgo 0, requiere el plugin Niagara, smoke)
Lists the parameters a collection instance overrides, with their values.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Parameter collection instance asset path. |
Devuelve: asset, collection, namespace, parameters, related, count, issues, message.
niagara.list_component_parameters (riesgo 0, requiere el plugin Niagara, requiere mundo, smoke)
Lists the override (instance) parameters of a level Niagara component with their values.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
Devuelve: owner, parameters, count, issues, message.
niagara.list_components (riesgo 0, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
system | string | obligatorio. Niagara system asset path. |
name | string | Component name. |
Devuelve: components, count, message.
niagara.list_data_interface_classes (riesgo 0, requiere el plugin Niagara, smoke)
Lists the data interface classes usable as dataInterfaceClass / di:
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | Property name (as declared by the engine). |
type | string | C++ type of the property. |
value | string | Value as Unreal property text (the same form the setters accept). |
Devuelve: classes, count.
niagara.list_effect_types (riesgo 0, requiere el plugin Niagara, smoke)
Lists Niagara effect type assets under a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Folder to search (default /Game). Valor predeterminado TEXT("/Game"). |
nameContains | string | Only names containing this text (case-insensitive). |
recursive | boolean | Include sub-folders. Valor predeterminado true. |
Devuelve: paths, count, message.
niagara.list_emitter_assets (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | Property name (as declared by the engine). |
type | string | C++ type of the property. |
value | string | Value as Unreal property text (the same form the setters accept). |
Devuelve: scripts, count, message.
niagara.list_emitter_attributes (riesgo 0, requiere el plugin Niagara, smoke)
Lists the particle attributes of the compiled emitter (name and type); compile the system first.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: handle, attributes, count, message.
niagara.list_emitter_properties (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.
niagara.list_emitter_versions (riesgo 0, UE 5.1+, requiere el plugin Niagara, smoke)
Lists the versions of a standalone emitter asset with the exposed version.
| Argumento | Tipo | Descripción |
|---|---|---|
emitterAsset | string | obligatorio. Standalone emitter asset path. |
version | string | Version selector: GUID or major.minor. |
major | integer | Major version for add_emitter_version (>= 1). Valor predeterminado 1. |
minor | integer | Minor version for add_emitter_version. Valor predeterminado 1. |
Devuelve: asset, versioningEnabled, exposedVersion, versions, count, message.
niagara.list_emitters (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: emitters, count, handles.
niagara.list_event_generators (riesgo 0, requiere el plugin Niagara, smoke)
Lists the events the emitter's compiled particle scripts generate (event id, payload, max per frame) and which handles consume them.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: handle, generators, count, message.
niagara.list_event_handlers (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.
niagara.list_level_components (riesgo 0, requiere el plugin Niagara, requiere mundo, smoke)
Lists every Niagara component of the editor level (optionally one system) with actor, system, activity and particle counts.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Only components playing this system (asset path); empty means every Niagara component. |
Devuelve: components, count, particles, message.
niagara.list_material_overrides (riesgo 0, requiere el plugin Niagara, smoke)
Lists the material override slots of a mesh renderer (OverrideMaterials) and the bOverrideMaterials flag.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Mesh renderer index; empty means the only mesh renderer. |
index | integer | Override slot index (set/remove). Valor predeterminado -1. |
material | string | Material asset path (add/set). |
Devuelve: renderer, overrideMaterials, overrides, count, message.
niagara.list_module_inputs (riesgo 0, UE 5.2+, requiere el 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+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
input | string | Input 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. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stack, module, inputs, input, count, compileStatus, message.
niagara.list_modules (riesgo 0, requiere el plugin Niagara, smoke)
Lists the modules of one stack (usage) in execution order: GUID, index, name, script, kind, enabled.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index. Empty = system stacks only (list_stacks: system + every emitter). |
usage | string | Stack usage (systemSpawn, systemUpdate, emitterSpawn, emitterUpdate, particleSpawn, particleUpdate, event:<i |
Devuelve: system, stacks, module, count, compileStatus, message.
niagara.list_parameter_types (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | Property name (as declared by the engine). |
type | string | C++ type of the property. |
value | string | Value as Unreal property text (the same form the setters accept). |
Devuelve: parameters, count, message.
niagara.list_particle_counts (riesgo 0, requiere el plugin Niagara, requiere PIE, smoke)
Lists every Niagara component of the PIE world (optionally one system) with per-emitter live particle counts.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Only components playing this system (asset path); empty means every Niagara component. |
Devuelve: components, count, particles, message.
niagara.list_recipes (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | Property name (as declared by the engine). |
type | string | C++ type of the property. |
value | string | Value as Unreal property text (the same form the setters accept). |
Devuelve: scripts, count, message.
niagara.list_renderer_bindings (riesgo 0, requiere el plugin Niagara, smoke)
Lists a renderer's attribute bindings with the bound attribute, its type and whether the emitter provides it.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind. |
Devuelve: renderer, kind, bindings, count, message.
niagara.list_renderer_fields (riesgo 0, requiere el plugin Niagara, smoke)
Lists the settable fields (name and type) and attribute bindings of a renderer kind.
| Argumento | Tipo | Descripción |
|---|---|---|
kind | string | obligatorio. Renderer kind: sprite, mesh, ribbon, light, component or decal (UE 5.2+). |
Devuelve: kind, class, fields, bindings.
niagara.list_renderer_meshes (riesgo 0, requiere el plugin Niagara, smoke)
Lists the mesh entries of a mesh renderer (mesh, scale, pivot offset).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Mesh renderer index; empty means the only mesh renderer. |
index | integer | Mesh entry index (set/remove). Valor predeterminado -1. |
mesh | string | Static mesh asset path (add/set; empty keeps the current mesh on set). |
scale | string | Scale as (X=..,Y=..,Z=..); empty keeps the current value. |
pivotOffset | string | Pivot offset as (X=..,Y=..,Z=..); empty keeps the current value. |
Devuelve: renderer, meshes, count, message.
niagara.list_renderers (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: renderers, count, message.
niagara.list_script_assets (riesgo 0, requiere el plugin Niagara, smoke)
Lists Niagara script assets (modules, functions, dynamic inputs), optionally filtered by path or class.
| Argumento | Tipo | Descripción |
|---|---|---|
script | string | obligatorio. Niagara script asset path (get_script_asset) or empty to list every script asset. |
filter | string | Optional case-insensitive filter on the asset path or class name (list_script_assets). |
Devuelve: scripts, count, message.
niagara.list_simulation_stages (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.
niagara.list_stack_issues (riesgo 0, UE 5.2+, requiere el 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+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index (only that emitter's stack). Empty = the system stack and every emitter stack. |
issue | string | Issue unique id (from list_stack_issues) or zero-based index. Empty: get lists every issue; apply applies the first fix of every fixable issue. |
fix | string | Fix unique id or zero-based index within the issue; empty = the issue's first fix (apply_stack_issue). |
compile | boolean | Request a system compile after applying fixes (default true). Valor predeterminado true. |
Devuelve: system, issues, issue, applied, count, compileStatus, message.
niagara.list_stacks (riesgo 0, requiere el plugin Niagara, smoke)
Lists the script stacks (usage selector, usage GUID, modules in order) of the system and of one or every emitter.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index. Empty = system stacks only (list_stacks: system + every emitter). |
usage | string | Stack usage (systemSpawn, systemUpdate, emitterSpawn, emitterUpdate, particleSpawn, particleUpdate, event:<i |
Devuelve: system, stacks, module, count, compileStatus, message.
niagara.list_system_scripts (riesgo 0, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name, index or id; empty selects the system scripts. |
usage | string | systemSpawn, systemUpdate, emitterSpawn, emitterUpdate, particleSpawn, particleUpdate, event, simulationStage or gpuCompute (list tools: empty = all). |
usageId | string | Usage GUID for event and simulation-stage scripts (empty = first of that usage). |
Devuelve: scripts, count.
niagara.list_templates (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | Property name (as declared by the engine). |
type | string | C++ type of the property. |
value | string | Value as Unreal property text (the same form the setters accept). |
Devuelve: scripts, count, message.
niagara.list_user_parameters (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: parameters, count, message.
niagara.move_simulation_stage (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Moves a simulation stage to a new index (execution order).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
stage | string | Simulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage. |
name | string | Stage name when adding; new name when setting (empty keeps it). |
index | integer | Target zero-based index (add: insert position, -1 appends; move: required destination). Valor predeterminado -1. |
enabled | string | true/false to enable or disable the stage; empty keeps it. |
iterationSource | string | Particles or DataInterface (DirectSet on engines that have it); empty keeps it. |
disablePartialParticleUpdate | string | true/false for Disable Partial Particle Update; empty keeps it. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, emitter, stages, stage, count, compileStatus, message.
niagara.recipe (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
recipe | string | obligatorio. Recipe name from niagara.list_recipes. |
folder | string | obligatorio. Destination folder under /Game. |
name | string | obligatorio. Bare system asset name. |
dryRun | boolean | Only check that the recipe template exists. Valor predeterminado false. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.recipe_beam (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Beam recipe: ribbon beam between two points. Variants: dynamic (default, DynamicBeam), static (StaticBeam).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
variant | string | Recipe variant (see the tool description; empty = default variant). |
gpu | boolean | Simulate the recipe emitters on the GPU. Valor predeterminado false. |
localSpace | boolean | Simulate in local space (particles follow the component). Valor predeterminado false. |
boundsExtent | number | Half size of fixed system bounds in cm; 0 keeps the recipe default. Valor predeterminado 0.0f. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.recipe_burst (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Burst recipe: one-shot sprite burst. Variants: omni (default, OmnidirectionalBurst), directional (DirectionalBurst), sprite (SimpleSpriteBurst), mesh (UpwardMeshBurst).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
variant | string | Recipe variant (see the tool description; empty = default variant). |
gpu | boolean | Simulate the recipe emitters on the GPU. Valor predeterminado false. |
localSpace | boolean | Simulate in local space (particles follow the component). Valor predeterminado false. |
boundsExtent | number | Half size of fixed system bounds in cm; 0 keeps the recipe default. Valor predeterminado 0.0f. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.recipe_fountain (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Fountain recipe: continuous upward sprite fountain (engine Fountain emitter). Variants: default.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
variant | string | Recipe variant (see the tool description; empty = default variant). |
gpu | boolean | Simulate the recipe emitters on the GPU. Valor predeterminado false. |
localSpace | boolean | Simulate in local space (particles follow the component). Valor predeterminado false. |
boundsExtent | number | Half size of fixed system bounds in cm; 0 keeps the recipe default. Valor predeterminado 0.0f. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.recipe_ribbon (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Ribbon recipe: trail ribbon following the component (LocationBasedRibbon).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
variant | string | Recipe variant (see the tool description; empty = default variant). |
gpu | boolean | Simulate the recipe emitters on the GPU. Valor predeterminado false. |
localSpace | boolean | Simulate in local space (particles follow the component). Valor predeterminado false. |
boundsExtent | number | Half size of fixed system bounds in cm; 0 keeps the recipe default. Valor predeterminado 0.0f. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.recipe_smoke (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Smoke/ambient recipe: slow hanging particulates with 2 s warmup so the volume is already filled when it appears (HangingParticulates).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
variant | string | Recipe variant (see the tool description; empty = default variant). |
gpu | boolean | Simulate the recipe emitters on the GPU. Valor predeterminado false. |
localSpace | boolean | Simulate in local space (particles follow the component). Valor predeterminado false. |
boundsExtent | number | Half size of fixed system bounds in cm; 0 keeps the recipe default. Valor predeterminado 0.0f. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.recipe_sparks (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sparks recipe: an omnidirectional spark burst plus a continuous ember fountain, two handles Sparks and Embers.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Content folder under /Game. |
name | string | obligatorio. Bare asset name. |
variant | string | Recipe variant (see the tool description; empty = default variant). |
gpu | boolean | Simulate the recipe emitters on the GPU. Valor predeterminado false. |
localSpace | boolean | Simulate in local space (particles follow the component). Valor predeterminado false. |
boundsExtent | number | Half size of fixed system bounds in cm; 0 keeps the recipe default. Valor predeterminado 0.0f. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.remove_collection_override (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Clears an instance override and restores the collection default value.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Parameter collection instance asset path. |
name | string | obligatorio. Friendly or full (NPC.) parameter name. |
Devuelve: owner, parameter, fields, message.
niagara.remove_collection_parameter (riesgo 3, modifica, destructivo, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
name | string | obligatorio. Parameter name. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | Text-import value. |
Devuelve: parameters, count, message.
niagara.remove_effect_type_emitter_scalability (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Removes the effect type emitter scaling entry at index.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (used to find the effect type when effectType is empty). |
effectType | string | Effect type asset path. |
index | integer | Entry index for remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. |
scaleSpawnCount | boolean | Scale spawn counts on these quality levels. Valor predeterminado true. |
spawnCountScale | number | Spawn count multiplier (0..1 typical). Valor predeterminado 1.0f. |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.remove_effect_type_scalability (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Removes the effect type system scalability setting at index.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (system overrides) or empty when effectType is given. |
effectType | string | Effect type asset path (effect-type tools; empty uses the system's effect type). |
index | integer | Entry index for set/remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it. |
cullByDistance | string | Cull by distance: true/false (empty leaves it). Setting distance fields turns their override on. |
maxDistance | string | Maximum distance in cm (empty leaves it). |
cullMaxInstanceCount | string | Cull when the effect type exceeds maxInstances: true/false (empty leaves it). |
maxInstances | string | Maximum instances of this effect type (empty leaves it). |
cullPerSystemMaxInstanceCount | string | Cull when this system exceeds maxSystemInstances: true/false (empty leaves it). |
maxSystemInstances | string | Maximum instances of this system (empty leaves it). |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.remove_emitter (riesgo 3, modifica, destructivo, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: message, compileStatus.
niagara.remove_emitter_parent (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Breaks inheritance: the emitter keeps its current stack but no longer follows a parent.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.
niagara.remove_emitter_scalability_override (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Removes the emitter scalability override at index.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
index | integer | Override index for remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. |
spawnCountScale | number | Spawn count multiplier for the override (add); negative leaves the spawn count unscaled. Valor predeterminado 1.0f. |
Devuelve: handle, qualityLevelMask, overrides, count, message, compileStatus.
niagara.remove_event_handler (riesgo 3, modifica, destructivo, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
handler | string | Event handler index or script usage GUID (get/remove). |
sourceEmitter | string | Emitter handle that generates the events (name, index or id; add). |
eventName | string | Source event name, e.g. LocationEvent, DeathEvent, CollisionEvent (add). |
executionMode | string | everyParticle, spawnedParticles, or singleParticle. Valor predeterminado TEXT("everyParticle"). |
spawnNumber | integer | Spawn count for spawned-particles execution. Valor predeterminado 0. |
maxEventsPerFrame | integer | Maximum events consumed per frame (0 = unlimited). Valor predeterminado 0. |
Devuelve: name, properties, eventHandlers, simulationStages, count, message, handlers, handle.
niagara.remove_material_override (riesgo 3, modifica, destructivo, requiere el plugin Niagara, smoke)
Removes one override slot (index); bOverrideMaterials is turned off when the list becomes empty.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Mesh renderer index; empty means the only mesh renderer. |
index | integer | Override slot index (set/remove). Valor predeterminado -1. |
material | string | Material asset path (add/set). |
Devuelve: renderer, overrideMaterials, overrides, count, message.
niagara.remove_module (riesgo 3, modifica, destructivo, UE 5.2+, requiere el plugin Niagara, smoke)
Deletes a module and its input nodes through the stack view model (the stack's Delete). UE 5.2+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
enabled | boolean | New enabled state (set_module_enabled). Valor predeterminado true. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stacks, module, count, compileStatus, message.
niagara.remove_renderer (riesgo 3, modifica, destructivo, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind. |
Devuelve: message, compileStatus.
niagara.remove_renderer_mesh (riesgo 3, modifica, destructivo, requiere el plugin Niagara, smoke)
Removes one mesh entry (index) from a mesh renderer.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Mesh renderer index; empty means the only mesh renderer. |
index | integer | Mesh entry index (set/remove). Valor predeterminado -1. |
mesh | string | Static mesh asset path (add/set; empty keeps the current mesh on set). |
scale | string | Scale as (X=..,Y=..,Z=..); empty keeps the current value. |
pivotOffset | string | Pivot offset as (X=..,Y=..,Z=..); empty keeps the current value. |
Devuelve: renderer, meshes, count, message.
niagara.remove_scalability_override (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Removes the system scalability override at index.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (system overrides) or empty when effectType is given. |
effectType | string | Effect type asset path (effect-type tools; empty uses the system's effect type). |
index | integer | Entry index for set/remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it. |
cullByDistance | string | Cull by distance: true/false (empty leaves it). Setting distance fields turns their override on. |
maxDistance | string | Maximum distance in cm (empty leaves it). |
cullMaxInstanceCount | string | Cull when the effect type exceeds maxInstances: true/false (empty leaves it). |
maxInstances | string | Maximum instances of this effect type (empty leaves it). |
cullPerSystemMaxInstanceCount | string | Cull when this system exceeds maxSystemInstances: true/false (empty leaves it). |
maxSystemInstances | string | Maximum instances of this system (empty leaves it). |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.remove_simulation_stage (riesgo 3, modifica, destructivo, requiere el plugin Niagara, smoke)
Removes a simulation stage and the graph nodes of its stack.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
stage | string | Simulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage. |
name | string | Stage name when adding; new name when setting (empty keeps it). |
index | integer | Target zero-based index (add: insert position, -1 appends; move: required destination). Valor predeterminado -1. |
enabled | string | true/false to enable or disable the stage; empty keeps it. |
iterationSource | string | Particles or DataInterface (DirectSet on engines that have it); empty keeps it. |
disablePartialParticleUpdate | string | true/false for Disable Partial Particle Update; empty keeps it. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, emitter, stages, stage, count, compileStatus, message.
niagara.remove_user_parameter (riesgo 3, modifica, destructivo, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.rename (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Source system asset path. |
folder | string | obligatorio. Destination folder. |
newName | string | obligatorio. Bare destination name. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.rename_collection_parameter (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
name | string | obligatorio. Current friendly or full (NPC.) name. |
newName | string | obligatorio. New friendly name (the collection namespace is added). |
Devuelve: asset, collection, namespace, parameters, related, count, issues, message.
niagara.rename_emitter (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
newName | string | New handle name for rename. |
value | boolean | New enabled/isolated state. Valor predeterminado false. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.rename_user_parameter (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.reorder_emitter (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
index | integer | obligatorio. Destination zero-based emitter index. |
Devuelve: emitters, count, handles.
niagara.reorder_renderer (riesgo 2, modifica, UE 5.2+, requiere el plugin Niagara, smoke)
Moves a renderer to another index of its emitter's renderer list (UE 5.2+).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index to move. |
newIndex | integer | obligatorio. Destination index in the emitter's renderer list. |
Devuelve: renderers, count, message.
niagara.reset_component (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
system | string | obligatorio. Niagara system asset path. |
name | string | Component name. |
Devuelve: component, system, active, message.
niagara.reset_live_component (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Resets the simulation of a Niagara component in the PIE world.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.reset_module_input (riesgo 2, modifica, UE 5.2+, requiere el plugin Niagara, smoke)
Resets a module input to its default (removes overrides, links, dynamic inputs and data interfaces). UE 5.2+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
input | string | Input 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. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stack, module, inputs, input, count, compileStatus, message.
niagara.reset_renderer_binding (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Resets one attribute binding to the renderer class default.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index. |
binding | string | obligatorio. Binding property name from niagara.list_renderer_bindings, e.g. ColorBinding. |
attribute | string | Attribute to bind (set only), e.g. Particles.Color or User.MyColor. |
Devuelve: renderer, kind, bindings, count, message.
niagara.save (riesgo 2, requiere el plugin Niagara)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: message, compileStatus.
niagara.seek_live_component (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Seeks a PIE Niagara component to a simulation age in seconds (value).
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
value | number | obligatorio. New value. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.set_collection_instance_parameter (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Collection instance asset path. |
name | string | obligatorio. Parameter name. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | Text-import value. |
Devuelve: parameters, count, message.
niagara.set_collection_instance_parent (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Re-parents a collection instance asset to another collection.
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Parameter collection instance asset path. |
collection | string | obligatorio. New parent collection asset path. |
Devuelve: asset, collection, namespace, parameters, related, count, issues, message.
niagara.set_collection_override (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Marks a collection instance parameter as overridden and optionally sets its value (typed by the collection parameter).
| Argumento | Tipo | Descripción |
|---|---|---|
instance | string | obligatorio. Parameter collection instance asset path. |
name | string | obligatorio. Friendly or full (NPC.) parameter name. |
value | string | Unreal text value; the type comes from the collection parameter. Empty keeps the current value. |
Devuelve: owner, parameter, fields, message.
niagara.set_collection_parameter (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
name | string | obligatorio. Parameter name. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | Text-import value. |
Devuelve: parameters, count, message.
niagara.set_collection_parameter_bool (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
name | string | obligatorio. Parameter name. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | Text-import value. |
Devuelve: parameters, count, message.
niagara.set_collection_parameter_color (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
name | string | obligatorio. Parameter name. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | Text-import value. |
Devuelve: parameters, count, message.
niagara.set_collection_parameter_float (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
name | string | obligatorio. Parameter name. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | Text-import value. |
Devuelve: parameters, count, message.
niagara.set_collection_parameter_vector (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
collection | string | obligatorio. Parameter collection asset path. |
name | string | obligatorio. Parameter name. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | Text-import value. |
Devuelve: parameters, count, message.
niagara.set_component_actor (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Assigns an actor of the level to an object user parameter of a level Niagara component (SetVariableActor).
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name that owns the Niagara component. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
parameter | string | obligatorio. Object user parameter name, with or without the User. prefix. |
targetActor | string | obligatorio. Label/name of the actor to assign. |
Devuelve: owner, parameter, fields, message.
niagara.set_component_age (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
value | number | obligatorio. New value. |
Devuelve: component, system, active, message.
niagara.set_component_asset (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
system | string | obligatorio. Niagara system asset path. |
Devuelve: component, system, active, message.
niagara.set_component_auto_activate (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_component_bool (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_component_color (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_component_float (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_component_int (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_component_object (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, 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.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name that owns the Niagara component. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
parameter | string | obligatorio. Object, texture, material, static mesh or render-target user parameter name. |
asset | string | obligatorio. Asset path or unique asset name. |
Devuelve: owner, parameter, fields, message.
niagara.set_component_parameter (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_component_quat (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_component_renderer (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Writes component renderer fields (ComponentType class, ComponentCountLimit, particle-ID assignment, visualization).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
values | array of string | obligatorio. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None. |
addIfMissing | boolean | Add a renderer of this kind to the emitter when it has none. Valor predeterminado false. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.set_component_rendering_enabled (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Turns rendering of a level Niagara component on or off while the simulation keeps running.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
enabled | boolean | obligatorio. New flag value. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.set_component_template (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets the component renderer's template component (TemplateComponent object text; None clears it).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_component_tick_enabled (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Enables or disables ticking of a level Niagara component and optionally sets its tick behavior (UsePrereqs, UseComponentTickGroup, ForceTickFirst, ForceTickLast).
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
enabled | boolean | obligatorio. Enable (true) or disable (false) component ticking. |
tickBehavior | string | Optional tick behavior: UsePrereqs, UseComponentTickGroup, ForceTickFirst or ForceTickLast. Empty keeps it. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.set_component_vec3 (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_component_visibility (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Shows or hides a level Niagara component (optionally its attached children too).
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
visible | boolean | obligatorio. Show (true) or hide (false) the component. |
propagateToChildren | boolean | Apply the visibility to attached children too. Valor predeterminado false. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.set_data_interface_input (riesgo 2, modifica, UE 5.7+, requiere el 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+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
input | string | obligatorio. Input path of a data-interface input (see list_module_inputs). |
dataInterfaceClass | string | obligatorio. Data-interface class, e.g. NiagaraDataInterfaceCurve. Must derive from the input's type. |
properties | array of string | Optional 'Property=Value' pairs applied to the new data interface (UE text import). UE 5.8+. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stack, module, inputs, input, count, compileStatus, message.
niagara.set_decal_renderer (riesgo 2, modifica, UE 5.2+, requiere el plugin Niagara, smoke)
Writes decal renderer fields (Material, SourceMode, RendererVisibility, DecalScreenSizeFade); UE 5.2+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
values | array of string | obligatorio. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None. |
addIfMissing | boolean | Add a renderer of this kind to the emitter when it has none. Valor predeterminado false. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.set_determinism (riesgo 2, modifica, UE 5.0+, requiere el plugin Niagara, smoke)
Enables deterministic simulation for the whole system (system-level determinism exists from UE 5.0).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
value | boolean | New flag value. Valor predeterminado false. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_dynamic_input (riesgo 2, modifica, UE 5.2+, requiere el plugin Niagara, smoke)
Drives a module input with a dynamic-input script; its own inputs become 'Input/Child' paths. UE 5.2+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
input | string | obligatorio. Input path (see list_module_inputs). |
dynamicInputScript | string | obligatorio. 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. |
name | string | Optional suggested node name. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stack, module, inputs, input, count, compileStatus, message.
niagara.set_effect_type (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
effectType | string | Effect type asset path. Empty clears it. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_effect_type_scalability (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Edits the effect type system scalability setting at index (only the given fields change).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (system overrides) or empty when effectType is given. |
effectType | string | Effect type asset path (effect-type tools; empty uses the system's effect type). |
index | integer | Entry index for set/remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it. |
cullByDistance | string | Cull by distance: true/false (empty leaves it). Setting distance fields turns their override on. |
maxDistance | string | Maximum distance in cm (empty leaves it). |
cullMaxInstanceCount | string | Cull when the effect type exceeds maxInstances: true/false (empty leaves it). |
maxInstances | string | Maximum instances of this effect type (empty leaves it). |
cullPerSystemMaxInstanceCount | string | Cull when this system exceeds maxSystemInstances: true/false (empty leaves it). |
maxSystemInstances | string | Maximum instances of this system (empty leaves it). |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.set_effect_type_settings (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets effect type scalars: update frequency, cull reaction and (UE 5.0+) local-player culling.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (used when effectType is empty). |
effectType | string | Effect type asset path. |
updateFrequency | string | SpawnOnly, Low, Medium, High or Continuous (empty leaves it). |
cullReaction | string | Deactivate, DeactivateImmediate, DeactivateResume or DeactivateImmediateResume (empty leaves it). |
allowCullingForLocalPlayers | string | true/false: allow scalability culling of effects owned by local players (UE 5.0+; empty leaves it). |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.set_emitter_allocation (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets allocation mode (AutomaticEstimate, ManualEstimate, FixedCount on UE 5.0+) and preallocation count.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
allocationMode | string | AutomaticEstimate, ManualEstimate or FixedCount (FixedCount UE 5.0+); empty leaves it. |
preAllocationCount | string | Particles to preallocate for manual modes; empty leaves it. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_allocation_mode (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_asset_metadata (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets standalone emitter asset metadata: description, category, library visibility and (UE 5.4+) inheritable.
| Argumento | Tipo | Descripción |
|---|---|---|
emitterAsset | string | obligatorio. Standalone emitter asset path. |
description | string | Asset description (empty leaves it; "none" clears it). |
category | string | Library category (empty leaves it; "none" clears it). |
libraryVisibility | string | Unexposed, Library or Hidden (UE 5.0+); UE 4.27 accepts Unexposed or Library. Empty leaves it. |
inheritable | string | true/false: other emitters may inherit from this one (UE 5.4+); empty leaves it. |
Devuelve: asset, parent, versioningEnabled, exposedVersion, renderers, eventHandlers, simulationStages, fields, message.
niagara.set_emitter_bounds (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets the bounds mode and/or fixed box (box written when min and max differ).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
mode | string | dynamic 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. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_bounds_calculation (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Bounds calculation: Dynamic or Fixed (UE 5.1+ also Programmable); older engines map it to bFixedBounds.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_determinism (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_enabled (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
newName | string | New handle name for rename. |
value | boolean | New enabled/isolated state. Valor predeterminado false. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_event_generator (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Replaces the emitter's event handler array (EventHandlerScriptProps) with Unreal property text; () clears it.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_fixed_bounds (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_gpu_spawn_limit (riesgo 2, modifica, UE 5.0+, requiere el plugin Niagara, smoke)
Maximum GPU particles spawned per frame (UE 5.0+).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_interpolation (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Interpolated spawning: true/false, or on UE 5.6+ an ENiagaraInterpolatedSpawnMode name (NoInterpolation, RunUpdateScript, Interpolation).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_isolated (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
newName | string | New handle name for rename. |
value | boolean | New enabled/isolated state. Valor predeterminado false. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_lifecycle (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
loopDuration | string | Emitter State "Loop Duration" seconds; empty leaves it. |
loopDelay | string | Emitter State "Loop Delay" seconds; empty leaves it. |
loopCount | string | Emitter State "Loop Count" (loop behavior Multiple only); empty leaves it. |
delayFirstLoopOnly | string | Emitter State "Delay First Loop Only" true/false; empty leaves it. |
recalculateDurationEachLoop | string | Emitter State "Recalculate Duration Each Loop" true/false; empty leaves it. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_local_space (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_parent (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
parent | string | New parent emitter asset path (set_emitter_parent). |
version | string | Parent version: GUID or major.minor (set_emitter_parent_version; set_emitter_parent defaults to the exposed version). |
Devuelve: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.
niagara.set_emitter_parent_version (riesgo 2, modifica, UE 5.1+, requiere el plugin Niagara, smoke)
Switches the parent version the emitter inherits from and merges it (parent must use versioning).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
parent | string | New parent emitter asset path (set_emitter_parent). |
version | string | Parent version: GUID or major.minor (set_emitter_parent_version; set_emitter_parent defaults to the exposed version). |
Devuelve: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.
niagara.set_emitter_persistent_ids (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_platforms (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Restricts the emitter to the given effect quality levels (all = every level).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
index | integer | Override index for remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. |
spawnCountScale | number | Spawn count multiplier for the override (add); negative leaves the spawn count unscaled. Valor predeterminado 1.0f. |
Devuelve: handle, qualityLevelMask, overrides, count, message, compileStatus.
niagara.set_emitter_preallocation (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_properties (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets a reflected emitter property (versioned emitter data on UE 5.1+, the emitter object before) from Unreal property text.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_random_seed (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_scalability (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_sim_stage_enabled (riesgo 2, modifica, UE ≤4.27, requiere el plugin Niagara, smoke)
Enables simulation stages on the emitter (the switch exists on UE 4.27 only; later engines always enable them).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_simulation (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
simTarget | string | CPUSim or GPUComputeSim (also cpu/gpu); empty leaves it. |
localSpace | string | true/false simulate in local space; empty leaves it. |
determinism | string | true/false deterministic random numbers; empty leaves it. |
randomSeed | string | Random seed used when deterministic; empty leaves it. |
interpolatedSpawn | string | true/false interpolated spawning; empty leaves it. |
requiresPersistentIds | string | true/false persistent particle ids; empty leaves it. |
maxGpuParticlesSpawnPerFrame | string | GPU particles spawned per frame limit (UE 5.0+); empty leaves it. |
combineEventSpawn | string | true/false combine event spawns (UE 4.27 to 5.2); empty leaves it. |
maxDeltaTimePerTick | string | Maximum delta time per tick in seconds, 0 removes the limit (UE 4.27 to 5.2); empty leaves it. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_emitter_simulation_target (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
property | string | obligatorio. Reflected emitter data property, for example SimTarget or bLocalSpace. |
value | string | obligatorio. UE text-import value. |
Devuelve: name, asset, enabled, isolated, parent, message, handle, fields, compileStatus.
niagara.set_event_handler (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Edits an event handler's source emitter/event, execution mode, spawn counts and event budget.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
handler | string | obligatorio. Event handler index or script usage GUID. |
sourceEmitter | string | Source emitter handle name or index whose events are received; empty keeps the current source. |
sourceEventName | string | Source event name, e.g. LocationEvent, DeathEvent, CollisionEvent; empty keeps it. |
executionMode | string | everyParticle, spawnedParticles or singleParticle; empty keeps it. |
spawnNumber | integer | Particles spawned per event (spawnedParticles mode); -1 keeps it. Valor predeterminado -1. |
maxEventsPerFrame | integer | Maximum events consumed per frame (0 = unlimited); -1 keeps it. Valor predeterminado -1. |
randomSpawnNumber | string | true/false to spawn a random count between minSpawnNumber and spawnNumber; empty keeps it. |
minSpawnNumber | integer | Minimum random spawn count; -1 keeps it. Valor predeterminado -1. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, emitter, handlers, handler, count, compileStatus, message.
niagara.set_fixed_bounds (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
min | {x,y,z} | obligatorio. Minimum fixed-bound coordinate. |
max | {x,y,z} | obligatorio. Maximum fixed-bound coordinate. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_light_color (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets the light renderer's color offset added to the particle color (ColorAdd, vector text).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_light_radius (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets the light renderer's radius scale (RadiusScale).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_light_renderer (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Writes light renderer fields (RadiusScale, DefaultExponent, ColorAdd, falloff and translucency flags...).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
values | array of string | obligatorio. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None. |
addIfMissing | boolean | Add a renderer of this kind to the emitter when it has none. Valor predeterminado false. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.set_linked_input (riesgo 2, modifica, UE 5.6+, requiere el plugin Niagara, smoke)
Links a module input to a namespaced parameter (User., Engine., Emitter., Particles., System.). UE 5.6+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
input | string | obligatorio. Input path (see list_module_inputs). |
parameter | string | obligatorio. Namespaced parameter to read, e.g. User.SpawnCount, Engine.DeltaTime, Emitter.Age. It takes the input's type. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stack, module, inputs, input, count, compileStatus, message.
niagara.set_live_parameter (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_live_visibility (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Shows or hides a Niagara component in the PIE world.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Niagara component name; may be omitted when the actor owns exactly one. |
visible | boolean | obligatorio. Show (true) or hide (false) the component. |
propagateToChildren | boolean | Apply the visibility to attached children too. Valor predeterminado false. |
Devuelve: actor, component, system, world, active, paused, visible, renderingEnabled, tickEnabled, autoActivate, complete, tickBehavior, desiredAge, age, location, particles, emitters, parameters, message.
niagara.set_material_override (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Replaces the material of one override slot (index) of a mesh renderer.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Mesh renderer index; empty means the only mesh renderer. |
index | integer | Override slot index (set/remove). Valor predeterminado -1. |
material | string | Material asset path (add/set). |
Devuelve: renderer, overrideMaterials, overrides, count, message.
niagara.set_mesh_facing (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_mesh_pivot (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_mesh_renderer (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Writes mesh renderer fields (FacingMode, SortMode, locked axis, frustum/camera culling, flipbook, bOverrideMaterials...); meshes and material overrides have their own tools.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
values | array of string | obligatorio. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None. |
addIfMissing | boolean | Add a renderer of this kind to the emitter when it has none. Valor predeterminado false. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.set_mesh_sort (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_module_enabled (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Enables or disables a stack module (FNiagaraStackGraphUtilities::SetModuleIsEnabled).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
enabled | boolean | New enabled state (set_module_enabled). Valor predeterminado true. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stacks, module, count, compileStatus, message.
niagara.set_module_input (riesgo 2, modifica, UE 5.2+, requiere el plugin Niagara, smoke)
Sets a module input to a local value (rapid-iteration constant or static value), replacing links/dynamic inputs. UE 5.2+.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | Emitter handle name or index; empty for systemSpawn/systemUpdate. |
usage | string | obligatorio. Stack usage, e.g. particleUpdate, emitterUpdate, event:0, stage:0, systemSpawn. |
module | string | obligatorio. Module node GUID, zero-based index in the stack, or exact unique function name. |
input | string | obligatorio. Input path (see list_module_inputs). |
value | string | obligatorio. 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). |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, stack, module, inputs, input, count, compileStatus, message.
niagara.set_paused (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label/name. |
name | string | Component name. |
property | string | obligatorio. Variable name or reflected property. |
type | string | UE type name. Valor predeterminado TEXT("float"). |
value | string | obligatorio. Text-import value. |
Devuelve: component, system, active, message.
niagara.set_properties (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_renderer_binding (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index. |
binding | string | obligatorio. Binding property name from niagara.list_renderer_bindings, e.g. ColorBinding. |
attribute | string | Attribute to bind (set only), e.g. Particles.Color or User.MyColor. |
Devuelve: renderer, kind, bindings, count, message.
niagara.set_renderer_enabled (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_renderer_material (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets the Material of a sprite, ribbon or decal renderer; mesh renderers use the material override tools.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
material | string | obligatorio. Material asset path. |
Devuelve: message, compileStatus.
niagara.set_renderer_mesh (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Edits one mesh entry (index): mesh, scale and/or pivot offset; empty fields keep their value.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Mesh renderer index; empty means the only mesh renderer. |
index | integer | Mesh entry index (set/remove). Valor predeterminado -1. |
mesh | string | Static mesh asset path (add/set; empty keeps the current mesh on set). |
scale | string | Scale as (X=..,Y=..,Z=..); empty keeps the current value. |
pivotOffset | string | Pivot offset as (X=..,Y=..,Z=..); empty keeps the current value. |
Devuelve: renderer, meshes, count, message.
niagara.set_renderer_property (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Writes any reflected renderer property from Unreal text (advanced; prefer the typed set_
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_renderer_sort_order (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_renderer_visibility (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets the visibility tag value a renderer draws with (RendererVisibility; sprite, mesh, light, component and decal renderers).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index. |
visibility | integer | Visibility tag value the renderer draws with (compared with the RendererVisibilityTag attribute). Valor predeterminado 0. |
Devuelve: renderer, kind, visibility, tagBinding, enabled, message.
niagara.set_ribbon_facing (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_ribbon_renderer (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Writes ribbon renderer fields (Material, FacingMode, UV0Settings/UV1Settings, Shape, tessellation...).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
values | array of string | obligatorio. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None. |
addIfMissing | boolean | Add a renderer of this kind to the emitter when it has none. Valor predeterminado false. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.set_ribbon_tessellation (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_ribbon_uv (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets the UV0 tiling length of a ribbon renderer (UV0Settings.TilingLength).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_scalability_override (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Edits the system scalability override at index (only the given fields change).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | Niagara system asset path (system overrides) or empty when effectType is given. |
effectType | string | Effect type asset path (effect-type tools; empty uses the system's effect type). |
index | integer | Entry index for set/remove. Valor predeterminado -1. |
qualityLevels | string | Effect quality levels: all, or a comma list of indices or Low, Medium, High, Epic, Cinematic. Empty leaves it. |
cullByDistance | string | Cull by distance: true/false (empty leaves it). Setting distance fields turns their override on. |
maxDistance | string | Maximum distance in cm (empty leaves it). |
cullMaxInstanceCount | string | Cull when the effect type exceeds maxInstances: true/false (empty leaves it). |
maxInstances | string | Maximum instances of this effect type (empty leaves it). |
cullPerSystemMaxInstanceCount | string | Cull when this system exceeds maxSystemInstances: true/false (empty leaves it). |
maxSystemInstances | string | Maximum instances of this system (empty leaves it). |
Devuelve: system, effectType, overrideScalability, entries, emitterEntries, fields, count, message.
niagara.set_simulation_stage (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Renames, enables/disables a simulation stage or sets its iteration source and partial-update flag.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
stage | string | Simulation stage index, script usage GUID or exact name. Empty on get_simulation_stage lists every stage. |
name | string | Stage name when adding; new name when setting (empty keeps it). |
index | integer | Target zero-based index (add: insert position, -1 appends; move: required destination). Valor predeterminado -1. |
enabled | string | true/false to enable or disable the stage; empty keeps it. |
iterationSource | string | Particles or DataInterface (DirectSet on engines that have it); empty keeps it. |
disablePartialParticleUpdate | string | true/false for Disable Partial Particle Update; empty keeps it. |
compile | boolean | Request a system compile after the change (default true). Valor predeterminado true. |
Devuelve: system, emitter, stages, stage, count, compileStatus, message.
niagara.set_sprite_alignment (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_sprite_cutout (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_sprite_facing (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_sprite_pivot (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_sprite_renderer (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Writes sprite renderer fields (Material, Alignment, FacingMode, SortMode, PivotInUVSpace, SubImageSize, cutout, camera distance culling...).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | Renderer index from niagara.list_renderers; empty means the only renderer of this kind. |
values | array of string | obligatorio. Field=Value entries; fields come from niagara.list_renderer_fields for this kind. Object fields take asset paths or None. |
addIfMissing | boolean | Add a renderer of this kind to the emitter when it has none. Valor predeterminado false. |
Devuelve: system, emitter, index, kind, class, enabled, fields, changed, message.
niagara.set_sprite_sort (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_sprite_sub_uv (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind when the emitter has exactly one renderer of that kind. |
property | string | obligatorio. Reflected property name, for example SortMode or FacingMode (ignored by the typed wrappers, which name their own field). |
value | string | obligatorio. UE text-import value. |
Devuelve: message, compileStatus.
niagara.set_system_allow_culling_for_local_players (riesgo 2, modifica, UE 5.0+, requiere el plugin Niagara, smoke)
Overrides the effect type's allow-culling-for-local-players flag on this system (UE 5.0+).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_auto_deactivate (riesgo 2, modifica, UE ≤5.3, requiere el plugin Niagara, smoke)
Sets whether the system deactivates automatically when all emitters finish (the flag exists up to UE 5.3).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_cull_reaction (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets the cull reaction (Deactivate, DeactivateImmediate, DeactivateResume, DeactivateImmediateResume) on the system's effect type.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_fixed_bounds_mode (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_metadata (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets asset metadata: description, category (UE 5.0+) and library visibility.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
description | string | Asset description shown in the asset picker (empty leaves it; "none" clears it). |
category | string | Library category (UE 5.0+; empty leaves it; "none" clears it). |
libraryVisibility | string | Unexposed, Library or Hidden (UE 5.0+); UE 4.27 accepts Unexposed or Library. Empty leaves it. |
Devuelve: target, fields, count, message, compileStatus.
niagara.set_system_override_scalability (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_performance (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets cook/edit performance switches: rapid-iteration baking, attribute compression and trimming, debug switches.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
bakeOutRapidIteration | string | true/false bake rapid-iteration parameters while editing (empty leaves it). |
bakeOutRapidIterationOnCook | string | true/false bake rapid-iteration parameters on cook (empty leaves it). |
compressAttributes | string | true/false compress particle attributes (empty leaves it). |
trimAttributes | string | true/false trim unused attributes while editing (empty leaves it). |
trimAttributesOnCook | string | true/false trim unused attributes on cook (empty leaves it). |
disableDebugSwitches | string | true/false disable debug switches (empty leaves it). |
Devuelve: target, fields, count, message, compileStatus.
niagara.set_system_rendering (riesgo 2, modifica, UE 5.0+, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
castShadow | string | true/false overrides component cast shadow; "default" removes the override; empty leaves it. |
receivesDecals | string | true/false receives decals; "default" removes the override; empty leaves it. |
renderCustomDepth | string | true/false render custom depth; "default" removes the override; empty leaves it. |
customDepthStencilValue | string | Custom depth stencil value 0-255; "default" removes the override; empty leaves it. |
translucencySortPriority | string | Translucency sort priority (UE 5.1+); "default" removes the override; empty leaves it. |
translucencySortDistanceOffset | string | Translucency sort distance offset (UE 5.1+); "default" removes the override; empty leaves it. |
Devuelve: target, fields, count, message, compileStatus.
niagara.set_system_scalability_override (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Replaces the system scalability overrides (FNiagaraSystemScalabilityOverrides text, e.g. (Overrides=())).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_significance_handler (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets the significance handler of the system's effect type: Distance, Age, a handler class path, or None.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_simulation (riesgo 2, modifica, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
warmupTime | string | Warmup seconds (empty leaves it). |
warmupTickCount | string | Warmup tick count (empty leaves it). |
warmupTickDelta | string | Warmup tick delta in seconds (empty leaves it). |
determinism | string | true/false deterministic simulation (UE 5.0+; empty leaves it). |
randomSeed | string | Random seed used when deterministic (UE 5.0+; empty leaves it). |
fixedTickDelta | string | true/false fixed tick delta (UE 5.0+; empty leaves it). |
fixedTickDeltaTime | string | Fixed tick delta seconds (UE 5.0+; empty leaves it). |
Devuelve: target, fields, count, message, compileStatus.
niagara.set_system_thumbnail_age (riesgo 2, modifica, UE ≤5.0, requiere el plugin Niagara, smoke)
Marks the system thumbnail as out of date (the flag exists up to UE 5.0).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_trim_attributes (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_warmup_tick_count (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_system_warmup_tick_delta (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
property | string | obligatorio. Reflected system property name. |
value | string | obligatorio. UE text-import value. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.set_user_parameter (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.set_user_parameter_bool (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.set_user_parameter_color (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.set_user_parameter_data_interface (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Writes editable fields of a data interface user parameter (Field=Value entries; object fields take asset paths).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. Data interface user parameter name. |
values | array of string | obligatorio. 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. |
Devuelve: owner, parameter, fields, message.
niagara.set_user_parameter_float (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.set_user_parameter_int (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.set_user_parameter_material (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets a material user parameter (UMaterialInterface asset; None clears it).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
asset | string | obligatorio. Asset path or unique asset name; None clears the value. |
addIfMissing | boolean | Create the user parameter with the tool's object type when it does not exist yet. Valor predeterminado false. |
Devuelve: owner, parameter, fields, message.
niagara.set_user_parameter_matrix (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets a 4x4 matrix user parameter from sixteen floats (row-major).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
values | array of number | obligatorio. Sixteen floats in row-major order (M[0][0], M[0][1] ... M[3][3]). |
addIfMissing | boolean | Create the user parameter as a matrix when it does not exist yet. Valor predeterminado false. |
Devuelve: owner, parameter, fields, message.
niagara.set_user_parameter_object (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets a generic UObject user parameter to any asset (None clears it).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
asset | string | obligatorio. Asset path or unique asset name; None clears the value. |
addIfMissing | boolean | Create the user parameter with the tool's object type when it does not exist yet. Valor predeterminado false. |
Devuelve: owner, parameter, fields, message.
niagara.set_user_parameter_position (riesgo 2, modifica, UE 5.0+, requiere el plugin Niagara, smoke)
Sets a position user parameter (large-world position type, UE 5.0+); value is (X=..,Y=..,Z=..).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
value | string | obligatorio. 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. |
addIfMissing | boolean | Create the user parameter with this type when it does not exist yet. Valor predeterminado false. |
Devuelve: owner, parameter, fields, message.
niagara.set_user_parameter_quat (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.set_user_parameter_render_target (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets a texture render target user parameter (UTextureRenderTarget asset; None clears it).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
asset | string | obligatorio. Asset path or unique asset name; None clears the value. |
addIfMissing | boolean | Create the user parameter with the tool's object type when it does not exist yet. Valor predeterminado false. |
Devuelve: owner, parameter, fields, message.
niagara.set_user_parameter_static_mesh (riesgo 2, modifica, UE 5.0+, requiere el plugin Niagara, smoke)
Sets a static mesh user parameter (UE 5.0+; None clears it).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
asset | string | obligatorio. Asset path or unique asset name; None clears the value. |
addIfMissing | boolean | Create the user parameter with the tool's object type when it does not exist yet. Valor predeterminado false. |
Devuelve: owner, parameter, fields, message.
niagara.set_user_parameter_texture (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sets a texture user parameter (UTexture asset; None clears it).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without the User. prefix. |
asset | string | obligatorio. Asset path or unique asset name; None clears the value. |
addIfMissing | boolean | Create the user parameter with the tool's object type when it does not exist yet. Valor predeterminado false. |
Devuelve: owner, parameter, fields, message.
niagara.set_user_parameter_vec2 (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.set_user_parameter_vec3 (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.set_user_parameter_vec4 (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
name | string | obligatorio. User parameter name, with or without User. prefix. |
newName | string | New name for rename operations. |
type | string | UE type name: float, int, bool, vec2, vec3, vec4, quat, color. Valor predeterminado TEXT("float"). |
value | string | Text-import default value. |
Devuelve: parameters, count, message.
niagara.set_warmup (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
seconds | number | obligatorio. Warmup seconds. |
Devuelve: asset, emitterCount, compileStatus, message, handles.
niagara.spawn_actor (riesgo 2, modifica, requiere el plugin Niagara, requiere mundo, smoke)
Places a Niagara actor in the editor level with the given system, label and location.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
actor | string | Optional actor label for the spawned test actor. |
location | {x,y,z} | Spawn location. |
name | string | Component name. |
Devuelve: component, system, active, message.
niagara.spawn_at_location (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
actor | string | Optional actor label for the spawned test actor. |
location | {x,y,z} | Spawn location. |
name | string | Component name. |
Devuelve: component, system, active, message.
niagara.spawn_attached (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
actor | string | obligatorio. Existing actor label/name to attach to. |
component | string | Optional component name on the actor. |
location | {x,y,z} | Relative location. |
Devuelve: component, system, active, message.
niagara.spawn_test_actor (riesgo 2, modifica, requiere el plugin Niagara, requiere PIE, requiere mundo, smoke)
Spawns a PIE test actor whose root is a Niagara component (named NiagaraSmokeComponent) playing the system.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
actor | string | Optional actor label for the spawned test actor. |
location | {x,y,z} | Spawn location. |
name | string | Component name. |
Devuelve: component, system, active, message.
niagara.sync_emitter_with_parent (riesgo 2, modifica, requiere el plugin Niagara, smoke)
Pulls the parent's changes into the emitter (merge) when it is not synchronized.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Handle name, index or handle id GUID. |
Devuelve: handle, hasParent, parent, parentVersion, parentAtLastMerge, synchronized, parentVersions, message, compileStatus.
niagara.validate (riesgo 0, requiere el plugin Niagara, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: valid, ready, compileStatus, errors, message, issues, warningCount.
niagara.validate_renderer_bindings (riesgo 0, requiere el plugin Niagara, smoke)
Checks a renderer's bindings: every non-particle binding must read a variable the emitter provides (state of the last compile).
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
emitter | string | obligatorio. Emitter handle name or index. |
renderer | string | obligatorio. Renderer index, or a kind (sprite, mesh, ribbon, light, component, decal) when the emitter has exactly one renderer of that kind. |
Devuelve: valid, checked, issues, message.
niagara.validate_renderers (riesgo 0, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: valid, checked, issues, message.
niagara.wait_compile (riesgo 0, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
system | string | obligatorio. Niagara system asset path. |
Devuelve: asset, emitterCount, compileStatus, message, handles.