Duststorm

Environmental reference

FXMaster+Filter effectAPI type: duststorm

Preview

Preview shows Duststorm and Sandstorm enabled together

Map maker

Map:Cze & Peku

Canvas-locked dust shader with directional flow, turbulence, streaks, and tinting.

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	duststorm
Exposed parameters	34

Important controls

• Direction: Sets the base travel direction of the dust filter.
• Direction Randomization: Randomly shifts the effect direction over time. At 1, the direction can randomize anywhere around the full compass.
• Density: Controls how much airborne dust is visible across the canvas.
• Streakiness: Controls how strongly the dust resolves into long directional streaks instead of a softer haze.
• Background: Render a persistent settled-sand surface behind the sandstorm. The surface follows the effect’s stack placement, scene or Region mask, Levels selection, and below-token/tile settings.
• Token Trails: Let visible tokens press darker, lower trails into accumulated sand as they move.

Setup notes

• Within an enabled Duststorm effect, the airborne dust and persistent sand Background can be toggled and configured separately. Disabling Duststorm disables both.
• Direction Randomization controls variation around the base Direction; Time Between Direction Changes controls how often a new target is selected.
• Streakiness and Opacity define the airborne filter, while the Background controls define persistent sand coverage.
• Use Token Trails and trail refill to make token movement visibly disturb the surface.

Bundled preset usage

Preset	API name	Availability	Variants
Ashfall	ashfall	FXMaster+	Normal, Top Down
Dust Devil	dust-devil	FXMaster+	Normal
Hurricane	hurricane	FXMaster+	Normal, Top Down
Luminous Sky	luminous-sky	FXMaster+	Normal
Sandstorm	sandstorm	FXMaster+	Normal
Tornado	tornado	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.

34 exposed parameters1 Scene-only1 Region-onlyduststorm 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	On	—	Always
Below Tilesi belowTiles	checkbox	Off	—	Always
Below Foregroundi belowForeground	checkbox	Off	—	Always
Levelsi levelsScene only	scene-levels	All Levels	—	Always
Tinti color	color	#b38b5a (enabled)	—	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.24	0–1 · step 0.01	Always
Speedi speed	range	0.2	0–1 · step 0.01	Always
Densityi density	range	0.55	0–1 · step 0.05	Always
Direction Randomizationi directionRandomization	range	0	0–1 · step 0.01	Always
Direction Change Radiusi directionRandomizationRadius	range	1	0–1 · step 0.01	Shown when Direction Randomization > 0
Time Between Direction Changesi directionChangeTime	range	8	1–60 · step 0.5	Shown when Direction Randomization > 0
Streakinessi streakiness	range	0.15	0–1 · step 0.05	Always
Opacityi opacity	range	1	0–1 · step 0.05	Always
Directioni direction	range	0	0–360 · step 5	Always
Backgroundi backgroundEnabled	checkbox	Off	—	Always
Background Filli backgroundMode	select	accumulate	Full Coverage, Fill Over Time	Shown when Background = On
Time to Full Coveragei backgroundDuration	range	180	10–3600 · step 10	Shown when Background = On and Background Fill = Fill Over Time
Background Opacityi backgroundOpacity	range	0.76	0–1 · step 0.01	Shown when Background = On
Fill Variationi backgroundFillVariation	range	0.75	0–1 · step 0.05	Shown when Background = On
Dune Heighti backgroundDriftStrength	range	0.62	0–1 · step 0.01	Shown when Background = On
Dune Size (Grid Spaces)i backgroundDriftScale	range	0.38	0.1–1 · step 0.01	Shown when Background = On
Sand Griti backgroundSandRippleStrength	range	0.45	0–1 · step 0.05	Shown when Background = On
Dune Migrationi backgroundMigrationEnabled	checkbox	Off	—	Shown when Background = On
Migration Speed (Grid Spaces/Minute)i backgroundMigrationSpeed	range	0.06	0.01–1 · step 0.01	Shown when Background = On and Dune Migration = On
Token Trailsi backgroundTrailsEnabled	checkbox	Off	—	Shown when Background = On
Refill Trails Over Timei backgroundTrailRefillEnabled	checkbox	Off	—	Shown when Background = On and Token Trails = On
Trail Refill Timei backgroundTrailRefillDuration	range	90	10–3600 · step 10	Shown when Background = On and Token Trails = On and Refill Trails Over Time = On
Trail Widthi backgroundTrailWidth	range	0.5	0–2 · step 0.05	Shown when Background = On and Token Trails = On
Trail Strengthi backgroundTrailStrength	range	0.72	0–1 · step 0.01	Shown when Background = On and 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_wikiduststorm_f",
    "type": "duststorm",
    "options": {
      "belowTokens": true,
      "color": {
        "value": "#b38b5a",
        "apply": true
      },
      "speed": 0.2,
      "direction": 0,
      "density": 0.55
    }
  }],
});

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.