editor.niagara.getInfo
Returns basic information about a Niagara system.
| Name | Type | Required | Description |
asset_path | string | Yes | Niagara system asset path |
Returns
| Field | Type | Description |
system_name | string | System name |
num_emitters | number | Number of emitters |
is_valid | bool | Whether system is valid |
is_ready_to_run | bool | Whether system is compiled and ready |
has_outstanding_compilation | bool | Whether 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_path | string | Yes | Niagara system asset path |
Returns
| Field | Type | Description |
emitters | array | Each: {emitter_name, emitter_index, is_enabled, sim_target} |
count | number | Number 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 |
path | string | Yes | Content directory (e.g. "/Game/FX") |
name | string | Yes | System name |
Returns
| Field | Type | Description |
success | bool | Whether creation succeeded |
asset_path | string | Full 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_path | string | Yes | Niagara system asset path |
Returns
| Field | Type | Description |
parameters | array | Each: {param_name, param_type, default_value} |
count | number | Number 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_path | string | Yes | Niagara system asset path |
param_name | string | Yes | Parameter name |
value | varies | Yes | Parameter value (number, bool, etc.) |
Returns
| Field | Type | Description |
success | bool | Whether 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_path | string | Yes | Niagara system asset path |
enabled | bool | Yes | Whether emitter should be enabled |
emitter_index | number | No* | Emitter index |
emitter_name | string | No* | Emitter name |
*One of emitter_index or emitter_name must be provided.
Returns
| Field | Type | Description |
success | bool | Whether state was changed |
changed | bool | Whether 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_path | string | Yes | Niagara system asset path |
Returns
| Field | Type | Description |
success | bool | Whether compilation succeeded |
is_ready_to_run | bool | Whether system is ready after compile |
has_outstanding_compilation | bool | Whether compilation is still pending |
errors | array | Compilation errors (empty if none) |
Example Request
{ "jsonrpc": "2.0", "id": 1, "method": "editor.niagara.compile", "params": { "asset_path": "/Game/FX/NS_Fire" } }