Skip to content

Wind

Environmental reference
FXMaster+Filter effectAPI type: wind
Preview shows Wind and Summer Leaves enabled together, with Wind in Manual Painting mode

Canvas-locked wind distortion with turbulence, gusts, streaks, synchronized direction, and manual painting.

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 wind
Exposed parameters 28

Wind can run across the complete Scene or Region, or it can be limited to a painted mask.

Start with Direction, Speed, and Density. Then use Scale and Opacity to set the overall coverage. Distortion, Turbulence, Sway Strength, Sway Frequency, Gustiness, Streakiness, and Highlight shape the movement and visible detail.

Direction Randomization adds variation around the base direction. Direction Change Radius sets the allowed range, and Time Between Direction Changes controls how often a new target is selected.

Enable Manual Painting to create a movement mask. Brush Radius (Grid Spaces) controls the painted area, while the Painting actions add to, erase, or clear the mask. This can work well for wind passing through a doorway, moving around a large obstruction, following a canyon, or remaining on one side of a Region.

See Wind Painting for the complete painting workflow.

Wind can act as the direction source for compatible effects. Enable Synchronized Direction on a supported particle or filter to follow Wind’s direction changes while retaining its own speed, scale, density, and appearance.

  • Manual Painting: Restrict movement to painted areas while leaving the subtle visible wind sheen across the full Scene or Region.
  • Direction: Sets the base direction of the wind movement.
  • Direction Randomization: Randomly shifts the effect direction over time. At 1, the direction can randomize anywhere around the full compass.
  • Turbulence: Irregular movement inside painted Manual Painting areas. Higher values create rougher local motion.
  • Gustiness: Adds larger shared pulses in wind speed so the effect accelerates and eases instead of remaining constant.
  • Streakiness: Controls how strongly the wind appears as long directional streaks.
  • Highlight: Controls the brightness of the subtle moving highlight used to make the wind visible.
  • Manual Painting opens the Wind painting tools. Brush Radius (Grid Spaces) controls the paint area, and the Painting actions add, erase, or clear the mask.
  • Direction Randomization and Time Between Direction Changes create evolving wind, while Sway, Turbulence, Gustiness, Streakiness, and Highlight shape its appearance.
  • Wind can drive Synchronized Direction on compatible particle and filter effects.
Preset API name Availability Variants
Arcane Winds arcane-winds FXMaster+ Normal
Gravewind gravewind FXMaster+ Normal
Windy windy FXMaster+ Normal

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.

28 exposed parameters1 Scene-only1 Region-onlywind API type

Hover 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.

ParameterControlDefaultRange or choicesAvailability
Below Tokens
belowTokens
checkboxOffAlways
Below Tiles
belowTiles
checkboxOffAlways
Below Foreground
belowForeground
checkboxOffAlways
Levels
levelsScene only
scene-levelsAll LevelsAlways
Manual Painting
manualPlacement
checkboxOffAlways
Distortion
distortion
range0.350–1 · step 0.05
Turbulence
turbulence
range0.20–1 · step 0.05
Sway Strength
swayStrength
range0.250–1 · step 0.05
Sway Frequency
swayFrequency
range0.320–1 · step 0.01
Brush Radius (Grid Spaces)
manualPaintBrushSize
range1.250.1–8 · step 0.05
Painting
manualPaintActions
filter-actions
Highlight Tint
color
color#dfefff (enabled)Always
Sound FX
soundFxEnabled
checkboxOffAlways
Sound FX Sounds
soundFxManualSoundIds
multi-selectRule default
Scale
dimensions
range0.260–1 · step 0.01Always
Speed
speed
range0.20.05–1 · step 0.05Always
Density
density
range0.250–1 · step 0.05Always
Direction Randomization
directionRandomization
range00–1 · step 0.01Always
Direction Change Radius
directionRandomizationRadius
range10–1 · step 0.01
Time Between Direction Changes
directionChangeTime
range81–60 · step 0.5
Gustiness
gustiness
range0.450–1 · step 0.05Always
Streakiness
streakiness
range0.60–1 · step 0.05Always
Highlight
sheenStrength
range0.20–1 · step 0.05Always
Opacity
opacity
range10–1 · step 0.05Always
Direction
direction
range00–360 · step 5Always
Darkness Activation
darknessActivationEnabled
checkboxOffAlways
Darkness Activation Range
darknessActivationRange
range-dual{"min":0,"max":1}0–1 · step 0.01
Edge Fade %
fadePercentRegion only
range00–1 · step 0.01Always

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_wikiwind_f",
"type": "wind",
"options": {
"manualPlacement": false,
"direction": 180,
"speed": 0.4,
"density": 0.55,
"turbulence": 0.5,
"gustiness": 0.45
}
}],
});
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.