Fog

Environmental reference

FXMasterFilter effectAPI type: fog

Shader-based fog with configurable color, scale, speed, density, and directional movement.

Environmental filters change the Scene surface or atmosphere. They can cover the full Scene, be limited to Regions, and be moved within the effect stack.

Reference	Value
Package	FXMaster
Effect kind	Filter effect
Category	Environmental
Runtime type	fog
Exposed parameters	19

Important controls

• Scale: Changes the size of the fog pattern. Lower values create smaller, tighter detail; higher values create broader fog banks.
• Opacity: Changes how opaque the continuous fog layer appears. Higher values hide more of the underlying map.
• Direction: Sets the direction the fog layer travels across the canvas.
• Synchronized Direction: Uses the active Wind or Duststorm direction for Fog. When the source direction changes, this effect follows it.
• Token Trails: Moving visible tokens temporarily lower fog opacity along their path. The cleared area fades smoothly back to normal fog opacity.

Setup notes

• This is the Fog filter. The particle Fog effect creates separate moving banks instead.
• Token Trails can temporarily clear haze around moving tokens and settle back over time.
• Synchronized Direction allows the filter to follow compatible Wind or Duststorm effects.

Bundled preset usage

Preset	API name	Availability	Variants
Aether Haze	aether-haze	FXMaster+	Normal
Fog	fog	FXMaster	Normal
Heat Wave	heat-wave	FXMaster	Normal
Luminous Sky	luminous-sky	FXMaster+	Normal
Mist	mist	FXMaster	Normal
Rolling Fog	rolling-fog	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.

19 exposed parameters1 Scene-only1 Region-onlyfog 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 color	color	#000000 (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
Scalei dimensions	range	0.04	0–1 · step 0.01	Always
Speedi speed	range	0.1	0–1 · step 0.01	Always
Opacityi density	range	0.5	0–1 · step 0.05	Always
Directioni direction	range	0	0–360 · step 5	Always
Synchronized Directioni synchronizedDirection	checkbox	Off	—	Always
Token Trailsi tokenTrailsEnabled	checkbox	Off	—	Always
Trail Widthi tokenTrailWidth	range	1.1	0–2 · step 0.05	Shown when Token Trails = On
Trail Strengthi tokenTrailStrength	range	0.85	0–1 · step 0.01	Shown when Token Trails = On
Settle Time (Seconds)i tokenTrailSettleTime	range	3	0.4–5 · step 0.1	Shown when Token Trails = 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
Edge Fade %i fadePercentRegion only	range	0	0–1 · step 0.01	Always

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({
  filters: [{
    "id": "apiMacro_wikifogfilter_f",
    "type": "fog",
    "options": {
      "color": "#b9c4c9",
      "speed": 0.3,
      "density": 0.45,
      "direction": 180,
      "tokenTrailsEnabled": false
    }
  }],
});

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

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