Embers

Ambient reference

FXMasterParticle effectAPI type: embers

Drifting embers for fires, volcanic scenes, ash, or magical atmospheres.

Ambient effects add visible movement without replacing the full weather setup. Use them on their own or layer them with another particle or filter.

Reference	Value
Package	FXMaster
Effect kind	Particle effect
Category	Ambient
Runtime type	embers
Exposed parameters	20

Important controls

• Top Down: Switches Embers to the overhead presentation intended for top-down maps. This changes particle projection and movement, so set it before finalizing scale and direction.
• Directional Movement: Makes embers travel in the configured Direction instead of relying only on the effect’s default random movement.
• Synchronized Direction: Uses the active Wind or Duststorm direction for Embers. When the source direction changes, this effect follows it.
• Lifetime: Changes how long individual embers remain active before they are recycled or replaced. Higher values usually allow longer travel paths.
• Density: Changes how many embers are visible or spawned at once. It does not change their size.

Setup notes

• Enable Synchronized Direction when Wind or Duststorm should drive the ember flow.
• Lower Density with a moderate Lifetime can suggest distant fire without obscuring the map.

Bundled preset usage

Preset	API name	Availability	Variants
Ashfall	ashfall	FXMaster+	Normal, Top Down
Divine Light	divine-light	FXMaster+	Normal
Spore Cloud	spore-cloud	FXMaster	Normal
Wildfire Smoke	wildfire-smoke	FXMaster	Normal

Parameters

The table combines the settings available for this effect in Scene and Region contexts. Scene-only and Region-only badges identify controls limited to one context. Hover or focus an info button to see what the parameter changes on the canvas. Select it to keep the card open. Each card also includes the default, range or choices, context, availability, API key, and control type.

20 exposed parameters1 Scene-onlyembers API type

iHover or focus an info button to see what the parameter changes on the canvas. Select it to keep the card open. Context badges identify Scene-only and Region-only controls; unbadged parameters are available in both. Hover or focus an availability condition to highlight the parameter that controls it.

Parameter	Control	Default	Range or choices	Availability
Below Tokensi belowTokens	checkbox	Off	—	Always
Below Tilesi belowTiles	checkbox	Off	—	Always
Below Foregroundi belowForeground	checkbox	Off	—	Always
Levelsi levelsScene only	scene-levels	All Levels	—	Always
Tinti tint	color	#f77300 (disabled)	—	Always
Sound FXi soundFxEnabled	checkbox	Off	—	Always
Sound FX Soundsi soundFxManualSoundIds	multi-select	Rule default	—	Shown when Sound FX = On and the matching enabled SoundFX rule uses Multi-Sound Mode = Manual with at least two configured sounds
Top Downi topDown	checkbox	Off	—	Hidden when Orbit = On
Orbiti orbit	checkbox	Off	—	Hidden when Top Down = On
Orbit Distancei orbitDistance	range	0.5	0–1 · step 0.01	Shown when Orbit = On
Directional Movementi directionalMovement	checkbox	Off	—	Hidden when Orbit = On or Top Down = On
Directioni direction	range	—	0–360 · step 5	Shown when Directional Movement = OnHidden when Orbit = On or Top Down = On
Synchronized Directioni synchronizedDirection	checkbox	Off	—	Shown when Directional Movement = OnHidden when Orbit = On or Top Down = On
Scalei scale	range	0.27	0.1–1 · step 0.01	Always
Speedi speed	range	0.27	0.1–1 · step 0.01	Always
Lifetimei lifetime	range	0.27	0.1–1 · step 0.01	Always
Densityi density	range	0.49	0.01–1 · step 0.01	Always
Opacityi alpha	range	1	0–1 · step 0.1	Always
Darkness Activationi darknessActivationEnabled	checkbox	Off	—	Always
Darkness Activation Rangei darknessActivationRange	range-dual	{"min":0,"max":1}	0–1 · step 0.01	Shown when Darkness Activation = On

Direct-effect API example

The Direct Effect API creates a separate row shown through Manage API Effects. Add a stable apiMacro_…_p or apiMacro_…_f ID when later macro calls need to update or stop the same row.

const created = await FXMASTER.api.effects.play({
  particles: [{
    "id": "apiMacro_wikiembers_p",
    "type": "embers",
    "options": {
      "belowTokens": false,
      "tint": {
        "value": "#f77300",
        "apply": false
      },
      "topDown": false,
      "orbit": false,
      "directionalMovement": false
    }
  }],
});

await FXMASTER.api.effects.particles.stop(created.particles);

For complete API behavior, scene targeting, stack ordering, and toggle groups, see the Direct Effect API guide.