editor.niagara

Niagara particle system editing

← API Reference

editor.niagara.getInfo

Returns basic information about a Niagara system.

Name Type Required Description
asset_pathstringYesNiagara system asset path

Returns

Field Type Description
system_namestringSystem name
num_emittersnumberNumber of emitters
is_validboolWhether system is valid
is_ready_to_runboolWhether system is compiled and ready
has_outstanding_compilationboolWhether compilation is pending

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.niagara.getInfo", "params": { "asset_path": "/Game/FX/NS_Fire" } }

editor.niagara.getEmitters

Returns all emitters in a Niagara system.

Name Type Required Description
asset_pathstringYesNiagara system asset path

Returns

Field Type Description
emittersarrayEach: {emitter_name, emitter_index, is_enabled, sim_target}
countnumberNumber of emitters

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.niagara.getEmitters", "params": { "asset_path": "/Game/FX/NS_Fire" } }

editor.niagara.create

Creates a new Niagara system asset.

Name Type Required Description
pathstringYesContent directory (e.g. "/Game/FX")
namestringYesSystem name

Returns

Field Type Description
successboolWhether creation succeeded
asset_pathstringFull asset path

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.niagara.create", "params": { "path": "/Game/FX", "name": "NS_Smoke" } }

editor.niagara.getParameters

Returns all user-exposed parameters in a Niagara system.

Name Type Required Description
asset_pathstringYesNiagara system asset path

Returns

Field Type Description
parametersarrayEach: {param_name, param_type, default_value}
countnumberNumber of parameters

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.niagara.getParameters", "params": { "asset_path": "/Game/FX/NS_Fire" } }

editor.niagara.setParameter

Sets a parameter value in a Niagara system (supports float, int, bool).

Name Type Required Description
asset_pathstringYesNiagara system asset path
param_namestringYesParameter name
valuevariesYesParameter value (number, bool, etc.)

Returns

Field Type Description
successboolWhether parameter was set

Example Request

{
  "jsonrpc": "2.0", "id": 1, "method": "editor.niagara.setParameter",
  "params": { "asset_path": "/Game/FX/NS_Fire", "param_name": "SpawnRate", "value": 100.0 }
}

editor.niagara.setEmitterEnabled

Enables or disables an emitter in a Niagara system.

Name Type Required Description
asset_pathstringYesNiagara system asset path
enabledboolYesWhether emitter should be enabled
emitter_indexnumberNo*Emitter index
emitter_namestringNo*Emitter name

*One of emitter_index or emitter_name must be provided.

Returns

Field Type Description
successboolWhether state was changed
changedboolWhether the enabled state actually changed

Example Request

{
  "jsonrpc": "2.0", "id": 1, "method": "editor.niagara.setEmitterEnabled",
  "params": { "asset_path": "/Game/FX/NS_Fire", "emitter_name": "Sparks", "enabled": false }
}

editor.niagara.compile

Compiles a Niagara system and waits for completion.

Name Type Required Description
asset_pathstringYesNiagara system asset path

Returns

Field Type Description
successboolWhether compilation succeeded
is_ready_to_runboolWhether system is ready after compile
has_outstanding_compilationboolWhether compilation is still pending
errorsarrayCompilation errors (empty if none)

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.niagara.compile", "params": { "asset_path": "/Game/FX/NS_Fire" } }