Sakura Bloom
Sakura bloom particles with top-down and orbit modes, rotation, synchronized direction, 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 | sakurabloom |
| Exposed parameters | 36 |
Airborne petals and accumulation
Section titled “Airborne petals and accumulation”Within an enabled Sakura Bloom effect, directional or Top Down petals and optional Background accumulation are configured separately. Disabling Sakura Bloom disables both layers. Choose Top Down before adjusting Rotation Strength, Direction, Scale, Speed, and Density.
Background petals
Section titled “Background petals”Background adds persistent coverage with immediate or timed fill, opacity, coverage, variation, pile amount, pile size, and a separate Ground Particle Size.
Token trails
Section titled “Token trails”Token Trails disturbs the accumulated petals. Trail Width, Trail Strength, and Trail Swirl define the path, Trail Lift Chance returns some petals to the airborne layer, and the settle controls determine how the surface returns.
Important controls
Section titled “Important controls”- Top Down: Switches Sakura Bloom 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: Controls how strongly sakura bloom particles rotate while moving. Higher values produce more visible turning and spin.
- Direction: Sets the primary travel direction for sakura bloom particles. Directional Spread can add variation around this angle.
- 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.
Setup notes
Section titled “Setup notes”- Top Down controls the airborne presentation, while Background and Token Trails control accumulated petals.
- Tune Ground Particle Size separately from the airborne Scale.
Bundled preset usage
Section titled “Bundled preset usage”| Preset | API name | Availability | Variants |
|---|---|---|---|
| Sakura Bloom | sakura-bloom |
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.
sakurabloom 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 | — | |
Orbit orbit | checkbox | Off | — | |
Orbit Distance orbitDistance | range | 0.5 | 0–1 · step 0.01 | |
Rotation Strength rotationStrength | range | 0 | 0–1 · step 0.01 | |
Direction direction | range | — | 0–360 · step 5 | |
Synchronized Direction synchronizedDirection | checkbox | Off | — | |
Scale scale | range | 0.15 | 0.1–1 · step 0.01 | Always |
Speed speed | range | 0.29 | 0.1–1 · step 0.01 | Always |
Lifetime lifetime | range | 0.27 | 0.1–1 · step 0.01 | Always |
Density density | range | 0.5 | 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.8 | 0–1 · step 0.01 | |
Ground Coverage backgroundCoverage | range | 0.6 | 0.05–1 · step 0.05 | |
Fill Variation backgroundFillVariation | range | 0.75 | 0–1 · step 0.05 | |
Pile Amount backgroundPileStrength | range | 0.45 | 0–1 · step 0.05 | |
Pile Size (Grid Spaces) backgroundPileSize | range | 4 | 0.5–12 · step 0.5 | |
Ground Particle Size backgroundParticleSize | range | 0.08 | 0.01–1 · step 0.01 | |
Token Trails backgroundInteractionEnabled | checkbox | On | — | |
Trail Width backgroundInteractionRadius | range | 1 | 0–2 · step 0.05 | |
Trail Strength backgroundInteractionStrength | range | 0.5 | 0–1 · step 0.05 | |
Trail Swirl backgroundInteractionSwirl | range | 1 | 0–1 · step 0.05 | |
Trail Lift Chance backgroundInteractionLiftChance | range | 1 | 0–1 · step 0.05 | |
Settle Time (Seconds) backgroundInteractionSettleTime | range | 5 | 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_wikisakurabloom_p", "type": "sakurabloom", "options": { "belowTokens": false, "tint": { "value": "#FFFFFF", "apply": false }, "topDown": false, "orbit": false, "scale": 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.