Command · vfx

vfx.module.enable

Enable or disable a named VFX module without removing it.

scope edit:sceneidempotentnon-destructive

Params

Typed as VfxEnableParams. Fields marked * are required.

emitter*

string

Stable emitter name.

required

stage*

string

One of spawn, initialize, update, render.

required

name*

string

Stable module name.

required

enabled*

bool

Whether the module runs; a disabled module keeps its place and settings.

required

JSON (MCP ara_apply, batches)

{
  "cmd": "vfx.module.enable",
  "args": {
    "emitter": "flame",
    "stage": "update",
    "name": "curl",
    "enabled": false
  }
}

CLI

ara do vfx.module.enable --args '{"emitter":"flame","stage":"update","name":"curl","enabled":false}' --why "…"