Sakura Blossoms
Sakura blossom particles with standard movement controls and persistent background 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 | sakurablossoms |
| Exposed parameters | 30 |
Blossom ambience and ground coverage
Section titled “Blossom ambience and ground coverage”Within an enabled Sakura Blossoms effect, the drifting blossom layer and optional persistent Background accumulation are configured separately. Background is not standalone; disabling Sakura Blossoms disables both layers. The airborne layer uses Scale, Speed, Lifetime, Density, and Opacity, while Background has its own fill and appearance controls.
Background and trails
Section titled “Background and trails”Background controls fill timing, opacity, coverage, variation, pile amount, pile size, and Ground Particle Size. Token Trails controls the affected radius, strength, swirl, lift chance, settle time, and settle impact around moving tokens.
Important controls
Section titled “Important controls”- Scale: Changes the rendered size of sakura blossoms. It does not change how many particles are present.
- Density: Changes how many sakura blossoms are visible or spawned at once. It does not change their size.
- Background: Render a persistent field of settled particles behind the active effect. The field follows the same stack placement, scene or Region mask, Levels selection, and below-token/tile settings.
- Token Trails: Allows moving tokens to disturb the persistent background and leave visible trails through it.
- Trail Lift Chance: Controls how often a disturbed background particle is lifted briefly into the air instead of only sliding along the surface.
Setup notes
Section titled “Setup notes”- Background fill and appearance controls are separate from airborne Scale, Speed, Lifetime, Density, and Opacity while the effect is enabled.
- Use Trail Lift Chance sparingly so frequent token movement does not continuously refill the airborne layer.
Bundled preset usage
Section titled “Bundled preset usage”No bundled preset currently uses this effect directly. Add it through Particle Effects or the Direct Effect API.
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.
sakurablossoms 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 | — | |
Scale scale | range | 0.24 | 0.1–1 · step 0.01 | Always |
Speed speed | range | 0.27 | 0.1–1 · step 0.01 | Always |
Lifetime lifetime | range | 0.27 | 0.1–1 · step 0.01 | Always |
Density density | range | 0.15 | 0.05–1 · step 0.05 | 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.86 | 0–1 · step 0.01 | |
Ground Coverage backgroundCoverage | range | 0.7 | 0.05–1 · step 0.05 | |
Fill Variation backgroundFillVariation | range | 0.8 | 0–1 · step 0.05 | |
Pile Amount backgroundPileStrength | range | 0.4 | 0–1 · step 0.05 | |
Pile Size (Grid Spaces) backgroundPileSize | range | 4.5 | 0.5–12 · step 0.5 | |
Ground Particle Size backgroundParticleSize | range | 0.23 | 0.01–1 · step 0.01 | |
Token Trails backgroundInteractionEnabled | checkbox | Off | — | |
Trail Width backgroundInteractionRadius | range | 0.95 | 0–2 · step 0.05 | |
Trail Strength backgroundInteractionStrength | range | 0.55 | 0–1 · step 0.05 | |
Trail Swirl backgroundInteractionSwirl | range | 0.85 | 0–1 · step 0.05 | |
Trail Lift Chance backgroundInteractionLiftChance | range | 0.65 | 0–1 · step 0.05 | |
Settle Time (Seconds) backgroundInteractionSettleTime | range | 2 | 0.1–12 · step 0.1 | |
Settle Impact backgroundInteractionSettleImpact | range | 1 | 0–1 · step 0.05 | |
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_wikisakurablossoms_p", "type": "sakurablossoms", "options": { "belowTokens": false, "tint": { "value": "#FFFFFF", "apply": false }, "scale": 0.24, "speed": 0.27, "density": 0.15 } }],});
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.