Hail

Weather reference

FXMasterParticle effectAPI type: hail

Directional hail particles with top-down mode, synchronized direction, and configurable scale, speed, density, and alpha.

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	hail
Exposed parameters	17

Important controls

• Top Down: Switches Hail to the overhead presentation intended for top-down maps. This changes particle projection and movement, so set it before finalizing scale and direction.
• Direction: Sets the primary travel direction for hail particles. Directional Spread can add variation around this angle.
• Synchronized Direction: Uses the active Wind or Duststorm direction for Hail. When the source direction changes, this effect follows it.
• Scale: Changes the rendered size of hail particles. It does not change how many particles are present.
• Density: Changes how many hail particles are visible or spawned at once. It does not change their size.

Setup notes

• Top Down changes the hail projection and should be selected before tuning Scale and Direction.
• Hail is visually strong, so moderate Opacity and Density values usually preserve token readability better.

Bundled preset usage

Preset	API name	Availability	Variants
Hail	hail	FXMaster	Normal, Top Down
Ice Storm	ice-storm	FXMaster	Normal, Top Down
Sleet	sleet	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.

17 exposed parameters1 Scene-onlyhail 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
Top Downi topDown	checkbox	Off	—	Always
Directioni direction	range	—	0–360 · step 5	Shown when Top Down = Off
Synchronized Directioni synchronizedDirection	checkbox	Off	—	Shown when Top Down = Off
Scalei scale	range	0.27	0.1–1 · step 0.01	Always
Speedi speed	range	0.18	0.1–1 · step 0.01	Always
Lifetimei lifetime	range	0.27	0.1–1 · step 0.01	Always
Densityi density	range	0.29	0.01–1 · step 0.01	Always
Opacityi alpha	range	1	0–1 · step 0.1	Always
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_wikihail_p",
    "type": "hail",
    "options": {
      "belowTokens": false,
      "tint": {
        "value": "#FFFFFF",
        "apply": false
      },
      "topDown": false,
      "scale": 0.27,
      "speed": 0.18
    }
  }],
});

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.