Autumn Leaves

Ambient reference

FXMasterParticle effectAPI type: autumnleaves

Layered falling leaves with variant selection, wind motion, spin, shadows, and persistent ground accumulation.

Ambient effects add visible movement without replacing the full weather setup. Use them on their own or layer them with another particle or filter.

Reference	Value
Package	FXMaster
Effect kind	Particle effect
Category	Ambient
Runtime type	autumnleaves
Exposed parameters	46

Airborne and background leaves

Within an enabled Autumn Leaves effect, airborne leaves and the persistent Background surface can be toggled and configured separately. Background is not a standalone effect; disabling Autumn Leaves disables both layers.

Airborne motion

Spawn Mode, Direction, Directional Spread, Scale, Speed, Density, Spin Speed, Turbulence, Gustiness, Depth Variation, and Ripple shape the moving leaves. Set the travel pattern first, then use the rendering controls to keep repeated particles from looking uniform.

Ground coverage

Background adds persistent leaf coverage with immediate or timed fill, opacity, coverage, variation, pile amount, pile size, and ground-particle size controls.

Token trails

Token Trails disturbs the settled leaves. Trail Width, Trail Strength, and Trail Swirl define the movement around a token. Trail Lift Chance can return some leaves to the airborne layer, while Settle Time (Seconds) and Settle Impact control the return to rest.

Important controls

• Spawn Mode: Chooses whether leaves spawn across the view, along the top edge, or along the edge facing into the selected wind direction.
• Direction: Sets the primary travel direction for airborne leaves. Directional Spread can add variation around this angle.
• Turbulence: Adds small independent changes to leaf travel direction.
• Background: Render a persistent field of settled leaves behind the falling effect. The field follows the same stack placement, scene or Region mask, Levels selection, and below-token/tile settings.
• Token Trails: Allow visible token trails to push, spin, and briefly lift nearby settled leaves while moving through them. Displaced leaves settle in their new positions for the current canvas session.

Setup notes

• Trail Width controls the affected area; Trail Strength and Trail Swirl shape the response; Settle Time (Seconds) controls how quickly the surface returns.
• Spawn Mode and Depth Variation help prevent the leaves from forming a uniform curtain.

Bundled preset usage

Preset	API name	Availability	Variants
Autumn Leaves	autumn-leaves	FXMaster	Normal, Top Down

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.

46 exposed parameters1 Scene-onlyautumnleaves 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	—	Hidden when Orbit = On
Orbiti orbit	checkbox	Off	—	Hidden when Top Down = On
Orbit Distancei orbitDistance	range	0.5	0–1 · step 0.01	Shown when Orbit = On
Directional Movementi directionalMovement	checkbox	Off	—	Hidden when Orbit = On or Top Down = On
Directioni direction	range	—	0–360 · step 5	Shown when Directional Movement = On or Spawn Mode = Upwind EdgeHidden when Orbit = On or Top Down = On
Synchronized Directioni synchronizedDirection	checkbox	Off	—	Shown when Directional Movement = OnHidden when Orbit = On or Top Down = On
Directional Spreadi spread	range	0	0–20 · step 1	Shown when Directional Movement = OnHidden when Orbit = On or Top Down = On
Spawn Modei spawnMode	select	full	Full View, Top Edge, Upwind Edge	Hidden when Orbit = On or Top Down = On
Scalei scale	range	0.3	0.1–1 · step 0.01	Always
Speedi speed	range	0.15	0.1–1 · step 0.01	Always
Lifetimei lifetime	range	0.65	0.1–1 · step 0.01	Always
Densityi density	range	0.5	0.05–1 · step 0.05	Always
Opacityi alpha	range	1	0–1 · step 0.1	Always
Spin Speedi spin	range	0.25	0–1 · step 0.05	Always
Turbulencei turbulence	range	0	0–1 · step 0.05	Hidden when Orbit = On
Gustinessi gustiness	range	0	0–1 · step 0.05	Hidden when Orbit = On
Depth Variationi depthVariation	range	0	0–1 · step 0.05	Always
Ripplei liveliness	range	0	0–1 · step 0.05	Always
Edge Definitioni edgeDefinition	range	0	0–1 · step 0.05	Always
Edge Widthi edgeWidth	range	0	0–3 · step 0.25	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.8	0–1 · step 0.01	Shown when Background = On
Ground Coveragei backgroundCoverage	range	0.4	0.05–1 · step 0.05	Shown when Background = On
Fill Variationi backgroundFillVariation	range	0.7	0–1 · step 0.05	Shown when Background = On and Background Fill = Fill Over Time
Pile Amounti backgroundPileStrength	range	0.6	0–1 · step 0.05	Shown when Background = On
Pile Size (Grid Spaces)i backgroundPileSize	range	3.5	0.5–12 · step 0.5	Shown when Background = On
Ground Particle Sizei backgroundLeafSize	range	0.21	0.01–1 · step 0.01	Shown when Background = On
Token Trailsi backgroundInteractionEnabled	checkbox	On	—	Shown when Background = On
Trail Widthi backgroundInteractionRadius	range	0.9	0–2 · step 0.05	Shown when Background = On and Token Trails = On
Trail Strengthi backgroundInteractionStrength	range	0.7	0–1 · step 0.05	Shown when Background = On and Token Trails = On
Trail Swirli backgroundInteractionSwirl	range	0.55	0–1 · step 0.05	Shown when Background = On and Token Trails = On
Trail Lift Chancei backgroundInteractionLiftChance	range	0.25	0–1 · step 0.05	Shown when Background = On and Token Trails = On
Token Elevation Thresholdi backgroundInteractionElevationThreshold	number-infinity	5	0–Infinity · step 0.5	Shown when Background = On and Token Trails = On
Settle Time (Seconds)i backgroundInteractionSettleTime	range	0.2	0.1–12 · step 0.1	Shown when Background = On and Token Trails = On
Settle Impacti backgroundInteractionSettleImpact	range	1	0–1 · step 0.05	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

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_wikiautumnleaves_p",
    "type": "autumnleaves",
    "options": {
      "topDown": true,
      "direction": 225,
      "synchronizedDirection": false,
      "density": 0.35,
      "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.