particles

8 public commands in this category.

• burst_particle

  Trigger an immediate burst of particles on an entity

  Scope: scene:write. Token cost: 0.

  entityId string (required)

  Entity with particle component

  count integer (optional)

  Number of particles to emit (default: 100)

• get_particle

  Get particle configuration for an entity

  Scope: scene:read. Token cost: 0.

  entityId string (required)

  Entity to query

• play_particle

  Start/resume particle emission on an entity

  Scope: scene:write. Token cost: 0.

  entityId string (required)

  Entity with particle component

• remove_particle

  Remove particle effect from an entity

  Scope: scene:write. Token cost: 0.

  entityId string (required)

  Entity to remove particles from

• set_particle

  Set or update particle effect on an entity. Creates a GPU particle emitter with configurable emission, velocity, color gradient, and rendering options.

  Scope: scene:write. Token cost: 0.

  entityId string (required)

  Entity to attach particles to

  acceleration array (optional)

  Acceleration [x, y, z] (gravity = [0, -9.8, 0])

  blendMode string (optional)

  Blend mode

  lifetimeMax number (optional)

  Max particle lifetime in seconds

  lifetimeMin number (optional)

  Min particle lifetime in seconds

  linearDrag number (optional)

  Linear drag coefficient

  maxParticles integer (optional)

  Max GPU particles (100-50000)

  orientation string (optional)

  Particle orientation

  preset string (optional)

  Preset name (overrides all other fields)

  sizeEnd number (optional)

  Particle end size

  sizeStart number (optional)

  Particle start size

  velocityMax array (optional)

  Max velocity [x, y, z]

  velocityMin array (optional)

  Min velocity [x, y, z]

  worldSpace boolean (optional)

  Emit in world space (true) or local space (false)

• set_particle_preset

  Apply a named particle preset to an entity. Replaces all particle configuration with preset defaults. Presets: fire, smoke, sparks, rain, snow, explosion, magic_sparkle, dust, trail.

  Scope: scene:write. Token cost: 0.

  entityId string (required)

  Target entity

  preset string (required)

  Preset name

• stop_particle

  Stop particle emission on an entity

  Scope: scene:write. Token cost: 0.

  entityId string (required)

  Entity with particle component

• toggle_particle

  Enable or disable particle emission on an entity without removing configuration

  Scope: scene:write. Token cost: 0.

  enabled boolean (required)

  Enable/disable emission

  entityId string (required)

  Target entity