Snowstorm
Dense procedural snowstorm with side-view or top-down presentation and sweeping background snow.
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 | snowstorm |
| Exposed parameters | 36 |
Snowstorm layers
Section titled “Snowstorm layers”Snowstorm is the denser and more directional snow effect. Within an enabled Snowstorm effect, the main airborne storm, persistent Background snow, and optional Sweeping Snow layer are configured separately. Disabling Snowstorm disables all of them.
Airborne storm
Section titled “Airborne storm”Choose Top Down before tuning Rotation Strength, Direction, Scale, Speed, and Density. Rotation Strength has its largest visual effect in Top Down mode and should remain lower when the flakes need to follow a more consistent route.
Background and sweeping snow
Section titled “Background and sweeping snow”Background adds accumulated snow with fill, opacity, variation, drift height, and drift size controls. Sweeping Snow adds a separate moving layer with its own opacity, scale, speed, and strength. The background is intentionally less opaque than Snow’s maximum so more of the map remains visible through the storm.
Token trails and refill
Section titled “Token trails and refill”Token trails use the same width, strength, refill, refill-time, and elevation controls as Snow. Configure these after the background appearance is established.
Important controls
Section titled “Important controls”- Top Down: Switches Snowstorm to the overhead presentation intended for top-down maps. This changes particle projection and movement, so set it before finalizing scale and direction.
- Rotation Strength: How strongly particles rotate as they move. 0 = no rotation; 1 = maximum configured rotation.
- Direction: Sets the primary travel direction for storm snowflakes. Directional Spread can add variation around this angle.
- Background: Render a persistent settled-snow surface beneath the snow storm effect. The surface follows the same stack placement, scene or Region mask, Levels selection, and below-token/tile settings as the standard snow background.
- Sweeping Snow: Adds the broad wind-swept snow sheet to the snow storm background instead of tying it to the main snowflake density.
- Token Trails: Create visible background trails as tokens move through the surface. By default trails remain for the current canvas session; Refill Trails Over Time can gradually restore the background.
Setup notes
Section titled “Setup notes”- Snowstorm is denser and more directional than Snow and includes a separate Sweeping Snow layer.
- Rotation Strength has its largest effect in Top Down mode. Keep it lower when flakes should follow a more consistent direction.
- Background Opacity can remain below full coverage so map details remain visible beneath the accumulated snow.
Bundled preset usage
Section titled “Bundled preset usage”| Preset | API name | Availability | Variants |
|---|---|---|---|
| Blizzard | blizzard |
FXMaster | Normal, Top Down |
Parameters
Section titled “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.
snowstorm API typeHover 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 Tokens belowTokens | checkbox | Off | — | Always |
Below Tiles belowTiles | checkbox | Off | — | Always |
Below Foreground belowForeground | checkbox | Off | — | Always |
Levels levelsScene only | scene-levels | All Levels | — | Always |
Tint tint | color | #FFFFFF (disabled) | — | Always |
Sound FX soundFxEnabled | checkbox | Off | — | Always |
Sound FX Sounds soundFxManualSoundIds | multi-select | Rule default | — | |
Top Down topDown | checkbox | Off | — | Always |
Rotation Strength rotationStrength | range | 0.35 | 0–1 · step 0.01 | |
Direction direction | range | — | 0–360 · step 5 | |
Synchronized Direction synchronizedDirection | checkbox | Off | — | |
Scale scale | range | 0.54 | 0.1–1 · step 0.01 | Always |
Speed speed | range | 0.82 | 0.1–1 · step 0.01 | Always |
Lifetime lifetime | range | 0.27 | 0.1–1 · step 0.01 | Always |
Density density | range | 0.3 | 0–1 · step 0.01 | Always |
Opacity alpha | range | 1 | 0–1 · step 0.1 | Always |
Background backgroundEnabled | checkbox | Off | — | Always |
Background Fill backgroundMode | select | accumulate | Full Coverage, Fill Over Time | |
Time to Full Coverage backgroundDuration | range | 180 | 10–3600 · step 10 | |
Background Opacity backgroundOpacity | range | 0.2 | 0–1 · step 0.01 | |
Fill Variation backgroundFillVariation | range | 0.75 | 0–1 · step 0.05 | |
Drift Height backgroundDriftStrength | range | 0 | 0–1 · step 0.05 | |
Drift Size (Grid Spaces) backgroundDriftScale | range | 0.01 | 0.01–1 · step 0.01 | |
Sweeping Snow backgroundSweepEnabled | checkbox | On | — | |
Sweep Opacity backgroundSweepOpacity | range | 0.4 | 0–1 · step 0.01 | |
Sweep Scale backgroundSweepScale | range | 1 | 0–1 · step 0.01 | |
Sweep Speed backgroundSweepSpeed | range | 0.8 | 0–1 · step 0.01 | |
Sweep Strength backgroundSweepStrength | range | 1 | 0–1 · step 0.01 | |
Token Trails backgroundTrailsEnabled | checkbox | Off | — | |
Refill Trails Over Time backgroundTrailRefillEnabled | checkbox | On | — | |
Trail Refill Time backgroundTrailRefillDuration | range | 90 | 10–3600 · step 10 | |
Trail Width backgroundTrailWidth | range | 0.5 | 0–2 · step 0.05 | |
Trail Strength backgroundTrailStrength | range | 0.25 | 0–1 · step 0.01 | |
Token Elevation Threshold backgroundInteractionElevationThreshold | number-infinity | 5 | 0–Infinity · step 0.5 | |
Darkness Activation darknessActivationEnabled | checkbox | Off | — | Always |
Darkness Activation Range darknessActivationRange | range-dual | {"min":0,"max":1} | 0–1 · step 0.01 |
Direct-effect API example
Section titled “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_wikisnowstorm_p", "type": "snowstorm", "options": { "topDown": true, "direction": 270, "speed": 0.55, "density": 0.45, "backgroundEnabled": 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.