Fire

Weather reference

FXMaster+Particle effectAPI type: fireparticles

Preview

Preview shows Fire in Manual Placement mode with Light Source enabled

Animated fire sprites with manual placement, optional light sources, glow, and token-burning visuals.

Weather effects can cover a full Scene or be limited to Regions. Configure the placement or movement controls exposed by the effect first, then tune its appearance, population, and optional background controls.

Reference	Value
Package	FXMaster+
Effect kind	Particle effect
Category	Weather
Runtime type	fireparticles
Exposed parameters	35

Manual Placement

Enable Manual Placement to place individual Fire particles instead of generating them through Density. Use Place to add flames, Delete to remove a selected placement, and Clear to remove the current placements.

Flame appearance

Variants, Direction, Scale, Opacity, Flicker, Glow, and Glow Radius define the placed flames. Horizontal Flip mirrors the selected placement when the source image needs to face the opposite direction.

Optional light sources

Enable Light Source to create illumination at each placed flame via a Foundry light source. Light Color, Light Radius, Bright Radius, Light Intensity, and Light Flicker control that illumination independently from the particle’s visual Glow.

Manual and generated controls

Density is hidden while Manual Placement is enabled because the saved placements determine how many flames appear. Burn Tokens remains available and can add the configured burning presentation when eligible tokens enter a flame’s trigger radius.

Important controls

• Variants: Selects which flame sprite variants can appear. Multiple selections mix different flame sizes and shapes within the same effect.
• Manual Placement: Replaces automatic flame distribution with exact positions placed on the current Scene. Each placed flame can keep its own direction and optional light settings.
• Light Source: Creates and manages Foundry ambient light sources for manually placed fire particles on the current Scene.
• Glow: Controls the brightness of the glow applied around each flame sprite.
• Burn Tokens: Applies a client-side token-shaped pulsing heat and smoke indicator to visible tokens that pass through this particle fire effect.

Setup notes

• Manual Placement stores individual flame positions and supports per-placement direction, adjustment, flipping, and optional light sources.
• Glow and Glow Radius affect the sprite presentation. Light Source controls create Scene illumination for manually placed flames.
• Burn Tokens adds a temporary burning presentation when eligible tokens enter the flame area.

Bundled preset usage

No bundled preset currently uses this effect directly. Add it through Particle Effects or the Direct Effect API.

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.

35 exposed parameters1 Scene-onlyfireparticles 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	#FFFFFF (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
Variantsi spritesheets	multi-select	Fire Small 1	Fire Small 1, Fire Small 2, Fire Small 3, Fire Small 4, Fire Medium 1, Fire Medium 2, Fire Medium 3, Fire Medium 4, Fire Medium 5, Fire Large 1, Fire Large 2, Fire Large 3, Fire Large 4, Fire Large 5	Always
Manual Placementi manualPlacement	checkbox	Off	—	Always
X Adjustmenti xAdjustment	range	0	-10–10 · step 0.05	Hidden when Manual Placement = On
Y Adjustmenti yAdjustment	range	0	-10–10 · step 0.05	Hidden when Manual Placement = On
Horizontal Flipi flipHorizontal	checkbox	Off	—	Shown when Manual Placement = On
Manual Placement Controlsi placementActions	particle-actions		—	Shown when Manual Placement = On
Light Sourcei lightSource	checkbox	Off	—	Shown when Manual Placement = On
Light Colori lightColor	color	#ff8a20 (enabled)	—	Shown when Manual Placement = On and Light Source = On
Light Radiusi lightRadius	range	4	0.5–20 · step 0.5	Shown when Manual Placement = On and Light Source = On
Bright Radiusi lightBrightRadius	range	1	0–20 · step 0.5	Shown when Manual Placement = On and Light Source = On
Light Intensityi lightAlpha	range	0.55	0.05–1 · step 0.05	Shown when Manual Placement = On and Light Source = On
Light Flickeri lightFlicker	range	0.65	0–1 · step 0.05	Shown when Manual Placement = On and Light Source = On
Directioni direction	range	0	0–360 · step 5	Always
Scalei scale	range	0.36	0.1–1 · step 0.01	Always
Densityi density	range	0.33	0–1 · step 0.01	Hidden when Manual Placement = On
Opacityi alpha	range	1	0–1 · step 0.05	Always
Flickeri flicker	range	0.55	0–1 · step 0.05	Always
Glowi glow	range	0.5	0–1 · step 0.01	Always
Glow Radiusi glowRadius	range	18	4–20 · step 1	Always
Burn Tokensi burnTokens	checkbox	Off	—	Always
Burn Durationi burnTokenDuration	range	8	1–60 · step 1	Shown when Burn Tokens = On
Burn Trigger Radiusi burnTokenRadius	range	0.75	0.1–5 · step 0.05	Shown when Burn Tokens = On
Burn Visual Scalei burnTokenScale	range	0.32	0.1–1 · step 0.01	Shown when Burn Tokens = On
Burn Opacityi burnTokenAlpha	range	0.85	0.1–1 · step 0.05	Shown when Burn Tokens = On
Burn Pulse Detaili burnTokenIntensity	range	0.43	0.1–1 · step 0.01	Shown when Burn Tokens = On
Burn Tinti burnTokenTint	color	#ff7a20 (disabled)	—	Shown when Burn Tokens = On
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_wikifireparticles_p",
    "type": "fireparticles",
    "options": {
      "manualPlacement": false,
      "scale": 0.5,
      "density": 0.35,
      "alpha": 1,
      "glow": 0.5
    }
  }],
});

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.